Class QDatepickerBoxGen

Generated QDatepickerBoxGen class.

This is the QDatepickerBoxGen class which is automatically generated by scraping the JQuery UI documentation website. As such, it includes all the options as listed by the JQuery UI website, which may or may not be appropriate for QCubed. See the QDatepickerBoxBase class for any glue code to make this class more usable in QCubed.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QTextBoxBase

QTextBox

QDatepickerBoxGen

Direct known subclasses

QDatepickerBoxBase

Indirect known subclasses

QDatepickerBox

Package: Controls\Base
See: QDatepickerBoxBase
Located at includes/base_controls/QDatepickerBoxGen.class.php

Methods summary
`protected array`	# `MakeJqOptions( )` Builds the option array to be sent to the widget constructor. Builds the option array to be sent to the widget constructor. Returns array key=>value array of options
`public string`	# `GetJqSetupFunction( )` Return the JavaScript function to call to associate the widget with the control. Return the JavaScript function to call to associate the widget with the control. Returns string
`public string`	# `GetEndScript( )` Returns the script that attaches the JQueryUI widget to the html object. Returns the script that attaches the JQueryUI widget to the html object. Returns string Overrides `QControlBase::GetEndScript()`
`public`	# `Destroy( )` Removes the datepicker functionality completely. This will return the element back to its pre-init state. Removes the datepicker functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Dialog( $date, $onSelect = null, $options = null, $pos = null )` Opens the datepicker in a dialog box. Opens the datepicker in a dialog box. date Type: String or Date The initial date. * onSelect Type: Function() A callback function when a date is selected. The function receives the date text and date picker instance as parameters. * options Type: Options The new options for the date picker. * pos Type: Number[2] or MouseEvent The position of the top/left of the dialog as [x, y] or a MouseEvent that contains the coordinates. If not specified the dialog is centered on the screen. Parameters `$date` `$onSelect` `$options` `$pos`
`public`	# `GetDate( )` Returns the current date for the datepicker or null if no date has been selected. Returns the current date for the datepicker or null if no date has been selected. This method does not accept any arguments.
`public`	# `Hide( )` Close a previously opened date picker. Close a previously opened date picker. This method does not accept any arguments.
`public`	# `IsDisabled( )` Determine whether a date picker has been disabled. Determine whether a date picker has been disabled. This method does not accept any arguments.
`public`	# `Option( $optionName )` Gets the value currently associated with the specified optionName. Gets the value currently associated with the specified optionName. Note: For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, "foo.bar" would get the value of the bar property on the foo option. * optionName Type: String The name of the option to get. Parameters `$optionName`
`public`	# `Option1( )` Gets an object containing key/value pairs representing the current datepicker options hash. Gets an object containing key/value pairs representing the current datepicker options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the datepicker option associated with the specified optionName. Sets the value of the datepicker option associated with the specified optionName. Note: For options that have objects as their value, you can set the value of just one property by using dot notation for optionName. For example, "foo.bar" would update only the bar property of the foo option. * optionName Type: String The name of the option to set. * value Type: Object A value to set for the option. Parameters `$optionName` `$value`
`public`	# `Option3( $options )` Sets one or more options for the datepicker. Sets one or more options for the datepicker. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Refresh( )` Redraw the date picker, after having made some external modifications. Redraw the date picker, after having made some external modifications. This method does not accept any arguments. Overrides `QControlBase::Refresh()`
`public`	# `SetDate( $date )` Sets the date for the datepicker. The new date may be a Date object or a string in the current date format (e.g., "01/26/2009"), a number of days from today (e.g., +7) or a string of values and periods ("y" for years, "m" for months, "w" for weeks, "d" for days, e.g., "+1m +7d"), or null to clear the selected date. Sets the date for the datepicker. The new date may be a Date object or a string in the current date format (e.g., "01/26/2009"), a number of days from today (e.g., +7) or a string of values and periods ("y" for years, "m" for months, "w" for weeks, "d" for days, e.g., "+1m +7d"), or null to clear the selected date. date Type: String or Date The new date. Parameters `$date`
`public`	# `Show( )` Open the date picker. If the datepicker is attached to an input, the input must be visible for the datepicker to be shown. Open the date picker. If the datepicker is attached to an input, the input must be visible for the datepicker to be shown. This method does not accept any arguments.
`public array\|boolean\|integer\|mixed\|null\|QControl\|QForm\|string`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Name of the property Returns array\|boolean\|integer\|mixed\|null\|`QControl`\|`QForm`\|string Throws Exception\|`QCallerException` Overrides `QTextBoxBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP __set magic method implementation PHP __set magic method implementation Parameters `$strName` Name of the property `$mixValue` Value of the property Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QTextBoxBase::__set()`
`public static QModelConnectorParam[]`	# `GetModelConnectorParams( )` If this control is attachable to a codegenerated control in a ModelConnector, this function will be used by the ModelConnector designer dialog to display a list of options for the control. If this control is attachable to a codegenerated control in a ModelConnector, this function will be used by the ModelConnector designer dialog to display a list of options for the control. Returns `QModelConnectorParam[]` Overrides `QTextBoxBase::GetModelConnectorParams()`

