com.liferay.faces.alloy.component.commandbutton

Class CommandButtonBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

javax.faces.component.html.HtmlCommandButton

com.liferay.faces.alloy.component.commandbutton.CommandButtonBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, 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

Direct Known Subclasses:

CommandButton

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class CommandButtonBase
extends javax.faces.component.html.HtmlCommandButton
implements com.liferay.faces.util.component.Styleable

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CommandButtonBase.CommandButtonPropertyKeys

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlCommandButton

javax.faces.component.html.HtmlCommandButton.PropertyKeys

Field Summary

Fields

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

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY

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 com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Constructor Summary

Constructors

Constructor and Description
CommandButtonBase()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAutofocus() autofocus attribute description: HTML passthrough attribute specifying whether or not the component should automatically recieve focus on the initial page load.
String	getExecute() execute attribute description: Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle.
String	getProcess() process attribute description: Synonym for the execute attribute.
String	getRender() render attribute description: Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
String	getType() type attribute description: The type of the button: button, submit (default), or reset.
String	getUpdate() update attribute description: Synonym for the render attribute.
boolean	isAjax() ajax attribute description: When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
boolean	isDisabled() disabled attribute description: When this flag is true, the component will be disabled, and the user will be unable to interact with the component.
void	setAjax(boolean ajax) ajax attribute description: When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.
void	setAutofocus(Boolean autofocus) autofocus attribute description: HTML passthrough attribute specifying whether or not the component should automatically recieve focus on the initial page load.
void	setDisabled(boolean disabled) disabled attribute description: When this flag is true, the component will be disabled, and the user will be unable to interact with the component.
void	setExecute(String execute) execute attribute description: Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle.
void	setProcess(String process) process attribute description: Synonym for the execute attribute.
void	setRender(String render) render attribute description: Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest.
void	setStyleClass(String styleClass) styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
void	setType(String type) type attribute description: The type of the button: button, submit (default), or reset.
void	setUpdate(String update) update attribute description: Synonym for the render attribute.

Methods inherited from class javax.faces.component.html.HtmlCommandButton

getAccesskey, getAlt, getDefaultEventName, getDir, getEventNames, getImage, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getStyle, getTabindex, getTitle, isReadonly, setAccesskey, setAlt, setDir, setImage, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setStyle, setTabindex, setTitle

Methods inherited from class javax.faces.component.UICommand

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

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, 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, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.faces.util.component.Styleable

getStyle, setStyle

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

CommandButtonBase

public CommandButtonBase()

Method Detail

isAjax

public boolean isAjax()

ajax attribute description:

When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.

setAjax

public void setAjax(boolean ajax)

ajax attribute description:

When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.

getAutofocus

public Boolean getAutofocus()

autofocus attribute description:

HTML passthrough attribute specifying whether or not the component should automatically recieve focus on the initial page load.

setAutofocus

public void setAutofocus(Boolean autofocus)

autofocus attribute description:

HTML passthrough attribute specifying whether or not the component should automatically recieve focus on the initial page load.

isDisabled

public boolean isDisabled()

disabled attribute description:

When this flag is true, the component will be disabled, and the user will be unable to interact with the component.

Overrides:

isDisabled in class javax.faces.component.html.HtmlCommandButton

setDisabled

public void setDisabled(boolean disabled)

disabled attribute description:

When this flag is true, the component will be disabled, and the user will be unable to interact with the component.

Overrides:

setDisabled in class javax.faces.component.html.HtmlCommandButton

getExecute

public String getExecute()

execute attribute description:

Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: @this, @form, @all, @none.

setExecute

public void setExecute(String execute)

execute attribute description:

Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: @this, @form, @all, @none.

getProcess

public String getProcess()

process attribute description:

Synonym for the execute attribute. The default value is "@all".

setProcess

public void setProcess(String process)

process attribute description:

Synonym for the execute attribute. The default value is "@all".

getRender

public String getRender()

render attribute description:

Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: @this, @form, @all, @none.

setRender

public void setRender(String render)

render attribute description:

Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: @this, @form, @all, @none.

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

getStyleClass in class javax.faces.component.html.HtmlCommandButton

setStyleClass

public void setStyleClass(String styleClass)

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

setStyleClass in interface com.liferay.faces.util.component.Styleable

Overrides:

setStyleClass in class javax.faces.component.html.HtmlCommandButton

getType

public String getType()

type attribute description:

The type of the button: button, submit (default), or reset.

Overrides:

getType in class javax.faces.component.html.HtmlCommandButton

setType

public void setType(String type)

type attribute description:

The type of the button: button, submit (default), or reset.

Overrides:

setType in class javax.faces.component.html.HtmlCommandButton

getUpdate

public String getUpdate()

update attribute description:

Synonym for the render attribute. The default value is "@none".

setUpdate

public void setUpdate(String update)

update attribute description:

Synonym for the render attribute. The default value is "@none".