org.carewebframework.shell.layout

Class UIElementStepPane

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementStepPane

public class UIElementStepPane
extends UIElementZKBase

A step-oriented UI Element. This is a composite element consisting of a button and its separator with an associated pane. Clicking on a button activates its corresponding pane.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementStepPane() Create the ZK components that comprise this UI element.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterMoveTo(int index) Changes the ordering of a button and its separator.
protected void	applyColor() Apply color changes to button and pane only.
protected void	applyHint() Provides a default implementation for setting the hint text of a UI element.
protected void	bind() Add the ZK components of the child pane to their respective parent components in the view.
void	bringToFront() Brings this UI element to the front of the UI by making it the active pane.
String	getIcon() Returns the button image url.
String	getInstanceName() Returns the instance name to use in the designer.
String	getLabel() Returns the button label.
protected void	setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu) Overrides the default behavior to also target the button component.
void	setEnabled(boolean enabled) Sets the enabled state of the component.
void	setIcon(String value) Sets the button image from a url.
void	setLabel(String value) Sets the button label.
protected void	unbind() Detach the ZK components of the child pane the UI.
protected void	updateVisibility(boolean visible, boolean activated) Provides a default implementation for ZK-derived UI components by setting the visibility of the outer component.

Methods inherited from class org.carewebframework.shell.layout.UIElementZKBase

activate, applyColor, applyHint, associateComponent, createFromTemplate, createFromTemplate, createFromTemplate, editProperties, fullSize, getAssociatedUIElement, getEnableDesignModeMask, getInnerComponent, getOuterComponent, getParent, getTemplateUrl, hasVisibleElements, moveChild, setDesignContextMenu, setDesignMode, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren

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

about, activateChildren, addChild, addChild, afterAddChild, afterInitialize, afterParentChanged, afterRemoveChild, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, destroy, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildren, getColor, getDefinition, getDisplayName, getEventManager, getFirstChild, getFirstVisibleChild, getHint, getIndex, 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, setHint, setIndex, setLocked, setParent, setRejectReason, setVisible, updateParentState, updateState, updateVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

UIElementStepPane

public UIElementStepPane()

Create the ZK components that comprise this UI element.

Method Detail

bind

protected void bind()

Add the ZK components of the child pane to their respective parent components in the view.

Overrides:

bind in class UIElementZKBase

See Also:

UIElementZKBase.bind()

unbind

protected void unbind()

Detach the ZK components of the child pane the UI.

Overrides:

unbind in class UIElementZKBase

See Also:

UIElementZKBase.unbind()

bringToFront

public void bringToFront()

Brings this UI element to the front of the UI by making it the active pane.

Overrides:

bringToFront in class UIElementBase

See Also:

UIElementBase.bringToFront()

afterMoveTo

protected void afterMoveTo(int index)

Changes the ordering of a button and its separator.

Overrides:

afterMoveTo in class UIElementZKBase

Parameters:

index - New position for element.

See Also:

UIElementZKBase.afterMoveTo(int)

getInstanceName

public String getInstanceName()

Returns the instance name to use in the designer.

Overrides:

getInstanceName in class UIElementBase

Returns:

The instance name.

See Also:

UIElementBase.getInstanceName()

applyColor

protected void applyColor()

Apply color changes to button and pane only.

Overrides:

applyColor in class UIElementBase

See Also:

UIElementBase.applyColor()

setDesignContextMenu

protected void setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu)

Overrides the default behavior to also target the button component.

Overrides:

setDesignContextMenu in class UIElementZKBase

Parameters:

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

updateVisibility

protected void updateVisibility(boolean visible,
                    boolean activated)

Description copied from class: UIElementZKBase

Provides a default implementation for ZK-derived UI components by setting the visibility of the outer component.

Overrides:

updateVisibility in class UIElementZKBase

Parameters:

visible - The current visibility state.

activated - The current activation state.

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: UIElementBase

Sets the enabled 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 enabled state in their wrapped UI components.

Overrides:

setEnabled in class UIElementBase

Parameters:

enabled - The enabled state.

getLabel

public String getLabel()

Returns the button label.

Returns:

The button's label.

setLabel

public void setLabel(String value)

Sets the button label.

Parameters:

value - The label value.

applyHint

protected void applyHint()

Description copied from class: UIElementBase

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.

Overrides:

applyHint in class UIElementBase

getIcon

public String getIcon()

Returns the button image url.

Returns:

Url for the button image. May be null or empty.

setIcon

public void setIcon(String value)

Sets the button image from a url.

Parameters:

value - Url for the button image. May be null or empty.