PHP Класс Prado\Web\UI\WebControls\TDatePicker

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 ButtonText 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 ButtonImageUrl 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.
С версии: 3.0
Автор: Carl G. Mathisen ([email protected])
Наследование: extends TTextBox
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
getButtonImageUrl ( ) : string
getButtonText ( ) : string
getCalendarStyle ( ) : string
getClientSide ( ) : TDatePickerClientScript Gets the TDatePickerClientScript to set the TDatePicker event handlers.
getCulture ( ) : string Gets the current culture.
getData ( ) : integer Returns the timestamp selected by the user.
getDate ( ) : string
getDateFormat ( ) : string
getFirstDayOfWeek ( ) : integer
getFromYear ( ) : integer
getInputMode ( ) : TDatePickerInputMode
getMode ( ) : TDatePickerMode
getPositionMode ( ) : TDatePickerPositionMode
getShowCalendar ( ) : boolean
getTimeStamp ( ) : integer
getUpToYear ( ) : integer
getValidationPropertyValue ( ) : integer Returns the value to be validated.
loadPostData ( $key, $values ) : boolean Loads user input data. Override parent implementation, when InputMode is DropDownList call getDateFromPostData to get date data.
onPreRender ( $param ) Publish the date picker Css asset files.
render ( $writer ) Renders body content.
setAutoPostBack ( $value ) AutoPostBack is not supported.
setButtonImageUrl ( $value )
setButtonText ( $value )
setCalendarStyle ( $value )
setCulture ( $value ) Sets the culture/language for the date picker.
setData ( $value ) Sets the timestamp represented by this control.
setDate ( $value )
setDateFormat ( $value ) Sets the format of the date string.
setFirstDayOfWeek ( $value ) Set the first day of week, with 0 as Sunday, 1 as Monday, etc.
setFromYear ( $value )
setInputMode ( $value )
setMode ( $value )
setPositionMode ( $value )
setShowCalendar ( $value ) Sets whether to pop up the calendar window when the control receives focus
setTimeStamp ( $value ) Sets the date for the date picker using timestamp.
setUpToYear ( $value )

Защищенные методы

Метод Описание
addAttributesToRender ( $writer ) Add the client id to the input textbox, and register the client scripts.
createClientScript ( ) : TDatePickerClientScript
getAssetUrl ( $file = '' ) : string
getCulturalOptions ( ) : array Get javascript localization options, e.g. month and weekday names.
getCurrentCulture ( ) : string
getDateFromPostData ( $key, $values ) : array Loads date from drop down list data.
getDatePickerButtonID ( ) : string Gets the ID for the date picker trigger button.
getDatePickerOptions ( ) : array Get javascript date picker options.
getDropDownDayOptions ( ) : array
getLocalizedCalendarInfo ( ) : DateTimeFormatInfo
getLocalizedMonthNames ( $info ) : array Returns the localized month names that depends on the month format pattern.
getTimeStampFromText ( ) : integer Gets the date from the text input using TSimpleDateFormatter
hasDayPattern ( )
publishCalendarStyle ( ) : string Publish the calendar style Css asset file.
registerCalendarClientScriptPre ( ) Registers the javascript code to initialize the date picker.
renderButtonDatePicker ( $writer ) : THtmlWriter Adds an additional button such that when clicked it shows the date picker.
renderCalendarDayOptions ( $writer, $selected = null ) Renders the day drop down list options.
renderCalendarMonthOptions ( $writer, $selected = null ) Renders the month drop down list options.
renderCalendarSelections ( $writer, $date ) Renders the calendar drop down list depending on the DateFormat pattern.
renderCalendarYearOptions ( $writer, $selected = null ) Renders the year drop down list options.
renderClientControlScript ( $writer )
renderDatePickerButtons ( $writer ) Renders the date picker popup buttons.
renderDropDownListCalendar ( $writer ) Renders the drop down list date picker.
renderImageButtonDatePicker ( $writer ) : THtmlWriter Adds an additional image button such that when clicked it shows the date picker.

