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

@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIFunction
extends AbstractAjaxFunction
implements javax.faces.component.behavior.ClientBehaviorHolder

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:

[email protected]

Nested Class Summary

protected static class

UIFunction.Properties

Field Summary

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

UIFunction()

Method Summary

Object	getData()
String	getDefaultEventName()
Collection<String>	getEventNames()
Object	getExecute()
String	getFamily()
String	getName() The name of the generated javascript function
String	getOnbeforedomupdate()
String	getOnbegin()
String	getOncomplete()
Object	getRender()
String	getStatus()
boolean	isBypassUpdates() If "true", after process validations phase it skips updates of model beans on a force render response.
boolean	isLimitRender()
void	setBypassUpdates(boolean bypassUpdates)
void	setData(Object data)
void	setExecute(Object execute)
void	setLimitRender(boolean limitRender)
void	setName(String name)
void	setOnbeforedomupdate(String onbeforedomupdate)
void	setOnbegin(String onbegin)
void	setOncomplete(String oncomplete)
void	setRender(Object render)
void	setStatus(String status)

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, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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 javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

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 class: AbstractActionComponent

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 class AbstractActionComponent

setBypassUpdates

public void setBypassUpdates(boolean bypassUpdates)

Specified by:

setBypassUpdates in class AbstractActionComponent

getData

public Object getData()

setData

public void setData(Object data)

getExecute

public Object getExecute()

setExecute

public void setExecute(Object execute)

isLimitRender

public boolean isLimitRender()

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()

setOnbeforedomupdate

public void setOnbeforedomupdate(String onbeforedomupdate)

getOnbegin

public String getOnbegin()

setOnbegin

public void setOnbegin(String onbegin)

getOncomplete

public String getOncomplete()

setOncomplete

public void setOncomplete(String oncomplete)

getRender

public Object getRender()

setRender

public void setRender(Object render)

getStatus

public String getStatus()

setStatus

public void setStatus(String status)