com.sun.rave.web.ui.component.util.event
Interface HandlerContext

All Known Implementing Classes:
HandlerContextImpl

public interface HandlerContext


Method Summary
 java.util.EventObject getEventObject()
           Accessor for the EventObject associated with this Handler.
 java.lang.String getEventType()
           This method provides access to the EventType.
 javax.faces.context.FacesContext getFacesContext()
           Accessor for the FacesContext.
 Handler getHandler()
           Accessor for the Handler descriptor for this Handler.
 HandlerDefinition getHandlerDefinition()
           Accessor for the Handler descriptor for this Handler.
 java.lang.Object getInputValue(java.lang.String name)
           This method returns the value for the named input.
 LayoutElement getLayoutElement()
           Accessor for the LayoutElement associated with this Handler.
 java.lang.Object getOutputValue(java.lang.String name)
           This method retrieves an Output value.
 void setHandler(Handler handler)
           Setter for the Handler descriptor for this Handler.
 void setOutputValue(java.lang.String name, java.lang.Object value)
           This method sets an Output value.
 

Method Detail

getFacesContext

javax.faces.context.FacesContext getFacesContext()

Accessor for the FacesContext.

Returns:
FacesContext

getLayoutElement

LayoutElement getLayoutElement()

Accessor for the LayoutElement associated with this Handler. The LayoutElement associated with this Handler is the LayoutElement which declared the handler. This provides a way for the handler to obtain access to the LayoutElement which is responsible for it being invoked.


getEventObject

java.util.EventObject getEventObject()

Accessor for the EventObject associated with this Handler. This may be null if an EventObject was not created for this handler. An EventObject, if it does exist, may provide additional details describing the context in which this Event is invoked.


getEventType

java.lang.String getEventType()

This method provides access to the EventType. This is mostly helpful for diagnostics, but may be used in a handler to determine more information about the context in which the code is executing.


getHandler

Handler getHandler()

Accessor for the Handler descriptor for this Handler. The Handler descriptor object contains specific meta information describing the invocation of this handler. This includes details such as input values, and where output values are to be set.


setHandler

void setHandler(Handler handler)

Setter for the Handler descriptor for this Handler.

Parameters:
handler - The Handler

getHandlerDefinition

HandlerDefinition getHandlerDefinition()

Accessor for the Handler descriptor for this Handler. The HandlerDefinition descriptor contains meta information about the actual Java handler that will handle the processing. This includes the inputs required, outputs produces, and the types for both.


getInputValue

java.lang.Object getInputValue(java.lang.String name)

This method returns the value for the named input. Input values are not stored in this Context itself, but in the Handler. If you are trying to set input values for a handler, you must create a new Handler object and set its input values.

Parameters:
name - The input name
Returns:
The value of the input (null if not found)

getOutputValue

java.lang.Object getOutputValue(java.lang.String name)

This method retrieves an Output value. Output values must not be stored in this Context itself (remember HandlerContext objects are shared). Output values are stored according to what is specified in the HandlerDefintion.

Parameters:
name - The output name
Returns:
The value of the output (null if not found)

setOutputValue

void setOutputValue(java.lang.String name,
                    java.lang.Object value)

This method sets an Output value. Output values must not be stored in this Context itself (remember HandlerContext objects are shared). Output values are stored according to what is specified in the HandlerDefintion.