com.esri.adf.web.faces.event
Class ADFEvent

java.lang.Object
  java.util.EventObject
      javax.faces.event.FacesEvent
          javax.faces.event.ActionEvent
              com.esri.adf.web.faces.event.ADFEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MapEvent, OverviewEvent, TaskEvent, TocEvent

public class ADFEvent

extends javax.faces.event.ActionEvent

The ADFEvent is the base class which provides the basic methods for events fired by the ADF web controls.

All ADF web control events such as MapEvent, OverviewEvent, etc. extend this class. It provides basic methods to get access to the component that fired the event, the associated WebContext as well as the parameters of the current request.

See Also:

Serialized Form

Field Summary

protected WebContext	context The WebContext associated with this event.
protected java.util.Map	parameters The parameters of the current request

Fields inherited from class java.util.EventObject

source

Constructor Summary

ADFEvent(javax.faces.component.UIComponent source, javax.faces.context.FacesContext facesContext, WebContext context)
Constructs a new ADF event object from the specified source component, in the current FacesContext and with the associated WebContext

Method Summary

java.lang.String	getParameter(java.lang.String paramName) Returns the request parameter with the given paramName.
WebContext	getWebContext() Returns the WebContext associated with this event

Methods inherited from class javax.faces.event.ActionEvent

isAppropriateListener, processListener

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

context

protected WebContext context

The WebContext associated with this event.

parameters

protected java.util.Map parameters

The parameters of the current request

Constructor Detail

ADFEvent

public ADFEvent(javax.faces.component.UIComponent source,
                javax.faces.context.FacesContext facesContext,
                WebContext context)

Constructs a new ADF event object from the specified source component, in the current FacesContext and with the associated WebContext

Parameters:

source - the source component that fired this event

facesContext - the current FacesContext

context - the WebContext associated with this event

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String paramName)

Returns the request parameter with the given paramName.

Parameters:

paramName - the name of the request parameter

Returns:

the value associated with paramName

getWebContext

public WebContext getWebContext()

Returns the WebContext associated with this event

Returns:

the WebContext associated with this event