echopointng.ui.syncpeer
Class PopUpPeer

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

All Implemented Interfaces:

ComponentSynchronizePeer, DomUpdateSupport, PropertyUpdateProcessor

Direct Known Subclasses:

BalloonHelpPeer, ComboBoxPeer

public class PopUpPeer
extends AbstractEchoPointContainerPeer
implements PropertyUpdateProcessor

PopUpPeer is the peer for PopUpPeer

Field Summary

static Service	POPUP_DEFAULT_TOGGLE_IMAGE
static Service	POPUP_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

PopUpPeer()

Method Summary

protected void	createDisposeDirective(ServerMessage serverMessage, Component component) Renders a directive to the outgoing ServerMessage to dispose the state of a PopUp, performing tasks such as deregistering event listeners on the client and deleting its JS object.
protected void	createInitDirective(RenderingContext rc, Component component, Style fallbackStyle) Renders a directive to the outgoing ServerMessage to initialize the state of a PopUp, performing tasks such as registering event listeners on the client and creating the EPMI JS object.
void	processPropertyUpdate(ContainerInstance ci, Component component, org.w3c.dom.Element propertyElement) Notifies the ComponentSynchronizePeer that a client property update has occurred.
protected org.w3c.dom.Element	renderBox(RenderingContext rc, Component component, Style fallbackStyle) This is called to render the popup floating box.
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

POPUP_DEFAULT_TOGGLE_IMAGE

public static final Service POPUP_DEFAULT_TOGGLE_IMAGE

POPUP_SERVICE

public static final Service POPUP_SERVICE

Service to provide supporting JavaScript library.

Constructor Detail

PopUpPeer

public PopUpPeer()

Method Detail

createDisposeDirective

protected void createDisposeDirective(ServerMessage serverMessage,
                                      Component component)

Renders a directive to the outgoing ServerMessage to dispose the state of a PopUp, performing tasks such as deregistering event listeners on the client and deleting its JS object.

createInitDirective

protected void createInitDirective(RenderingContext rc,
                                   Component component,
                                   Style fallbackStyle)

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

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)

renderBox

protected org.w3c.dom.Element renderBox(RenderingContext rc,
                                        Component component,
                                        Style fallbackStyle)

This is called to render the popup floating box. The name of the returned box Element must be elementId + "Box" for JavaScript reasons.

Returns:

a new top level Element for the floating box

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:

AbstractEchoPointPeer.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)