Uiinfrastructure API Docs  
 

AHTMLComponent Members

AHTMLComponent overview

Public Instance Constructors

AHTMLComponent Constructor Creates an AHTML Component

Public Instance Methods

AddValidator Add a validator to this component's collection of validators.
Create (inherited from AComponent) Create method for the object returns an instance of the object.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetComponentHeadContent (inherited from AComponent) 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.)
GetComponentHTML (inherited from AComponent) This method serves as a getter for component HTML. Sub-classes must implement this method.
GetComponentMgr Returns a ComponentMgr for this component. By default classes that extend AHTMLComponent may use this method to return the defualt ComponentMgr HTMLComponentMgr. If a component needs another ComponentMgr it should override this method.
GetComponentMgrName Returns the name of the ComponentMgr for this component. By default classes that extend AHTMLComponent may use this method to return the defualt ComponentMgr name, HTMLComponentMgr.STR_CLASS_NAME. If a component needs another ComponentMgr it should override this method.
GetComponentPostContent (inherited from AComponent) 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.)
GetComponentPreContent (inherited from AComponent) 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.)
GetComponentPreFormContent (inherited from AComponent) 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.)
GetHashCode (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.
GetHTMLComponentName JF- Returns the name of this HTML Component.
GetHTMLComponentSize JF- Returns the size of this HTML Component.
GetHTMLComponentStyleClass JF- Returns the style class of this HTML Component.
GetHTMLComponentValue JF- Returns the value of this HTML Component.
GetJSValidationCode Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.
GetLabel Returns the Label of this component
GetName (inherited from AComponent) Return the name or this component.
GetPageMgr (inherited from AComponent) This method returns the page manager that houses this component manager.
GetSubComponentHTMLByIndex (inherited from AComponent) 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.
GetType (inherited from Object)Gets the Type of the current instance.
GetUniqueInstanceID (inherited from AComponent) This method returns the string used to uniquely idenify this component on a page.
GetValidators Return the list of Validators associated with this object.
Init JF- Initializes a new AHTMLComponent object.
SetHTMLComponentName JF- Sets the name of this HTML Component.
SetHTMLComponentSize JF- Sets the size of this HTML Component.
SetHTMLComponentStyleClass JF- Sets the style class of this HTML Component.
SetHTMLComponentValue JF- Sets the value of this HTML Component.
SetLabel Sets the Label of this component
StoreUserInput JF- Store the new value of this HTML component.
ToString (inherited from Object)Returns a String that represents the current Object.
Validate Return an XPArrayList of UIError messages gathered by calling the validate() method on all Validators in this Component's collection of Validators.

Protected Instance Fields

m_ptPageMgr (inherited from AComponent) The page manager associated with this component.

Protected Instance Methods

AppendUniqueIDToElementName (inherited from AComponent) 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".
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetHTMLComponentBaseName JF- Returns the base name of this HTML Component. E.g.: in_tx_pc
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
SetParameters Transfer the properties set to this object to the associated properties on the HTMLInput object. For example, Set the HTMLInput's styleClass with this object's GetHTMLComponentStyleClass.

See Also

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