Class QDraggableBase

Implements the jQuery UI Draggable capabilities on to a control.

This class is designed to work as a kind of add-on class to a QControl, giving its capabilities to the control. To make a QControl draggable, simply set $ctl->Dragable = true. You can then get to this class to further manipulate the aspects of the draggable through $ctl->DragObj.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QDraggableGen

QDraggableBase

Direct known subclasses

QDraggable

Package: Controls\Base
Link: http://jqueryui.com/draggable/
Located at includes/base_controls/QDraggableBase.class.php

Methods summary
`public`	# `getJqControlId( )`
`public string`	# `Render( boolean $blnDisplayOutput = true )` This render method is the most basic render-method available. It will perform attribute overiding (if any) and will either display the rendered HTML (if blnDisplayOutput is true, which it is by default), or it will return the rendered HTML as a string. This render method is the most basic render-method available. It will perform attribute overiding (if any) and will either display the rendered HTML (if blnDisplayOutput is true, which it is by default), or it will return the rendered HTML as a string. Parameters `$blnDisplayOutput` render the control or return as string Returns string Throws Exception\|`QCallerException` Overrides `QControlBase::Render()`
`protected string`	# `GetControlHtml( )` This method will render the control, itself, and will return the rendered HTML as a string This method will render the control, itself, and will return the rendered HTML as a string As an abstract method, any class extending QControlBase must implement it. This ensures that each control has its own specific html. When outputting html, you should call GetHtmlAttributes to get the attributes for the main control. If you are outputting a complex control, and need to include ids in subcontrols, your ids should be of the form: $parentControl->ControlId . '_' . $strSubcontrolId. The underscore indicates that actions and post data should be routed first to the parent control, and the parent control will handle the rest. Returns string
`public boolean`	# `Validate( )` Checks if this controls contains a valid value. Checks if this controls contains a valid value. This abstract method defines how a control should validate itself based on the value/ properties it has. It should also include the handling of ensuring the "Required" requirements are obeyed if this control's "Required" flag is set to true. For Controls that can't realistically be "validated" (e.g. labels, datagrids, etc.), those controls should simply have Validate() return true. Returns boolean
`public`	# `ParsePostData( )` ParsePostData parses the value of this control from FormState ParsePostData parses the value of this control from FormState This abstract method must be implemented by all controls. When utilizing formgen, the programmer should never access form variables directly (e.g. via the $_FORM array). It can be assumed that at ANY given time, a control's values/properties will be "up to date" with whatever the webuser has entered in. When a Form is Created via Form::Create(string), the form will go through to check and see if it is a first-run of a form, or if it is a post-back. If it is a postback, it will go through its own private array of controls and call ParsePostData on EVERY control it has. Each control is responsible for "knowing" how to parse the $_POST data to update its own values/properties based on what was returned to via the postback.
`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 `QDraggableGen::GetEndScript()`
`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 `QDraggableGen::__set()`
`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 `QDraggableGen::__get()`

Methods inherited from QDraggableGen
`Destroy(), Disable(), Enable(), GetJqSetupFunction(), GetModelConnectorParams(), Instance(), MakeJqOptions(), Option(), Option1(), Option2(), Option3()`

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(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), 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 summary
`boolean`	`RevertOn` Revert Modes Revert Modes	# `true`
`boolean`	`RevertOff`	# `false`
`string`	`RevertValid`	# `'valid'`
`string`	`RevertInvalid`	# `'invalid'`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected array`	`$aryOriginalPosition`	# `null`
`protected array`	`$aryNewPosition`	# `null`

Properties inherited from QDraggableGen
`$arrGrid, $blnAddClasses, $blnDisabled, $blnRefreshPositions, $blnScroll, $intDelay, $intDistance, $intOpacity, $intRevertDuration, $intScrollSensitivity, $intScrollSpeed, $intSnapTolerance, $intZIndex, $mixAppendTo, $mixCancel, $mixConnectToSortable, $mixContainment, $mixCursorAt, $mixHandle, $mixHelper, $mixIframeFix, $mixRevert, $mixSnap, $mixStack, $strAxis, $strCursor, $strJavaScripts, $strScope, $strSnapMode, $strStyleSheets`

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 mixed`	`$Handle` A drag handle. Can be a control, a selector or array of controls or jQuery selectors.
`public read-only Integer`	`$DeltaX` Amount of change in left that happened on the last drag
`public read-only Integer`	`$DeltaY` Amount of change in top that happened on the last drag

Magic properties inherited from QDraggableGen
`$AddClasses, $AppendTo, $Axis, $Cancel, $ConnectToSortable, $Containment, $Cursor, $CursorAt, $Delay, $Disabled, $Distance, $Grid, $Helper, $IframeFix, $Opacity, $RefreshPositions, $Revert, $RevertDuration, $Scope, $Scroll, $ScrollSensitivity, $ScrollSpeed, $Snap, $SnapMode, $SnapTolerance, $Stack, $ZIndex`

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 QDraggableBase

Direct known subclasses

Parameters

Returns

Throws

Overrides

Returns

Returns

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides