| java.lang.Object
 org.jaffa.presentation.portlet.component.Component
All known Subclasses: org.jaffa.presentation.portlet.widgets.tests.LookupClientComponent, org.jaffa.presentation.portlet.widgets.tests.ButtonComponent, org.jaffa.presentation.portlet.widgets.tests.LabelComponent, org.jaffa.presentation.portlet.widgets.tests.TableComponent, org.jaffa.components.finder.FinderComponent, org.jaffa.presentation.portlet.widgets.tests.GridComponent, org.jaffa.components.maint.DeleteComponent, org.jaffa.presentation.portlet.widgets.tests.EditBoxComponent, org.jaffa.applications.test.modules.security.components.test1.ui.Test1Component, org.jaffa.components.maint.MaintComponent, org.jaffa.presentation.portlet.widgets.tests.UserGridComponent, org.jaffa.presentation.portlet.widgets.tests.ImageComponent, org.jaffa.components.finder.FinderComponent2, org.jaffa.components.maint.CreateComponent, org.jaffa.components.maint.UpdateComponent, org.jaffa.presentation.portlet.widgets.tests.DateTimeComponent, org.jaffa.presentation.portlet.widgets.tests.TextComponent, org.jaffa.presentation.portlet.widgets.tests.DropDownComponent, org.jaffa.presentation.portlet.widgets.tests.TreeComponent, org.jaffa.components.maint.MaintComponent2, org.jaffa.presentation.portlet.session.ui.SessionExplorerComponent, org.jaffa.presentation.portlet.widgets.tests.CheckBoxComponent, org.jaffa.presentation.portlet.widgets.tests.RadioButtonComponent, org.jaffa.presentation.portlet.widgets.tests.FoldingSectionComponent,
| Component | | abstract public class Component implements IComponent(Code) | | The base class for all Components
|
| addChildComponent | | public void addChildComponent(Component component)(Code) | | This adds a child component to an internal list. A child component instantiated via the run() method, will be implicitly added to the internal list.
Parameters:
component - The child component. |
| addFormKeyChangeListener | | public void addFormKeyChangeListener(FormKeyChangeListener listener)(Code) | | Registers listener so that it will receive FormKeyChangeEvents.
The ActionBase typically creates the FormKeyChangeEvent object, when processing an event for a component, that has a ContainerFormKey.
It will then fire the FormKeyChangeListener registered with the component, passing the FormKeyChangeEvent object.
The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
Parameters:
listener - the FormKeyChangeListener to register. |
| getComponentDefinition | | public ComponentDefinition getComponentDefinition()(Code) | | Returns the ComponentDefinition based on which this Component was created
The ComponentDefintion object for the Component |
| getComponentId | | public String getComponentId()(Code) | | Returns the Id for the component
The componentId |
| getContainerFormKey | | public FormKey getContainerFormKey()(Code) | | Getter for property containerFormKey.
This property is useful when this component is being rendered as a tile inside another component.
The outer component is expected to set this property on this component.
The outer component is also expected to register the FormKeyChangeListener on this component.
The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey.
The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
All this helps render the tiles correctly.
Value of property containerFormKey. |
| getFormKeyChangeListeners | | public FormKeyChangeListener[] getFormKeyChangeListeners()(Code) | | Returns an array of all the FormKeyChangeListeners registered on this component.
all of the component's FormKeyChangeListeners or a null if no ancestor listeners are currently registered. |
| getReturnToFormKey | | public FormKey getReturnToFormKey()(Code) | | Getter for property returnToFormKey.
This FormKey determines the screen to display when quitting from a component.
Value of property returnToFormKey. |
| getToken | | public String getToken()(Code) | | Getter for property token.
Value of property token. |
| getUserSession | | public UserSession getUserSession()(Code) | | Returns the UserSession, under which the Component was created
The UserSession object |
| isActive | | public boolean isActive()(Code) | | Returns a true if the component is still active. The component will be set to inactive status after a quit().
a true if the component is still active. |
| quit | | public void quit()(Code) | | This will kill all the Forms
Finally de-register itself from the UserSession
|
| quitAndReturnToCallingScreen | | public FormKey quitAndReturnToCallingScreen()(Code) | | This should invoke the quit() method, and then return the FormKey for the calling screen.
The FormKey should have been set by a call to setReturnToFormKey().
The FormKey for the caling screen. A null will be returned, if no calling screen was specified. |
| reflectAndSetParms | | public void reflectAndSetParms(HttpServletRequest request)(Code) | | Invoke the setters on the component passing the parameters in the request-stream
This is a convenience method which can be invoked after creation of a new Component
Parameters:
request - The HTTP request we are processing |
| removeFormKeyChangeListener | | public void removeFormKeyChangeListener(FormKeyChangeListener listener)(Code) | | Unregisters listener so that it will no longer receive FormKeyChangeEvents.
Parameters:
listener - the FormKeyChangeListener to be removed. |
| returnChildComponents | | public Collection returnChildComponents()(Code) | | This returns a collection of components which were created by this component.
a collection of components which were created by this component. |
| returnLastActivityDate | | public DateTime returnLastActivityDate()(Code) | | This returns the timestamp for the last known activity on the component.
The timestamp for the last known activity on the component. |
| run | | public Component run(String component)(Code) | | Convenience Method for 'ComponentManager.run()'.
This may throw the runtime ComponentCreationRuntimeException
Parameters:
component - The name of the component to create. There should be a valid definition for this name in the 'components.xml' file An instance of the Component |
| setComponentId | | void setComponentId(String componentId)(Code) | | |
| setContainerFormKey | | public void setContainerFormKey(FormKey containerFormKey)(Code) | | Setter for property containerFormKey.
This property is useful when this component is being rendered as a tile inside another component.
The outer component is expected to set this property on this component.
The outer component is also expected to register the FormKeyChangeListener on this component.
The ActionBase will intercept all FormKeys for this component. It will then fire the FormKeyChangeEvents on the listeners. The ActionBase will then return the ContainerFormKey.
The Component will fire the FormKeyChangeEvents on the listeners during the quit(), passing the ReturnToFormKey.
All this helps render the tiles correctly.
Parameters:
containerFormKey - New value of property containerFormKey. |
| setReturnToFormKey | | public void setReturnToFormKey(FormKey returnToFormKey)(Code) | | Setter for property returnToFormKey.
This FormKey determines the screen to display when quitting from a component.
Parameters:
returnToFormKey - New value of property returnToFormKey. |
| setToken | | public void setToken(String token)(Code) | | Setter for property token.
Parameters:
token - New value of property token. |
| updateLastActivityDate | | public void updateLastActivityDate()(Code) | | This updates the activity timestamp on the component. This will ideally be called by the central servlet that services an event on a component.
|
|
|