Plumtree UI Infrastructure API  
 

ATimePicker Members

ATimePicker overview

Public Instance Methods

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.
GetAMPM Returns the AMPM string
GetAMPMInputName Provides a means of retrieving the HTML Input name for the AMPM portion of the date picker. This allows for using javascript to programmatically set input values, for example.
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 
GetComponentMgrName 
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.
GetHours Returns the hours string
GetHoursInputName Provides a means of retrieving the HTML Input name for the hours portion of the date picker. This allows for using javascript to programmatically set input values, for example.
GetMinutes Returns the minutes string
GetMinutesInputName Provides a means of retrieving the HTML Input name for the minutes portion of the date picker. This allows for using javascript to programmatically set input values, for example.
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.
GetTimeAsEnglishString Returns the time chosen by the user as a String in the English format: "h:mm:ss a".
GetTimeAsString Returns the time portion of the date and time chosen by the user as a String.
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 AComponent) Return an Arraylist of validators associated with this object.
InitOverloaded. Creates a new TimePicker object based on a complete time string in XPDateFormat.MEDIUM format
Init (inherited from AComponent)Overloaded. Initializes a new AComponent()
StoreUserInput (inherited from AComponent) 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.
ToString (inherited from Object)Returns a String that represents the current Object.
Validate (inherited from AComponent) 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 Constructors

ATimePicker Constructor Initializes a new instance of the ATimePicker class.

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.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

ATimePicker Class | com.plumtree.uiinfrastructure.pagecontrols.timepicker Namespace