org.carewebframework.shell.layout

Class UIElementTabPane

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementTabPane

public class UIElementTabPane
extends UIElementZKBase

Wraps the ZK Tab and Tabpanel components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIElementTabPane.TabEx Re-purpose close tab button for drop down menu.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementTabPane() Set up the tab and tab panel ZK components.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterMoveTo(int index) Requires moving both ZK components.
protected void	applyColor() Applies color to the tab caption text as well as the tab panel.
protected void	applyHint() Hint text should be applied to the tab.
protected void	bind() Override to bind wrapped components to the UI.
void	bringToFront() Make this tab pane active.
String	getIcon() Returns the tab icon.
String	getInstanceName() The caption label is the instance name.
String	getLabel() Returns the caption label.
protected void	setDesignContextMenu(org.zkoss.zul.Menupopup contextMenu) Apply/remove the design context menu both tab and tab panel.
void	setEnabled(boolean enabled) Apply the disable style when a tab is disabled.
void	setIcon(String value) Sets the tab icon.
void	setLabel(String value) Sets the caption label.
protected void	unbind() Override to unbind wrapped components from the UI.
protected void	updateVisibility(boolean visible, boolean activated) Sets the visibility and selection state of the tab.

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

UIElementTabPane

public UIElementTabPane()

Set up the tab and tab panel ZK components. Note that we use a custom widget override to allow setting the color of the caption text.

Method Detail

bringToFront

public void bringToFront()

Make this tab pane active.

Overrides:

bringToFront in class UIElementBase

afterMoveTo

protected void afterMoveTo(int index)

Requires moving both ZK components.

Overrides:

afterMoveTo in class UIElementZKBase

Parameters:

index - New position for element.

getInstanceName

public String getInstanceName()

The caption label is the instance name.

Overrides:

getInstanceName in class UIElementBase

Returns:

The instance name.

updateVisibility

protected void updateVisibility(boolean visible,
                    boolean activated)

Sets the visibility and selection state of the tab.

Overrides:

updateVisibility in class UIElementZKBase

Parameters:

visible - The current visibility state.

activated - The current activation state.

setDesignContextMenu

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

Apply/remove the design context menu both tab and tab panel.

Overrides:

setDesignContextMenu in class UIElementZKBase

Parameters:

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

setEnabled

public void setEnabled(boolean enabled)

Apply the disable style when a tab is disabled.

Overrides:

setEnabled in class UIElementBase

Parameters:

enabled - The enabled state.

applyColor

protected void applyColor()

Applies color to the tab caption text as well as the tab panel.

Overrides:

applyColor in class UIElementBase

bind

protected void bind()

Description copied from class: UIElementBase

Override to bind wrapped components to the UI.

Overrides:

bind in class UIElementZKBase

unbind

protected void unbind()

Description copied from class: UIElementBase

Override to unbind wrapped components from the UI.

Overrides:

unbind in class UIElementZKBase

getLabel

public String getLabel()

Returns the caption label.

Returns:

The caption label.

setLabel

public void setLabel(String value)

Sets the caption label.

Parameters:

value - The caption label.

getIcon

public String getIcon()

Returns the tab icon.

Returns:

The tab icon.

setIcon

public void setIcon(String value)

Sets the tab icon.

Parameters:

value - The tab icon.

applyHint

protected void applyHint()

Hint text should be applied to the tab.

Overrides:

applyHint in class UIElementBase