javax.faces.component.behavior

Class AjaxBehavior

java.lang.Object

javax.faces.component.behavior.BehaviorBase

javax.faces.component.behavior.ClientBehaviorBase

javax.faces.component.behavior.AjaxBehavior

All Implemented Interfaces:

Behavior, ClientBehavior, PartialStateHolder, StateHolder

public class AjaxBehavior
extends ClientBehaviorBase

An instance of this class is added as a ClientBehavior to a component using the ClientBehaviorHolder.addClientBehavior(java.lang.String, javax.faces.component.behavior.ClientBehavior) contract that components implement. The presence of this ClientBehavior will cause the rendering of JavaScript that produces an Ajax request using the specification public JavaScript API when the component is rendered.

If the component is an instance of EditableValueHolder, Where at all possible, the component must have the UI register the ajax event when the initial value is changed, not when focus is lost on the component.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ALL
private static java.util.List<java.lang.String>	ALL_LIST
static java.lang.String	BEHAVIOR_ID The standard id for this behavior.
private java.util.Map<java.lang.String,javax.el.ValueExpression>	bindings
private java.lang.Boolean	disabled
private static java.lang.String	DISABLED
private java.util.List<java.lang.String>	execute
private static java.lang.String	EXECUTE
private static java.lang.String	FORM
private static java.util.List<java.lang.String>	FORM_LIST
private static java.util.Set<ClientBehaviorHint>	HINTS
private java.lang.Boolean	immediate
private static java.lang.String	IMMEDIATE
private static java.lang.String	NONE
private static java.util.List<java.lang.String>	NONE_LIST
private java.lang.String	onerror
private static java.lang.String	ONERROR
private java.lang.String	onevent
private static java.lang.String	ONEVENT
private java.util.List<java.lang.String>	render
private static java.lang.String	RENDER
private static java.util.regex.Pattern	SPLIT_PATTERN
private static java.lang.String	THIS
private static java.util.List<java.lang.String>	THIS_LIST

Constructor Summary

Constructors

Constructor and Description
AjaxBehavior()

Method Summary

Modifier and Type	Method and Description
void	addAjaxBehaviorListener(AjaxBehaviorListener listener) Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from this AjaxBehavior.
private java.util.List<java.lang.String>	copyToList(java.util.Collection<java.lang.String> collection)
private java.lang.Object	eval(java.lang.String propertyName, java.lang.Object value)
private java.util.Collection<java.lang.String>	getCollectionValue(java.lang.String propertyName, java.util.Collection<java.lang.String> collection)
java.util.Collection<java.lang.String>	getExecute() Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.
java.util.Set<ClientBehaviorHint>	getHints() This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING.
java.lang.String	getOnerror() Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.
java.lang.String	getOnevent() Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.
java.util.Collection<java.lang.String>	getRender() Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.
java.lang.String	getRendererType() Returns the renderer type of the ClientBehaviorRenderer to use for the behavior.
javax.el.ValueExpression	getValueExpression(java.lang.String name) Returns the ValueExpression used to calculate the value for the specified property name, if any.
boolean	isDisabled() Return the disabled status of this behavior.
boolean	isImmediate() Return the immediate status of this behaivor.
boolean	isImmediateSet() Tests whether the immediate attribute is specified.
void	removeAjaxBehaviorListener(AjaxBehaviorListener listener) Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications from this AjaxBehavior.
private static java.util.Map<java.lang.String,javax.el.ValueExpression>	restoreBindings(FacesContext context, java.lang.Object state)
private static java.util.List<java.lang.String>	restoreList(java.lang.String propertyName, java.lang.Object state)
void	restoreState(FacesContext context, java.lang.Object state) Implementation of StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object).
private static java.lang.Object	saveBindings(FacesContext context, java.util.Map<java.lang.String,javax.el.ValueExpression> bindings)
private static java.lang.Object	saveList(java.util.List<java.lang.String> list)
java.lang.Object	saveState(FacesContext context) Implementation of StateHolder.saveState(javax.faces.context.FacesContext).
void	setDisabled(boolean disabled) Sets the disabled status of this behavior.
void	setExecute(java.util.Collection<java.lang.String> execute) Sets the component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.
void	setImmediate(boolean immediate) Sets the immediate status of this behavior.
private void	setLiteralValue(java.lang.String propertyName, javax.el.ValueExpression expression)
void	setOnerror(java.lang.String onerror) Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.
void	setOnevent(java.lang.String onevent) Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.
void	setRender(java.util.Collection<java.lang.String> render) Sets the component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding) Sets the ValueExpression used to calculate the value for the specified property name.
private static java.util.List<java.lang.String>	toList(java.lang.String propertyName, javax.el.ValueExpression expression, java.lang.Object value)
private static java.util.List<java.lang.String>	toSingletonList(java.lang.String propertyName, java.lang.String value)

