Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.event
Class ClientListenerSet

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

All Implemented Interfaces:
java.io.Serializable

public class ClientListenerSet
extends java.lang.Object
implements java.io.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(java.lang.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(java.lang.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(java.lang.String featureName)
          Adds a dependency on a JavaScript library feature defined by the JavaScript library partitioning system.
 void addListener(java.lang.String type, java.lang.String functionName)
          Adds a client listener.
 java.lang.String encodeAsJson()
          Returns a JSON encoding of the listeners.
 java.lang.String encodeBehaviorsAsJson()
          Encodes the client behaviors as a JSON string array.
 java.lang.Iterable<java.lang.String> getFeatureDependencies()
          Returns an iterable collection containing the names of the JavaScript library features required by this ClientListenerSet.
 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(java.lang.String type,
                        java.lang.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(java.lang.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(java.lang.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 java.lang.Iterable<java.lang.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(java.lang.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

public java.lang.String encodeAsJson()
Returns a JSON encoding of the listeners.

encodeBehaviorsAsJson

public java.lang.String encodeBehaviorsAsJson()
Encodes the client behaviors as a JSON string array.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.