Class QDraggableGen

Generated QDraggableGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QDraggableGen

Direct known subclasses

QDraggableBase

Indirect known subclasses

QDraggable

Abstract
Package: Controls\Base
See: QDraggableBase
Located at includes/base_controls/QDraggableGen.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 draggable functionality completely. This will return the element back to its pre-init state. Removes the draggable functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the draggable. Disables the draggable. This method does not accept any arguments.
`public`	# `Enable( )` Enables the draggable. Enables the draggable. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the draggables instance object. If the element does not have an associated instance, undefined is returned. Retrieves the draggables 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 draggable 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 draggable options hash. Gets an object containing key/value pairs representing the current draggable options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the draggable option associated with the specified optionName. Sets the value of the draggable 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 draggable. Sets one or more options for the draggable. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public mixed`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Property Name Returns mixed Throws Exception\|`QCallerException` Overrides `QControlBase::__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 `QCallerException` Exception\|`QCallerException` Exception\|`QInvalidCastException` Overrides `QControlBase::__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 QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetControlHtml(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ParsePostData(), ProcessActionParameters(), PutState(), Refresh(), 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(), Validate(), 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 boolean`	`$blnAddClasses`	# `null`
`protected mixed`	`$mixAppendTo`	# `null`
`protected string`	`$strAxis`	# `null`
`protected mixed`	`$mixCancel`	# `null`
`protected mixed`	`$mixConnectToSortable`	# `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 array`	`$arrGrid`	# `null`
`protected mixed`	`$mixHandle`	# `null`
`protected mixed`	`$mixHelper`	# `null`
`protected mixed`	`$mixIframeFix`	# `null`
`protected integer`	`$intOpacity`	# `null`
`protected boolean`	`$blnRefreshPositions`	# `null`
`protected mixed`	`$mixRevert`	# `null`
`protected integer`	`$intRevertDuration`	# `null`
`protected string`	`$strScope`	# `null`
`protected boolean`	`$blnScroll`	# `null`
`protected integer`	`$intScrollSensitivity`	# `null`
`protected integer`	`$intScrollSpeed`	# `null`
`protected mixed`	`$mixSnap`	# `null`
`protected string`	`$strSnapMode`	# `null`
`protected integer`	`$intSnapTolerance`	# `null`
`protected mixed`	`$mixStack`	# `null`
`protected integer`	`$intZIndex`	# `null`

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, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strName, $strPreferredRenderMethod, $strRenderMethod, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Magic properties summary
`public boolean`	`$AddClasses` If set to false, will prevent the ui-draggable class from being added. This may be desired as a performance optimization when calling .draggable() on hundreds of elements.
`public mixed`	`$AppendTo` Which element the draggable helper should be appended to while dragging. Note: The appendTo option only works when the helper option is set to not use the original element.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 draggable.
`public string`	`$Axis` Constrains dragging to either the horizontal (x) or vertical (y) axis. Possible values: "x", "y".
`public mixed`	`$Cancel` Prevents dragging from starting on specified elements.
`public mixed`	`$ConnectToSortable` Allows the draggable to be dropped onto the specified sortables. If this option is used, a draggable can be dropped onto a sortable list and then becomes part of it. Note: The helper option must be set to "clone" in order to work flawlessly. Requires the jQuery UI Sortable plugin to be included.
`public mixed`	`$Containment` Constrains dragging to within the bounds of the specified element or region.Multiple types supported: * Selector: The draggable element will be contained to the bounding box of the first element found by the selector. If no element is found, no containment will be set. * Element: The draggable element will be contained to the bounding box of this element. * String: Possible values: "parent", "document", "window". * Array: An array defining a bounding box in the form [ x1, y1, x2, y2 ].
`public string`	`$Cursor` The CSS cursor during the drag operation.
`public mixed`	`$CursorAt` Sets the offset of the dragging helper relative to the mouse cursor. 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 after mousedown until dragging should start. This option can be used to prevent unwanted drags when clicking on an element.
`public boolean`	`$Disabled` Disables the draggable if set to true.
`public integer`	`$Distance` Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element.
`public array`	`$Grid` Snaps the dragging helper to a grid, every x and y pixels. The array must be of the form [ x, y ].
`public mixed`	`$Handle` If specified, restricts dragging from starting unless the mousedown occurs on the specified element(s). Only elements that descend from the draggable element are permitted.
`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.
`public mixed`	`$IframeFix` Prevent iframes from capturing the mousemove events during a drag. Useful in combination with the cursorAt option, or in any case where the mouse cursor may not be over the helper.Multiple types supported: * Boolean: When set to true, transparent overlays will be placed over all iframes on the page. * Selector: Any iframes matching the selector will be covered by transparent overlays.
`public integer`	`$Opacity` Opacity for the helper while being dragged.
`public boolean`	`$RefreshPositions` If set to true, all droppable positions are calculated on every mousemove. Caution: This solves issues on highly dynamic pages, but dramatically decreases performance.
`public mixed`	`$Revert` Whether the element should revert to its start position when dragging stops.Multiple types supported: * Boolean: If set to true the element will always revert. * String: If set to "invalid", revert will only occur if the draggable has not been dropped on a droppable. For "valid", its the other way around. * Function: A function to determine whether the element should revert to its start position. The function must return true to revert the element.
`public integer`	`$RevertDuration` The duration of the revert animation, in milliseconds. Ignored if the revert option is false.
`public string`	`$Scope` Used to group sets of draggable and droppable items, in addition to droppables accept option. A draggable with the same scope value as a droppable will be accepted by the droppable.
`public boolean`	`$Scroll` If set to true, container auto-scrolls while dragging.
`public integer`	`$ScrollSensitivity` Distance in pixels from the edge of the viewport after which the viewport should scroll. Distance is relative to pointer, not the draggable. Ignored if the scroll option is false.
`public integer`	`$ScrollSpeed` The speed at which the window should scroll once the mouse pointer gets within the scrollSensitivity distance. Ignored if the scroll option is false.
`public mixed`	`$Snap` Whether the element should snap to other elements.Multiple types supported: * Boolean: When set to true, the element will snap to all other draggable elements. * Selector: A selector specifying which elements to snap to.
`public string`	`$SnapMode` Determines which edges of snap elements the draggable will snap to. Ignored if the snap option is false. Possible values: "inner", "outer", "both".
`public integer`	`$SnapTolerance` The distance in pixels from the snap element edges at which snapping should occur. Ignored if the snap option is false.
`public mixed`	`$Stack` Controls the z-index of the set of elements that match the selector, always brings the currently dragged item to the front. Very useful in things like window managers.
`public integer`	`$ZIndex` Z-index for the helper while being dragged.

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, $HorizontalAlign, $Left, $Margin, $NoWrap, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Class QDraggableGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides