Skip navigation links

oracle.adf.view.rich.event
Class ClientListenerSet

java.lang.Object
oracle.adf.view.rich.event.ClientListenerSet

All Implemented Interfaces:

Serializable

public class ClientListenerSet

extends Object

implements Serializable

A ClientListenerSet represents the group of client listeners and behaviors registered on a component.

See Also:

Serialized Form

Constructor Summary

ClientListenerSet()
Creates a ClientListenerSet.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientListenerSet

public ClientListenerSet()

Creates a ClientListenerSet.

Method Detail

addListener

public void addListener(String type,
                        String functionName)

Adds a client listener.

Parameters:

type - the type of client listener

functionName - the name of the Javascript function to call

addBehavior

public void addBehavior(String behavior)

Adds a client behavior. Clients cannot call this method today, as the syntax of behaviors in this API is not publicly specified.

addBehavior

public 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. Clients cannot call this method today, as the syntax of behaviors in this API is not publicly specified.

addFeatureDependency

public void addFeatureDependency(String featureName)

Adds a dependency on a JavaScript library feature defined by the JavaScript library partitioning system.

Parameters:

featureName - name of a JavaScript library feature that is required by this ClientListenerSet.

getFeatureDependencies

public Iterable<String> getFeatureDependencies()

Returns an iterable collection containing the names of the JavaScript library features required by this ClientListenerSet.

Returns:

non-null Iterable containing feature names

addCustomServerListener

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

Parameters:

type - the type of the custom event

expr - MethodExpression that must return void and take a single ClientEvent parameter

invokeCustomEventListeners

public void invokeCustomEventListeners(javax.faces.context.FacesContext context,
                                       ClientEvent event)

Invoke any custom event listeners with a custom client event.

encodeAsJson

@Deprecated
public String encodeAsJson()

Deprecated. This method is no longer invoked by RichRenderer and should no longer be used.

Returns a JSON encoding of the listeners.

encodeBehaviorsAsJson

@Deprecated
public String encodeBehaviorsAsJson()

Deprecated. This method is no longer invoked by RichRenderer and should no longer be used.

Encodes the client behaviors as a JSON string array.

getBehaviors

public final Collection<Object> getBehaviors()

Access the list of client behaviors attached to this object. The items are either strings or value expressions.

Returns:

Read-only collection of strings and value expressions of the client behaviors

getListenerTypes

public final Collection<String> getListenerTypes()

Retrieve the types of the listeners that have been added to this object.

Returns:

Read-only collection of types for the listeners that are present

getListeners

public final Collection<String> getListeners(String type)

Retrieve the the listeners for a given listener type.

Parameters:

type - the type of listener

Returns:

Read-only non-null collection of listeners for the given type

Skip navigation links