org.apache.myfaces.tobago.taglib.component
Class ButtonTag

java.lang.Object
  javax.faces.webapp.UIComponentTag
      org.apache.myfaces.tobago.taglib.component.TobagoTag
          org.apache.myfaces.tobago.taglib.component.AbstractCommandTag
              org.apache.myfaces.tobago.taglib.component.ButtonTag

All Implemented Interfaces:

JspTag, Tag, AbstractCommandTagDeclaration, ButtonTagDeclaration, TobagoTagDeclaration, HasAction, HasActionListener, HasBinding, HasCommandType, HasDeprecatedWidth, HasId, HasIdBindingAndRendered, HasImage, HasLabel, HasLabelWithAccessKey, HasLink, HasMarkup, HasOnclick, HasResource, HasTabIndex, HasTarget, HasTip, IsDefaultCommand, IsDisabled, IsImmediateCommand, IsInline, IsRendered, IsTransition

public class ButtonTag
extends AbstractCommandTag
implements ButtonTagDeclaration

Renders a button element.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentTag

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

ButtonTag()

Method Summary

String	getAccessKey()
String	getComponentType()
String	getImage()
String	getLabel()
String	getLabelWithAccessKey()
void	release()
void	setAccessKey(String accessKey) Deprecated!
void	setDefaultCommand(String defaultCommand) If true the command is excuted as default -- for example if the user presses the enter key inside a related input field.
void	setImage(String image) Url to an image to display.
void	setLabel(String label) Text value to display as label.
void	setLabelWithAccessKey(String labelWithAccessKey) Deprecated!
void	setMarkup(String markup) Indicate markup of this component.
protected void	setProperties(UIComponent component)
void	setTabIndex(String tabIndex) Controls the navigation of the focus through the input controls on a page with the Tab-Key.
void	setTarget(String target) Name of a frame where the resource retrieved via this hyperlink is to be displayed.
void	setTip(String tip) Text value to display as tooltip.

Methods inherited from class org.apache.myfaces.tobago.taglib.component.AbstractCommandTag

getAction, getActionListener, getImmediate, getType, setAction, setActionListener, setDisabled, setImmediate, setJsfResource, setLink, setOnclick, setResource, setTransition, setType

Methods inherited from class org.apache.myfaces.tobago.taglib.component.TobagoTag

doEndTag, doStartTag, getDisabled, getHeight, getHidden, getInline, getReadonly, getRendererType, getTitle, getWidth, setHeight, setHidden, setInline, setReadonly, setTitle, setWidth

Methods inherited from class javax.faces.webapp.UIComponentTag

encodeBegin, encodeChildren, encodeEnd, findComponent, getComponentInstance, getCreated, getDoEndValue, getDoStartValue, getFacesContext, getFacetName, getId, getParent, getParentUIComponentTag, isSuppressed, isValueReference, setBinding, setId, setPageContext, setParent, setRendered, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasAction

setAction

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasActionListener

setActionListener

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsImmediateCommand

setImmediate

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasOnclick

setOnclick

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasLink

setLink

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasResource

setJsfResource, setResource

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsTransition

setTransition

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasId

setId

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasBinding

setBinding

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsRendered

setRendered

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsDisabled

setDisabled

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasCommandType

setType

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.HasDeprecatedWidth

setWidth

Methods inherited from interface org.apache.myfaces.tobago.taglib.decl.IsInline

setInline

Constructor Detail

ButtonTag

public ButtonTag()

Method Detail

setProperties

protected void setProperties(UIComponent component)

Overrides:

setProperties in class AbstractCommandTag

getComponentType

public String getComponentType()

Overrides:

getComponentType in class AbstractCommandTag

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class AbstractCommandTag

getAccessKey

public String getAccessKey()

setAccessKey

public void setAccessKey(String accessKey)

Description copied from interface: HasLabelWithAccessKey

Deprecated! Has not longer any function. See label attribute.

Specified by:

setAccessKey in interface HasLabelWithAccessKey

getImage

public String getImage()

setImage

public void setImage(String image)

Description copied from interface: HasImage

Url to an image to display.

Specified by:

setImage in interface HasImage

getLabel

public String getLabel()

Overrides:

getLabel in class TobagoTag

setLabel

public void setLabel(String label)

Description copied from interface: HasLabel

Text value to display as label. If text contains an underscore the next character is used as accesskey.

Specified by:

setLabel in interface HasLabel

Overrides:

setLabel in class TobagoTag

getLabelWithAccessKey

public String getLabelWithAccessKey()

setLabelWithAccessKey

public void setLabelWithAccessKey(String labelWithAccessKey)

Description copied from interface: HasLabelWithAccessKey

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.

Specified by:

setLabelWithAccessKey in interface HasLabelWithAccessKey

setTip

public void setTip(String tip)

Description copied from interface: HasTip

Text value to display as tooltip.

Specified by:

setTip in interface HasTip

setDefaultCommand

public void setDefaultCommand(String defaultCommand)

Description copied from interface: IsDefaultCommand

If true the command is excuted as default -- for example if the user presses the enter key inside a related input field.

Specified by:

setDefaultCommand in interface IsDefaultCommand

setTarget

public void setTarget(String target)

Description copied from interface: HasTarget

Name of a frame where the resource retrieved via this hyperlink is to be displayed.

Specified by:

setTarget in interface HasTarget

setMarkup

public void setMarkup(String markup)

Description copied from interface: HasMarkup

Indicate markup of this component. Possible value is 'none'. But this can be overridden in the theme.

Specified by:

setMarkup in interface HasMarkup

setTabIndex

public void setTabIndex(String tabIndex)

Description copied from interface: HasTabIndex

Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.

Specified by:

setTabIndex in interface HasTabIndex