Methods inherited from class javax.faces.component.behavior.ClientBehaviorBase

decode, getRenderer, getScript

Methods inherited from class javax.faces.component.behavior.BehaviorBase

addBehaviorListener, broadcast, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, setTransient

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

broadcast

Field Detail

BEHAVIOR_ID

public static final java.lang.String BEHAVIOR_ID

The standard id for this behavior.

See Also:

Constant Field Values

HINTS

private static final java.util.Set<ClientBehaviorHint> HINTS

onerror

private java.lang.String onerror

onevent

private java.lang.String onevent

execute

private java.util.List<java.lang.String> execute

render

private java.util.List<java.lang.String> render

disabled

private java.lang.Boolean disabled

immediate

private java.lang.Boolean immediate

bindings

private java.util.Map<java.lang.String,javax.el.ValueExpression> bindings

ONEVENT

private static final java.lang.String ONEVENT

See Also:

Constant Field Values

ONERROR

private static final java.lang.String ONERROR

See Also:

Constant Field Values

IMMEDIATE

private static final java.lang.String IMMEDIATE

See Also:

Constant Field Values

DISABLED

private static final java.lang.String DISABLED

See Also:

Constant Field Values

EXECUTE

private static final java.lang.String EXECUTE

See Also:

Constant Field Values

RENDER

private static final java.lang.String RENDER

See Also:

Constant Field Values

ALL

private static java.lang.String ALL

FORM

private static java.lang.String FORM

THIS

private static java.lang.String THIS

NONE

private static java.lang.String NONE

ALL_LIST

private static java.util.List<java.lang.String> ALL_LIST

FORM_LIST

private static java.util.List<java.lang.String> FORM_LIST

THIS_LIST

private static java.util.List<java.lang.String> THIS_LIST

NONE_LIST

private static java.util.List<java.lang.String> NONE_LIST

SPLIT_PATTERN

private static java.util.regex.Pattern SPLIT_PATTERN

Constructor Detail

AjaxBehavior

public AjaxBehavior()

Method Detail

getRendererType

public java.lang.String getRendererType()

Description copied from class: ClientBehaviorBase

Returns the renderer type of the ClientBehaviorRenderer to use for the behavior. The default implementation returns null. Subclasses should either override this method to return a string that identifies the type of ClientBehaviorRenderer to use, or should override ClientBehaviorBase.getScript(javax.faces.component.behavior.ClientBehaviorContext) and perform script rendering locally in the ClientBehavior implementation.

Overrides:

getRendererType in class ClientBehaviorBase

Returns:

the default renderer type, which is null.

getHints

public java.util.Set<ClientBehaviorHint> getHints()

This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING.

Specified by:

getHints in interface ClientBehavior

Overrides:

getHints in class ClientBehaviorBase

Returns:

unmodifiable set containing the hint ClientBehaviorHint SUBMITTING.

Since:

2.0

getOnerror

public java.lang.String getOnerror()

Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

Since:

2.0

setOnerror

public void setOnerror(java.lang.String onerror)

Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.

Parameters:

onerror - the error handling function name

Since:

2.0

getOnevent

public java.lang.String getOnevent()

Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event.

Since:

2.0

setOnevent

public void setOnevent(java.lang.String onevent)

Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.

Parameters:

onevent - the event handling function name

Since:

2.0

getExecute

public java.util.Collection<java.lang.String> getExecute()

Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

Note that the returned collection may be unmodifiable. Modifications should be performed by calling setExecute(java.util.Collection<java.lang.String>).

