Uiinfrastructure API Docs  
 

TimePicker Members

TimePicker overview

Public Static Fields

iconiconAM some helpful static Strings
iconiconDOUBLE0 
iconiconEMPTY 
iconiconH 
iconiconHTMLSELECT_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.
iconiconHTMLSELECT_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.
iconiconHTMLSELECT_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.
iconiconPM 
iconiconSTR_MVC_CLASS_NAME 
iconiconTWELVE 

Public Static Methods

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

Public Instance Constructors

icon TimePicker Constructor Initializes a new instance of the TimePicker class.

Public Instance Methods

iconCreate This method is used by the ASManager to return new instances of managed objects.
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconGetAMPM Returns the AMPM string
iconGetAMPMInputName 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.
iconGetComponentHeadContent (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.)
iconGetComponentHTML Returns the time picker HTML, which consists of either 2 or three select lists, depending on whether AMPM notation is used in the locale
iconGetComponentMgr Return a new ComponentMgr of the type that manages this class (a JSDateTimePickerMgr).
iconGetComponentMgrName Return the name of the component manager responsible for this page control
iconGetComponentPostContent (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.)
iconGetComponentPreContent (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.)
iconGetComponentPreFormContent (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.)
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.
iconGetHours Returns the hours string
iconGetHoursInputName 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.
iconGetMinutes Returns the minutes string
iconGetMinutesInputName 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.
iconGetName Return the name of the MVC object.
iconGetPageMgr (inherited from AComponent) This method returns the page manager that houses this component manager.
iconGetSubComponentHTMLByIndex (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.
iconGetTimeAsEnglishString 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.
iconGetTimeAsString Returns the time portion of the date and time chosen by the user as a String.
iconGetType (inherited from Object)Gets the Type of the current instance.
iconGetUniqueInstanceID (inherited from AComponent) This method returns the string used to uniquely idenify this component on a page.
iconGetValidators Currently validation on the date/time picker page controls is not implemented. This method returns null.
iconInitOverloaded. Creates a new TimePicker object based on a complete time string in XPDateFormat.MEDIUM format using the given time as the preset value.
iconInit (inherited from AComponent)Overloaded. Initializes a new AComponent()
iconStoreUserInput Saves the items selected by the user into member variables
iconToString (inherited from Object)Returns a String that represents the current Object.
iconValidate Currently validation on the date/time picker page controls is not implemented. This method returns null.

Protected Instance Fields

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

Protected Instance Methods

iconAppendUniqueIDToElementName (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".
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

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