Uiinfrastructure API Docs  
 

TimePicker Members

TimePicker overview

Public Static Fields

AM some helpful static Strings
DOUBLE0 
EMPTY 
H 
HTMLSELECT_AMPM The constant part of the name for the AM/PM select list that will optionally be returned by the date picker. The unique identifier string will be appended to this name on construction of the object.
HTMLSELECT_HOURS The constant part of the name for the hours select list that will be returned by the time-picker. The unique identifier string will be appended to this name on construction of the object.
HTMLSELECT_MINUTES The constant part of the name for the minutes select list that will be returned by the time picker. The unique identifier string will be appended to this name on construction of the object.
PM 
STR_MVC_CLASS_NAME 
TWELVE 

Public Static Methods

TransformTimeToNewLocale Transforms a time from one format to another based on the Locale.

Public Instance Constructors

TimePicker Constructor Initializes a new instance of the TimePicker class.

Public Instance Methods

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.
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 Returns the time picker HTML, which consists of either 2 or three select lists, depending on whether AMPM notation is used in the locale
GetComponentMgr Return a new ComponentMgr of the type that manages this class (a JSDateTimePickerMgr).
GetComponentMgrName Return the name of the component manager responsible for this page control
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 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.
GetTimeAsEnglishString Returns the time in the format format: "h:mm:ss a" the default US en time format. Note this is a poorly named method and in fact what's returned is the time formatted to the default format of the server.
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 Currently validation on the date/time picker page controls is not implemented. This method returns null.
InitOverloaded. Creates a new TimePicker object based on a complete time string in XPDateFormat.MEDIUM format using the given time as the preset value.
Init (inherited from AComponent)Overloaded. Initializes a new AComponent()
StoreUserInput Saves the items selected by the user into member variables
ToString (inherited from Object)Returns a String that represents the current Object.
Validate Currently validation on the date/time picker page controls is not implemented. This method returns null.

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

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