Приватные методы

Метод Описание
renderDropDownListOptions ( $writer, $options, $selected = null ) Renders a drop down lists.

Описание методов

addAttributesToRender() защищенный Метод

Add the client id to the input textbox, and register the client scripts.
protected addAttributesToRender ( $writer )

createClientScript() защищенный Метод

protected createClientScript ( ) : TDatePickerClientScript
Результат TDatePickerClientScript javascript validator event options.

getAssetUrl() защищенный Метод

protected getAssetUrl ( $file = '' ) : string
Результат string date picker asset url.

getButtonImageUrl() публичный Метод

public getButtonImageUrl ( ) : string
Результат string the image url for "Image" UI mode.

getButtonText() публичный Метод

public getButtonText ( ) : string
Результат string text for the date picker button. Default is "...".

getCalendarStyle() публичный Метод

public getCalendarStyle ( ) : string
Результат string current calendar style

getClientSide() публичный Метод

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 getClientSide ( ) : TDatePickerClientScript
Результат TDatePickerClientScript javascript validator event options.

getCulturalOptions() защищенный Метод

Get javascript localization options, e.g. month and weekday names.
protected getCulturalOptions ( ) : array
Результат array localization options.

getCulture() публичный Метод

Gets the current culture.
public getCulture ( ) : string
Результат string current culture, e.g. en_AU.

getCurrentCulture() защищенный Метод

protected getCurrentCulture ( ) : string
Результат string the current culture, falls back to application if culture is not set.

getData() публичный Метод

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link getTimeStamp()}.
См. также: getTimeStamp
С версии: 3.1.2
public getData ( ) : integer
Результат integer the timestamp of the TDatePicker control.

getDate() публичный Метод

public getDate ( ) : string
Результат string the date string.

getDateFormat() публичный Метод

public getDateFormat ( ) : string
Результат string the format of the date string

getDateFromPostData() защищенный Метод

Loads date from drop down list data.
protected getDateFromPostData ( $key, $values ) : array
Результат array the date selected

getDatePickerButtonID() защищенный Метод

Gets the ID for the date picker trigger button.
protected getDatePickerButtonID ( ) : string
Результат string unique button ID

getDatePickerOptions() защищенный Метод

Get javascript date picker options.
protected getDatePickerOptions ( ) : array
Результат array date picker client-side options

getDropDownDayOptions() защищенный Метод

protected getDropDownDayOptions ( ) : array
Результат array list of day options for a drop down list.

getFirstDayOfWeek() публичный Метод

public getFirstDayOfWeek ( ) : integer
Результат integer first day of the week

getFromYear() публичный Метод

public getFromYear ( ) : integer
Результат integer date picker starting year, default is -5 years

getInputMode() публичный Метод

public getInputMode ( ) : TDatePickerInputMode
Результат TDatePickerInputMode input method of date values. Defaults to TDatePickerInputMode::TextBox.

getLocalizedCalendarInfo() защищенный Метод

protected getLocalizedCalendarInfo ( ) : DateTimeFormatInfo
Результат DateTimeFormatInfo date time format information for the current culture.

getLocalizedMonthNames() защищенный Метод

"MMMM" will return the month names, "MM" or "MMM" return abbr. month names and "M" return month digits.
protected getLocalizedMonthNames ( $info ) : array
Результат array localized month names.

getMode() публичный Метод

public getMode ( ) : TDatePickerMode
Результат TDatePickerMode current calendar UI mode.

getPositionMode() публичный Метод

public getPositionMode ( ) : TDatePickerPositionMode
Результат TDatePickerPositionMode current calendar UI position.

getShowCalendar() публичный Метод

public getShowCalendar ( ) : boolean
Результат boolean whether the calendar window should pop up when the control receives focus

getTimeStamp() публичный Метод

public getTimeStamp ( ) : integer
Результат integer current selected date from the date picker as timestamp, NULL if timestamp is not set previously.

getTimeStampFromText() защищенный Метод

