org.richfaces.component

Class BasicActionComponent

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.richfaces.component.AbstractActionComponent

org.richfaces.component.BasicActionComponent

All Implemented Interfaces:

EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AjaxActivatorProps, AjaxProps, BypassProps

Direct Known Subclasses:

AbstractAjaxFunction, AbstractCommandButton, AbstractCommandLink, AbstractPoll

public class BasicActionComponent
extends AbstractActionComponent
implements AjaxProps

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, 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

Constructor Summary

Constructors

Constructor and Description
BasicActionComponent()

Method Summary

Methods

Modifier and Type	Method and Description
Object	getData() Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
Object	getExecute() Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle.
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	getOncomplete() The client-side script method to be called after the DOM is updated
Object	getRender() Ids of components that will participate in the "render" portion of the Request Processing Lifecycle.
String	getStatus() Name of the request status component that will indicate the status of the Ajax request
boolean	isBypassUpdates() If "true", after process validations phase it skips updates of model beans on a force render response.
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	setExecute(Object execute)
void	setRender(Object render)

Methods inherited from class org.richfaces.component.AbstractActionComponent

queueEvent

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getFamily, getValue, isImmediate, 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, getDefaultEventName, getEventNames, 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

Constructor Detail

BasicActionComponent

public BasicActionComponent()

Method Detail

getExecute

public Object getExecute()

Ids of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords

Specified by:

getExecute in interface AjaxProps

setExecute

public void setExecute(Object execute)

getRender

public Object getRender()

Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords

Specified by:

getRender in interface AjaxActivatorProps

setRender

public void setRender(Object render)

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

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

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

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

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

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

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

isResetValues

public boolean isResetValues()

Description copied from interface: AjaxActivatorProps

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 AjaxActivatorProps