echopointng.ui.syncpeer
Class LiveTablePeer

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

All Implemented Interfaces:

ActionProcessor, ComponentSynchronizePeer, DomUpdateSupport

public class LiveTablePeer
extends AbstractEchoPointContainerPeer
implements ActionProcessor

LiveTablePeer is the peer for LiveTable

Field Summary

static Service

LIVETABLE_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.ActionProcessor

ACTION_NAME, ACTION_VALUE

Constructor Summary

LiveTablePeer()

Method Summary

protected void	createDisposeDirective(ServerMessage serverMessage, Component component) Disposes of the LiveTable on the client.
protected void	createInitDirective(RenderingContext rc, LiveTable liveTable, Style fallbackStyle) Renders a directive to the outgoing ServerMessage to initialize the state of a LiveTable, performing tasks such as registering event listeners on the client and creating the JS object.
void	processAction(ContainerInstance ci, Component component, org.w3c.dom.Element actionElement) Notifies the ComponentSynchronizePeer that a client action has occurred.
void	renderDispose(RenderContext rc, ServerComponentUpdate update, Component component) Removes any render state that is associated with the component.
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

LIVETABLE_SERVICE

public static final Service LIVETABLE_SERVICE

Service to provide supporting JavaScript library.

Constructor Detail

LiveTablePeer

public LiveTablePeer()

Method Detail

createDisposeDirective

protected void createDisposeDirective(ServerMessage serverMessage,
                                      Component component)

Disposes of the LiveTable on the client.

createInitDirective

protected void createInitDirective(RenderingContext rc,
                                   LiveTable liveTable,
                                   Style fallbackStyle)

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

processAction

public void processAction(ContainerInstance ci,
                          Component component,
                          org.w3c.dom.Element actionElement)

Description copied from interface: ActionProcessor

Notifies the ComponentSynchronizePeer that a client action has occurred.

Specified by:

processAction in interface ActionProcessor

Parameters:

ci - the relevant ContainerInstance

component - the target Component

actionElement - the XML element describing the action (the name and value of the action may be obtained by querying the ACTION_NAME and ACTION_VALUE attribute values.

See Also:

ActionProcessor.processAction(nextapp.echo2.webcontainer.ContainerInstance, nextapp.echo2.app.Component, org.w3c.dom.Element)

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)

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)

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)