public class

UIButton

extends UICommand
java.lang.Object
   ↳ javax.faces.component.UIComponent
     ↳ javax.faces.component.UIComponentBase
       ↳ javax.faces.component.UICommand
         ↳ org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
           ↳ org.apache.myfaces.tobago.internal.component.AbstractUICommand
             ↳ org.apache.myfaces.tobago.component.UICommand
               ↳ org.apache.myfaces.tobago.component.UIButton

Class Overview

Renders a button element. UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.ButtonTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class org.apache.myfaces.tobago.component.UICommand
From class javax.faces.component.UICommand
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UIButton()
Public Methods
Character getAccessKey()
Deprecated! Has not longer any function.@deprecated
String getImage()
Url to an image to display.
String getLabel()
Text value to display as label.
String getLabelWithAccessKey()
Deprecated! Use 'label' instead.
Integer getTabIndex()
Controls the navigation of the focus through the input controls on a page with the Tab-Key.
String getTip()
Text value to display as tooltip.
boolean isDefaultCommand()
If true the command is executed as default -- for example if the user presses the enter key inside a related input field.
boolean isDisabled()
Flag indicating that this element is disabled.
boolean isImmediate()
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
boolean isInline()
Flag indicating this component should rendered as an inline element.
boolean isJsfResource()
Flag indicating that the resource referenced by the resource attribute is a jsf resource.
boolean isTransition()
Specify, if the command calls an JSF-Action.
void restoreState(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setAccessKey(Character accessKey)
void setDefaultCommand(boolean defaultCommand)
void setDisabled(boolean disabled)
void setImage(String image)
void setImmediate(boolean immediate)
void setInline(boolean inline)
void setJsfResource(boolean jsfResource)
void setLabel(String label)
void setLabelWithAccessKey(String labelWithAccessKey)
void setTabIndex(Integer tabIndex)
void setTip(String tip)
void setTransition(boolean transition)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.component.UICommand
From class org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
From class javax.faces.component.UICommand
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.ActionSource
From interface javax.faces.component.ActionSource2
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.component.SupportsRenderedPartially
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.layout.LayoutBase
From interface org.apache.myfaces.tobago.layout.LayoutComponent

Constants

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.Button"

Public Constructors

public UIButton ()

Public Methods

public Character getAccessKey ()

Deprecated! Has not longer any function.@deprecated

public String getImage ()

Url to an image to display.

public String getLabel ()

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

public String getLabelWithAccessKey ()

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

public Integer getTabIndex ()

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.

public String getTip ()

Text value to display as tooltip.

public boolean isDefaultCommand ()

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

public boolean isDisabled ()

Flag indicating that this element is disabled.
Default: false

public boolean isImmediate ()

Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Default: false

public boolean isInline ()

Flag indicating this component should rendered as an inline element.
Default: false@deprecated

public boolean isJsfResource ()

Flag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.
Default: false

public boolean isTransition ()

Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Default: true

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setAccessKey (Character accessKey)

public void setDefaultCommand (boolean defaultCommand)

public void setDisabled (boolean disabled)

public void setImage (String image)

public void setImmediate (boolean immediate)

public void setInline (boolean inline)

public void setJsfResource (boolean jsfResource)

public void setLabel (String label)

public void setLabelWithAccessKey (String labelWithAccessKey)

public void setTabIndex (Integer tabIndex)

public void setTip (String tip)

public void setTransition (boolean transition)