Class QSortableGen

Generated QSortableGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QBlockControl

QPanel

QSortableGen

Direct known subclasses

QSortableBase

Indirect known subclasses

QSortable

Package: Controls\Base
See: QSortableBase
Located at includes/base_controls/QSortableGen.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 `QBlockControl::GetEndScript()`
`public`	# `Cancel( )` Cancels a change in the current sortable and reverts it to the state prior to when the current sort was started. Useful in the stop and receive callback functions. Cancels a change in the current sortable and reverts it to the state prior to when the current sort was started. Useful in the stop and receive callback functions. This method does not accept any arguments.
`public`	# `Destroy( )` Removes the sortable functionality completely. This will return the element back to its pre-init state. Removes the sortable functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the sortable. Disables the sortable. This method does not accept any arguments.
`public`	# `Enable( )` Enables the sortable. Enables the sortable. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the sortables instance object. If the element does not have an associated instance, undefined is returned. Retrieves the sortables 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 sortable plugin has loaded. * 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 sortable options hash. Gets an object containing key/value pairs representing the current sortable options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the sortable option associated with the specified optionName. Sets the value of the sortable 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 sortable. Sets one or more options for the sortable. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Refresh( )` Refresh the sortable items. Triggers the reloading of all sortable items, causing new items to be recognized. Refresh the sortable items. Triggers the reloading of all sortable items, causing new items to be recognized. This method does not accept any arguments. Overrides `QControlBase::Refresh()`
`public`	# `RefreshPositions( )` Refresh the cached positions of the sortable items. Calling this method refreshes the cached item positions of all sortables. Refresh the cached positions of the sortable items. Calling this method refreshes the cached item positions of all sortables. This method does not accept any arguments.
`public`	# `Serialize( $options )` Serializes the sortables item ids into a form/ajax submittable string. Calling this method produces a hash that can be appended to any url to easily submit a new item order back to the server. Serializes the sortables item ids into a form/ajax submittable string. Calling this method produces a hash that can be appended to any url to easily submit a new item order back to the server. It works by default by looking at the id of each item in the format "setname_number", and it spits out a hash like "setname[]=number&setname[]=number". Note: If serialize returns an empty string, make sure the id attributes include an underscore. They must be in the form: "set_number" For example, a 3 element list with id attributes "foo_1", "foo_5", "foo_2" will serialize to "foo[]=1&foo[]=5&foo[]=2". You can use an underscore, equal sign or hyphen to separate the set and number. For example "foo=1", "foo-1", and "foo_1" all serialize to "foo[]=1". * options Type: Object Options to customize the serialization. * key (default: the part of the attribute in front of the separator) Type: String Replaces part1[] with the specified value. * attribute (default: "id") Type: String The name of the attribute to use for the values. * expression (default: /(.+)-=_/) Type: RegExp A regular expression used to split the attribute value into key and value parts. Parameters `$options`
`public`	# `ToArray( $options )` Serializes the sortables item ids into an array of string. Serializes the sortables item ids into an array of string. options Type: Object Options to customize the serialization. attribute (default: "id") Type: String The name of the attribute to use for the values. Parameters `$options`
`public mixed`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Name of the property Returns mixed Throws Exception\|`QCallerException` Overrides `QBlockControl::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP __set magic method implementation PHP __set magic method implementation Parameters `$strName` Property Name `$mixValue` Property Value Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QBlockControl::__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 `QControlBase::GetModelConnectorParams()`

Methods inherited from QBlockControl
`AddControlToMove(), AddDropZone(), GetControlHtml(), GetInnerHtml(), ParsePostData(), RemoveAllControlsToMove(), RemoveAllDropZones(), RemoveControlToMove(), RemoveDropZone(), Validate()`

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(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState(), __construct()

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`	`$mixAppendTo`	# `null`
`protected string`	`$strAxis`	# `null`
`protected mixed`	`$mixCancel`	# `null`
`protected mixed`	`$mixConnectWith`	# `null`
`protected mixed`	`$mixContainment`	# `null`
`protected string`	`$strCursor`	# `null`
`protected mixed`	`$mixCursorAt`	# `null`
`protected integer`	`$intDelay`	#
`protected boolean`	`$blnDisabled`	# `null`
`protected integer`	`$intDistance`	# `null`
`protected boolean`	`$blnDropOnEmpty`	# `null`
`protected boolean`	`$blnForceHelperSize`	# `null`
`protected boolean`	`$blnForcePlaceholderSize`	# `null`
`protected array`	`$arrGrid`	# `null`
`protected mixed`	`$mixHandle`	# `null`
`protected mixed`	`$mixHelper`	# `null`
`protected mixed`	`$mixItems`	# `null`
`protected integer`	`$intOpacity`	# `null`
`protected string`	`$strPlaceholder`	# `null`
`protected mixed`	`$mixRevert`	# `null`
`protected boolean`	`$blnScroll`	# `null`
`protected integer`	`$intScrollSensitivity`	# `null`
`protected integer`	`$intScrollSpeed`	# `null`
`protected string`	`$strTolerance`	# `null`
`protected integer`	`$intZIndex`	# `null`

