| java.lang.Object
 nextapp.echo2.app.update.ServerUpdateManager
| ServerUpdateManager | | public class ServerUpdateManager implements Serializable(Code) | | Monitors updates to component hierarchy and records deltas between
server state of application and client state of application.
|
| Method Summary | |
| public void | enqueueCommand(Command command)
Enqueues a Command for processing. | | public PropertyUpdate | getApplicationPropertyUpdate(String propertyName)
Returns a PropertyUpdate representing the
application-level property update with the specified name. | | public Command[] | getCommands()
Returns the stored Commands. | | public ServerComponentUpdate[] | getComponentUpdates()
Returns the stored ServerComponentUpdates. | | public void | init(ClientUpdateManager clientUpdateManager)
Initialization life-cycle method. | | public boolean | isEmpty()
Determines if the manager has no updates. | | public boolean | isFullRefreshRequired()
Determines if a full refresh of the client state is required. | | public void | processApplicationPropertyUpdate(String propertyName, Object oldValue, Object newValue)
Processes an update to a property of the ApplicationInstance. | | public void | processComponentAdd(Component parent, Component child)
Processes the addition of a component to the hierarchy. | | public void | processComponentLayoutDataUpdate(Component updatedComponent)
Processes an update to the LayoutData of a component. | | public void | processComponentPropertyUpdate(Component updatedComponent, String propertyName, Object oldValue, Object newValue)
Processes an update to a property of a component (other than the
LayoutData property). | | public void | processComponentRemove(Component parent, Component child)
Processes the removal of a component from the hierarchy. | | public void | processComponentVisibilityUpdate(Component updatedComponent)
Processes an update to the visible state of a component. | | public void | processFullRefresh()
Processes a full refresh of the application state, in response to a
severe change, such as application locale or style sheet. | | void | purge()
Removes all ServerComponentUpdates from the manager,
resetting its state to zero. |
| enqueueCommand | | public void enqueueCommand(Command command)(Code) | | Enqueues a Command for processing.
Parameters:
command - the command |
| getApplicationPropertyUpdate | | public PropertyUpdate getApplicationPropertyUpdate(String propertyName)(Code) | | Returns a PropertyUpdate representing the
application-level property update with the specified name.
If the specified property has not been updated, null is returned.
Parameters:
propertyName - the name of the property the PropertyUpdate |
| getCommands | | public Command[] getCommands()(Code) | | Returns the stored Commands. The commands
are NOT removed or modified by this call.
the commands |
| getComponentUpdates | | public ServerComponentUpdate[] getComponentUpdates()(Code) | | Returns the stored ServerComponentUpdates. The updates
are NOT removed or modified by this call. The updates will be returned
sorted by depth of their parent components within the hierarchy, but in
otherwise random order.
the updates |
| init | | public void init(ClientUpdateManager clientUpdateManager)(Code) | | Initialization life-cycle method. Must be invoked before using
the ServerUpdateManager.
Parameters:
clientUpdateManager - the ClientUpdateManager thatwill be used to process input from the client |
| isEmpty | | public boolean isEmpty()(Code) | | Determines if the manager has no updates.
true if the manager has no updates |
| isFullRefreshRequired | | public boolean isFullRefreshRequired()(Code) | | Determines if a full refresh of the client state is required.
true if a full refresh is required |
| processApplicationPropertyUpdate | | public void processApplicationPropertyUpdate(String propertyName, Object oldValue, Object newValue)(Code) | | Processes an update to a property of the ApplicationInstance.
Parameters:
propertyName - the name of the property
Parameters:
oldValue - the previous value of the property
Parameters:
newValue - the current value of the property |
| processComponentAdd | | public void processComponentAdd(Component parent, Component child)(Code) | | Processes the addition of a component to the hierarchy.
Creates/updates a ServerComponentUpdate if required.
Parameters:
parent - a component which currently exists in the hierarchy
Parameters:
child - the component which was added to parent |
| processComponentLayoutDataUpdate | | public void processComponentLayoutDataUpdate(Component updatedComponent)(Code) | | Processes an update to the LayoutData of a component.
Creates/updates a ServerComponentUpdate if required.
Parameters:
updatedComponent - a component which currently exists in the hierarchy whose LayoutData has changed |
| processComponentPropertyUpdate | | public void processComponentPropertyUpdate(Component updatedComponent, String propertyName, Object oldValue, Object newValue)(Code) | | Processes an update to a property of a component (other than the
LayoutData property).
Creates/updates a ServerComponentUpdate if required.
Parameters:
updatedComponent - the component whose property(s) changed.
Parameters:
propertyName - the name of the changed property
Parameters:
oldValue - The previous value of the property
Parameters:
newValue - The new value of the property |
| processComponentRemove | | public void processComponentRemove(Component parent, Component child)(Code) | | Processes the removal of a component from the hierarchy.
Creates/updates a ServerComponentUpdate if required.
Parameters:
parent - a component which currently exists in the hierarchy
Parameters:
child - the component which was removed from parent |
| processComponentVisibilityUpdate | | public void processComponentVisibilityUpdate(Component updatedComponent)(Code) | | Processes an update to the visible state of a component.
Creates/updates a ServerComponentUpdate if required.
Parameters:
updatedComponent - a component which currently exists in the hierarchy whose visible state has changed. |
| processFullRefresh | | public void processFullRefresh()(Code) | | Processes a full refresh of the application state, in response to a
severe change, such as application locale or style sheet.
|
| purge | | void purge()(Code) | | Removes all ServerComponentUpdates from the manager,
resetting its state to zero. This method is invoked by the
container once it has retrieved and processed all available updates.
|
|
|