com.plumtree.xpshared.htmlconstructs
Class PTDatePicker

java.lang.Object
  com.plumtree.xpshared.htmlconstructs.PTDatePicker

public class PTDatePicker
extends java.lang.Object

Author:

JohnH Use this class to obtain PTDatePicker objects.

Use of this construct requires the inclusion of several HTML elements to make it work. First, the following DIV must be placed before the FORM tag on the page:

These all can be implemented using the methods of this construct. Call GetDatePickerIncludes to retrieve an HTMLElementCollection that can be used in the Display Page classes of editors to insert script and the style link into the HEAD, for example. The DIV is retrieved as an HTMLElement by calling the GetCalDiv method.

Field Summary

static int

DATE_PICKER_CHANGE_LIST

Constructor Summary

PTDatePicker()

Method Summary

static HTMLElement	GetCalDiv() This returns an HTMLElement containing the DIV tag that is used to control location of the date picker.
static HTMLElement	GetDatePicker(java.lang.String strImageServerURL, java.lang.String strVarName, java.lang.String strFormName, java.lang.String strInputName, java.lang.String strButtonName, java.lang.String strStartDate) This returns an HTML INPUT box followed by a calendar button which, when pressed, displays a calendar from which a date can be chosen.
static HTMLElement	GetDatePickerIncludes(java.lang.String strLangID, JSRegistry _jsRegistry) Deprecated. Use GetDatePickerIncludes(XPLocale locale, JSRegistry _jsRegistry) This function returns the SCRIPT includes for the date picker
static HTMLElement	GetDatePickerIncludes(XPLocale locale, JSRegistry _jsRegistry) This function returns the SCRIPT includes for the date picker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE_PICKER_CHANGE_LIST

public static final int DATE_PICKER_CHANGE_LIST

See Also:

Constant Field Values

Constructor Detail

PTDatePicker

public PTDatePicker()

Method Detail

GetCalDiv

public static HTMLElement GetCalDiv()

This returns an HTMLElement containing the DIV tag that is used to control location of the date picker. It must be placed after the BODY but before the form tag.

GetDatePicker

public static HTMLElement GetDatePicker(java.lang.String strImageServerURL,
                                        java.lang.String strVarName,
                                        java.lang.String strFormName,
                                        java.lang.String strInputName,
                                        java.lang.String strButtonName,
                                        java.lang.String strStartDate)

This returns an HTML INPUT box followed by a calendar button which, when pressed, displays a calendar from which a date can be chosen. *

Parameters:

strImageServerURL - - The URL to where the date picker images are stored. This URL must contain the trailing slash.

strVarName - - A unique variable used in writing out the script tag

strFormName - - The name of the form the control is displayed in

strInputName - - The name for the input box generated by the construct

strButtonName - - The name for the button generated by the construct

strStartDate - - The string to populate initially in the date control

GetDatePickerIncludes

public static HTMLElement GetDatePickerIncludes(java.lang.String strLangID,
                                                JSRegistry _jsRegistry)

Deprecated. Use GetDatePickerIncludes(XPLocale locale, JSRegistry _jsRegistry) This function returns the SCRIPT includes for the date picker

Parameters:

_strLangID - The language string

_jsRegistry - The javascript registry

Returns:

an HTMLElementCollection containing the script includes for the date picker

Throws:

XPException

GetDatePickerIncludes

public static HTMLElement GetDatePickerIncludes(XPLocale locale,
                                                JSRegistry _jsRegistry)

This function returns the SCRIPT includes for the date picker

Parameters:

_strLangID - The language string

_jsRegistry - The javascript registry

Returns:

an HTMLElementCollection containing the script includes for the date picker

Throws:

XPException