org.carewebframework.shell.layout

Class UIElementZKBase

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

Direct Known Subclasses:

UIElementActionBase, UIElementDesktop, UIElementFrame, UIElementLayout, UIElementMenuBase, UIElementPlugin, UIElementSplitterPane, UIElementSplitterView, UIElementStepPane, UIElementStepView, UIElementTabMenu, UIElementTabPane, UIElementTabView, UIElementToolbar, UIElementTreePane, UIElementTreeView

public abstract class UIElementZKBase
extends UIElementBase

This is an abstract class from which all ZK-based UI elements must derive.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementZKBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(boolean activate) Checks for a pending mask operation when a UI element is activated.
protected void	afterMoveTo(int index) Provides a default behavior for resequencing this element relative to its siblings.
protected void	applyColor(Object cmpt) Applies the current color setting to the target component.
protected void	applyHint(Object cmpt) Applies the current hint text to the target component.
void	associateComponent(org.zkoss.zk.ui.Component component) Associates the specified ZK component with this UI element.
protected void	bind() Override to bind wrapped components to the UI.
protected org.zkoss.zk.ui.Component	createFromTemplate() Create wrapped component(s) from a template (a zul page).
protected org.zkoss.zk.ui.Component	createFromTemplate(String template) Create wrapped component(s) from specified template (a zul page).
protected org.zkoss.zk.ui.Component	createFromTemplate(String template, org.zkoss.zk.ui.Component parent, Object controller) Create wrapped component(s) from specified template (a zul page).
void	editProperties() Invokes the property grid with this element as its target.
protected void	fullSize(org.zkoss.zk.ui.HtmlBasedComponent cmpt) Set width and height of a component to 100%.
static UIElementBase	getAssociatedUIElement(org.zkoss.zk.ui.Component component) Returns the UI element that registered the ZK component.
protected boolean	getEnableDesignModeMask() Returns true if the design mode mask is to be used.
org.zkoss.zk.ui.Component	getInnerComponent() Returns the innermost wrapped ZK component.
org.zkoss.zk.ui.Component	getOuterComponent() Returns the outermost wrapped ZK component.
UIElementZKBase	getParent() Returns the parent of this element.
protected String	getTemplateUrl() Returns the URL of the default template to use in createFromTemplate.
protected boolean	hasVisibleElements(org.zkoss.zk.ui.Component comp) Returns true if any associated UI elements in the component subtree are visible.
protected void	moveChild(org.zkoss.zk.ui.Component child, int index) Moves a child to the position specified by an index.
protected void	setDesignContextMenu(org.zkoss.zk.ui.Component component, org.zkoss.zul.Menupopup contextMenu) Apply/remove the design context menu to/from the specified component.
protected void	setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu) Apply/remove the design context menu to/from ZK components.
void	setDesignMode(boolean designMode) Augments the parent method by activating the associated design context menu when design mode is activated.
protected void	setEnableDesignModeMask(boolean value) Sets whether to use the design mode mask.
void	setInnerComponent(Object value) Augments the parent method by automatically associating the component with this UI element.
void	setOuterComponent(Object value) Augments the parent method by automatically associating the component with this UI element.
protected void	swapChildren(org.zkoss.zk.ui.Component child1, org.zkoss.zk.ui.Component child2) Swaps the position of the two child components.
protected void	unbind() Override to unbind wrapped components from the UI.
protected void	updateVisibility(boolean visible, boolean activated) Provides a default implementation for ZK-derived UI components by setting the visibility of the outer component.

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

about, activateChildren, addChild, addChild, afterAddChild, afterInitialize, afterParentChanged, afterRemoveChild, applyColor, applyHint, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, bringToFront, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, destroy, 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, 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

UIElementZKBase

public UIElementZKBase()

Method Detail

getAssociatedUIElement

public static UIElementBase getAssociatedUIElement(org.zkoss.zk.ui.Component component)

Returns the UI element that registered the ZK component.

Parameters:

component - The ZK component of interest.

Returns:

The associated UI element.

associateComponent

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

Associates the specified ZK component with this UI element.

Parameters:

component - ZK component to associate.

setOuterComponent

public void setOuterComponent(Object value)

Augments the parent method by automatically associating the component with this UI element.

Overrides:

setOuterComponent in class UIElementBase

Parameters:

value - The outermost wrapped UI component.

setInnerComponent

public void setInnerComponent(Object value)

Augments the parent method by automatically associating the component with this UI element.

Overrides:

setInnerComponent in class UIElementBase

Parameters:

value - The innermost wrapped UI component.

updateVisibility

protected void updateVisibility(boolean visible,
                    boolean activated)

Provides a default implementation for ZK-derived UI components by setting the visibility of the outer component.

Overrides:

updateVisibility in class UIElementBase

Parameters:

visible - The current visibility state.

activated - The current activation state.

getTemplateUrl

protected String getTemplateUrl()

Returns the URL of the default template to use in createFromTemplate. Override this method to provide an alternate default URL.

Returns:

The template URL.

createFromTemplate

protected org.zkoss.zk.ui.Component createFromTemplate()

