Class QSpinnerGen

Generated QSpinnerGen class.

This is the QSpinnerGen 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 QSpinnerBase class for any glue code to make this class more usable in QCubed.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QTextBoxBase

QTextBox

QSpinnerGen

Direct known subclasses

QSpinnerBase

Indirect known subclasses

QSpinner

Package: Controls\Base
See: QSpinnerBase
Located at includes/base_controls/QSpinnerGen.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 spinner functionality completely. This will return the element back to its pre-init state. Removes the spinner functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the spinner. Disables the spinner. This method does not accept any arguments.
`public`	# `Enable( )` Enables the spinner. Enables the spinner. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the spinners instance object. If the element does not have an associated instance, undefined is returned. Retrieves the spinners instance object. If the element does not have an associated instance, undefined is returned. Unlike other widget methods, instance() is safe to call on any element after the spinner plugin has loaded. * This method does not accept any arguments.
`public`	# `IsValid( )` Returns whether the Spinners value is valid given its min, max, and step. Returns whether the Spinners value is valid given its min, max, and step. 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 spinner options hash. Gets an object containing key/value pairs representing the current spinner options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the spinner option associated with the specified optionName. Sets the value of the spinner 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 spinner. Sets one or more options for the spinner. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `PageDown( $pages = null )` Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented. Decrements the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is decremented. If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value. Invoking pageDown() will cause start, spin, and stop events to be triggered. * pages Type: Number Number of pages to decrement, defaults to 1. Parameters `$pages`
`public`	# `PageUp( $pages = null )` Increments the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is incremented. Increments the value by the specified number of pages, as defined by the page option. Without the parameter, a single page is incremented. If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value. Invoking pageUp() will cause start, spin, and stop events to be triggered. * pages Type: Number Number of pages to increment, defaults to 1. Parameters `$pages`
`public`	# `StepDown( $steps = null )` Decrements the value by the specified number of steps. Without the parameter, a single step is decremented. Decrements the value by the specified number of steps. Without the parameter, a single step is decremented. If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value. Invoking stepDown() will cause start, spin, and stop events to be triggered. * steps Type: Number Number of steps to decrement, defaults to 1. Parameters `$steps`
`public`	# `StepUp( $steps = null )` Increments the value by the specified number of steps. Without the parameter, a single step is incremented. Increments the value by the specified number of steps. Without the parameter, a single step is incremented. If the resulting value is above the max, below the min, or results in a step mismatch, the value will be adjusted to the closest valid value. Invoking stepUp() will cause start, spin, and stop events to be triggered. * steps Type: Number Number of steps to increment, defaults to 1. Parameters `$steps`
`public`	# `Value( )` Gets the current value as a number. The value is parsed based on the numberFormat and culture options. Gets the current value as a number. The value is parsed based on the numberFormat and culture options. This signature does not accept any arguments.
`public`	# `Value1( $value )` value Type: Number or String The value to set. If passed as a string, the value is parsed based on the numberFormat and culture options. value Type: Number or String The value to set. If passed as a string, the value is parsed based on the numberFormat and culture options. Parameters `$value`
`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(), Refresh(), 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 string`	`$strCulture`	# `null`
`protected boolean`	`$blnDisabled`	# `null`
`protected mixed`	`$mixIcons`	# `null`
`protected mixed`	`$mixIncremental`	# `null`
`protected mixed`	`$mixMax`	# `null`
`protected mixed`	`$mixMin`	# `null`
`protected string`	`$strNumberFormat`	# `null`
`protected integer`	`$intPage`	# `null`
`protected mixed`	`$mixStep`	# `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 string`	`$Culture` Sets the culture to use for parsing and formatting the value. If null, the currently set culture in Globalize is used, see Globalize docs for available cultures. Only relevant if the numberFormat option is set. Requires Globalize to be included.
`public boolean`	`$Disabled` Disables the spinner if set to true.
`public mixed`	`$Icons` Icons to use for buttons, matching an icon provided by the jQuery UI CSS Framework. * up (string, default: "ui-icon-triangle-1-n") * down (string, default: "ui-icon-triangle-1-s")
`public mixed`	`$Incremental` Controls the number of steps taken when holding down a spin button.Multiple types supported: * Boolean: When set to true, the stepping delta will increase when spun incessantly. When set to false, all steps are equal (as defined by the step option). * Function: Receives one parameter: the number of spins that have occurred. Must return the number of steps that should occur for the current spin.
`public mixed`	`$Max` The maximum allowed value. The elements max attribute is used if it exists and the option is not explicitly set. If null, there is no maximum enforced.Multiple types supported: * Number: The maximum value. * String: If Globalize is included, the max option can be passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method.
`public mixed`	`$Min` The minimum allowed value. The elements min attribute is used if it exists and the option is not explicitly set. If null, there is no minimum enforced.Multiple types supported: * Number: The minimum value. * String: If Globalize is included, the min option can be passed as a string which will be parsed based on the numberFormat and culture options; otherwise it will fall back to the native parseFloat() method.
`public string`	`$NumberFormat` Format of numbers passed to Globalize, if available. Most common are "n" for a decimal number and "C" for a currency value. Also see the culture option.
`public integer`	`$Page` The number of steps to take when paging via the pageUp/pageDown methods.
`public mixed`	`$Step` The size of the step to take when spinning via buttons or via the stepUp()/stepDown() methods. The elements step attribute is used if it exists and the option is not explicitly set.Multiple types supported: * Number: The size of the step. * String: If Globalize is included, the step option can be passed as a string which will be parsed based on the numberFormat and culture options, otherwise it will fall back to the native parseFloat.

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 QSpinnerGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides