org.carewebframework.shell.elements

Class ElementTreePane

java.lang.Object

org.carewebframework.shell.elements.ElementBase

org.carewebframework.shell.elements.ElementUI

org.carewebframework.shell.elements.ElementTreePane

public class ElementTreePane
extends ElementUI

A child of a ElementTreeView, 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.elements.ElementUI

autoEnable, autoHide, EVENT_ELEMENT_ACTIVATE, EVENT_ELEMENT_INACTIVATE, log

Constructor Summary

Constructors

Constructor and Description
ElementTreePane()

Method Summary

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Forward only to active child.
protected void	afterAddChild(ElementBase child) Initializes the child after it is added.
protected void	afterMoveChild(ElementBase child, ElementBase before) Only the node needs to be resequenced, since pane sequencing is arbitrary.
protected void	afterRemoveChild(ElementBase 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 ElementBase> clazz) Returns true if this element may accept a child of the specified class.
boolean	canAcceptChild(ElementBase 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.fujion.component.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) Override to set the visibility of wrapped components.

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

activate, addTrigger, afterParentChanged, applyColor, applyColor, applyHint, associateComponent, beforeParentChanged, 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, setDesignMode, setHint, setInnerComponent, setMaskMode, setOuterComponent, setVisible, updateState, updateVisibility

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

about, addChild, addChild, afterInitialize, beforeAddChild, beforeInitialize, beforeRemoveChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, editProperties, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildCount, getChildren, getChildren, getDefinition, getDisplayName, getEventManager, getFirstChild, getIndex, getLastChild, getPropEditClass, getRejectReason, getSerializableChildren, hasAncestor, hasChild, indexOfChild, isContainer, isDesignMode, isEnabled, isLocked, listenToChild, listenToParent, moveChild, moveChild, notifyChildren, notifyParent, registerAllowedChildClass, registerAllowedParentClass, remove, removeChild, removeChildren, setDefinition, setDefinition, 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

ElementTreePane

public ElementTreePane()

Method Detail

bringToFront

public void bringToFront()

Description copied from class: ElementUI

Brings this element to the front of the user interface.

Overrides:

bringToFront in class ElementUI

updateVisibility

protected void updateVisibility(boolean visible,
                                boolean activated)

Description copied from class: ElementUI

Override to set the visibility of wrapped components. Invoked when visibility or activation states change.

Overrides:

updateVisibility in class ElementUI

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 ElementBase

Parameters:

enabled - The enabled state.

activateChildren

public void activateChildren(boolean activate)

Forward only to active child.

Overrides:

activateChildren in class ElementUI

Parameters:

activate - The activate status.

setDesignContextMenu

protected void setDesignContextMenu(org.fujion.component.Menupopup contextMenu)

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

Overrides:

setDesignContextMenu in class ElementUI

Parameters:

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

afterAddChild

protected void afterAddChild(ElementBase child)

Initializes the child after it is added.

Overrides:

afterAddChild in class ElementUI

Parameters:

child - The child element added.

afterRemoveChild

protected void afterRemoveChild(ElementBase child)

Description copied from class: ElementUI

Called after a child is logically removed from the parent.

Overrides:

afterRemoveChild in class ElementUI

Parameters:

child - The child UI element.

canAcceptChild

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

Description copied from class: ElementBase

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

Overrides:

canAcceptChild in class ElementBase

Parameters:

clazz - Child class to test.

Returns:

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

canAcceptChild

public boolean canAcceptChild(ElementBase child)

Description copied from class: ElementBase

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

Overrides:

canAcceptChild in class ElementBase

Parameters:

child - Child instance to test.

Returns:

True if this element may accept the specified child.

bind

public void bind()

Description copied from class: ElementUI

Override to bind wrapped components to the UI.

Overrides:

bind in class ElementUI

unbind

public void unbind()

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

Overrides:

unbind in class ElementUI

getInstanceName

public String getInstanceName()

The caption label is the instance name.

Overrides:

getInstanceName in class ElementBase

Returns:

The instance name.

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.

applyHint

protected void applyHint()

Apply the hint to the selector node.

Overrides:

applyHint in class ElementUI

getLabel

public String getLabel()

setLabel

public void setLabel(String label)