Class \Prado\Web\UI\WebControls\TDatePicker

TDatePicker class.

TDatePicker displays a text box for date input purpose. When the text box receives focus, a calendar will pop up and users can pick up from it a date that will be automatically entered into the text box. The format of the date string displayed in the text box is determined by the DateFormat property. Valid formats are the combination of the following tokens,

 Character Format Pattern (en-US)
 -----------------------------------------
 d          day digit
 dd         padded day digit e.g. 01, 02
 M          month digit
 MM         padded month digit
 MMMM       localized month name, e.g. March, April
 yy         2 digit year
 yyyy       4 digit year
 -----------------------------------------

TDatePicker has four Mode to show the date picker popup.

Basic -- Only shows a text input, focusing on the input shows the

               date picker. This way you can access the popup using only
               the keyboard. Note that because of this, TAB-bing through
               this control will automatically select the current date if
               no previous date was selected. If you close the popup (eg.
               pressing the ESC key) you'll need to un-focus and re-focus
               the control again for the popup to reappear.

Clickable -- Only shows a text input, clicking on the input shows the

               date picker. This mode solves the two small problems of the
               Basic mode. It was first introduced in Prado 3.2.

Button -- Shows a button next to the text input, clicking on the

                button shows the date, button text can be by the
                <b>ButtonText</b> property

ImageButton -- Shows an image next to the text input, clicking on

                     the image shows the date picker, image source can be
                     change through the <b>ButtonImageUrl</b> property.

The CssClass property can be used to override the css class name for the date picker panel. CalendarStyle property sets the packages styles available. E.g. default.

The InputMode property can be set to "TextBox" or "DropDownList" with default as "TextBox". In DropDownList mode, in addition to the popup date picker, three drop down list (day, month and year) are presented to select the date .

The PositionMode property can be set to "Top" or "Bottom" with default as "Bottom". It specifies the position of the calendar popup, relative to the input field.

Class hierarchy

\Prado\Web\UI\WebControls\TDatePicker

\Prado\Web\UI\WebControls\TTextBox implements IPostBackDataHandler, IValidatable, IDataRenderer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Author: Carl G. Mathisen <carlgmathisen@gmail.com>
Since: 3.0

Methods summary
`public`	`getButtonImageUrl() : string`
`public`	`getButtonText() : string`
`public`	`getCalendarStyle() : string`
`public`	`getClientSide() : TDatePickerClientScript` Gets the TDatePickerClientScript to set the TDatePicker event handlers. The date picker on the client-side supports the following events. `OnDateChanged` -- raised when the date is changed. You can attach custom javascript code to each of these events
`public`	`getCulture() : string` Gets the current culture.
`public`	`getData() : int` Returns the timestamp selected by the user. This method is required by IDataRenderer. It is the same as getTimeStamp().
`public`	`getDate() : string`
`public`	`getDateFormat() : string`
`public`	`getFirstDayOfWeek() : int`
`public`	`getFromYear() : int`
`public`	`getInputMode() : TDatePickerInputMode`
`public`	`getMode() : TDatePickerMode`
`public`	`getPositionMode() : TDatePickerPositionMode`
`public`	`getShowCalendar() : bool`
`public`	`getTimeStamp() : int`
`public`	`getUpToYear() : int`
`public`	`getValidationPropertyValue() : int\|string` Returns the value to be validated. This method is required by \Prado\Web\UI\IValidatable interface.
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. Override parent implementation, when InputMode is DropDownList call getDateFromPostData to get date data. This method is primarly used by framework developers.
`public`	`onPreRender(mixed $param) : mixed` Publish the date picker Css asset files.
`public`	`render(THtmlWriter $writer) : mixed` Renders body content. This method overrides parent implementation by adding additional date picker button if Mode is Button or ImageButton.
`public`	`setAutoPostBack(mixed $value) : mixed` AutoPostBack is not supported.
`public`	`setButtonImageUrl(string $value) : mixed`
`public`	`setButtonText(string $value) : mixed`
`public`	`setCalendarStyle(string $value) : mixed`
`public`	`setCulture(string $value) : mixed` Sets the culture/language for the date picker.
`public`	`setData(int $value) : mixed` Sets the timestamp represented by this control. This method is required by IDataRenderer. It is the same as setTimeStamp().
`public`	`setDate(string $value) : mixed`
`public`	`setDateFormat(string $value) : mixed` Sets the format of the date string.
`public`	`setFirstDayOfWeek(int $value) : mixed` Set the first day of week, with 0 as Sunday, 1 as Monday, etc.
`public`	`setFromYear(int $value) : mixed`
`public`	`setInputMode(TDatePickerInputMode $value) : mixed`
`public`	`setMode(TDatePickerMode $value) : mixed`
`public`	`setPositionMode(TDatePickerPositionMode $value) : mixed`
`public`	`setShowCalendar(bool $value) : mixed` Sets whether to pop up the calendar window when the control receives focus
`public`	`setTimeStamp(float $value) : mixed` Sets the date for the date picker using timestamp.
`public`	`setUpToYear(int $value) : mixed`
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Add the client id to the input textbox, and register the client scripts.
`protected`	`createClientScript() : TDatePickerClientScript`
`protected`	`getAssetUrl([string $file = '' ]) : string`
`protected`	`getCulturalOptions() : array<string\|int, mixed>` Get javascript localization options, e.g. month and weekday names.
`protected`	`getCurrentCulture() : string`
`protected`	`getDateFromPostData(string $key, array<string\|int, mixed> $values) : string` Loads date from drop down list data.
`protected`	`getDatePickerButtonID() : string` Gets the ID for the date picker trigger button.
`protected`	`getDatePickerOptions() : array<string\|int, mixed>` Get javascript date picker options.
`protected`	`getDropDownDayOptions() : array<string\|int, mixed>`
`protected`	`getLocalizedCalendarInfo() : CultureInfo`
`protected`	`getLocalizedMonthNames(CultureInfo $info) : array<string\|int, mixed>` Returns the localized month names that depends on the month format pattern. "MMMM" will return the month names, "MM" or "MMM" return abbr. month names and "M" return month digits.
`protected`	`getTimeStampFromText() : int` Gets the date from the text input using TSimpleDateFormatter
`protected`	`hasDayPattern() : mixed`
`protected`	`publishCalendarStyle() : string` Publish the calendar style Css asset file.
`protected`	`registerCalendarClientScriptPre() : mixed` Registers the javascript code to initialize the date picker.
`protected`	`renderButtonDatePicker(THtmlWriter $writer) : mixed` Adds an additional button such that when clicked it shows the date picker.
`protected`	`renderCalendarDayOptions(THtmlWriter $writer[, null\|mixed $selected = null ]) : mixed` Renders the day drop down list options.
`protected`	`renderCalendarMonthOptions(THtmlWriter $writer[, null\|mixed $selected = null ]) : mixed` Renders the month drop down list options.
`protected`	`renderCalendarSelections(THtmlWriter $writer, DateTime $date) : mixed` Renders the calendar drop down list depending on the DateFormat pattern.
`protected`	`renderCalendarYearOptions(THtmlWriter $writer[, null\|mixed $selected = null ]) : mixed` Renders the year drop down list options.
`protected`	`renderClientControlScript(mixed $writer) : mixed` Renders the javascript for textbox.
`protected`	`renderDatePickerButtons(mixed $writer) : mixed` Renders the date picker popup buttons.
`protected`	`renderDropDownListCalendar(mixed $writer) : mixed` Renders the drop down list date picker.
`protected`	`renderImageButtonDatePicker(THtmlWriter $writer) : mixed` Adds an additional image button such that when clicked it shows the date picker.
`private`	`renderDropDownListOptions(THtmlWriter $writer, array<string\|int, mixed> $options[, null\|mixed $selected = null ]) : mixed` Renders a drop down lists.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoCompleteType, getAutoGlobalListen, getAutoPostBack, getAutoTrim, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getCausesValidation, getClassHierarchy, getClientID, getColumns, getConfig, getControls, getCssClass, getCustomData, getData, getDataChanged, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getIsValid, getListeningToGlobalEvents, getMaxLength, getNamingContainer, getPage, getParent, getPersistPassword, getPluginModule, getReadOnly, getRegisteredObject, getRequest, getResponse, getRows, getSafeText, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getTextMode, getToolTip, getUniqueID, getUser, getValidationGroup, getValidationPropertyValue, getViewState, getVisible, getWidth, getWrap, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadPostData, loadState, onDataBinding, onInit, onLoad, onPreRender, onTextChanged, onUnload, publishAsset, publishFilePath, raiseEvent, raisePostDataChangedEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setAutoCompleteType, setAutoPostBack, setAutoTrim, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCausesValidation, setColumns, setConfig, setCssClass, setCustomData, setData, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setIsValid, setMaxLength, setPage, setPersistPassword, setReadOnly, setRows, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setTextMode, setToolTip, setValidationGroup, setViewState, setVisible, setWidth, setWrap, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getControlStage, getControlState, getPostBackOptions, getSafeTextParser, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, renderClientControlScript, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`SCRIPT_PATH` Script path relative to the TClientScriptManager::SCRIPT_PATH	`'datepicker'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\Web\UI\WebControls\TTextBox::DEFAULT_COLUMNS, \Prado\Web\UI\WebControls\TTextBox::DEFAULT_ROWS, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TDatePicker

Basic -- Only shows a text input, focusing on the input shows the

Clickable -- Only shows a text input, clicking on the input shows the

Button -- Shows a button next to the text input, clicking on the

ImageButton -- Shows an image next to the text input, clicking on

Class hierarchy

`OnDateChanged` -- raised when the date is changed.

Classes

Interfaces

Traits

Class \Prado\Web\UI\WebControls\TDatePicker

Basic -- Only shows a text input, focusing on the input shows the

Clickable -- Only shows a text input, clicking on the input shows the

Button -- Shows a button next to the text input, clicking on the

ImageButton -- Shows an image next to the text input, clicking on

Class hierarchy

OnDateChanged -- raised when the date is changed.

`OnDateChanged` -- raised when the date is changed.