org.carewebframework.shell.plugins

Class PluginContainer

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Div

org.zkoss.zul.Idspace

org.carewebframework.shell.plugins.PluginContainer

All Implemented Interfaces:

Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl

public class PluginContainer
extends org.zkoss.zul.Idspace

Container that manages CareWeb plugins

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
PluginContainer() Create the plugin container.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activate the plugin.
void	addToolbarComponent(org.zkoss.zk.ui.Component component) Adds the specified component to the toolbar container.
void	bringToFront() Calls the hosting UI element to bring the plugin to the front of the UI.
void	destroy() Release contained resources.
void	disableActions(boolean disable) Enables/disables registered actions elements.
protected void	doAfterLoad() Actions to perform after the container is loaded.
Object	getAssociatedBean(String beanId) Returns a bean that has been associated (via registerBean) with this plugin.
String	getColor() Returns the color (as an HTML-formatted RGB string) for this element.
static PluginContainer	getContainer(org.zkoss.zk.ui.Component comp) Returns the plugin container for the given component.
PluginDefinition	getPluginDefinition() Return the definition associated with this plugin.
Object	getPropertyValue(PropertyInfo propInfo) Returns the value for a registered property.
CareWebShell	getShell() Returns the shell instance that hosts this container.
void	inactivate() Inactivate the plugin.
boolean	isDisabled() Returns the disable status of the container.
void	load() Initializes a plugin, if not already done.
void	onAction(PluginEvent event) Notify listeners of plugin events.
void	onCommand(CommandEvent event) Forward onCommand events to first level children of the container.
void	registerAction(org.zkoss.zk.ui.ext.Disable actionElement) Registers an action element.
void	registerComponent(org.zkoss.zk.ui.Component component) Register a component with the container.
void	registerListener(IPluginEvent listener) Registers a listener for the IPluginEvent callback event.
void	registerListener(IPluginEventListener listener) Registers a listener for the IPluginEventListener callback event.
void	registerProperties(Object instance, String... propertyNames) Registers one or more named properties to the container.
void	registerProperty(Object instance, String propertyName, boolean override) Registers a named property to the container.
void	setBusy(String message) If message is not null, disables the plugin and displays the busy message.
void	setColor(String value) Sets the container's background color.
void	setDesignMode(boolean designMode) Sets design mode for the container.
void	setDisabled(boolean disabled) Enables/disables the container and all registered action elements.
void	setPluginDefinition(PluginDefinition definition) Sets the plugin definition the container will use to instantiate the plugin.
void	setPropertyValue(PropertyInfo propInfo, Object value) Sets a value for a registered property.
boolean	setVisible(boolean visible) Sets the visibility of the contained resource and any registered components.
boolean	tryRegisterListener(Object object, boolean register) Attempts to register or unregister an object as an event listener.
void	unregisterListener(IPluginEvent listener) Unregisters a listener for the IPluginEvent callback event.
void	unregisterListener(IPluginEventListener listener) Unregisters a listener for the IPluginEvent callback event.

Methods inherited from class org.zkoss.zul.Div

getAlign, renderProperties, setAlign

Methods inherited from class org.zkoss.zul.impl.XulElement

clone, getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.IdSpace

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeScopeListener, setAttribute, setAttribute

Constructor Detail

PluginContainer

public PluginContainer()

Create the plugin container.

Method Detail

getContainer

public static PluginContainer getContainer(org.zkoss.zk.ui.Component comp)

Returns the plugin container for the given component.

Parameters:

comp - The component whose hosting container is sought.

Returns:

The hosting plugin container, or null if no container hosts the component.

activate

public void activate()

Activate the plugin.

inactivate

public void inactivate()

Inactivate the plugin.

destroy

public void destroy()

Release contained resources.

bringToFront

public void bringToFront()

Calls the hosting UI element to bring the plugin to the front of the UI.

setVisible

public boolean setVisible(boolean visible)

Sets the visibility of the contained resource and any registered components.

Specified by:

setVisible in interface org.zkoss.zk.ui.Component

Overrides:

setVisible in class org.zkoss.zk.ui.AbstractComponent

Parameters:

visible - Visibility state to set

onAction

public void onAction(PluginEvent event)

Notify listeners of plugin events.

Parameters:

event - The plugin event containing the action.

doAfterLoad

protected void doAfterLoad()

Actions to perform after the container is loaded.

onCommand

public void onCommand(CommandEvent event)

Forward onCommand events to first level children of the container.

Parameters:

event - The command event.

load

public void load()

Initializes a plugin, if not already done. This loads the plugin's principal zul page, attaches any event listeners, and sends a load event to subscribers.

addToolbarComponent

public void addToolbarComponent(org.zkoss.zk.ui.Component component)