Gets the date from the text input using TSimpleDateFormatter
protected getTimeStampFromText ( ) : integer
Результат integer current selected date timestamp

getUpToYear() публичный Метод

public getUpToYear ( ) : integer
Результат integer date picker ending year, default +10 years

getValidationPropertyValue() публичный Метод

This methid is required by \Prado\Web\UI\IValidatable interface.
public getValidationPropertyValue ( ) : integer
Результат integer the interger timestamp if valid, otherwise the original text.

hasDayPattern() защищенный Метод

protected hasDayPattern ( )

loadPostData() публичный Метод

This method is primarly used by framework developers.
public loadPostData ( $key, $values ) : boolean
Результат boolean whether the data of the component has been changed

onPreRender() публичный Метод

Publish the date picker Css asset files.
public onPreRender ( $param )

publishCalendarStyle() защищенный Метод

Publish the calendar style Css asset file.
protected publishCalendarStyle ( ) : string
Результат string Css file url.

registerCalendarClientScriptPre() защищенный Метод

Registers the javascript code to initialize the date picker.

render() публичный Метод

This method overrides parent implementation by adding additional date picker button if Mode is Button or ImageButton.
public render ( $writer )

renderButtonDatePicker() защищенный Метод

Adds an additional button such that when clicked it shows the date picker.
protected renderButtonDatePicker ( $writer ) : THtmlWriter
Результат THtmlWriter writer

renderCalendarDayOptions() защищенный Метод

Renders the day drop down list options.
protected renderCalendarDayOptions ( $writer, $selected = null )

renderCalendarMonthOptions() защищенный Метод

Renders the month drop down list options.
protected renderCalendarMonthOptions ( $writer, $selected = null )

renderCalendarSelections() защищенный Метод

Renders the calendar drop down list depending on the DateFormat pattern.
protected renderCalendarSelections ( $writer, $date )

renderCalendarYearOptions() защищенный Метод

Renders the year drop down list options.
protected renderCalendarYearOptions ( $writer, $selected = null )

renderClientControlScript() защищенный Метод

protected renderClientControlScript ( $writer )

renderDatePickerButtons() защищенный Метод

Renders the date picker popup buttons.
protected renderDatePickerButtons ( $writer )

renderDropDownListCalendar() защищенный Метод

Renders the drop down list date picker.
protected renderDropDownListCalendar ( $writer )

renderImageButtonDatePicker() защищенный Метод

Adds an additional image button such that when clicked it shows the date picker.
protected renderImageButtonDatePicker ( $writer ) : THtmlWriter
Результат THtmlWriter writer

setAutoPostBack() публичный Метод

AutoPostBack is not supported.
public setAutoPostBack ( $value )

setButtonImageUrl() публичный Метод

public setButtonImageUrl ( $value )

setButtonText() публичный Метод

public setButtonText ( $value )

setCalendarStyle() публичный Метод

public setCalendarStyle ( $value )

setCulture() публичный Метод

Sets the culture/language for the date picker.
public setCulture ( $value )

setData() публичный Метод

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setTimeStamp()}.
См. также: setTimeStamp
С версии: 3.1.2
public setData ( $value )

setDate() публичный Метод

public setDate ( $value )

setDateFormat() публичный Метод

Sets the format of the date string.
public setDateFormat ( $value )

setFirstDayOfWeek() публичный Метод

Set the first day of week, with 0 as Sunday, 1 as Monday, etc.
public setFirstDayOfWeek ( $value )

setFromYear() публичный Метод

public setFromYear ( $value )

setInputMode() публичный Метод

public setInputMode ( $value )

setMode() публичный Метод

public setMode ( $value )

setPositionMode() публичный Метод

public setPositionMode ( $value )

setShowCalendar() публичный Метод

Sets whether to pop up the calendar window when the control receives focus
public setShowCalendar ( $value )

setTimeStamp() публичный Метод

Sets the date for the date picker using timestamp.
public setTimeStamp ( $value )

setUpToYear() публичный Метод

public setUpToYear ( $value )