org.carewebframework.shell.elements

Class ElementTreeView

java.lang.Object

org.carewebframework.shell.elements.ElementBase

org.carewebframework.shell.elements.ElementUI

org.carewebframework.shell.elements.ElementTreeView

public class ElementTreeView
extends ElementUI

A tree view consists of a selector pane on the left containing a treeview 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.elements.ElementUI

autoEnable, autoHide, EVENT_ELEMENT_ACTIVATE, EVENT_ELEMENT_INACTIVATE, log

Constructor Summary

Constructors

Constructor and Description
ElementTreeView()

Method Summary

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Only the active pane should receive the activation request.
protected void	afterMoveChild(ElementBase child, ElementBase before) Only the node needs to be resequenced, since pane sequencing is arbitrary.
protected void	afterRemoveChild(ElementBase 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(ElementTreePane 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.elements.ElementUI

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

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

about, addChild, addChild, afterInitialize, 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, 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

ElementTreeView

public ElementTreeView()

Method Detail

afterMoveChild

protected void afterMoveChild(ElementBase child,
                              ElementBase before)

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

Overrides:

afterMoveChild in class ElementUI

Parameters:

child - Child element that was moved.

before - Child element was moved before this one.

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.

afterRemoveChild

protected void afterRemoveChild(ElementBase child)

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

Overrides:

afterRemoveChild in class ElementUI

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 ElementUI

Parameters:

activate - The activate status.

setActivePane

protected void setActivePane(ElementTreePane pane)

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

Parameters:

pane - Pane to make active.