Uiinfrastructure API Docs  
 

AComponent Members

AComponent overview

Public Instance Constructors

icon AComponent Constructor Creates a new AComponent

Public Instance Methods

iconCreate Create method for the object returns an instance of the object.
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconGetComponentHeadContent This method returns script that needs to be printed within the HTML head tag. This method could have been abstract except that most components do not have a use for it. It therefore returns null and should be overridden as needed. (Note: there is an anologous method for printing page- level content in ComponentMgr.)
iconGetComponentHTML This method serves as a getter for component HTML. Sub-classes must implement this method.
iconGetComponentPostContent This method returns script that needs to be printed after the component itself has been printed. This method could have been abstract except that most components do not have a use for it. It therefore returns null and should be overridden as needed. (Note: there is an anologous method for printing page- level content in ComponentMgr.)
iconGetComponentPreContent This method returns script that needs to be printed before the component itself has been printed. This method could have been abstract except that most components do not have a use for it. It therefore returns null and should be overridden as needed. (Note: there is an anologous method for printing page- level content in ComponentMgr.)
iconGetComponentPreFormContent This method returns script that needs to be printed before the form in which this component is embedded. It therefore returns null and should be overridden as needed. (Note: there is an anologous method for printing page- level content in ComponentMgr.)
iconGetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
iconGetName Return the name or this component.
iconGetPageMgr This method returns the page manager that houses this component manager.
iconGetSubComponentHTMLByIndex This method serves as a getter for "sub-component" HTML. The breakdown of sub-components is decided by the component author. One example is the date/time-picker. It is made up of two sub-components: the date-picker and the time-picker. The constants for component sub-index should be specified in the component file and prefixed with "N_SUB_COMPONENT_INDEX." If the specified index is not valid, null should be returned. This method returns null in the parent instead of being abstract becuase many components will not need to use this method.
iconGetType (inherited from Object)Gets the Type of the current instance.
iconGetUniqueInstanceID This method returns the string used to uniquely idenify this component on a page.
iconGetValidators Return an Arraylist of validators associated with this object.
iconInit Initializes a new AComponent()
iconStoreUserInput This abstract method stores the input submitted by the user. It should be called after a POST or GET. In the case of the date picker, it would store the date.
iconToString (inherited from Object)Returns a String that represents the current Object.
iconValidate For every Validator associated with this object execute it's Validate method. Return an Arraylist of UIError objects generated from executing the Validators. Return and empty Arraylist if no problems were found.

Protected Instance Fields

iconm_ptPageMgr The page manager associated with this component.

Protected Instance Methods

iconAppendUniqueIDToElementName This method should be used to add the unique identifier to HTML inputs related to this component. If my element name is "in_cb_MyCheckBox" and my unique ID is "one", then this method will return "in_cb_MyCheckBox_one".
iconFinalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
iconMemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

AComponent Class | com.plumtree.uiinfrastructure.pagecontrols.framework Namespace