org.carewebframework.shell.elements

Class ElementStepView

java.lang.Object

org.carewebframework.shell.elements.ElementBase

org.carewebframework.shell.elements.ElementUI

org.carewebframework.shell.elements.ElementStepView

public class ElementStepView
extends ElementUI

A step-oriented UI Element. This is implemented as a window component with a top toolbar containing sequential steps as a sequence of buttons.

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
ElementStepView() Creates the UI components that comprise this UI element.

Method Summary

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Activates the active pane.
protected void	afterMoveChild(ElementBase child, ElementBase before) Element has been moved to a different position under this parent.
protected void	beforeRemoveChild(ElementBase child) Called before a child is logically removed from the parent.
ElementStepPane	getActivePane() Returns the currently active pane, or null if no pane is active.
int	getActivePaneIndex() Returns the index of the active pane, or -1 if no pane is active.
String	getCaption() Returns the caption of the panel.
boolean	getNoHome() Returns true if home pane is suppressed.
boolean	getNoNavigation() Returns true if navigation controls are suppressed.
ThemeUtil.PanelStyle	getStyle() Returns the panel style to use for the desktop.
protected ElementStepPane	nextVisiblePane(boolean forward, int fromIndex) Returns the next visible pane before/after the specified one.
protected int	nextVisiblePaneIndex(boolean forward, int fromIndex) Returns the index of the next visible pane before/after the specified one.
void	setActivePane(ElementStepPane pane) Sets the active pane.
void	setCaption(String caption) Sets the caption.
void	setNoHome(boolean noHome) Set to true to suppress home pane.
void	setNoNavigation(boolean noNavigation) Set to true to suppress navigation controls.
void	setStyle(ThemeUtil.PanelStyle style) Sets the panel style to use for the desktop.
protected void	updateNavigationElements() Update any navigation elements based on the currently active pane.
protected void	updateState() Updates the state of child components.

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

activate, addTrigger, afterAddChild, afterParentChanged, afterRemoveChild, 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, updateVisibility, updateVisibility

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

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

ElementStepView

public ElementStepView()

Creates the UI components that comprise this UI element.

Method Detail

beforeRemoveChild

protected void beforeRemoveChild(ElementBase child)

Description copied from class: ElementBase

Called before a child is logically removed from the parent.

Overrides:

beforeRemoveChild in class ElementBase

Parameters:

child - The child UI element.

activateChildren

public void activateChildren(boolean activate)

Activates the active pane. If no pane is currently active, activate the first pane.

Overrides:

activateChildren in class ElementUI

Parameters:

activate - The activate status.

See Also:

ElementUI.activateChildren(boolean)

setCaption

public void setCaption(String caption)

Sets the caption.

Parameters:

caption - The caption.

getCaption

public String getCaption()

Returns the caption of the panel.

Returns:

The panel caption.

getActivePane

public ElementStepPane getActivePane()

Returns the currently active pane, or null if no pane is active.

Returns:

The currently active pane.

setActivePane

public void setActivePane(ElementStepPane pane)

Sets the active pane. Since only one pane can be active at a time, the currently active pane is first deactivated.

Parameters:

pane - Step pane to activate.

getActivePaneIndex

public int getActivePaneIndex()

Returns the index of the active pane, or -1 if no pane is active.

Returns:

The index of the active pane.

updateState

protected void updateState()

Updates the state of child components. This logic ensures that the separator following the last button in the step sequence is hidden.

Overrides:

updateState in class ElementUI

See Also:

ElementBase.updateState()

updateNavigationElements

protected void updateNavigationElements()

Update any navigation elements based on the currently active pane.

nextVisiblePaneIndex

protected int nextVisiblePaneIndex(boolean forward,
                                   int fromIndex)

Returns the index of the next visible pane before/after the specified one.

Parameters:

forward - If true, search forward. Otherwise, search backward.

fromIndex - Pane index from which to search.

Returns:

Index of the next visible pane.

nextVisiblePane

protected ElementStepPane nextVisiblePane(boolean forward,
                                          int fromIndex)

Returns the next visible pane before/after the specified one.

Parameters:

forward - If true, search forward. Otherwise, search backward.

fromIndex - Pane index from which to search.

Returns:

The next visible pane.

afterMoveChild

protected void afterMoveChild(ElementBase child,
                              ElementBase before)

Description copied from class: ElementUI

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

Overrides:

afterMoveChild in class ElementUI

Parameters:

child - Child element that was moved.

before - Child element was moved before this one.

getNoNavigation

public boolean getNoNavigation()

Returns true if navigation controls are suppressed.

Returns:

True if navigation controls are suppressed.

setNoNavigation

public void setNoNavigation(boolean noNavigation)

Set to true to suppress navigation controls.

Parameters:

noNavigation - True to suppress navigation controls.

getNoHome

public boolean getNoHome()

Returns true if home pane is suppressed.

Returns:

Home suppression flag.

setNoHome

public void setNoHome(boolean noHome)

Set to true to suppress home pane.

Parameters:

noHome - Home suppression flag.

getStyle

public ThemeUtil.PanelStyle getStyle()

Returns the panel style to use for the desktop.

Returns:

The panel style.

setStyle

public void setStyle(ThemeUtil.PanelStyle style)

Sets the panel style to use for the desktop.

Parameters:

style - The panel style.