org.carewebframework.shell.layout

Class UIElementButton

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementActionBase

org.carewebframework.shell.layout.UIElementButton

Direct Known Subclasses:

UIElementLink

public class UIElementButton
extends UIElementActionBase

Simple button stock object.

Field Summary

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

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementButton()
UIElementButton(org.zkoss.zul.impl.LabelImageElement component, ThemeUtil.ButtonSize size, ThemeUtil.ButtonStyle style)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyColor() Provides a default implementation for setting the color of a UI element.
String	getIcon() Returns the URL of the icon to be display on the button.
String	getInstanceName() Returns the instance name of this element.
String	getLabel() Returns the button's label text.
ThemeUtil.ButtonSize	getSize()
ThemeUtil.ButtonStyle	getStyle()
void	setIcon(String url) Sets the URL of the icon to be display on the button.
void	setLabel(String value) Sets the button's label text.
void	setSize(ThemeUtil.ButtonSize size)
void	setStyle(ThemeUtil.ButtonStyle style)

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

getAction, setAction, setDesignMode, updateListener

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, getTemplateUrl, hasVisibleElements, moveChild, setDesignContextMenu, setDesignContextMenu, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren, unbind, updateVisibility

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

about, activateChildren, addChild, addChild, afterAddChild, afterInitialize, afterParentChanged, afterRemoveChild, applyHint, beforeAddChild, beforeInitialize, beforeParentChanged, beforeRemoveChild, bringToFront, 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, setEnabled, 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

UIElementButton

public UIElementButton()

UIElementButton

public UIElementButton(org.zkoss.zul.impl.LabelImageElement component,
               ThemeUtil.ButtonSize size,
               ThemeUtil.ButtonStyle style)

Method Detail

getInstanceName

public String getInstanceName()

Description copied from class: UIElementBase

Returns the instance name of this element. By default, this is the same as the display name, but subclasses may override this to provide additional information that would distinguish multiple instances of the same UI element.

Overrides:

getInstanceName in class UIElementBase

Returns:

The instance name.

getLabel

public String getLabel()

Returns the button's label text.

Returns:

The label text.

setLabel

public void setLabel(String value)

Sets the button's label text.

Parameters:

value - The label text.

setIcon

public void setIcon(String url)

Sets the URL of the icon to be display on the button.

Parameters:

url - Icon URL.

getIcon

public String getIcon()

Returns the URL of the icon to be display on the button.

Returns:

Icon URL.

getSize

public ThemeUtil.ButtonSize getSize()

setSize

public void setSize(ThemeUtil.ButtonSize size)

getStyle

public ThemeUtil.ButtonStyle getStyle()

setStyle

public void setStyle(ThemeUtil.ButtonStyle style)

applyColor

protected void applyColor()

Description copied from class: UIElementBase

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.

Overrides:

applyColor in class UIElementBase