|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.behavior.BehaviorBase
javax.faces.component.behavior.ClientBehaviorBase
javax.faces.component.behavior.AjaxBehavior
public class AjaxBehavior
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.
| Field Summary | |
|---|---|
static java.lang.String |
BEHAVIOR_ID
The standard id for this behavior. |
| Constructor Summary | |
|---|---|
AjaxBehavior()
|
|
| Method Summary | |
|---|---|
void |
addAjaxBehaviorListener(AjaxBehaviorListener listener)
Add the specified |
java.util.Collection<java.lang.String> |
getExecute()
Return a non-empty
|
java.util.Set<ClientBehaviorHint> |
getHints()
This method returns an unmodifiable |
java.lang.String |
getOnerror()
Return the |
java.lang.String |
getOnevent()
Return the |
java.util.Collection<java.lang.String> |
getRender()
Return a non-empty
|
java.lang.String |
getRendererType()
Returns the renderer type of the
|
ValueExpression |
getValueExpression(java.lang.String name)
Returns the |
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 |
void |
restoreState(FacesContext context,
java.lang.Object state)
Implementation of
|
java.lang.Object |
saveState(FacesContext context)
Implementation of
|
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 |
void |
setImmediate(boolean immediate)
Sets the immediate status of this behavior. |
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 |
void |
setValueExpression(java.lang.String name,
ValueExpression binding)
Sets the |
| 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 |
|---|
public static final java.lang.String BEHAVIOR_ID
The standard id for this behavior.
| Constructor Detail |
|---|
public AjaxBehavior()
| Method Detail |
|---|
public java.lang.String getRendererType()
ClientBehaviorBaseReturns 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.
getRendererType in class ClientBehaviorBasepublic java.util.Set<ClientBehaviorHint> getHints()
This method returns an unmodifiable Set containing
the ClientBehaviorHint SUBMITTING.
getHints in interface ClientBehaviorgetHints in class ClientBehaviorBaseClientBehaviorHint
SUBMITTING.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.
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.
onerror - the error handling function namepublic 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.
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.
onevent - the event handling function namepublic 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.
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.
execute - the ids of components to executepublic 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.
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.
render - the ids of components to renderpublic boolean isDisabled()
Return the disabled status of this behavior.
public void setDisabled(boolean disabled)
Sets the disabled status of this behavior.
public boolean isImmediate()
Return the immediate status of this behaivor.
public void setImmediate(boolean immediate)
Sets the immediate status of this behavior.
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.
public ValueExpression getValueExpression(java.lang.String name)
Returns the ValueExpression
used to calculate the value for the specified property name, if any.
name - Name of the property for which to retrieve a
ValueExpression
java.lang.NullPointerException - if name
is null
public void setValueExpression(java.lang.String name,
ValueExpression binding)
Sets the ValueExpression
used to calculate the value for the specified property name.
name - Name of the property for which to set a
ValueExpressionbinding - The ValueExpression to set, or null
to remove any currently set ValueExpression
java.lang.NullPointerException - if name
is nullpublic void addAjaxBehaviorListener(AjaxBehaviorListener listener)
Add the specified AjaxBehaviorListener
to the set of listeners registered to receive event notifications
from this AjaxBehavior.
listener - The AjaxBehaviorListener to be registered
java.lang.NullPointerException - if listener
is nullpublic void removeAjaxBehaviorListener(AjaxBehaviorListener listener)
Remove the specified AjaxBehaviorListener
from the set of listeners registered to receive event notifications
from this AjaxBehavior.
listener - The AjaxBehaviorListener to be removed
java.lang.NullPointerException - if listener
is nullpublic java.lang.Object saveState(FacesContext context)
BehaviorBaseImplementation of
StateHolder.saveState(javax.faces.context.FacesContext).
saveState in interface StateHoldersaveState in class BehaviorBase
public void restoreState(FacesContext context,
java.lang.Object state)
BehaviorBaseImplementation of
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object).
restoreState in interface StateHolderrestoreState in class BehaviorBase
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24