Skip navigation links

oracle.adf.view.rich.render
Class ClientEvent

java.lang.Object
oracle.adf.view.rich.render.ClientEvent

All Implemented Interfaces:

java.io.Serializable

public class ClientEvent

extends java.lang.Object

implements java.io.Serializable

Object representing a single client event. Client events generally do not have a UIComponent, but those delivered to custom server listeners (via AdfCustomEvent) do.

While ClientEvent is Serializable, no version compatibility is guaranteed. Further, the Component property, if specified is never Serialized and, of course, neither are non-Serializable Map parameters, or any parameters if the Map instance is not Serializable.

See Also:

Serialized Form

Constructor Summary

ClientEvent(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> parameters)
Creates a ClientEvent with a type and a map of parameters.

ClientEvent(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> parameters, javax.faces.component.UIComponent component)
Creates a ClientEvent with a type and a map of parameters.

Method Summary

javax.faces.component.UIComponent	getComponent() Returns the source of the event.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Returns the Map of parameters associated with the event.
java.lang.String	getType() Returns the type of the event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientEvent

public ClientEvent(java.lang.String type,
                   java.util.Map<java.lang.String,java.lang.Object> parameters)

Creates a ClientEvent with a type and a map of parameters.

ClientEvent

public ClientEvent(java.lang.String type,
                   java.util.Map<java.lang.String,java.lang.Object> parameters,
                   javax.faces.component.UIComponent component)

Creates a ClientEvent with a type and a map of parameters.

Method Detail

getType

public java.lang.String getType()

Returns the type of the event.

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Returns the Map of parameters associated with the event.

getComponent

public javax.faces.component.UIComponent getComponent()

Returns the source of the event. Note that this may be null; in particular, events returned via RichRenderer.getClientEvent() do not have an attached component, but those passed to custom event handlers (via <af:serverListener>) do have a component.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Skip navigation links