Adds the specified component to the toolbar container. The component is registered to this container and will visible only when the container is active.

Parameters:

component - Component to add.

registerComponent

public void registerComponent(org.zkoss.zk.ui.Component component)

Register a component with the container. The container will control the visibility of the component according to when it is active/inactive.

Parameters:

component - Component to register.

registerAction

public void registerAction(org.zkoss.zk.ui.ext.Disable actionElement)

Registers an action element. Action elements implement the Disable interface and are automatically enabled/disabled when the owning container is enabled/disabled.

Parameters:

actionElement - A component implementing the Disable interface.

registerListener

public void registerListener(IPluginEvent listener)

Registers a listener for the IPluginEvent callback event. If the listener has already been registered, the request is ignored.

Parameters:

listener - Listener to be registered.

registerListener

public void registerListener(IPluginEventListener listener)

Registers a listener for the IPluginEventListener callback event. If the listener has already been registered, the request is ignored.

Parameters:

listener - Listener to be registered.

unregisterListener

public void unregisterListener(IPluginEvent listener)

Unregisters a listener for the IPluginEvent callback event.

Parameters:

listener - Listener to be unregistered.

unregisterListener

public void unregisterListener(IPluginEventListener listener)

Unregisters a listener for the IPluginEvent callback event.

Parameters:

listener - Listener to be unregistered.

tryRegisterListener

public boolean tryRegisterListener(Object object,
                          boolean register)

Attempts to register or unregister an object as an event listener.

Parameters:

object - Object to register/unregister.

register - If true, we are attempting to register. If false, unregister.

Returns:

True if operation was successful. False if the object supports none of the recognized event listeners.

registerProperties

public void registerProperties(Object instance,
                      String... propertyNames)

Registers one or more named properties to the container. Using this, a plugin can expose properties for serialization and deserialization.

Parameters:

instance - The object instance holding the property accessors. If null, any existing registration will be removed.

propertyNames - One or more property names to register.

registerProperty

public void registerProperty(Object instance,
                    String propertyName,
                    boolean override)

Registers a named property to the container. Using this, a plugin can expose a property for serialization and deserialization.

Parameters:

instance - The object instance holding the property accessors. If null, any existing registration will be removed.

propertyName - Name of property to register.

override - If the property is already registered to a non-proxy, the previous registration will be replaced if this is true; otherwise the request is ignored.

getAssociatedBean

public Object getAssociatedBean(String beanId)

Returns a bean that has been associated (via registerBean) with this plugin.

Parameters:

beanId - The id of the bean.

Returns:

The bean instance, or null if not found.

getPropertyValue

public Object getPropertyValue(PropertyInfo propInfo)
                        throws Exception

Returns the value for a registered property.

Parameters:

propInfo - Property info.

Returns:

The property value.

Throws:

Exception - Unspecified exception.

setPropertyValue

public void setPropertyValue(PropertyInfo propInfo,
                    Object value)
                      throws Exception

Sets a value for a registered property.

Parameters:

propInfo - Property info.

value - The value to set.

Throws:

Exception - Unspecified exception.

getPluginDefinition

public PluginDefinition getPluginDefinition()

Return the definition associated with this plugin.

Returns:

The associated plugin definition.

setPluginDefinition

public void setPluginDefinition(PluginDefinition definition)

Sets the plugin definition the container will use to instantiate the plugin. If there is a status bean associated with the plugin, it is registered with the container at this time. If there are style sheet resources associated with the plugin, they will be added to the container at this time.

Parameters:

definition - The plugin definition.

setDisabled

public void setDisabled(boolean disabled)

Enables/disables the container and all registered action elements.

Parameters:

disabled - Disable status.

disableActions

public void disableActions(boolean disable)

Enables/disables registered actions elements. Note that if the container is disabled, the action elements will not be enabled by this call. It may be used, however, to temporarily disable action elements that would otherwise be enabled.

Parameters:

disable - The disable status.

isDisabled

public boolean isDisabled()

Returns the disable status of the container.

Returns:

True if this plugin is disabled.

setBusy

public void setBusy(String message)

If message is not null, disables the plugin and displays the busy message. If message is null, removes any previous message and returns the plugin to its previous state.

Parameters:

message - The message to display, or null to clear previous message.

setDesignMode

public void setDesignMode(boolean designMode)

Sets design mode for the container.

Parameters:

designMode - If true, associated actions and busy mask are disabled.

getShell

public CareWebShell getShell()

Returns the shell instance that hosts this container.

Returns:

The shell instance.

getColor

public String getColor()

Returns the color (as an HTML-formatted RGB string) for this element.

Returns:

An HTML-formatted color specification (e.g., #0F134E). May be null.

setColor

public void setColor(String value)

Sets the container's background color.

Parameters:

value - A correctly formatted HTML color specification.