org.carewebframework.shell.layout

Class UIElementTreePane

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementTreePane

public class UIElementTreePane
extends UIElementZKBase

A child of a UIElementTreeView, this UI element specifies the tree path where its associated tree node is to reside in the parent's tree.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementTreePane()

Method Summary

Methods

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Forward only to active child.
protected void	afterAddChild(UIElementBase child) Initializes the child after it is added.
void	afterMoveTo(int index) Only the node needs to be resequenced, since pane sequencing is arbitrary.
protected void	afterRemoveChild(UIElementBase child) Called after a child is logically removed from the parent.
protected void	applyHint() Apply the hint to the selector node.
void	bind() Override to bind wrapped components to the UI.
void	bringToFront() Brings this element to the front of the user interface.
boolean	canAcceptChild(Class<? extends UIElementBase> clazz) Returns true if this element may accept a child of the specified class.
boolean	canAcceptChild(UIElementBase child) Returns true if this element may accept the specified child.
String	getInstanceName() The caption label is the instance name.
String	getLabel()
protected void	setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu) Apply/remove the design context menu to/from both the pane and its associated node.
void	setEnabled(boolean enabled) Sets the enabled state of the node.
void	setLabel(String label)
void	unbind() Remove the node from the tree view when this element is destroyed.
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.UIElementZKBase

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

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

about, addChild, addChild, afterInitialize, afterParentChanged, applyColor, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, destroy, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildren, getColor, getDefinition, getDisplayName, getEventManager, getFirstChild, getFirstVisibleChild, getHint, getIndex, 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, 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

UIElementTreePane

public UIElementTreePane()

Method Detail

bringToFront

public void bringToFront()

Description copied from class: UIElementBase

Brings this element to the front of the user interface.

Overrides:

bringToFront in class UIElementBase

updateVisibility

protected void updateVisibility(boolean visible,
                    boolean activated)

Description copied from class: UIElementZKBase

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

Overrides:

updateVisibility in class UIElementZKBase

Parameters:

visible - The current visibility state.

activated - The current activation state.

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled state of the node.

Overrides:

setEnabled in class UIElementBase

Parameters:

enabled - The enabled state.

activateChildren

public void activateChildren(boolean activate)

Forward only to active child.

Overrides:

activateChildren in class UIElementBase

Parameters:

activate - The activate status.

setDesignContextMenu

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

Apply/remove the design context menu to/from both the pane and its associated node.

Overrides:

setDesignContextMenu in class UIElementZKBase

Parameters:

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

afterAddChild

protected void afterAddChild(UIElementBase child)

Initializes the child after it is added.

Overrides:

afterAddChild in class UIElementBase

Parameters:

child - The child element added.

afterRemoveChild

protected void afterRemoveChild(UIElementBase child)

Description copied from class: UIElementBase

Called after a child is logically removed from the parent.

Overrides:

afterRemoveChild in class UIElementBase

Parameters:

child - The child UI element.

canAcceptChild

public boolean canAcceptChild(Class<? extends UIElementBase> clazz)

Description copied from class: UIElementBase

Returns true if this element may accept a child of the specified class. Updates the reject reason with the result.

Overrides:

canAcceptChild in class UIElementBase

Parameters:

clazz - Child class to test.

Returns:

True if this element may accept a child of the specified class.

canAcceptChild

public boolean canAcceptChild(UIElementBase child)

Description copied from class: UIElementBase

Returns true if this element may accept the specified child. Updates the reject reason with the result.

Overrides:

canAcceptChild in class UIElementBase

Parameters:

child - Child instance to test.

Returns:

True if this element may accept the specified child.

bind

public void bind()

Description copied from class: UIElementBase

Override to bind wrapped components to the UI.

Overrides:

bind in class UIElementZKBase

unbind

public void unbind()

Remove the node from the tree view when this element is destroyed.

Overrides:

unbind in class UIElementZKBase

getInstanceName

public String getInstanceName()

The caption label is the instance name.

Overrides:

getInstanceName in class UIElementBase

Returns:

The instance name.

afterMoveTo

public void afterMoveTo(int index)

Only the node needs to be resequenced, since pane sequencing is arbitrary.

Overrides:

afterMoveTo in class UIElementZKBase

Parameters:

index - New position for element.

applyHint

protected void applyHint()

Apply the hint to the selector node.

Overrides:

applyHint in class UIElementBase

getLabel

public String getLabel()

setLabel

public void setLabel(String label)