org.carewebframework.shell.elements

Class ElementUI

java.lang.Object

org.carewebframework.shell.elements.ElementBase

org.carewebframework.shell.elements.ElementUI

Direct Known Subclasses:

ElementActionBase, ElementDesktop, ElementFrame, ElementImage, ElementLabel, ElementLayout, ElementMenubar, ElementPlugin, ElementSplitterPane, ElementSplitterView, ElementStepPane, ElementStepView, ElementTabPane, ElementTabView, ElementToolbar, ElementTreePane, ElementTreeView

public abstract class ElementUI
extends ElementBase

This is the base class for all layout elements supported by the CareWeb framework.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoEnable
protected boolean	autoHide
static String	EVENT_ELEMENT_ACTIVATE
static String	EVENT_ELEMENT_INACTIVATE
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
ElementUI()

Method Summary

Modifier and Type	Method and Description
void	activate(boolean activate) Activates or inactivates a UI element.
protected void	activateChildren(boolean activate) Default behavior is to pass activation/inactivation event to children.
void	addTrigger(ElementTrigger trigger)
protected void	afterAddChild(ElementBase child) Called after a child is logically added to the parent.
protected void	afterMoveChild(ElementBase child, ElementBase before) Element has been moved to a different position under this parent.
protected void	afterParentChanged(ElementBase oldParent) Called after the parent has been changed.
protected void	afterRemoveChild(ElementBase child) Called after a child is logically removed from the parent.
protected void	applyColor() Provides a default implementation for setting the color of a UI element.
protected void	applyColor(org.fujion.component.BaseUIComponent comp) Applies the current color setting to the target component.
protected void	applyHint() Provides a default implementation for setting the hint text of a UI element.
protected void	applyHint(org.fujion.component.BaseUIComponent comp) Applies the current hint text to the target component.
void	associateComponent(org.fujion.component.BaseComponent component) Associates the specified CWF component with this UI element.
protected void	beforeParentChanged(ElementBase newParent) Called before the parent has been changed.
protected void	bind() Override to bind wrapped components to the UI.
void	bringToFront() Brings this element to the front of the user interface.
protected org.fujion.component.BaseUIComponent	createFromTemplate() Create wrapped component(s) from a template (a cwf page).
protected org.fujion.component.BaseUIComponent	createFromTemplate(String template) Create wrapped component(s) from specified template (a cwf page).
protected org.fujion.component.BaseUIComponent	createFromTemplate(String template, org.fujion.component.BaseComponent parent, Object controller) Create wrapped component(s) from specified template (a cwf page).
void	destroy() Override to implement special cleanup when an object is destroyed.
protected void	fullSize(org.fujion.component.BaseUIComponent component) Set width and height of a component to 100%.
static ElementUI	getAssociatedElement(org.fujion.component.BaseComponent component) Returns the UI element that registered the CWF component.
String	getColor() Returns the color (as an HTML-formatted RGB string) for this element.
static org.fujion.component.Menupopup	getDesignContextMenu(org.fujion.component.BaseComponent component) Returns the design context menu currently bound to the component.
ElementUI	getFirstVisibleChild() Returns the first visible child.
String	getHint() Returns the tool tip text.
org.fujion.component.BaseUIComponent	getInnerComponent() Returns the innermost wrapped UI component.
ElementUI	getLastVisibleChild() Returns the last visible child.
protected DesignMask.MaskMode	getMaskMode() Returns true if the design mode mask is to be used.
org.fujion.component.BaseUIComponent	getMaskTarget() Returns the component that will receive the design mode mask.
ElementUI	getNextSibling(boolean visibleOnly) Returns this element's next sibling.
org.fujion.component.BaseUIComponent	getOuterComponent() Returns the outermost wrapped UI component.
ElementUI	getParent() Returns the parent of this element.
ElementUI	getRoot() Returns the UI element at the root of the component tree.
protected String	getTemplateUrl() Returns the URL of the default template to use in createFromTemplate.
Set<ElementTrigger>	getTriggers()
protected boolean	hasVisibleElements(org.fujion.component.BaseUIComponent component) Returns true if any associated UI elements in the component subtree are visible.
boolean	isActivated() Returns the activation status of the element.
boolean	isVisible() Returns the visible state of the UI element.
protected void	rebindChildren() Rebind any children.
void	removeTrigger(ElementTrigger trigger)
void	setColor(String value) Provides a default implementation for setting the color of a UI element.
protected void	setDesignContextMenu(org.fujion.component.BaseUIComponent component, org.fujion.component.Menupopup contextMenu) Apply/remove the design context menu to/from the specified component.
protected void	setDesignContextMenu(org.fujion.component.Menupopup contextMenu) Apply/remove the design context menu to/from CWF components.
void	setDesignMode(boolean designMode) Sets design mode status for this component and all its children and triggers.
void	setHint(String value) Sets the tool tip text.
protected void	setInnerComponent(org.fujion.component.BaseUIComponent value) Sets the innermost wrapped UI component.
protected void	setMaskMode(DesignMask.MaskMode mode) Sets whether to use the design mode mask.
protected void	setOuterComponent(org.fujion.component.BaseUIComponent value) Sets the outermost wrapped UI component.
void	setVisible(boolean visible) Sets the visibility state of the component.
protected void	unbind() Override to unbind wrapped components from the UI.
protected void	updateState() Update a UI element based on the state of its children.
protected void	updateVisibility() Calls updateVisibility with current settings.
protected void	updateVisibility(boolean visible, boolean activated) Override to set the visibility of wrapped components.

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

