org.carewebframework.shell.layout

Class UIElementStepView

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementStepView

public class UIElementStepView
extends UIElementZKBase

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

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementStepView() Creates the ZK components that comprise this UI element.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateChildren(boolean activate) Activates the active pane.
protected void	beforeRemoveChild(UIElementBase child) Called before a child is logically removed from the parent.
UIElementStepPane	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 String	getTemplateUrl() Url for zul template.
protected UIElementStepPane	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	onClick$btnHome() Activate the home pane.
void	onClick$btnLeft() Navigate one pane left.
void	onClick$btnRight() Navigate one pane right.
void	setActivePane(UIElementStepPane 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.layout.UIElementZKBase

activate, afterMoveTo, applyColor, applyHint, associateComponent, bind, createFromTemplate, createFromTemplate, createFromTemplate, editProperties, fullSize, getAssociatedUIElement, getEnableDesignModeMask, getInnerComponent, getOuterComponent, getParent, 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, updateVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIElementStepView

public UIElementStepView()
                  throws Exception

Creates the ZK components that comprise this UI element.

Throws:

Exception - Unspecified exception.

Method Detail

beforeRemoveChild

protected void beforeRemoveChild(UIElementBase child)

Description copied from class: UIElementBase

Called before a child is logically removed from the parent.

Overrides:

beforeRemoveChild in class UIElementBase

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 UIElementBase

Parameters:

activate - The activate status.

See Also:

UIElementBase.activateChildren(boolean)

getTemplateUrl

protected String getTemplateUrl()

Url for zul template.

Overrides:

getTemplateUrl in class UIElementZKBase

Returns:

The template URL.

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 UIElementStepPane getActivePane()

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

Returns:

The currently active pane.

setActivePane

public void setActivePane(UIElementStepPane 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 UIElementBase

See Also:

UIElementBase.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 UIElementStepPane 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.

onClick$btnLeft

public void onClick$btnLeft()

Navigate one pane left.

onClick$btnRight

public void onClick$btnRight()

Navigate one pane right.

onClick$btnHome

public void onClick$btnHome()

Activate the home pane.

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.