com.goldencode.p2j.ui

Class ClientConfigManager

java.lang.Object

com.goldencode.p2j.ui.ConfigManager

com.goldencode.p2j.ui.ClientConfigManager

All Implemented Interfaces:

WidgetListener, WidgetStateListener

public class ClientConfigManager
extends ConfigManager
implements WidgetStateListener

Management of widget configurations, on client-side.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	canPushUpdates Flag indicating when the client-side can start pushing updates.
private ThinClient	tc Cache of the ThinClient instance.

Fields inherited from class com.goldencode.p2j.ui.ConfigManager

activeConfigs, backupConfigs, cfgDefs, dirtyConfigs, widgetCfg

Constructor Summary

Constructors

Constructor and Description
ClientConfigManager() Initialize the client-side.

Method Summary

Modifier and Type	Method and Description
void	activateConfigUpdates() Inform the client-side that it can start sending the config updates.
void	deactivateConfigUpdates() Inform the client-side that it can no longer send config updates.
WidgetConfigUpdates[]	getConfigUpdates() Get the widget configuration updates, by comparing the active with the backup configuration.
protected boolean	isRegisteredWidget(WidgetId id) Check if the given ID is associated with a registered widget.
void	notifyWidgetDestroyed(Widget<? extends OutputManager<?>> w) Notify the given widget has been destroyed.
(package private) ConfigOwner<?>	resolveConfigOwner(WidgetId widgetId) The method attempts to resolve a ConfigOwner reference from the widget widgetId.
void	setConfigField(WidgetId wid, WidgetConfig wcfg, int fid, java.lang.Object value) Set the widget config field to the specified value.
void	setConfigField(WidgetId wid, WidgetConfig wcfg, java.lang.String fname, java.lang.Object value) Set the widget config field to the specified value.
(package private) <T extends WidgetConfig> void	setWidgetConfig(T cfg, java.lang.Object value, WidgetConfigDef wdef, int fid) Set a widget configuration field to the specified value.
void	switchId(WidgetId oldId, WidgetId newId) Switch the widget's ID from the old one to the new one.
private void	switchId(WidgetId oldId, WidgetId newId, java.util.Map map) Helper method to replace the entry in the given map, to use the new key.
void	trackAllChanges(WidgetConfig cfg) Mark all differences between the backup config and the given widget configuration as being "dirty".

Methods inherited from class com.goldencode.p2j.ui.ConfigManager

addDirtyConfig, addWidgetConfig, addWidgetConfig, addWidgetConfiguration, duplicate, getActiveConfig, getBackupConfig, getConfigDef, getConfigDef, getDynamicConfig, getInstance, notifyWidgetDestroyed, registerExternalWidgetConfigs, removeWidgetConfig, replaceConfig, resolveWidgetConfig, resolveWidgetConfig, setDynamicConfig, setTracking, syncConfigChanges, trackConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.client.widget.WidgetStateListener

ancestorChanged

Field Detail

canPushUpdates

private boolean canPushUpdates

Flag indicating when the client-side can start pushing updates. The notification to start pushing updates will come from the server-side, via ClientExports.activateConfigUpdates().

tc

private final ThinClient tc

Cache of the ThinClient instance.

Constructor Detail

ClientConfigManager

public ClientConfigManager()

Initialize the client-side.

Method Detail

setConfigField

public void setConfigField(WidgetId wid,
                           WidgetConfig wcfg,
                           java.lang.String fname,
                           java.lang.Object value)

Set the widget config field to the specified value.

Parameters:

wid - The widget ID.

wcfg - The widget configuration; if this is a down widget, this will be used.

fname - The list of config field names.

value - The list of new config field values.

setConfigField

public void setConfigField(WidgetId wid,
                           WidgetConfig wcfg,
                           int fid,
                           java.lang.Object value)

Set the widget config field to the specified value.

Parameters:

wid - The widget ID.

wcfg - The widget configuration; if this is a down widget, this will be used.

fid - The config field id.

value - The list of new config field values.

deactivateConfigUpdates

public void deactivateConfigUpdates()

Inform the client-side that it can no longer send config updates.

activateConfigUpdates

public void activateConfigUpdates()

Inform the client-side that it can start sending the config updates.

getConfigUpdates

public WidgetConfigUpdates[] getConfigUpdates()

Get the widget configuration updates, by comparing the active with the backup configuration.

Overrides:

getConfigUpdates in class ConfigManager

Returns:

A list of widget configuration updates to be sent to the server side.

notifyWidgetDestroyed

public void notifyWidgetDestroyed(Widget<? extends OutputManager<?>> w)

Notify the given widget has been destroyed. This includes removing its ID from the maps.

Specified by:

notifyWidgetDestroyed in interface WidgetStateListener

Parameters:

w - The deleted widget.

switchId

public void switchId(WidgetId oldId,
                     WidgetId newId)

Switch the widget's ID from the old one to the new one. The references remain unchanged.

Parameters:

oldId - The old widget ID, currently in use by the manager.

newId - The new widget ID.

trackAllChanges

public void trackAllChanges(WidgetConfig cfg)

Mark all differences between the backup config and the given widget configuration as being "dirty".

Parameters:

cfg - The configuration from which the changes are extracted.

isRegisteredWidget

protected boolean isRegisteredWidget(WidgetId id)

Check if the given ID is associated with a registered widget.

Specified by:

isRegisteredWidget in class ConfigManager

Parameters:

id - The widget ID.

Returns:

true if a widget exists in the registry, with the given ID.

resolveConfigOwner

ConfigOwner<?> resolveConfigOwner(WidgetId widgetId)

The method attempts to resolve a ConfigOwner reference from the widget widgetId.

Specified by:

resolveConfigOwner in class ConfigManager

Parameters:

widgetId - Widget Id.

Returns:

A ConfigOwner reference or null if such cannot be find.

setWidgetConfig

<T extends WidgetConfig> void setWidgetConfig(T cfg,
                                              java.lang.Object value,
                                              WidgetConfigDef wdef,
                                              int fid)

Set a widget configuration field to the specified value.

Overrides:

setWidgetConfig in class ConfigManager

Type Parameters:

T - Config type.

Parameters:

cfg - The widget configuration to be updated.

value - The new field value.

wdef - The definition of the widget configuration.

fid - The ID of the changed field.

switchId

private void switchId(WidgetId oldId,
                      WidgetId newId,
                      java.util.Map map)

Helper method to replace the entry in the given map, to use the new key.

Parameters:

oldId - The old widget ID, which has some state registered in the given map.

newId - The new widget ID, to which the state needs to be re-put.

map - The map which needs to be updated.