EVENT_ELEMENT_ACTIVATE

public static final String EVENT_ELEMENT_ACTIVATE

See Also:

Constant Field Values

EVENT_ELEMENT_INACTIVATE

public static final String EVENT_ELEMENT_INACTIVATE

See Also:

Constant Field Values

autoHide

protected boolean autoHide

autoEnable

protected boolean autoEnable

Constructor Detail

ElementUI

public ElementUI()

Method Detail

getAssociatedElement

public static ElementUI getAssociatedElement(org.fujion.component.BaseComponent component)

Returns the UI element that registered the CWF component.

Parameters:

component - The CWF component of interest.

Returns:

The associated UI element.

getDesignContextMenu

public static org.fujion.component.Menupopup getDesignContextMenu(org.fujion.component.BaseComponent component)

Returns the design context menu currently bound to the component.

Parameters:

component - The CWF component of interest.

Returns:

The associated design context menu, or null if none.

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.fujion.component.BaseUIComponent createFromTemplate()

Create wrapped component(s) from a template (a cwf 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 "web/org/carewebframework/xxx/clazz.fsp".

Returns:

Top level component.

createFromTemplate

protected org.fujion.component.BaseUIComponent createFromTemplate(String template)

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

Parameters:

template - URL of cwf 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.fujion.component.BaseUIComponent createFromTemplate(String template,
                                                                  org.fujion.component.BaseComponent parent,
                                                                  Object controller)

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

Parameters:

template - URL of cwf 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.

associateComponent

public void associateComponent(org.fujion.component.BaseComponent component)

Associates the specified CWF component with this UI element.

Parameters:

component - CWF component to associate.

setDesignMode

public void setDesignMode(boolean designMode)

Sets design mode status for this component and all its children and triggers.

Overrides:

setDesignMode in class ElementBase

Parameters:

designMode - The design mode flag.

setDesignContextMenu

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

Apply/remove the design context menu to/from CWF components. This default implementation applies the design context menu to the outer CWF 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.fujion.component.BaseUIComponent component,
                                    org.fujion.component.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.

getMaskTarget

public org.fujion.component.BaseUIComponent getMaskTarget()

Returns the component that will receive the design mode mask. Override if necessary.

Returns:

The component that will receive the design mode mask.

afterAddChild

protected void afterAddChild(ElementBase child)

Called after a child is logically added to the parent.

Overrides:

afterAddChild in class ElementBase

Parameters:

child - The child element added.

afterRemoveChild

protected void afterRemoveChild(ElementBase child)

Called after a child is logically removed from the parent.

Overrides:

afterRemoveChild in class ElementBase

Parameters:

child - The child UI element.

afterParentChanged

protected void afterParentChanged(ElementBase oldParent)

Called after the parent has been changed.

Overrides:

afterParentChanged in class ElementBase

Parameters:

oldParent - The value of the parent property prior to the change.

beforeParentChanged

protected void beforeParentChanged(ElementBase newParent)

Called before the parent has been changed.

Overrides:

beforeParentChanged in class ElementBase

Parameters:

newParent - The value of the parent property prior to the change.

destroy

public void destroy()

Override to implement special cleanup when an object is destroyed.

Overrides:

destroy in class ElementBase

bind

protected void bind()

Override to bind wrapped components to the UI.

unbind

protected void unbind()

Override to unbind wrapped components from the UI.

rebindChildren

protected void rebindChildren()

Rebind any children. This may be called if the wrapped UI component is recreated.

getInnerComponent

public org.fujion.component.BaseUIComponent getInnerComponent()

Returns the innermost wrapped UI component. For UI elements that may host child elements, this would be the wrapped UI component that can host the child components. For UI elements that wrap a single UI component, getInnerComponent and getOuterComponent should return the same value.

Returns:

The inner component.

setInnerComponent

protected void setInnerComponent(org.fujion.component.BaseUIComponent value)

Sets the innermost wrapped UI component.

Parameters:

value - The innermost wrapped UI component.

getOuterComponent

public org.fujion.component.BaseUIComponent getOuterComponent()

Returns the outermost wrapped UI component. This represents the wrapped UI component that will be the direct child of the UI component wrapped by the parent element. For UI elements that wrap a single UI component, getInnerComponent and getOuterComponent should return the same value.

Returns:

The outer component.

setOuterComponent

protected void setOuterComponent(org.fujion.component.BaseUIComponent value)

Sets the outermost wrapped UI component.

Parameters:

value - The outermost wrapped UI component.

fullSize

protected void fullSize(org.fujion.component.BaseUIComponent component)

Set width and height of a component to 100%.

Parameters:

component - BaseComponent

activate

public void activate(boolean activate)

Activates or inactivates a UI element. In general, this method should not be overridden to introduce new behavior. Rather, if a UI element must change its visual state in response to a change in activation state, it should override the updateVisibility method. If a UI element requires special activation logic for its children (e.g., if it allows only one child to be active at a time), it should override the activateChildren method.

Parameters:

activate - The activate status.

activateChildren

protected void activateChildren(boolean activate)

Default behavior is to pass activation/inactivation event to children. Override to restrict propagation of the event.

Parameters:

activate - The activate status.

isActivated

public final boolean isActivated()

Returns the activation status of the element.

Returns:

The activation status.

getFirstVisibleChild

public ElementUI getFirstVisibleChild()

Returns the first visible child.

Returns:

First visible child, or null if none;

getLastVisibleChild

public ElementUI getLastVisibleChild()

Returns the last visible child.

Returns:

Last visible child, or null if none;

getNextSibling

public ElementUI getNextSibling(boolean visibleOnly)

Returns this element's next sibling.

Parameters:

visibleOnly - If true, skip any non-visible siblings.

Returns:

The next sibling, or null if none.

afterMoveChild

protected void afterMoveChild(ElementBase child,
                              ElementBase before)

Element has been moved to a different position under this parent. Adjust wrapped components accordingly.

Overrides:

afterMoveChild in class ElementBase

Parameters:

child - Child element that was moved.

before - Child element was moved before this one.

bringToFront

public void bringToFront()

Brings this element to the front of the user interface.

getParent

public ElementUI getParent()

Returns the parent of this element. May be null.

Overrides:

getParent in class ElementBase

Returns:

This element's parent.

getRoot

public ElementUI getRoot()

Returns the UI element at the root of the component tree.

Overrides:

getRoot in class ElementBase

Returns:

Root UI element.

setVisible

public final void setVisible(boolean visible)

Sets the visibility state of the component. This base implementation only sets the internal flag and notifies the parent of the state change. Each UI element is responsible for overriding this method and reflecting the visibility state in their wrapped UI components.

Parameters:

visible - The visibility state.

updateVisibility

protected final void updateVisibility()

Calls updateVisibility with current settings.

updateVisibility

protected void updateVisibility(boolean visible,
                                boolean activated)

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

Parameters:

visible - The current visibility state.

activated - The current activation state.

isVisible

public final boolean isVisible()

Returns the visible state of the UI element.

Returns:

True if the UI element is visible.

getColor

public final String getColor()

Returns the color (as an HTML-formatted RGB string) for this element.

Returns:

An HTML-formatted color specification (e.g., #0F134E). May be null.

setColor

public final void setColor(String value)

Provides a default implementation for setting the color of a UI element. This is provided to allow components to easily expose a color property in the property editor. It may not be appropriate for all subclasses. To change which UI elements are affected, override the applyColor() method.

Parameters:

value - A correctly formatted HTML color specification.

applyColor

protected void applyColor()

Provides a default implementation for setting the color of a UI element. Sets the color of the inner and outer components. Override to modify this default behavior.

applyColor

protected void applyColor(org.fujion.component.BaseUIComponent comp)

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.

Parameters:

comp - Component to receive the color setting.

getHint

public final String getHint()

Returns the tool tip text.

Returns:

The tool tip text.

setHint

public final void setHint(String value)

Sets the tool tip text.

Parameters:

value - The tool tip text.

applyHint

protected void applyHint()

Provides a default implementation for setting the hint text of a UI element. Sets the hint text of the inner and outer components. Override to modify this default behavior.

applyHint

protected void applyHint(org.fujion.component.BaseUIComponent comp)

Applies the current hint text to the target component.

Parameters:

comp - Component to receive the hint text.

updateState

protected void updateState()

Update a UI element based on the state of its children. The default implementation acts on container elements only and has the following behavior:

• If all children are disabled, the parent is also disabled (set autoEnable to false to turn off).
• If all children are hidden or there are no children and design mode is not active, the parent is also hidden (set autoHide to false to turn off).

Overrides:

updateState in class ElementBase

getMaskMode

protected DesignMask.MaskMode getMaskMode()

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.

setMaskMode

protected void setMaskMode(DesignMask.MaskMode mode)

Sets whether to use the design mode mask.

Parameters:

mode - True to enable the design mode mask.

hasVisibleElements

protected boolean hasVisibleElements(org.fujion.component.BaseUIComponent component)

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

Parameters:

component - Component subtree to examine.

Returns:

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

addTrigger

public void addTrigger(ElementTrigger trigger)

removeTrigger

public void removeTrigger(ElementTrigger trigger)

getTriggers

public Set<ElementTrigger> getTriggers()