Echo.Arc
ComponentSync
Abstract
Class Hierarchy:
Direct Known Subclasses:
Extras.Sync.RichTextArea
Component synchronization peer for application rendered components. Application rendered component peers should extend this peer. The super-implementations of the renderAdd(), renderDispose(), renderDisplay(), and renderUpdate() methods must be invoked.
Instance Method Summary
Public, Abstract createComponent()
Creates the base component of that will be added to the root of the rendering application.
Public, Virtual getDomainElement()
Returns the element in which the client should be rendered.
Public, Virtual renderAdd()
renderAdd() implementation: must be invoked by overriding method.
Public, Virtual renderDisplay()
renderDisplay() implementation: must be invoked by overriding method.
Public, Virtual renderDispose()
renderDispose() implementation: must be invoked by overriding method.
Public, Virtual renderUpdate()
Default implementation disposes of the existing client and application and creates a new one.

Methods inherited from class Echo.Render.ComponentSync
renderAdd, renderDispose, renderUpdate

Instance Method Detail
createComponent
Creates the base component of that will be added to the root of the rendering application. This component should probably be a ContentPane or other container. This method must be overridden by ARC implementations.
Returns:
(Echo.Component) $functionDO.getReturnDescription()
getDomainElement
Returns the element in which the client should be rendered.
Returns:
(Element) $functionDO.getReturnDescription()
renderAdd
renderAdd() implementation: must be invoked by overriding method.
renderDisplay
renderDisplay() implementation: must be invoked by overriding method. This method will create a new client and application instance if one does not exist (i.e., if this method is being called for the first time after renderAdd()). When the application is created, the component returned by createComponent() will be added to the root component of the application. The application will be installed in the DOM at the element returned by the getDomainElement().
renderDispose
renderDispose() implementation: must be invoked by overriding method.
renderUpdate
Default implementation disposes of the existing client and application and creates a new one. All application state will be lost. This method should thus be overridden in the event that the application rendered component desires to perform a more efficient update. This implementation may be called by the overriding implementation if replacing-and-redrawing is desired.