| java.lang.Object
 org.jaffa.presentation.portlet.FormKey
| FormKey | | public class FormKey implements Cloneable,Comparable,Serializable(Code) | | This object is returned by the event handlers. It indicates the form to which control should be passed & the corresponding Component's id. Ensure that a 'forward' mapping exists for the formName in the struts-config file.
The formName and componentId are immutable properties and can only be passed in the constructor.
The title can be set at any time and is mainly for use in the historyNav.jsp, for displaying the history bar links.
|
| Method Summary | |
| public Object | clone()
Returns a clone of the object. | | public int | compareTo(Object obj)
Compares this object with another FormKey object.
It compares the fields componentId, formName of the 2 objects.
Parameters:
obj - the other FormKey object. | | public boolean | equals(Object obj)
Compares this object with another FormKey object.
Returns a true if both the objects have the same formName, componentId.
Parameters:
obj - the other FormKey object. | | public static FormKey | getCloseBrowserFormKey()
Returns the FormKey that will render the JSP used for closing a browser window. | | public String | getComponentId()
| | public String | getFormName()
| | public String | getTitle()
Getter for property title. | | public int | hashCode()
Returns an int which will be the sum of the of the hashcodes of componentId, formName. | | public void | setTitle(String title)
Setter for property title. | | public String | toString()
|
| FormKey | | public FormKey(String formName, String componentId)(Code) | | Constructs an instance of the FormKey class
Parameters:
formName - The formName
Parameters:
componentId - The componentId |
| clone | | public Object clone()(Code) | | Returns a clone of the object.
a clone of the object. |
| compareTo | | public int compareTo(Object obj)(Code) | | Compares this object with another FormKey object.
It compares the fields componentId, formName of the 2 objects.
Parameters:
obj - the other FormKey object. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |
| equals | | public boolean equals(Object obj)(Code) | | Compares this object with another FormKey object.
Returns a true if both the objects have the same formName, componentId.
Parameters:
obj - the other FormKey object. a true if both the objects have the same formName, componentId. |
| getCloseBrowserFormKey | | public static FormKey getCloseBrowserFormKey()(Code) | | Returns the FormKey that will render the JSP used for closing a browser window.
The JSP to be rendered is found by the forward mapping 'jaffa_closeBrowser' specified in the struts-config.xml file.
The FormKey that will render the JSP used for closing a browser window. |
| getComponentId | | public String getComponentId()(Code) | | Returns the componentId
The componentId |
| getFormName | | public String getFormName()(Code) | | Returns the formName
The formName |
| getTitle | | public String getTitle()(Code) | | Getter for property title.
Value of property title. |
| hashCode | | public int hashCode()(Code) | | Returns an int which will be the sum of the of the hashcodes of componentId, formName.
an int which will be the sum of the of the hashcodes of componentId, formName. |
| setTitle | | public void setTitle(String title)(Code) | | Setter for property title.
Parameters:
title - New value of property title. |
| toString | | public String toString()(Code) | | Returns the debug information for the object
The debug information |
|
|