Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## echopointng.ui.syncpeer
Class TitleBarPeer

    java.lang.Object
      echopointng.ui.syncpeer.AbstractEchoPointPeer
          echopointng.ui.syncpeer.AbstractEchoPointContainerPeer
              echopointng.ui.syncpeer.TitleBarPeer

All Implemented Interfaces:
  ComponentSynchronizePeer, DomUpdateSupport, PropertyUpdateProcessor

    public class TitleBarPeer

extends AbstractEchoPointContainerPeer
implements PropertyUpdateProcessor

`TitleBarPeer` is the peer for `TitleBarPeer`

Field Summary
`static Service` | `TITLEBAR_SERVICE` Service to provide supporting JavaScript library.

Fields inherited from class echopointng.ui.syncpeer.AbstractEchoPointPeer
`DEFAULT_CONTAINER_TAG, partialUpdateManager`

Fields inherited from interface nextapp.echo2.webcontainer.PropertyUpdateProcessor
`PROPERTY_NAME, PROPERTY_VALUE`

Constructor Summary
`TitleBarPeer()`

Method Summary
`protected void` | `createDisposeDirective(ServerMessage serverMessage, Component component)`
`protected void` | `createInitDirective(RenderingContext rc, Component component, java.lang.String partnerComponentId, Style fallbackStyle)` Renders a directive to the outgoing `ServerMessage` to initialize the state of a TitleBar, performing tasks such as registering event listeners on the client and creating the JS object.
`void` | `processPropertyUpdate(ContainerInstance ci, Component component, org.w3c.dom.Element propertyElement)` Notifies the `ComponentSynchronizePeer` that a client property update has occurred.
`void` | `renderDispose(RenderContext rc, ServerComponentUpdate update, Component component)` Removes any render state that is associated with the component.
`void` | `renderHtml(RenderContext rc, ServerComponentUpdate update, org.w3c.dom.Node parent, Component component, java.lang.String partnerComponentId)` This method will render the TitleBar as usual however it informs the TitleBar of the id of the partner Component, that wants to be called in JS if the expand icons are pressed.
`void` | `renderHtml(RenderingContext rc, org.w3c.dom.Node parent, Component component)` This is the rendering method you must implement if you are to use `AbstractEchoPointPeer`.
`boolean` | `renderUpdate(RenderContext rc, ServerComponentUpdate update, java.lang.String targetId)` This looks for children with updated layour data or updated properties on the peer's component and if there are any, it removes and redraws the entire peer otherwise it just replaces the children and the redraws them.

Methods inherited from class echopointng.ui.syncpeer.AbstractEchoPointContainerPeer
`getContainerId`

Methods inherited from class echopointng.ui.syncpeer.AbstractEchoPointPeer
`disposeRenderState, renderAdd, renderHtml, renderReplaceableChild, renderUpdateAddChildren, renderUpdateBaseImpl, renderUpdateRemoveChildren, retreiveRenderState, storeRenderState`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### TITLEBAR_SERVICE

    public static final Service TITLEBAR_SERVICE

  Service to provide supporting JavaScript library.

Constructor Detail

### TitleBarPeer

    public TitleBarPeer()

Method Detail

### processPropertyUpdate

    public void processPropertyUpdate(ContainerInstance ci,
                                      Component component,
                                      org.w3c.dom.Element propertyElement)

  Description copied from interface: `PropertyUpdateProcessor`
  Notifies the `ComponentSynchronizePeer` that a client property update has occurred.

  Specified by:
    `processPropertyUpdate` in interface `PropertyUpdateProcessor`
  Parameters:
    `ci` - the relevant `ContainerInstance`
    `component` - the target `Component`
    `propertyElement` - the XML element describing the property update (the name and value of the changed property may be obtained by querying the `PROPERTY_NAME` and `PROPERTY_VALUE` attribute values.
  See Also:
    `PropertyUpdateProcessor.processPropertyUpdate(nextapp.echo2.webcontainer.ContainerInstance, nextapp.echo2.app.Component, org.w3c.dom.Element)`

### renderUpdate

    public boolean renderUpdate(RenderContext rc,
                                ServerComponentUpdate update,
                                java.lang.String targetId)

  Description copied from class: `AbstractEchoPointContainerPeer`
  This looks for children with updated layour data or updated properties on the peer's component and if there are any, it removes and redraws the entire peer otherwise it just replaces the children and the redraws them. This method ends up calling the ends `renderUpdate(rc, update, targetId, fullReplace)` method with an appropriate value for `fullReplace`.

  Specified by:
    `renderUpdate` in interface `ComponentSynchronizePeer`
  Overrides:
    `renderUpdate` in class `AbstractEchoPointContainerPeer`
  Parameters:
    `rc` - the relevant `RenderContext`
    `update` - the `ServerComponentUpdate` for which this operation is being performed
    `targetId` - the id of the HTML element inside of which the components HTML code should be rendered.
  Returns:
    true if updates to descendants should NOT be performed
  See Also:
    `AbstractEchoPointContainerPeer.renderUpdate(nextapp.echo2.webcontainer.RenderContext, nextapp.echo2.app.update.ServerComponentUpdate, java.lang.String)`

### renderHtml

    public void renderHtml(RenderingContext rc,
                           org.w3c.dom.Node parent,
                           Component component)

  Description copied from class: `AbstractEchoPointPeer`
  This is the rendering method you must implement if you are to use `AbstractEchoPointPeer`.

  Its a simpler wrapper for the standard one but provides some neato setup services that would otherwise be repeated over and over again.

  Note the use of RenderingContext object instead of the standard Echo RenderContext as this provides more rich code facilities.

  Specified by:
    `renderHtml` in class `AbstractEchoPointPeer`
  Parameters:
    `rc` - - the RenderingContext to use
    `parent` - - the parent Node to put content into
    `component` - - the component in question
  See Also:
    `AbstractEchoPointPeer.renderHtml(echopointng.ui.util.RenderingContext, Node, nextapp.echo2.app.Component)`

### renderHtml

    public void renderHtml(RenderContext rc,
                           ServerComponentUpdate update,
                           org.w3c.dom.Node parent,
                           Component component,
                           java.lang.String partnerComponentId)

  This method will render the TitleBar as usual however it informs the TitleBar of the id of the partner Component, that wants to be called in JS if the expand icons are pressed.

### createInitDirective

    protected void createInitDirective(RenderingContext rc,
                                       Component component,
                                       java.lang.String partnerComponentId,
                                       Style fallbackStyle)

  Renders a directive to the outgoing `ServerMessage` to initialize the state of a TitleBar, performing tasks such as registering event listeners on the client and creating the JS object.

### renderDispose

    public void renderDispose(RenderContext rc,
                              ServerComponentUpdate update,
                              Component component)

  Description copied from class: `AbstractEchoPointPeer`
  Removes any render state that is associated with the component.

  Remember to call `super.renderDispose()` if you overrride this method.

  Specified by:
    `renderDispose` in interface `ComponentSynchronizePeer`
  Overrides:
    `renderDispose` in class `AbstractEchoPointPeer`
  Parameters:
    `rc` - the relevant `RenderContext`
    `update` - the `ServerComponentUpdate` for which this operation is being performed
  See Also:
    `ComponentSynchronizePeer.renderDispose(nextapp.echo2.webcontainer.RenderContext, nextapp.echo2.app.update.ServerComponentUpdate, nextapp.echo2.app.Component)`

### createDisposeDirective

    protected void createDisposeDirective(ServerMessage serverMessage,
                                          Component component)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD