org.carewebframework.shell.elements

Class ElementPlugin

java.lang.Object

org.carewebframework.shell.elements.ElementBase

org.carewebframework.shell.elements.ElementUI

org.carewebframework.shell.elements.ElementPlugin

All Implemented Interfaces:

IPropertyAccessor, org.fujion.ancillary.IDisable

public class ElementPlugin
extends ElementUI
implements org.fujion.ancillary.IDisable, IPropertyAccessor

This class is used for all container-hosted plugins.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ElementPlugin.PluginContainer

Field Summary

Fields inherited from class org.carewebframework.shell.elements.ElementUI

autoEnable, autoHide, EVENT_ELEMENT_ACTIVATE, EVENT_ELEMENT_INACTIVATE, log

Constructor Summary

Constructors

Constructor and Description
ElementPlugin() Sets the container as the wrapped component and registers itself to receive action notifications from the container.

Method Summary

Modifier and Type	Method and Description
void	about() Displays an about dialog for the UI element.
void	activate() Activate the plugin.
void	activateChildren(boolean active) Passes the activation request to the container.
void	addToolbarComponent(org.fujion.component.BaseComponent component) Adds the specified component to the toolbar container.
void	afterInitialize(boolean deserializing) Additional processing of the plugin after it is initialized.
protected void	applyColor() Set background color on container's first child.
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.
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()
void	load() Initializes a plugin, if not already done.
void	registerAction(org.fujion.ancillary.IDisable actionElement) Registers an action element.
void	registerBean(String beanId, boolean isRequired) Registers a helper bean with this container.
void	registerComponent(org.fujion.component.BaseUIComponent component) Register a component with the container.
void	registerId(String id, org.fujion.component.BaseComponent component) Allows auto-wire to work even if component is not a child of 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	setDefinition(PluginDefinition definition) Sets the plugin definition the container will use to instantiate the plugin.
void	setDesignMode(boolean designMode) Passes design mode setting to the container.
void	setDisabled(boolean disabled)
void	setPropertyValue(PropertyInfo propInfo, Object value) Sets a value for a registered property.
void	tryRegisterController(Object object) Registers an object as a controller if it implements the IPluginController interface.
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.
protected void	updateVisibility(boolean visible, boolean activated) Sets the visibility of the contained resource and any registered components.

Methods inherited from class org.carewebframework.shell.elements.ElementUI

activate, addTrigger, afterAddChild, afterMoveChild, afterParentChanged, afterRemoveChild, applyColor, applyHint, applyHint, associateComponent, beforeParentChanged, bind, bringToFront, createFromTemplate, createFromTemplate, createFromTemplate, fullSize, getAssociatedElement, getColor, getDesignContextMenu, getFirstVisibleChild, getHint, getInnerComponent, getLastVisibleChild, getMaskMode, getMaskTarget, getNextSibling, getOuterComponent, getParent, getRoot, getTemplateUrl, getTriggers, hasVisibleElements, isActivated, isVisible, rebindChildren, removeTrigger, setColor, setDesignContextMenu, setDesignContextMenu, setHint, setInnerComponent, setMaskMode, setOuterComponent, setVisible, unbind, updateState, updateVisibility

Methods inherited from class org.carewebframework.shell.elements.ElementBase

addChild, addChild, beforeAddChild, beforeInitialize, beforeRemoveChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, editProperties, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildCount, getChildren, getChildren, getDefinition, getDisplayName, getEventManager, getFirstChild, getIndex, getInstanceName, getLastChild, getPropEditClass, getRejectReason, getSerializableChildren, hasAncestor, hasChild, indexOfChild, isContainer, isDesignMode, isEnabled, isLocked, listenToChild, listenToParent, moveChild, moveChild, notifyChildren, notifyParent, registerAllowedChildClass, registerAllowedParentClass, remove, removeChild, removeChildren, setDefinition, setEnabled, setIndex, setLocked, setParent, setRejectReason, updateParentState

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementPlugin

public ElementPlugin()

Sets the container as the wrapped component and registers itself to receive action notifications from the container.

Method Detail

about

public void about()

Description copied from class: ElementBase

Displays an about dialog for the UI element.

Overrides:

about in class ElementBase

See Also:

ElementBase.about()

activateChildren

public void activateChildren(boolean active)

Passes the activation request to the container.

Overrides:

activateChildren in class ElementUI

Parameters:

active - The activate status.

See Also:

ElementUI.activateChildren(boolean)

activate

public void activate()

Activate the plugin.

inactivate

public void inactivate()

Inactivate the plugin.

afterInitialize

public void afterInitialize(boolean deserializing)
                     throws Exception

Additional processing of the plugin after it is initialized.

Overrides:

afterInitialize in class ElementBase

Parameters:

deserializing - If true, initialization is occurring as a result of deserialization.

Throws:

Exception - Unspecified exception.

See Also:

ElementBase.afterInitialize(boolean)

destroy

public void destroy()

Release contained resources.

Overrides:

destroy in class ElementUI

setDesignMode

public void setDesignMode(boolean designMode)

Passes design mode setting to the container.

Overrides:

setDesignMode in class ElementUI

Parameters:

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

getPropertyValue

public Object getPropertyValue(PropertyInfo propInfo)
                        throws Exception

Returns the value for a registered property.

Specified by:

getPropertyValue in interface IPropertyAccessor

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.

Specified by:

setPropertyValue in interface IPropertyAccessor

Parameters:

propInfo - Property info.

value - The value to set.

Throws:

Exception - Unspecified exception.

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface org.fujion.ancillary.IDisable

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface org.fujion.ancillary.IDisable

updateVisibility

protected void updateVisibility(boolean visible,
                                boolean activated)

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

Overrides:

updateVisibility in class ElementUI

Parameters:

visible - Visibility state to set

activated - The current activation state.

setDefinition

public void setDefinition(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.

Overrides:

setDefinition in class ElementBase

Parameters:

definition - The plugin definition.

registerAction

public void registerAction(org.fujion.ancillary.IDisable 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.

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.

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.

doAfterLoad

protected void doAfterLoad()

Actions to perform after the container is loaded.

load

public void load()

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

addToolbarComponent

public void addToolbarComponent(org.fujion.component.BaseComponent 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 - BaseComponent to add.

registerComponent

public void registerComponent(org.fujion.component.BaseUIComponent 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 - BaseComponent to register.

registerId

public void registerId(String id,
                       org.fujion.component.BaseComponent component)

Allows auto-wire to work even if component is not a child of the container.

Parameters:

id - BaseComponent id.

component - BaseComponent to be registered.

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.

tryRegisterController

public void tryRegisterController(Object object)

Registers an object as a controller if it implements the IPluginController interface.

Parameters:

object - Object to register.

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.

registerBean

public void registerBean(String beanId,
                         boolean isRequired)

Registers a helper bean with this container.

Parameters:

beanId - The bean's id.

isRequired - If true and the bean is not found, an exception is raised.

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.

applyColor

protected void applyColor()

Set background color on container's first child.

Overrides:

applyColor in class ElementUI

getShell

public CareWebShell getShell()

Returns the shell instance that hosts this container.

Returns:

The shell instance.