org.apache.myfaces.component.html.ext
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
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlCommandButton
                      extended by org.apache.myfaces.component.html.ext.HtmlCommandButton
All Implemented Interfaces:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ForceIdAware, UserRoleAware

public class HtmlCommandButton
extends AbstractHtmlCommandButton


Nested Class Summary
protected static class HtmlCommandButton.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlCommandButton()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getActionFor()
          Comma separated list of subForm-ids for which validation and model update should take place when this command is executed.
 String getAlt()
           
 String getDir()
           
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getLabel()
           
 String getLang()
           
 String getOnblur()
           
 String getOnchange()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnfocus()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getOnselect()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTitle()
           
 String getType()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isDisabled()
           
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 boolean isReadonly()
           
 void setAccesskey(String accesskey)
           
 void setActionFor(String actionFor)
           
 void setAlt(String alt)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setLabel(String label)
           
 void setLang(String lang)
           
 void setOnblur(String onblur)
           
 void setOnchange(String onchange)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnfocus(String onfocus)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setOnselect(String onselect)
           
 void setReadonly(boolean readonly)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTitle(String title)
           
 void setType(String type)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlCommandButton
getClientId, isRendered
 
Methods inherited from class javax.faces.component.html.HtmlCommandButton
getDefaultEventName, getEventNames, getImage, setImage
 
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, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlCommandButton

public HtmlCommandButton()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlCommandButton

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlCommandButton

getActionFor

public String getActionFor()
Description copied from class: AbstractHtmlCommandButton
Comma separated list of subForm-ids for which validation and model update should take place when this command is executed. You need to wrap your input components in org.apache.myfaces.custom.subform.SubForm instances for this to work.

Specified by:
getActionFor in class AbstractHtmlCommandButton

setActionFor

public void setActionFor(String actionFor)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getType

public String getType()
Overrides:
getType in class javax.faces.component.html.HtmlCommandButton

setType

public void setType(String type)
Overrides:
setType in class javax.faces.component.html.HtmlCommandButton

getLabel

public String getLabel()
Overrides:
getLabel in class javax.faces.component.html.HtmlCommandButton

setLabel

public void setLabel(String label)
Overrides:
setLabel in class javax.faces.component.html.HtmlCommandButton

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlCommandButton

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlCommandButton

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlCommandButton

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlCommandButton

getAlt

public String getAlt()
Overrides:
getAlt in class javax.faces.component.html.HtmlCommandButton

setAlt

public void setAlt(String alt)
Overrides:
setAlt in class javax.faces.component.html.HtmlCommandButton

getTabindex

public String getTabindex()
Overrides:
getTabindex in class javax.faces.component.html.HtmlCommandButton

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class javax.faces.component.html.HtmlCommandButton

getOnblur

public String getOnblur()
Overrides:
getOnblur in class javax.faces.component.html.HtmlCommandButton

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class javax.faces.component.html.HtmlCommandButton

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class javax.faces.component.html.HtmlCommandButton

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class javax.faces.component.html.HtmlCommandButton

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class javax.faces.component.html.HtmlCommandButton

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class javax.faces.component.html.HtmlCommandButton

getOnchange

public String getOnchange()
Overrides:
getOnchange in class javax.faces.component.html.HtmlCommandButton

setOnchange

public void setOnchange(String onchange)
Overrides:
setOnchange in class javax.faces.component.html.HtmlCommandButton

getOnselect

public String getOnselect()
Overrides:
getOnselect in class javax.faces.component.html.HtmlCommandButton

setOnselect

public void setOnselect(String onselect)
Overrides:
setOnselect in class javax.faces.component.html.HtmlCommandButton

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlCommandButton

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlCommandButton

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlCommandButton

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlCommandButton

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlCommandButton

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlCommandButton

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlCommandButton

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlCommandButton

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlCommandButton

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlCommandButton

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlCommandButton

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlCommandButton

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlCommandButton

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlCommandButton

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlCommandButton

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlCommandButton

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlCommandButton

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlCommandButton

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlCommandButton

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlCommandButton

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlCommandButton

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlCommandButton

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlCommandButton

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlCommandButton

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlCommandButton

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlCommandButton

isDisabled

public boolean isDisabled()
Overrides:
isDisabled in class javax.faces.component.html.HtmlCommandButton

setDisabled

public void setDisabled(boolean disabled)
Overrides:
setDisabled in class javax.faces.component.html.HtmlCommandButton

isReadonly

public boolean isReadonly()
Overrides:
isReadonly in class javax.faces.component.html.HtmlCommandButton

setReadonly

public void setReadonly(boolean readonly)
Overrides:
setReadonly in class javax.faces.component.html.HtmlCommandButton

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlCommandButton

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlCommandButton


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.