org.richfaces.component

Class UIFunction

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.AbstractAjaxFunction

org.richfaces.component.UIFunction

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, AjaxActivatorProps, AjaxCommandProps, AjaxProps, BypassProps, ErrorProps

@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UIFunction
extends AbstractAjaxFunction
implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxCommandProps, BypassProps

The <a4j:jsFunction> component performs Ajax requests directly from JavaScript code and retrieves server-side data. The server-side data is returned in JavaScript Object Notation (JSON) format prior to the execution of any JavaScript code defined using the "oncomplete" attribute.

Author:

asmirnov@exadel.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UIFunction.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

Constructor Summary

Constructors

Constructor and Description
UIFunction()

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.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
String	getName() The name of the generated javascript function
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
String	getOnerror() The client-side script method to be called when the request results in an error
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	setBypassUpdates(boolean bypassUpdates)
void	setData(Object data)
void	setLimitRender(boolean limitRender)
void	setName(String name)
void	setOnbeforedomupdate(String onbeforedomupdate)
void	setOnbegin(String onbegin)
void	setOncomplete(String oncomplete)
void	setOnerror(String onerror)
void	setResetValues(boolean resetValues)
void	setStatus(String status)

Methods inherited from class org.richfaces.component.BasicActionComponent

getExecute, 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.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

UIFunction

public UIFunction()

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

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)

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)

getName

public String getName()

Description copied from class: AbstractAjaxFunction

The name of the generated javascript function

Specified by:

getName in class AbstractAjaxFunction

setName

public void setName(String name)

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)

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)

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)

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)