Properties inherited from QPanel
`$blnHtmlEntities, $blnIsBlockElement, $strDefaultDisplayStyle, $strTagName`

Properties inherited from QBlockControl
`$blnAutoRenderChildren, $blnDropTarget, $objDropsControlsArray, $objDropsGroupingsArray, $objIsDropZoneFor, $objMovesControlsArray, $strFormat, $strTemplate, $strText`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $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, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strName, $strPreferredRenderMethod, $strRenderMethod, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public mixed`	`$AppendTo` Defines where the helper that moves with the mouse is being appended to during the drag (for example, to resolve overlap/zIndex issues).Multiple types supported: * jQuery: A jQuery object containing the element to append the helper to. * Element: The element to append the helper to. * Selector: A selector specifying which element to append the helper to. * String: The string "parent" will cause the helper to be a sibling of the sortable item.
`public string`	`$Axis` If defined, the items can be dragged only horizontally or vertically. Possible values: "x", "y".
`public mixed`	`$Cancel` Prevents sorting if you start on elements matching the selector.
`public mixed`	`$ConnectWith` A selector of other sortable elements that the items from this list should be connected to. This is a one-way relationship, if you want the items to be connected in both directions, the connectWith option must be set on both sortable elements.
`public mixed`	`$Containment` Defines a bounding box that the sortable items are constrained to while dragging. Note: The element specified for containment must have a calculated width and height (though it need not be explicit). For example, if you have float: left sortable children and specify containment: "parent" be sure to have float: left on the sortable/parent container as well or it will have height: 0, causing undefined behavior.Multiple types supported: * Element: An element to use as the container. * Selector: A selector specifying an element to use as the container. * String: A string identifying an element to use as the container. Possible values: "parent", "document", "window".
`public string`	`$Cursor` Defines the cursor that is being shown while sorting.
`public mixed`	`$CursorAt` Moves the sorting element or helper so the cursor always appears to drag from the same position. Coordinates can be given as a hash using a combination of one or two keys: { top, left, right, bottom }.
`public integer`	`$Delay` Time in milliseconds to define when the sorting should start. Adding a delay helps preventing unwanted drags when clicking on an element.
`public boolean`	`$Disabled` Disables the sortable if set to true.
`public integer`	`$Distance` Tolerance, in pixels, for when sorting should start. If specified, sorting will not start until after mouse is dragged beyond distance. Can be used to allow for clicks on elements within a handle.
`public boolean`	`$DropOnEmpty` If false, items from this sortable cant be dropped on an empty connect sortable (see the connectWith option.
`public boolean`	`$ForceHelperSize` If true, forces the helper to have a size.
`public boolean`	`$ForcePlaceholderSize` If true, forces the placeholder to have a size.
`public array`	`$Grid` Snaps the sorting element or helper to a grid, every x and y pixels. Array values: [ x, y ].
`public mixed`	`$Handle` Restricts sort start click to the specified element.
`public mixed`	`$Helper` Allows for a helper element to be used for dragging display.Multiple types supported: * String: If set to "clone", then the element will be cloned and the clone will be dragged. * Function: A function that will return a DOMElement to use while dragging. The function receives the event and the element being sorted.
`public mixed`	`$Items` Specifies which items inside the element should be sortable.
`public integer`	`$Opacity` Defines the opacity of the helper while sorting. From 0.01 to 1.
`public string`	`$Placeholder` A class name that gets applied to the otherwise white space.
`public mixed`	`$Revert` Whether the sortable items should revert to their new positions using a smooth animation.Multiple types supported: * Boolean: When set to true, the items will animate with the default duration. * Number: The duration for the animation, in milliseconds.
`public boolean`	`$Scroll` If set to true, the page scrolls when coming to an edge.
`public integer`	`$ScrollSensitivity` Defines how near the mouse must be to an edge to start scrolling.
`public integer`	`$ScrollSpeed` The speed at which the window should scroll once the mouse pointer gets within the scrollSensitivity distance.
`public string`	`$Tolerance` Specifies which mode to use for testing whether the item being moved is hovering over another item. Possible values: * "intersect": The item overlaps the other item by at least 50%. * "pointer": The mouse pointer overlaps the other item.
`public integer`	`$ZIndex` Z-index for element/helper while being sorted.

Magic properties inherited from QBlockControl
`$AutoRenderChildren, $DropTarget, $Format, $HorizontalAlign, $HtmlEntities, $ResizeHandleDirection, $ResizeHandleMaximum, $ResizeHandleMinimum, $TagName, $Template, $Text, $VerticalAlign`

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, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $Left, $Margin, $NoWrap, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $Width`

Packages

Classes

Class QSortableGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Overrides

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides