org.carewebframework.shell.layout

Class UIElementTreeView

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementTreeView

public class UIElementTreeView
extends UIElementZKBase

A tree view consists of a selector pane on the left containing a ZK tree component and a view area on the right where tree panes are positioned. Clicking on a node in the tree activates the associated tree pane.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementTreeView()

Method Summary

Methods

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Only the active pane should receive the activation request.
protected void	beforeRemoveChild(UIElementBase child) Remove the associated tree node when a tree pane is removed.
String	getCaption() Returns the caption of the selector pane.
ThemeUtil.ButtonStyle	getSelectionStyle() Returns the button style to use for selected nodes.
boolean	isOpen() Returns true if the selector pane is open.
protected void	setActivePane(UIElementTreePane pane) Activates the specified pane.
void	setCaption(String value) Sets the caption of the selector pane.
void	setOpen(boolean value) Opens or closes the selector pane.
void	setSelectionStyle(ThemeUtil.ButtonStyle selectionStyle) Sets the button style to use for selected nodes.

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, setDesignMode, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren, unbind, updateVisibility

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

about, addChild, addChild, afterAddChild, afterInitialize, afterParentChanged, afterRemoveChild, applyColor, applyHint, beforeAddChild, beforeInitialize, beforeParentChanged, 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

UIElementTreeView

public UIElementTreeView()
                  throws Exception

Throws:

Exception

Method Detail

setCaption

public void setCaption(String value)

Sets the caption of the selector pane.

Parameters:

value - Selector pane caption.

getCaption

public String getCaption()

Returns the caption of the selector pane.

Returns:

Selector pane caption.

setOpen

public void setOpen(boolean value)

Opens or closes the selector pane.

Parameters:

value - True to open the selector pane; false to close it.

isOpen

public boolean isOpen()

Returns true if the selector pane is open.

Returns:

True if selector pane is open.

getSelectionStyle

public ThemeUtil.ButtonStyle getSelectionStyle()

Returns the button style to use for selected nodes.

Returns:

Button style for selected nodes.

setSelectionStyle

public void setSelectionStyle(ThemeUtil.ButtonStyle selectionStyle)

Sets the button style to use for selected nodes.

Parameters:

selectionStyle - Button style for selected nodes.

beforeRemoveChild

protected void beforeRemoveChild(UIElementBase child)

Remove the associated tree node when a tree pane is removed.

Overrides:

beforeRemoveChild in class UIElementBase

Parameters:

child - The child UI element.

activateChildren

public void activateChildren(boolean activate)

Only the active pane should receive the activation request.

Overrides:

activateChildren in class UIElementBase

Parameters:

activate - The activate status.

setActivePane

protected void setActivePane(UIElementTreePane pane)

Activates the specified pane. Any previously active pane will be deactivated.

Parameters:

pane - Pane to make active.