public class ClientListenerSet extends Object implements Serializable
Constructor and Description |
---|
ClientListenerSet()
Creates a ClientListenerSet.
|
Modifier and Type | Method and Description |
---|---|
void |
addBehavior(String behavior)
Adds a client behavior.
|
void |
addBehavior(javax.el.ValueExpression behavior)
Adds a client behavior defined by a deferred value expression, which will be evaluated later to return a String.
|
void |
addCustomServerListener(String type, javax.el.MethodExpression expr)
Adds a server-side listener (specified by the MethodExpression) that should be executed when a custom client event is fired.
|
void |
addFeatureDependency(String featureName)
Adds a dependency on a JavaScript library feature defined by the JavaScript library partitioning system.
|
void |
addListener(String type, String functionName)
Adds a client listener.
|
String |
encodeAsJson()
Deprecated.
This method is no longer invoked by
RichRenderer and should no longer be used. |
String |
encodeBehaviorsAsJson()
Deprecated.
This method is no longer invoked by
RichRenderer and should no longer be used. |
Collection<Object> |
getBehaviors()
Access the list of client behaviors attached to this object.
|
Iterable<String> |
getFeatureDependencies()
Returns an iterable collection containing the names of the JavaScript library features required by this ClientListenerSet.
|
Collection<String> |
getListeners(String type)
Retrieve the the listeners for a given listener type.
|
Collection<String> |
getListenerTypes()
Retrieve the types of the listeners that have been added to this object.
|
void |
invokeCustomEventListeners(javax.faces.context.FacesContext context, ClientEvent event)
Invoke any custom event listeners with a custom client event.
|
public void addListener(String type, String functionName)
type
- the type of client listenerfunctionName
- the name of the Javascript function to callpublic void addBehavior(String behavior)
public void addBehavior(javax.el.ValueExpression behavior)
public void addFeatureDependency(String featureName)
featureName
- name of a JavaScript library feature that is required by this ClientListenerSet.public Iterable<String> getFeatureDependencies()
public void addCustomServerListener(String type, javax.el.MethodExpression expr)
type
- the type of the custom eventexpr
- MethodExpression that must return void and take a single ClientEvent parameterpublic void invokeCustomEventListeners(javax.faces.context.FacesContext context, ClientEvent event)
@Deprecated public String encodeAsJson()
RichRenderer
and should no longer be used.@Deprecated public String encodeBehaviorsAsJson()
RichRenderer
and should no longer be used.public final Collection<Object> getBehaviors()
public final Collection<String> getListenerTypes()
public final Collection<String> getListeners(String type)
type
- the type of listener