Create wrapped component(s) from a template (a zul page). Performs autowiring of variables and events. The template URL is derived from the class name. For example, if the class is "org.carewebframework.xxx.Clazz", the template URL is assumed to be "~./org/carewebframework/xxx/Clazz.zul".

Returns:

Top level component.

createFromTemplate

protected org.zkoss.zk.ui.Component createFromTemplate(String template)

Create wrapped component(s) from specified template (a zul page). Performs autowiring of variables and events.

Parameters:

template - URL of zul page that will serve as a template. If a path is not specified, it is derived from the package. If the URL is not specified, the template name is obtained from getTemplateUrl.

Returns:

Top level component.

createFromTemplate

protected org.zkoss.zk.ui.Component createFromTemplate(String template,
                                           org.zkoss.zk.ui.Component parent,
                                           Object controller)

Create wrapped component(s) from specified template (a zul page).

Parameters:

template - URL of zul page that will serve as a template. If the URL is not specified, the template name is obtained from getTemplateUrl.

parent - The component that will become the parent.

controller - If specified, events and variables are autowired to the controller.

Returns:

Top level component.

moveChild

protected void moveChild(org.zkoss.zk.ui.Component child,
             int index)

Moves a child to the position specified by an index.

Parameters:

child - Child to move

index - Move child to this position.

swapChildren

protected void swapChildren(org.zkoss.zk.ui.Component child1,
                org.zkoss.zk.ui.Component child2)

Swaps the position of the two child components.

Parameters:

child1 - The first child.

child2 - The second child.

afterMoveTo

protected void afterMoveTo(int index)

Provides a default behavior for resequencing this element relative to its siblings. This assumes there is one wrapped ZK component and it is that component whose position is to be changed.

Overrides:

afterMoveTo in class UIElementBase

Parameters:

index - New position for element.

fullSize

protected void fullSize(org.zkoss.zk.ui.HtmlBasedComponent cmpt)

Set width and height of a component to 100%.

Parameters:

cmpt - Component

activate

public void activate(boolean activate)

Checks for a pending mask operation when a UI element is activated.

Overrides:

activate in class UIElementBase

Parameters:

activate - The activate status.

setDesignMode

public void setDesignMode(boolean designMode)

Augments the parent method by activating the associated design context menu when design mode is activated.

Overrides:

setDesignMode in class UIElementBase

Parameters:

designMode - If true, design mode is activated.

setDesignContextMenu

protected void setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu)

Apply/remove the design context menu to/from ZK components. This default implementation applies the design context menu to the outer ZK component only. It may be overridden to modify this default behavior.

Parameters:

contextMenu - The design menu if design mode is activated, or null if it is not.

setDesignContextMenu

protected void setDesignContextMenu(org.zkoss.zk.ui.Component component,
                        org.zkoss.zul.Menupopup contextMenu)

Apply/remove the design context menu to/from the specified component. If applying the design context menu, any existing context menu is saved. When removing the context menu, any saved context menu is restored.

Parameters:

component - Component to which to apply/remove the design context menu.

contextMenu - The design menu if design mode is activated, or null if it is not.

bind

protected void bind()

Description copied from class: UIElementBase

Override to bind wrapped components to the UI.

Overrides:

bind in class UIElementBase

unbind

protected void unbind()

Description copied from class: UIElementBase

Override to unbind wrapped components from the UI.

Overrides:

unbind in class UIElementBase

editProperties

public void editProperties()

Invokes the property grid with this element as its target.

Overrides:

editProperties in class UIElementBase

getInnerComponent

public org.zkoss.zk.ui.Component getInnerComponent()

Returns the innermost wrapped ZK component.

Overrides:

getInnerComponent in class UIElementBase

Returns:

The inner ZK component.

getOuterComponent

public org.zkoss.zk.ui.Component getOuterComponent()

Returns the outermost wrapped ZK component.

Overrides:

getOuterComponent in class UIElementBase

Returns:

The outer ZK component.

getParent

public UIElementZKBase getParent()

Description copied from class: UIElementBase

Returns the parent of this element. May be null.

Overrides:

getParent in class UIElementBase

Returns:

This element's parent.

applyColor

protected void applyColor(Object cmpt)

Applies the current color setting to the target component. If the target implements a custom method for performing this operation, that method will be invoked. Otherwise, the background color of the target is set. Override this method to provide alternate implementations.

Overrides:

applyColor in class UIElementBase

Parameters:

cmpt - Component to receive the color setting.

applyHint

protected void applyHint(Object cmpt)

Applies the current hint text to the target component.

Overrides:

applyHint in class UIElementBase

Parameters:

cmpt - Component to receive the hint text.

getEnableDesignModeMask

protected boolean getEnableDesignModeMask()

Returns true if the design mode mask is to be used. This mask is used to cover the underlying outer component when in design mode.

Returns:

True if the design mode mask is enabled.

setEnableDesignModeMask

protected void setEnableDesignModeMask(boolean value)

Sets whether to use the design mode mask.

Parameters:

value - True to enable the design mode mask.

hasVisibleElements

protected boolean hasVisibleElements(org.zkoss.zk.ui.Component comp)

Returns true if any associated UI elements in the component subtree are visible.

Parameters:

comp - Component subtree to examine.

Returns:

True if any associated UI element in the subtree is visible.