|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.rave.web.ui.component.util.event.HandlerDefinition
public class HandlerDefinition
A HandlerDefinition defines a "handler" that may be invoked in the process of executing an event. A HandlerDefinition has an id, java method, input definitions, output definitions, and child handlers.
The java 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.
Field Summary | |
---|---|
static java.lang.Class[] |
EVENT_ARGS
|
Constructor Summary | |
---|---|
HandlerDefinition(java.lang.String id)
Constructor |
Method Summary | |
---|---|
void |
addChildHandler(Handler desc)
This method adds a Handler to the list of child handlers. |
void |
addInputDef(IODescriptor desc)
This method adds an IODescriptor to the list of input descriptors. |
void |
addOutputDef(IODescriptor desc)
This method adds an IODescriptor to the list of output descriptors. |
java.util.List |
getChildHandlers()
This method retrieves the List of child Handler. |
java.lang.String |
getDescription()
For future tool support |
java.lang.reflect.Method |
getHandlerMethod()
|
java.lang.String |
getId()
This method returns the id for this handler. |
IODescriptor |
getInputDef(java.lang.String name)
This method returns the requested IODescriptor, null if not found. |
java.util.Map |
getInputDefs()
This method retrieves the Map of input IODescriptors. |
IODescriptor |
getOutputDef(java.lang.String name)
This method returns the requested IODescriptor, null if not found. |
java.util.Map |
getOutputDefs()
This method retrieves the Map of output IODescriptors. |
boolean |
isStatic()
This method determines if the handler is static. |
void |
setChildHandlers(java.util.List childHandlers)
This method sets the List of child Handlers for this HandlerDefinition. |
void |
setDescription(java.lang.String desc)
For future tool support |
void |
setHandlerMethod(java.lang.reflect.Method method)
|
void |
setHandlerMethod(java.lang.String cls,
java.lang.String methodName)
This method sets the event handler (method) to be invoked. |
void |
setInputDefs(java.util.Map inputDefs)
This method sets the input IODescriptors for this handler. |
void |
setOutputDefs(java.util.Map outputDefs)
This method sets the output IODescriptors for this handler. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class[] EVENT_ARGS
Constructor Detail |
---|
public HandlerDefinition(java.lang.String id)
Method Detail |
---|
public java.lang.String getId()
public java.lang.String getDescription()
public void setDescription(java.lang.String desc)
public void setHandlerMethod(java.lang.String cls, java.lang.String methodName)
This method sets the event handler (method) to be invoked. The method should be public and accept a prameter of type "HandlerContext" Example:
public void beginDisplay(HandlerContext handlerCtx)
cls
- The full class name containing methodmethodName
- The method name of the handler within classpublic void setHandlerMethod(java.lang.reflect.Method method)
public boolean isStatic()
This method determines if the handler is static.
public java.lang.reflect.Method getHandlerMethod()
public void addInputDef(IODescriptor desc)
desc
- The input IODescriptor to addpublic void setInputDefs(java.util.Map inputDefs)
inputDefs
- The Map of IODescriptorspublic java.util.Map getInputDefs()
public IODescriptor getInputDef(java.lang.String name)
public void addOutputDef(IODescriptor desc)
desc
- The IODescriptor to addpublic void setOutputDefs(java.util.Map outputDefs)
outputDefs
- The Map of output IODescriptorspublic java.util.Map getOutputDefs()
public IODescriptor getOutputDef(java.lang.String name)
public void addChildHandler(Handler desc)
desc
- The Handler to addpublic void setChildHandlers(java.util.List childHandlers)
childHandlers
- The List of child Handler objectspublic java.util.List getChildHandlers()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |