org.richfaces.component

Class UICommandButton

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.richfaces.component.AbstractActionComponent

org.richfaces.component.BasicActionComponent

org.richfaces.component.AbstractCommandButton

org.richfaces.component.UICommandButton

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.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AccesskeyProps, AjaxActivatorProps, AjaxCommandProps, AjaxProps, BypassProps, CommandButtonProps, CoreProps, DisabledProps, ErrorProps, EventsKeyProps, EventsMouseProps, MetaComponentResolver

@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UICommandButton
extends AbstractCommandButton
implements javax.faces.component.behavior.ClientBehaviorHolder, MetaComponentResolver, AccesskeyProps, AjaxCommandProps, BypassProps, CommandButtonProps, CoreProps

The <a4j:commandButton> component is similar to the JavaServer Faces (JSF) <h:commandButton> component, but additionally includes Ajax support.

Author:

Nick Belaevski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UICommandButton.Properties

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface org.richfaces.component.MetaComponentResolver

META_COMPONENT_SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UICommandButton()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAccesskey() Access key that, when pressed, transfers focus to this element.
Object	getData() Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
String	getImage() Absolute or relative URL of the image to be displayed for this button.
String	getOnbeforedomupdate() The client-side script method to be called after the ajax response comes back, but before the DOM is updated
String	getOnbegin() The client-side script method to be called before an ajax request.
String	getOnclick() Javascript code executed when a pointer button is clicked over this element.
String	getOncomplete() The client-side script method to be called after the DOM is updated
String	getOndblclick() Javascript code executed when a pointer button is double clicked over this element.
String	getOnerror() The client-side script method to be called when the request results in an error
String	getOnkeydown() Javascript code executed when a key is pressed down over this element.
String	getOnkeypress() Javascript code executed when a key is pressed and released over this element.
String	getOnkeyup() Javascript code executed when a key is released over this element.
String	getOnmousedown() Javascript code executed when a pointer button is pressed down over this element.
String	getOnmousemove() Javascript code executed when a pointer button is moved within this element.
String	getOnmouseout() Javascript code executed when a pointer button is moved away from this element.
String	getOnmouseover() Javascript code executed when a pointer button is moved onto this element.
String	getOnmouseup() Javascript code executed when a pointer button is released over this element.
String	getStatus() Name of the request status component that will indicate the status of the Ajax request
String	getStyle() CSS style(s) to be applied when this component is rendered.
String	getStyleClass() Space-separated list of CSS style class(es) to be applied when this element is rendered.
String	getTabindex() This attribute specifies the position of the current element in the tabbing order for the current document.
String	getTitle() Advisory title information about markup elements generated for this component.
String	getType() Type of button to create.
boolean	isBypassUpdates() If "true", after process validations phase it skips updates of model beans on a force render response.
boolean	isDisabled() Flag indicating that this element must never receive focus or be included in a subsequent submit.
boolean	isLimitRender() If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
boolean	isResetValues() If true, indicate that this particular Ajax transaction is a value reset transaction.
void	setAccesskey(String accesskey)
void	setBypassUpdates(boolean bypassUpdates)
void	setData(Object data)
void	setDisabled(boolean disabled)
void	setImage(String image)
void	setLimitRender(boolean limitRender)
void	setOnbeforedomupdate(String onbeforedomupdate)
void	setOnbegin(String onbegin)
void	setOnclick(String onclick)
void	setOncomplete(String oncomplete)
void	setOndblclick(String ondblclick)
void	setOnerror(String onerror)
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	setResetValues(boolean resetValues)
void	setStatus(String status)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTabindex(String tabindex)
void	setTitle(String title)
void	setType(String type)

Methods inherited from class org.richfaces.component.AbstractCommandButton

getExecute, resolveClientId, substituteUnresolvedClientId

Methods inherited from class org.richfaces.component.BasicActionComponent

getRender, setExecute, setRender

Methods inherited from class org.richfaces.component.AbstractActionComponent

queueEvent

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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

addClientBehavior, getClientBehaviors

Methods inherited from interface org.richfaces.component.MetaComponentResolver

resolveClientId, substituteUnresolvedClientId

Methods inherited from interface org.richfaces.component.attribute.AjaxProps

getExecute

Methods inherited from interface org.richfaces.component.attribute.AjaxActivatorProps

getRender

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UICommandButton

public UICommandButton()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getAccesskey

public String getAccesskey()

Description copied from interface: AccesskeyProps

Access key that, when pressed, transfers focus to this element.

Specified by:

getAccesskey in interface AccesskeyProps

setAccesskey

public void setAccesskey(String accesskey)

isBypassUpdates

public boolean isBypassUpdates()

Description copied from interface: BypassProps

If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input.

Specified by:

isBypassUpdates in interface BypassProps

Overrides:

isBypassUpdates in class BasicActionComponent

setBypassUpdates

public void setBypassUpdates(boolean bypassUpdates)

getData

public Object getData()

Description copied from interface: AjaxActivatorProps

Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data

Specified by:

getData in interface AjaxActivatorProps

Overrides:

getData in class BasicActionComponent

setData

public void setData(Object data)

isDisabled

public boolean isDisabled()

Description copied from interface: DisabledProps

Flag indicating that this element must never receive focus or be included in a subsequent submit.

Specified by:

isDisabled in interface DisabledProps

setDisabled

public void setDisabled(boolean disabled)

getImage

public String getImage()

Description copied from class: AbstractCommandButton

Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the "value" property

Specified by:

getImage in class AbstractCommandButton

setImage

public void setImage(String image)

isLimitRender

public boolean isLimitRender()

Description copied from interface: AjaxActivatorProps

If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels

Specified by:

isLimitRender in interface AjaxActivatorProps

Overrides:

isLimitRender in class BasicActionComponent

setLimitRender

public void setLimitRender(boolean limitRender)

getOnbeforedomupdate

public String getOnbeforedomupdate()

Description copied from interface: AjaxActivatorProps

The client-side script method to be called after the ajax response comes back, but before the DOM is updated

Specified by:

getOnbeforedomupdate in interface AjaxActivatorProps

Overrides:

getOnbeforedomupdate in class BasicActionComponent

setOnbeforedomupdate

public void setOnbeforedomupdate(String onbeforedomupdate)

getOnbegin

public String getOnbegin()

Description copied from interface: AjaxProps

The client-side script method to be called before an ajax request.

Specified by:

getOnbegin in interface AjaxProps

Overrides:

getOnbegin in class BasicActionComponent

setOnbegin

public void setOnbegin(String onbegin)

getOnclick

public String getOnclick()

Description copied from interface: CommandButtonProps

Javascript code executed when a pointer button is clicked over this element.

Specified by:

getOnclick in interface CommandButtonProps

Specified by:

getOnclick in interface EventsMouseProps

setOnclick

public void setOnclick(String onclick)

getOncomplete

public String getOncomplete()

Description copied from interface: AjaxActivatorProps

The client-side script method to be called after the DOM is updated

Specified by:

getOncomplete in interface AjaxActivatorProps

Overrides:

getOncomplete in class BasicActionComponent

setOncomplete

public void setOncomplete(String oncomplete)

getOndblclick

public String getOndblclick()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is double clicked over this element.

Specified by:

getOndblclick in interface EventsMouseProps

setOndblclick

public void setOndblclick(String ondblclick)

getOnerror

public String getOnerror()

Description copied from interface: ErrorProps

The client-side script method to be called when the request results in an error

Specified by:

getOnerror in interface ErrorProps

Overrides:

getOnerror in class BasicActionComponent

setOnerror

public void setOnerror(String onerror)

getOnkeydown

public String getOnkeydown()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is pressed down over this element.

Specified by:

getOnkeydown in interface EventsKeyProps

setOnkeydown

public void setOnkeydown(String onkeydown)

getOnkeypress

public String getOnkeypress()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is pressed and released over this element.

Specified by:

getOnkeypress in interface EventsKeyProps

setOnkeypress

public void setOnkeypress(String onkeypress)

getOnkeyup

public String getOnkeyup()

Description copied from interface: EventsKeyProps

Javascript code executed when a key is released over this element.

Specified by:

getOnkeyup in interface EventsKeyProps

setOnkeyup

public void setOnkeyup(String onkeyup)

getOnmousedown

public String getOnmousedown()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is pressed down over this element.

Specified by:

getOnmousedown in interface EventsMouseProps

setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove

public String getOnmousemove()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved within this element.

Specified by:

getOnmousemove in interface EventsMouseProps

setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout

public String getOnmouseout()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved away from this element.

Specified by:

getOnmouseout in interface EventsMouseProps

setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover

public String getOnmouseover()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is moved onto this element.

Specified by:

getOnmouseover in interface EventsMouseProps

setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup

public String getOnmouseup()

Description copied from interface: EventsMouseProps

Javascript code executed when a pointer button is released over this element.

Specified by:

getOnmouseup in interface EventsMouseProps

setOnmouseup

public void setOnmouseup(String onmouseup)

isResetValues

public boolean isResetValues()

Description copied from interface: AjaxCommandProps

If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.

Specified by:

isResetValues in interface AjaxCommandProps

Overrides:

isResetValues in class BasicActionComponent

setResetValues

public void setResetValues(boolean resetValues)

getStatus

public String getStatus()

Description copied from interface: AjaxProps

Name of the request status component that will indicate the status of the Ajax request

Specified by:

getStatus in interface AjaxProps

Overrides:

getStatus in class BasicActionComponent

setStatus

public void setStatus(String status)

getStyle

public String getStyle()

Description copied from interface: CoreProps

CSS style(s) to be applied when this component is rendered.

Specified by:

getStyle in interface CoreProps

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

Description copied from interface: CoreProps

Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Specified by:

getStyleClass in interface CoreProps

setStyleClass

public void setStyleClass(String styleClass)

getTabindex

public String getTabindex()

Description copied from class: AbstractCommandButton

This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros

Specified by:

getTabindex in class AbstractCommandButton

setTabindex

public void setTabindex(String tabindex)

getTitle

public String getTitle()

Description copied from interface: CoreProps

Advisory title information about markup elements generated for this component.

Specified by:

getTitle in interface CoreProps

setTitle

public void setTitle(String title)

getType

public String getType()

Description copied from interface: CommandButtonProps

Type of button to create. Can be one of "submit", "button", "image" and "reset". If not specified, the default value is "submit".

Specified by:

getType in interface CommandButtonProps

setType

public void setType(String type)