Since:

2.0

setExecute

public void setExecute(java.util.Collection<java.lang.String> execute)

Sets the component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle.

Parameters:

execute - the ids of components to execute

Since:

2.0

getRender

public java.util.Collection<java.lang.String> getRender()

Return a non-empty Collection<String> of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

Note that the returned collection may be unmodifiable. Modifications should be performed by calling setRender(java.util.Collection<java.lang.String>).

Since:

2.0

setRender

public void setRender(java.util.Collection<java.lang.String> render)

Sets the component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle.

Parameters:

render - the ids of components to render

Since:

2.0

isDisabled

public boolean isDisabled()

Return the disabled status of this behavior.

Since:

2.0

setDisabled

public void setDisabled(boolean disabled)

Sets the disabled status of this behavior.

Since:

2.0

isImmediate

public boolean isImmediate()

Return the immediate status of this behaivor.

Since:

2.0

setImmediate

public void setImmediate(boolean immediate)

Sets the immediate status of this behavior.

Since:

2.0

isImmediateSet

public boolean isImmediateSet()

Tests whether the immediate attribute is specified. Returns true if the immediate attribute is specified, either as a locally set property or as a value expression. This information allows an associated client behavior renderer to fall back on the parent component's immediate status when immediate is not explicitly specified on the AjaxBehavior.

Since:

2.0

getValueExpression

public javax.el.ValueExpression getValueExpression(java.lang.String name)

Returns the ValueExpression used to calculate the value for the specified property name, if any.

Parameters:

name - Name of the property for which to retrieve a ValueExpression

Throws:

java.lang.NullPointerException - if name is null

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Sets the ValueExpression used to calculate the value for the specified property name.

Parameters:

name - Name of the property for which to set a ValueExpression

binding - The ValueExpression to set, or null to remove any currently set ValueExpression

Throws:

java.lang.NullPointerException - if name is null

addAjaxBehaviorListener

public void addAjaxBehaviorListener(AjaxBehaviorListener listener)

Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from this AjaxBehavior.

Parameters:

listener - The AjaxBehaviorListener to be registered

Throws:

java.lang.NullPointerException - if listener is null

Since:

2.0

removeAjaxBehaviorListener

public void removeAjaxBehaviorListener(AjaxBehaviorListener listener)

Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications from this AjaxBehavior.

Parameters:

listener - The AjaxBehaviorListener to be removed

Throws:

java.lang.NullPointerException - if listener is null

Since:

2.0

saveState

public java.lang.Object saveState(FacesContext context)

Description copied from class: BehaviorBase

Implementation of StateHolder.saveState(javax.faces.context.FacesContext).

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class BehaviorBase

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

Description copied from class: BehaviorBase

Implementation of StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object).

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class BehaviorBase

saveBindings

private static java.lang.Object saveBindings(FacesContext context,
                                             java.util.Map<java.lang.String,javax.el.ValueExpression> bindings)

restoreBindings

private static java.util.Map<java.lang.String,javax.el.ValueExpression> restoreBindings(FacesContext context,
                                                                                        java.lang.Object state)

saveList

private static java.lang.Object saveList(java.util.List<java.lang.String> list)

restoreList

private static java.util.List<java.lang.String> restoreList(java.lang.String propertyName,
                                                            java.lang.Object state)

eval

private java.lang.Object eval(java.lang.String propertyName,
                              java.lang.Object value)

getCollectionValue

private java.util.Collection<java.lang.String> getCollectionValue(java.lang.String propertyName,
                                                                  java.util.Collection<java.lang.String> collection)

setLiteralValue

private void setLiteralValue(java.lang.String propertyName,
                             javax.el.ValueExpression expression)

toList

private static java.util.List<java.lang.String> toList(java.lang.String propertyName,
                                                       javax.el.ValueExpression expression,
                                                       java.lang.Object value)

toSingletonList

private static java.util.List<java.lang.String> toSingletonList(java.lang.String propertyName,
                                                                java.lang.String value)

copyToList

private java.util.List<java.lang.String> copyToList(java.util.Collection<java.lang.String> collection)