javax.faces.component.html
Class HtmlCommandButton

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by javax.faces.component.html.HtmlCommandButton
All Implemented Interfaces:
ActionSource, ActionSource2, StateHolder

public class HtmlCommandButton
extends UICommand

Events:

Type Phases Description
javax.faces.event.ActionEvent Invoke
Application
Apply
Request
Values
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlCommandButton()
          Construct an instance of the HtmlCommandButton.
 
Method Summary
 java.lang.String getAccesskey()
          Gets Sets the access key for this element.
 java.lang.String getAlt()
          Gets Specifies alternative text that can be used by a browser that can't show this element.
 java.lang.String getDir()
          Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getFamily()
           
 java.lang.String getImage()
          Gets Absolute or relative URL of the image
 java.lang.String getLabel()
          Gets A diplay name for this component.
 java.lang.String getLang()
          Gets The base language of this document.
 java.lang.String getOnblur()
          Gets Specifies a script to be invoked when the element loses focus.
 java.lang.String getOnchange()
          Gets Specifies a script to be invoked when the element is modified.
 java.lang.String getOnclick()
          Gets Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          Gets Script to be invoked when the element is double-clicked.
 java.lang.String getOnfocus()
          Gets Specifies a script to be invoked when the element receives focus.
 java.lang.String getOnkeydown()
          Gets Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          Gets Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          Gets Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          Gets Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          Gets Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          Gets Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          Gets Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          Gets Script to be invoked when the pointing device is released over this element.
 java.lang.String getOnselect()
          Gets Specifies a script to be invoked when the element is selected.
 java.lang.String getStyle()
          Gets CSS styling instructions.
 java.lang.String getStyleClass()
          Gets The CSS class for this element.
 java.lang.String getTabindex()
          Gets Specifies the position of this element within the tab order of the document.
 java.lang.String getTitle()
          Gets An advisory title for this element.
 java.lang.String getType()
          Gets A hint to the user agent about the content type of the linked resource.
 boolean isDisabled()
          Gets When true, this element cannot receive focus.
 boolean isReadonly()
          Gets When true, indicates that this component cannot be modified by the user.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setAccesskey(java.lang.String accesskey)
          Sets Sets the access key for this element.
 void setAlt(java.lang.String alt)
          Sets Specifies alternative text that can be used by a browser that can't show this element.
 void setDir(java.lang.String dir)
          Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 void setDisabled(boolean disabled)
          Sets When true, this element cannot receive focus.
 void setImage(java.lang.String image)
          Sets Absolute or relative URL of the image
 void setLabel(java.lang.String label)
          Sets A diplay name for this component.
 void setLang(java.lang.String lang)
          Sets The base language of this document.
 void setOnblur(java.lang.String onblur)
          Sets Specifies a script to be invoked when the element loses focus.
 void setOnchange(java.lang.String onchange)
          Sets Specifies a script to be invoked when the element is modified.
 void setOnclick(java.lang.String onclick)
          Sets Script to be invoked when the element is clicked.
 void setOndblclick(java.lang.String ondblclick)
          Sets Script to be invoked when the element is double-clicked.
 void setOnfocus(java.lang.String onfocus)
          Sets Specifies a script to be invoked when the element receives focus.
 void setOnkeydown(java.lang.String onkeydown)
          Sets Script to be invoked when a key is pressed down over this element.
 void setOnkeypress(java.lang.String onkeypress)
          Sets Script to be invoked when a key is pressed over this element.
 void setOnkeyup(java.lang.String onkeyup)
          Sets Script to be invoked when a key is released over this element.
 void setOnmousedown(java.lang.String onmousedown)
          Sets Script to be invoked when the pointing device is pressed over this element.
 void setOnmousemove(java.lang.String onmousemove)
          Sets Script to be invoked when the pointing device is moved while it is in this element.
 void setOnmouseout(java.lang.String onmouseout)
          Sets Script to be invoked when the pointing device is moves out of this element.
 void setOnmouseover(java.lang.String onmouseover)
          Sets Script to be invoked when the pointing device is moved into this element.
 void setOnmouseup(java.lang.String onmouseup)
          Sets Script to be invoked when the pointing device is released over this element.
 void setOnselect(java.lang.String onselect)
          Sets Specifies a script to be invoked when the element is selected.
 void setReadonly(boolean readonly)
          Sets When true, indicates that this component cannot be modified by the user.
 void setStyle(java.lang.String style)
          Sets CSS styling instructions.
 void setStyleClass(java.lang.String styleClass)
          Sets The CSS class for this element.
 void setTabindex(java.lang.String tabindex)
          Sets Specifies the position of this element within the tab order of the document.
 void setTitle(java.lang.String title)
          Sets An advisory title for this element.
 void setType(java.lang.String type)
          Sets A hint to the user agent about the content type of the linked resource.
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlCommandButton

public HtmlCommandButton()
Construct an instance of the HtmlCommandButton.

Method Detail

getStyle

public java.lang.String getStyle()
Gets CSS styling instructions.

Returns:
the new style value

setStyle

public void setStyle(java.lang.String style)
Sets CSS styling instructions.

Parameters:
style - the new style value

getStyleClass

public java.lang.String getStyleClass()
Gets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Returns:
the new styleClass value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Parameters:
styleClass - the new styleClass value

getDir

public java.lang.String getDir()
Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Returns:
the new dir value

setDir

public void setDir(java.lang.String dir)
Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Parameters:
dir - the new dir value

getLang

public java.lang.String getLang()
Gets The base language of this document.

Returns:
the new lang value

setLang

public void setLang(java.lang.String lang)
Sets The base language of this document.

Parameters:
lang - the new lang value

getTitle

public java.lang.String getTitle()
Gets An advisory title for this element. Often used by the user agent as a tooltip.

Returns:
the new title value

setTitle

public void setTitle(java.lang.String title)
Sets An advisory title for this element. Often used by the user agent as a tooltip.

Parameters:
title - the new title value

getOnclick

public java.lang.String getOnclick()
Gets Script to be invoked when the element is clicked.

Returns:
the new onclick value

setOnclick

public void setOnclick(java.lang.String onclick)
Sets Script to be invoked when the element is clicked.

Parameters:
onclick - the new onclick value

getOndblclick

public java.lang.String getOndblclick()
Gets Script to be invoked when the element is double-clicked.

Returns:
the new ondblclick value

setOndblclick

public void setOndblclick(java.lang.String ondblclick)
Sets Script to be invoked when the element is double-clicked.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public java.lang.String getOnmousedown()
Gets Script to be invoked when the pointing device is pressed over this element.

Returns:
the new onmousedown value

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)
Sets Script to be invoked when the pointing device is pressed over this element.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public java.lang.String getOnmouseup()
Gets Script to be invoked when the pointing device is released over this element.

Returns:
the new onmouseup value

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)
Sets Script to be invoked when the pointing device is released over this element.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public java.lang.String getOnmouseover()
Gets Script to be invoked when the pointing device is moved into this element.

Returns:
the new onmouseover value

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)
Sets Script to be invoked when the pointing device is moved into this element.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public java.lang.String getOnmousemove()
Gets Script to be invoked when the pointing device is moved while it is in this element.

Returns:
the new onmousemove value

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)
Sets Script to be invoked when the pointing device is moved while it is in this element.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public java.lang.String getOnmouseout()
Gets Script to be invoked when the pointing device is moves out of this element.

Returns:
the new onmouseout value

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)
Sets Script to be invoked when the pointing device is moves out of this element.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public java.lang.String getOnkeypress()
Gets Script to be invoked when a key is pressed over this element.

Returns:
the new onkeypress value

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)
Sets Script to be invoked when a key is pressed over this element.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public java.lang.String getOnkeydown()
Gets Script to be invoked when a key is pressed down over this element.

Returns:
the new onkeydown value

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)
Sets Script to be invoked when a key is pressed down over this element.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public java.lang.String getOnkeyup()
Gets Script to be invoked when a key is released over this element.

Returns:
the new onkeyup value

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)
Sets Script to be invoked when a key is released over this element.

Parameters:
onkeyup - the new onkeyup value

getOnblur

public java.lang.String getOnblur()
Gets Specifies a script to be invoked when the element loses focus.

Returns:
the new onblur value

setOnblur

public void setOnblur(java.lang.String onblur)
Sets Specifies a script to be invoked when the element loses focus.

Parameters:
onblur - the new onblur value

getOnfocus

public java.lang.String getOnfocus()
Gets Specifies a script to be invoked when the element receives focus.

Returns:
the new onfocus value

setOnfocus

public void setOnfocus(java.lang.String onfocus)
Sets Specifies a script to be invoked when the element receives focus.

Parameters:
onfocus - the new onfocus value

getOnchange

public java.lang.String getOnchange()
Gets Specifies a script to be invoked when the element is modified.

Returns:
the new onchange value

setOnchange

public void setOnchange(java.lang.String onchange)
Sets Specifies a script to be invoked when the element is modified.

Parameters:
onchange - the new onchange value

getOnselect

public java.lang.String getOnselect()
Gets Specifies a script to be invoked when the element is selected.

Returns:
the new onselect value

setOnselect

public void setOnselect(java.lang.String onselect)
Sets Specifies a script to be invoked when the element is selected.

Parameters:
onselect - the new onselect value

getAccesskey

public java.lang.String getAccesskey()
Gets Sets the access key for this element.

Returns:
the new accesskey value

setAccesskey

public void setAccesskey(java.lang.String accesskey)
Sets Sets the access key for this element.

Parameters:
accesskey - the new accesskey value

getTabindex

public java.lang.String getTabindex()
Gets Specifies the position of this element within the tab order of the document.

Returns:
the new tabindex value

setTabindex

public void setTabindex(java.lang.String tabindex)
Sets Specifies the position of this element within the tab order of the document.

Parameters:
tabindex - the new tabindex value

isDisabled

public boolean isDisabled()
Gets When true, this element cannot receive focus.

Returns:
the new disabled value

setDisabled

public void setDisabled(boolean disabled)
Sets When true, this element cannot receive focus.

Parameters:
disabled - the new disabled value

isReadonly

public boolean isReadonly()
Gets When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.

Returns:
the new readonly value

setReadonly

public void setReadonly(boolean readonly)
Sets When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.

Parameters:
readonly - the new readonly value

getLabel

public java.lang.String getLabel()
Gets A diplay name for this component.

Returns:
the new label value

setLabel

public void setLabel(java.lang.String label)
Sets A diplay name for this component.

Parameters:
label - the new label value

getImage

public java.lang.String getImage()
Gets Absolute or relative URL of the image

Returns:
the new image value

setImage

public void setImage(java.lang.String image)
Sets Absolute or relative URL of the image

Parameters:
image - the new image value

getAlt

public java.lang.String getAlt()
Gets Specifies alternative text that can be used by a browser that can't show this element.

Returns:
the new alt value

setAlt

public void setAlt(java.lang.String alt)
Sets Specifies alternative text that can be used by a browser that can't show this element.

Parameters:
alt - the new alt value

getType

public java.lang.String getType()
Gets A hint to the user agent about the content type of the linked resource.

Returns:
the new type value

setType

public void setType(java.lang.String type)
Sets A hint to the user agent about the content type of the linked resource.

Parameters:
type - the new type value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UICommand

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UICommand
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UICommand


Copyright © 2011 Apache Software Foundation. All Rights Reserved.