Plumtree UI Infrastructure API  
 

DatePicker Members

DatePicker overview

Public Static Fields

BLANK Constant for Month Names
DAY_DROP_DOWN String constant for day select drop down component
DELIMETERS Delimeters in the date pattern
MAX_DAY 
MIN_DAY 
MIN_YEAR String constant for min year, max year, min num of days, max num of days
MONTH_DROP_DOWN String constant for month select drop down component
NUM_OF_MONTHS 
NUM_OF_YEARS 
REG_EXP_DELEMETERS Reg. expression for delimeters in date pattern
STR_BLANK Constant String for BLANK
STR_COMP_BASE_NAME component's base name
STR_MVC_CLASS_NAME mvc class name for datepicker component
YEAR_DROP_DOWN String constant for year select drop down component

Public Instance Constructors

DatePicker Constructor Creates a new DatePicker for 508 mode

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.
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 
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.)
GetDateAsDateTime This function returns an XPDateTime object that represents the date and the user has chosen using the HTMLDatePicker.
GetDateInputName Returns the name of the date input. In this case there isn't one so return null;
GetDateTimeAsDateTime (inherited from ADatePickerComponent) 
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.
GetName Return the name of the MVC object.
GetPageMgr (inherited from AComponent) This method returns the page manager that houses this component manager.
GetPTDatepickerVarName Returns the name of the PTDatepicker JavaScript variable name. In this case there isn't one so return null;
GetSelectedDateAsString Returns the date as a String in the pattern format specified by the locale, null values in memeber variables, m_strYear, m_strMonth, or m_strDay indicate an invalid date so return the default, and empty String.
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 Currently validation on the date/time picker page controls is not implemented. This method returns null.
InitOverloaded. initializes a new HTMLDatePicker object with the month, day and year blank
Init (inherited from AComponent)Overloaded. Initializes a new AComponent()
SetBlankDate Sets the month, day, and year of drop down menus to blank
SetDefaultDate (inherited from ADatePickerComponent) 
StoreUserInput Store the new value of this HTML component.
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.
m_strDay 
m_strMonth Variables to save the month, day, and year
m_strYear 

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

See Also

DatePicker Class | com.plumtree.uiinfrastructure.pagecontrols.datepicker Namespace