Methods inherited from QTextBoxBase
`GetControlHtml(), GetState(), InitHtmlPurifier(), ParsePostData(), PutState(), RenderHtmlAttributes(), Sanitize(), Select(), SetPurifierConfig(), Validate(), __construct()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strJavaScripts` List of JavaScript files to be attached with the control when rendering List of JavaScript files to be attached with the control when rendering	# `__JQUERY_EFFECTS__`
`protected string`	`$strStyleSheets` List of CSS files to be attaches with the control when rendering List of CSS files to be attaches with the control when rendering	# `__JQUERY_CSS__`
`protected mixed`	`$mixAltField`	# `null`
`protected string`	`$strAltFormat`	# `null`
`protected string`	`$strAppendText`	# `null`
`protected boolean`	`$blnAutoSize`	# `null`
`protected QJsClosure`	`$mixOnBeforeShow`	# `null`
`protected QJsClosure`	`$mixOnBeforeShowDay`	# `null`
`protected string`	`$strButtonImage`	# `null`
`protected boolean`	`$blnButtonImageOnly`	# `null`
`protected string`	`$strButtonText`	# `null`
`protected QJsClosure`	`$mixOnCalculateWeek`	# `null`
`protected boolean`	`$blnChangeMonth`	# `null`
`protected boolean`	`$blnChangeYear`	# `null`
`protected string`	`$strCloseText`	# `null`
`protected boolean`	`$blnConstrainInput`	# `null`
`protected string`	`$strCurrentText`	# `null`
`protected string`	`$strJqDateFormat`	# `null`
`protected array`	`$arrDayNames`	# `null`
`protected array`	`$arrDayNamesMin`	# `null`
`protected array`	`$arrDayNamesShort`	# `null`
`protected mixed`	`$mixDefaultDate`	# `null`
`protected QJsClosure`	`$mixDuration`	# `null`
`protected integer`	`$intFirstDay`	#
`protected boolean`	`$blnGotoCurrent`	# `null`
`protected boolean`	`$blnHideIfNoPrevNext`	# `null`
`protected boolean`	`$blnIsRTL`	# `null`
`protected mixed`	`$mixMaxDate`	# `null`
`protected mixed`	`$mixMinDate`	# `null`
`protected array`	`$arrMonthNames`	# `null`
`protected array`	`$arrMonthNamesShort`	# `null`
`protected boolean`	`$blnNavigationAsDateFormat`	# `null`
`protected string`	`$strNextText`	# `null`
`protected mixed`	`$mixNumberOfMonths`	# `null`
`protected QJsClosure`	`$mixOnChangeMonthYear`	# `null`
`protected QJsClosure`	`$mixOnClose`	# `null`
`protected QJsClosure`	`$mixOnSelect`	# `null`
`protected string`	`$strPrevText`	# `null`
`protected boolean`	`$blnSelectOtherMonths`	# `null`
`protected mixed`	`$mixShortYearCutoff`	# `null`
`protected string`	`$strShowAnim`	# `null`
`protected boolean`	`$blnShowButtonPanel`	# `null`
`protected integer`	`$intShowCurrentAtPos`	#
`protected boolean`	`$blnShowMonthAfterYear`	# `null`
`protected string`	`$strShowOn`	# `null`
`protected mixed`	`$mixShowOptions`	# `null`
`protected boolean`	`$blnShowOtherMonths`	# `null`
`protected boolean`	`$blnShowWeek`	# `null`
`protected integer`	`$intStepMonths`	# `null`
`protected string`	`$strWeekHeader`	# `null`
`protected string`	`$strYearRange`	# `null`
`protected string`	`$strYearSuffix`	# `null`

Properties inherited from QTextBox
`$strCssClass`

Properties inherited from QTextBoxBase
`$blnAutoTrim, $intColumns, $intMaxLength, $intMinLength, $intRows, $intSanitizeFilter, $intValidateFilter, $mixSanitizeFilterOptions, $mixValidateFilterOptions, $objHTMLPurifierConfig, $strCrossScripting, $strFormat, $strLabelForInvalid, $strLabelForRequired, $strLabelForRequiredUnnamed, $strLabelForTooLong, $strLabelForTooLongUnnamed, $strLabelForTooShort, $strLabelForTooShortUnnamed, $strPlaceholder, $strText, $strTextMode`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strName, $strPreferredRenderMethod, $strRenderMethod, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public mixed`	`$AltField` An input element that is to be updated with the selected date from the datepicker. Use the altFormat option to change the format of the date within this field. Leave as blank for no alternate field.
`public string`	`$AltFormat` The dateFormat to be used for the altField option. This allows one date format to be shown to the user for selection purposes, while a different format is actually sent behind the scenes. For a full list of the possible formats see the formatDate function
`public string`	`$AppendText` The text to display after each date field, e.g., to show the required format.
`public boolean`	`$AutoSize` Set to true to automatically resize the input field to accommodate dates in the current dateFormat.
`public QJsClosure`	`$OnBeforeShow` Type:Function( Element input, Object inst )Default:nullA function that takes an input field and current datepicker instance and returns an options object to update the datepicker with. It is called just before the datepicker is displayed.
`public QJsClosure`	`$OnBeforeShowDay` Type:Function( Date date )Default:nullA function that takes a date as a parameter and must return an array with: * [0]: true/false indicating whether or not this date is selectable * [1]: a CSS class name to add to the dates cell or "" for the default presentation * [2]: an optional popup tooltip for this date The function is called for each day in the datepicker before it is displayed.
`public string`	`$ButtonImage` A URL of an image to use to display the datepicker when the showOn option is set to "button" or "both". If set, the buttonText option becomes the alt value and is not directly displayed.
`public boolean`	`$ButtonImageOnly` Whether the button image should be rendered by itself instead of inside a button element. This option is only relevant if the buttonImage option has also been set.
`public string`	`$ButtonText` The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "both".
`public QJsClosure`	`$OnCalculateWeek` Type:Function()Default:jQuery.datepicker.iso8601WeekA function to calculate the week of the year for a given date. The default implementation uses the ISO 8601 definition: weeks start on a Monday; the first week of the year contains the first Thursday of the year.
`public boolean`	`$ChangeMonth` Whether the month should be rendered as a dropdown instead of text.
`public boolean`	`$ChangeYear` Whether the year should be rendered as a dropdown instead of text. Use the yearRange option to control which years are made available for selection.
`public string`	`$CloseText` The text to display for the close link. Use the showButtonPanel option to display this button.
`public boolean`	`$ConstrainInput` When true, entry in the input field is constrained to those characters allowed by the current dateFormat option.
`public string`	`$CurrentText` The text to display for the current day link. Use the showButtonPanel option to display this button.
`public string`	`$JqDateFormat` The format for parsed and displayed dates. For a full list of the possible formats see the formatDate function.
`public array`	`$DayNames` The list of long day names, starting from Sunday, for use as requested via the dateFormat option.
`public array`	`$DayNamesMin` The list of minimised day names, starting from Sunday, for use as column headers within the datepicker.
`public array`	`$DayNamesShort` The list of abbreviated day names, starting from Sunday, for use as requested via the dateFormat option.
`public mixed`	`$DefaultDate` Set the date to highlight on first opening if the field is blank. Specify either an actual date via a Date object or as a string in the current dateFormat, or a number of days from today (e.g. +7) or a string of values and periods (y for years, m for months, w for weeks, d for days, e.g. +1m +7d), or null for today.Multiple types supported: * Date: A date object containing the default date. * Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. * String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.
`public QJsClosure`	`$Duration` Control the speed at which the datepicker appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast").
`public integer`	`$FirstDay` Set the first day of the week: Sunday is 0, Monday is 1, etc.
`public boolean`	`$GotoCurrent` When true, the current day link moves to the currently selected date instead of today.
`public boolean`	`$HideIfNoPrevNext` Normally the previous and next links are disabled when not applicable (see the minDate and maxDate options). You can hide them altogether by setting this attribute to true.
`public boolean`	`$IsRTL` Whether the current language is drawn from right to left.
`public mixed`	`$MaxDate` The maximum selectable date. When set to null, there is no maximum.Multiple types supported: * Date: A date object containing the maximum date. * Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. * String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.
`public mixed`	`$MinDate` The minimum selectable date. When set to null, there is no minimum.Multiple types supported: * Date: A date object containing the minimum date. * Number: A number of days from today. For example 2 represents two days from today and -1 represents yesterday. * String: A string in the format defined by the dateFormat option, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.
`public array`	`$MonthNames` The list of full month names, for use as requested via the dateFormat option.
`public array`	`$MonthNamesShort` The list of abbreviated month names, as used in the month header on each datepicker and as requested via the dateFormat option.
`public boolean`	`$NavigationAsDateFormat` Whether the currentText, prevText and nextText options should be parsed as dates by the formatDate function, allowing them to display the target month names for example.
`public string`	`$NextText` The text to display for the next month link. With the standard ThemeRoller styling, this value is replaced by an icon.
`public mixed`	`$NumberOfMonths` The number of months to show at once.Multiple types supported: * Number: The number of months to display in a single row. * Array: An array defining the number of rows and columns to display.
`public QJsClosure`	`$OnChangeMonthYear` Type:Function( Integer year, Integer month, Object inst )Default:nullCalled when the datepicker moves to a new month and/or year. The function receives the selected year, month (1-12), and the datepicker instance as parameters. this refers to the associated input field.
`public QJsClosure`	`$OnClose` Type:Function( String dateText, Object inst )Default:nullCalled when the datepicker is closed, whether or not a date is selected. The function receives the selected date as text ("" if none) and the datepicker instance as parameters. this refers to the associated input field.
`public QJsClosure`	`$OnSelect` Type:Function( String dateText, Object inst )Default:nullCalled when the datepicker is selected. The function receives the selected date as text and the datepicker instance as parameters. this refers to the associated input field.
`public string`	`$PrevText` The text to display for the previous month link. With the standard ThemeRoller styling, this value is replaced by an icon.
`public boolean`	`$SelectOtherMonths` Whether days in other months shown before or after the current month are selectable. This only applies if the showOtherMonths option is set to true.
`public mixed`	`$ShortYearCutoff` The cutoff year for determining the century for a date (used in conjunction with dateFormat y). Any dates entered with a year value less than or equal to the cutoff year are considered to be in the current century, while those greater than it are deemed to be in the previous century.Multiple types supported: * Number: A value between 0 and 99 indicating the cutoff year. * String: A relative number of years from the current year, e.g., "+3" or "-5".
`public string`	`$ShowAnim` The name of the animation used to show and hide the datepicker. Use "show" (the default), "slideDown", "fadeIn", any of the jQuery UI effects. Set to an empty string to disable animation.
`public boolean`	`$ShowButtonPanel` Whether to display a button pane underneath the calendar. The button pane contains two buttons, a Today button that links to the current day, and a Done button that closes the datepicker. The buttons text can be customized using the currentText and closeText options respectively.
`public integer`	`$ShowCurrentAtPos` When displaying multiple months via the numberOfMonths option, the showCurrentAtPos option defines which position to display the current month in.
`public boolean`	`$ShowMonthAfterYear` Whether to show the month after the year in the header.
`public string`	`$ShowOn` When the datepicker should appear. The datepicker can appear when the field receives focus ("focus"), when a button is clicked ("button"), or when either event occurs ("both").
`public mixed`	`$ShowOptions` If using one of the jQuery UI effects for the showAnim option, you can provide additional properties for that animation using this option.
`public boolean`	`$ShowOtherMonths` Whether to display dates in other months (non-selectable) at the start or end of the current month. To make these days selectable use the selectOtherMonths option.
`public boolean`	`$ShowWeek` When true, a column is added to show the week of the year. The calculateWeek option determines how the week of the year is calculated. You may also want to change the firstDay option.
`public integer`	`$StepMonths` Set how many months to move when clicking the previous/next links.
`public string`	`$WeekHeader` The text to display for the week of the year column heading. Use the showWeek option to display this column.
`public string`	`$YearRange` The range of years displayed in the year drop-down: either relative to todays year ("-nn:+nn"), relative to the currently selected year ("c-nn:c+nn"), absolute ("nnnn:nnnn"), or combinations of these formats ("nnnn:-nn"). Note that this option only affects what appears in the drop-down, to restrict which dates may be selected use the minDate and/or maxDate options.
`public string`	`$YearSuffix` Additional text to display after the year in the month headers.

Magic properties inherited from QTextBoxBase
`$AutoTrim, $Columns, $CrossScripting, $Format, $LabelForInvalid, $LabelForRequired, $LabelForRequiredUnnamed, $LabelForTooLong, $LabelForTooLongUnnamed, $LabelForTooShort, $LabelForTooShortUnnamed, $MaxLength, $MinLength, $Placeholder, $Rows, $SanitizeFilter, $SanitizeFilterOptions, $Text, $TextMode, $ValidateFilter, $ValidateFilterOptions, $Value`

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Class QDatepickerBoxGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Overrides

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides