PHP Class 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.
Exibir arquivo
Open project: pradosoft/prado
Class Usage Examples
Public Methods
Protected Methods
Private Methods
Method Details
addAttributesToRender()
protected method
Add the client id to the input textbox, and register the client scripts.
createClientScript()
protected method
protected createClientScript ( ) : TDatePickerClientScript |
return |
TDatePickerClientScript |
javascript validator event options. |
getAssetUrl()
protected method
getButtonText()
public method
getCalendarStyle()
public method
getClientSide()
public method
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 |
return |
TDatePickerClientScript |
javascript validator event options. |
getCulturalOptions()
protected method
Get javascript localization options, e.g. month and weekday names.
getCulture()
public method
Gets the current culture.
getCurrentCulture()
protected method
This method is required by {@link \Prado\IDataRenderer}.
It is the same as {@link getTimeStamp()}.
getDateFromPostData()
protected method
Loads date from drop down list data.
getDatePickerOptions()
protected method
Get javascript date picker options.
getDropDownDayOptions()
protected method
getFirstDayOfWeek()
public method
getFromYear()
public method
getLocalizedCalendarInfo()
protected method
protected getLocalizedCalendarInfo ( ) : DateTimeFormatInfo |
return |
DateTimeFormatInfo |
date time format information for the current culture. |
getLocalizedMonthNames()
protected method
"MMMM" will return the month names, "MM" or "MMM" return abbr. month names
and "M" return month digits.
public getMode ( ) : TDatePickerMode |
return |
TDatePickerMode |
current calendar UI mode. |
getPositionMode()
public method
public getPositionMode ( ) : TDatePickerPositionMode |
return |
TDatePickerPositionMode |
current calendar UI position. |
getShowCalendar()
public method
getTimeStamp()
public method
public getTimeStamp ( ) : integer |
return |
integer |
current selected date from the date picker as timestamp, NULL if timestamp is not set previously. |
getTimeStampFromText()
protected method
Gets the date from the text input using TSimpleDateFormatter
getUpToYear()
public method
getValidationPropertyValue()
public method
This methid is required by \Prado\Web\UI\IValidatable interface.
hasDayPattern()
protected method
loadPostData()
public method
This method is primarly used by framework developers.
onPreRender()
public method
Publish the date picker Css asset files.
publishCalendarStyle()
protected method
Publish the calendar style Css asset file.
registerCalendarClientScriptPre()
protected method
Registers the javascript code to initialize the date picker.
This method overrides parent implementation by adding
additional date picker button if Mode is Button or ImageButton.
renderCalendarDayOptions()
protected method
Renders the day drop down list options.
renderCalendarMonthOptions()
protected method
Renders the month drop down list options.
renderCalendarSelections()
protected method
Renders the calendar drop down list depending on the DateFormat pattern.
renderCalendarYearOptions()
protected method
Renders the year drop down list options.
renderClientControlScript()
protected method
renderDropDownListCalendar()
protected method
Renders the drop down list date picker.
setAutoPostBack()
public method
AutoPostBack is not supported.
setButtonText()
public method
setCalendarStyle()
public method
setCulture()
public method
Sets the culture/language for the date picker.
This method is required by {@link \Prado\IDataRenderer}.
It is the same as {@link setTimeStamp()}.
setFirstDayOfWeek()
public method
Set the first day of week, with 0 as Sunday, 1 as Monday, etc.
setFromYear()
public method
setPositionMode()
public method
setShowCalendar()
public method
Sets whether to pop up the calendar window when the control receives focus
setTimeStamp()
public method
Sets the date for the date picker using timestamp.
setUpToYear()
public method