org.carewebframework.shell.layout

Class UIElementPlugin

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementPlugin

All Implemented Interfaces:

IPropertyAccessor, org.zkoss.zk.ui.ext.Disable

public class UIElementPlugin
extends UIElementZKBase
implements org.zkoss.zk.ui.ext.Disable, IPropertyAccessor

This class is used for all container-hosted plugins.

Field Summary

Fields inherited from class org.carewebframework.shell.layout.UIElementBase

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	about() Displays an about dialog for the UI element.
void	activateChildren(boolean active) Passes the activation request to the container.
void	afterInitialize(boolean deserializing) Additional processing of the plugin after it is initialized.
void	destroy() Passes the destroy event to the container.
PluginContainer	getContainer() Returns the container wrapped by this UI element.
Object	getPropertyValue(PropertyInfo propInfo) Delegates retrieval of property values to the container.
boolean	isDisabled()
void	setDefinition(PluginDefinition definition) Also passes the plugin definition to the container.
void	setDesignMode(boolean designMode) Passes design mode setting to the container.
void	setDisabled(boolean disabled)
void	setPropertyValue(PropertyInfo propInfo, Object value) Delegates setting of property values to the container.

Methods inherited from class org.carewebframework.shell.layout.UIElementZKBase

activate, afterMoveTo, applyColor, applyHint, associateComponent, bind, createFromTemplate, createFromTemplate, createFromTemplate, editProperties, fullSize, getAssociatedUIElement, getEnableDesignModeMask, getInnerComponent, getOuterComponent, getParent, getTemplateUrl, hasVisibleElements, moveChild, setDesignContextMenu, setDesignContextMenu, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren, unbind, updateVisibility

Methods inherited from class org.carewebframework.shell.layout.UIElementBase

addChild, addChild, afterAddChild, afterParentChanged, afterRemoveChild, applyColor, applyHint, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, bringToFront, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildren, getColor, getDefinition, getDisplayName, getEventManager, getFirstChild, getFirstVisibleChild, getHint, getIndex, getInstanceName, getLastChild, getLastVisibleChild, getNextSibling, getPropEditClass, getRejectReason, getRoot, getSerializableChildren, hasAncestor, hasChild, indexOfChild, isActivated, isContainer, isDesignMode, isEnabled, isLocked, isVisible, raise, raise, registerAllowedChildClass, registerAllowedParentClass, remove, removeChild, removeChildren, setColor, setDefinition, setEnabled, setHint, setIndex, setLocked, setParent, setRejectReason, setVisible, updateParentState, updateState, updateVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

UIElementPlugin

public UIElementPlugin()

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

Method Detail

setDefinition

public void setDefinition(PluginDefinition definition)

Also passes the plugin definition to the container.

Overrides:

setDefinition in class UIElementBase

Parameters:

definition - The plugin definition.

See Also:

UIElementBase.setDefinition(org.carewebframework.shell.plugins.PluginDefinition)

getContainer

public PluginContainer getContainer()

Returns the container wrapped by this UI element.

Returns:

The container.

about

public void about()

Description copied from class: UIElementBase

Displays an about dialog for the UI element.

Overrides:

about in class UIElementBase

See Also:

UIElementBase.about()

activateChildren

public void activateChildren(boolean active)

Passes the activation request to the container.

Overrides:

activateChildren in class UIElementBase

Parameters:

active - The activate status.

See Also:

UIElementBase.activateChildren(boolean)

afterInitialize

public void afterInitialize(boolean deserializing)
                     throws Exception

Additional processing of the plugin after it is initialized.

Overrides:

afterInitialize in class UIElementBase

Parameters:

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

Throws:

Exception - Unspecified exception.

See Also:

UIElementBase.afterInitialize(boolean)

destroy

public void destroy()

Passes the destroy event to the container.

Overrides:

destroy in class UIElementBase

See Also:

UIElementBase.destroy()

setDesignMode

public void setDesignMode(boolean designMode)

Passes design mode setting to the container.

Overrides:

setDesignMode in class UIElementZKBase

Parameters:

designMode - If true, design mode is activated.

See Also:

UIElementZKBase.setDesignMode(boolean)

getPropertyValue

public Object getPropertyValue(PropertyInfo propInfo)
                        throws Exception

Delegates retrieval of property values to the container.

Specified by:

getPropertyValue in interface IPropertyAccessor

Parameters:

propInfo - The property descriptor.

Returns:

The value of the property.

Throws:

Exception - Unspecified exception.

See Also:

IPropertyAccessor.getPropertyValue(org.carewebframework.shell.property.PropertyInfo)

setPropertyValue

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

Delegates setting of property values to the container.

Specified by:

setPropertyValue in interface IPropertyAccessor

Parameters:

propInfo - The property descriptor.

value - The new value of the property.

Throws:

Exception - Unspecified exception.

See Also:

IPropertyAccessor.setPropertyValue(org.carewebframework.shell.property.PropertyInfo, java.lang.Object)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface org.zkoss.zk.ui.ext.Disable

See Also:

Disable.isDisabled()

setDisabled

public void setDisabled(boolean disabled)

Specified by:

setDisabled in interface org.zkoss.zk.ui.ext.Disable

See Also:

Disable.setDisabled(boolean)