Plumtree UI Infrastructure API  
 

HTMLNameDescLang Members

HTMLNameDescLang overview

Public Static Fields

STR_MVC_CLASS_NAME class name constant

Public Instance Constructors

HTMLNameDescLang Constructor Default constructor. Creates a new HTMLTextAndDropDown object.

Public Instance Fields

m_SelectDropDown the selectdropdown for this object
m_TextArea the textarea for this object
m_TextBox the textbox for this object

Public Instance Methods

AddValidator (inherited from AHTMLComponent) Add a validator to this component's collection of validators.
Create This method is used by the ASManager to return new instances of managed objects.
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 Returns the HTML for this component.
GetComponentMgr (inherited from AHTMLComponent) 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 (inherited from AHTMLComponent) 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.)
GetData Returns member variable m_ptGSArrayWrapper.
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 (inherited from AHTMLComponent) JF- Returns the name of this HTML Component.
GetHTMLComponentSize (inherited from AHTMLComponent) JF- Returns the size of this HTML Component.
GetHTMLComponentStyleClass (inherited from AHTMLComponent) JF- Returns the style class of this HTML Component.
GetHTMLComponentValue Return the component values of the TextBox and SelectDropdown separated by a space.
GetJSValidationCode Return a string made up of all the JSValidationCode for each of the Validator's associated with this component.
GetLabel (inherited from AHTMLComponent) Returns the Label of this component
GetName Return the name of the MVC object.
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 (inherited from AHTMLComponent) Return the list of Validators associated with this object.
InitOverloaded. Initializes a new HTMLNameDescLang object. Creates and initializes the HTMLTextBox, HTMLTextArea and HTMLSelectDropdown objects contained by this object. Populates the default languages for the select.
Init (inherited from AHTMLComponent)Overloaded. JF- Initializes a new AHTMLComponent object.
SetData Sets the member variable m_ptGSArrayWrapper
SetHTMLComponentName (inherited from AHTMLComponent) JF- Sets the name of this HTML Component.
SetHTMLComponentSize (inherited from AHTMLComponent) JF- Sets the size of this HTML Component.
SetHTMLComponentStyleClass (inherited from AHTMLComponent) JF- Sets the style class of this HTML Component.
SetHTMLComponentValue (inherited from AHTMLComponent) JF- Sets the value of this HTML Component.
SetLabel (inherited from AHTMLComponent) Sets the Label of this component
SetLangChoices Set the options of the member variable m_SelectDropDown with the appropriate languages.
SetPrimaryLanguage Set the primary language member variable.
StoreUserInput (inherited from AHTMLComponent) JF- Store the new value of this HTML component.
ToString (inherited from Object)Returns a String that represents the current Object.
Validate 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

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 Returns the base name of this HTML Component.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
SetParameters (inherited from AHTMLComponent) 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

HTMLNameDescLang Class | com.plumtree.uiinfrastructure.pagecontrols.htmlpagecontrols Namespace