| java.lang.Object
 com.sun.rave.web.ui.component.util.event.Handler
| Handler | | public class Handler implements java.io.Serializable(Code) | | This class contains the information necessary to invoke a Handler. The
HandlerDefinition class provides a definition of how to invoke
a Handler, this class uses that information with in conjuction with
information provided in this class to execute the handler
method. This class typically will hold input values and
specify where output should be stored.
The handler method to be invoked must have the
following method signature:
public void beginDisplay(HandlerContext handlerCtx)
void above can return a value. Depending on the type of
event, return values may be handled differently.
author:
Ken Paulsen (ken.paulsen@sun.com) |
| getInputMap | | protected Map getInputMap()(Code) | | This method returns a Map of NVPs representing the input to this
handler.
|
| getInputValue | | public Object getInputValue(String name)(Code) | | This method simply returns the named input value, null if not
found. It will not attempt to resolve $...{...} expressions or
do modifications of any kind. If you are looking for a method to
do these types of operations, try:
getInputValue(FacesContext, String).
Parameters:
name - The name used to identify the input value. |
| getInputValue | | public Object getInputValue(HandlerContext ctx, String name)(Code) | | This method returns the value for the named input. Input values
are not stored in this HandlerContext 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.
This method attempts to resolve $...{...} expressions. It also
will return the default value if the value is null. If you don't
want these things to happen, look at
Handler.getInputValue(String).
Parameters:
name - The input name The value of the input (null if not found) |
| getOutputValue | | public Object getOutputValue(HandlerContext context, String name)(Code) | | This method retrieves an output value. Output values are stored
in the location specified by the OutputType in the Handler.
Parameters:
context - The HandlerContext
Parameters:
name - The output name The value of the output (null if not set) |
| isStatic | | public boolean isStatic()(Code) | | This method determines if the handler is static.
|
| setHandlerDefinition | | protected void setHandlerDefinition(HandlerDefinition handler)(Code) | | This method sets the HandlerDefinition used by this Handler.
|
| setOutputMapping | | public void setOutputMapping(String outputName, String targetKey, String targetType)(Code) | | This method adds a new OutputMapping to this handler. An
OutputMapping allows the handler to return a value and have it
"mapped" to the location of your choice. The "outputType"
corresponds to a registered OutputType (see OutputTypeManager).
Parameters:
outputName - The Handler's name for the output value
Parameters:
targetKey - The 'key' the OutputType uses to store the output
Parameters:
targetType - The OutputType implementation map the output |
| setOutputValue | | public void setOutputValue(HandlerContext context, String name, Object value)(Code) | | This method stores an output value. Output values are stored
as specified by the OutputType in the Handler.
Parameters:
context - The HandlerContext
Parameters:
name - The name the Handler uses for the output
Parameters:
value - The value to set |
|
|