Class QDroppableGen

Generated QDroppableGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QDroppableGen

Direct known subclasses

QDroppableBase

Indirect known subclasses

QDroppable

Abstract
Package: Controls\Base
See: QDroppableBase
Located at includes/base_controls/QDroppableGen.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 droppable functionality completely. This will return the element back to its pre-init state. Removes the droppable functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the droppable. Disables the droppable. This method does not accept any arguments.
`public`	# `Enable( )` Enables the droppable. Enables the droppable. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the droppables instance object. If the element does not have an associated instance, undefined is returned. Retrieves the droppables 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 droppable 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 droppable options hash. Gets an object containing key/value pairs representing the current droppable options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the droppable option associated with the specified optionName. Sets the value of the droppable 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 droppable. Sets one or more options for the droppable. 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 mixed`	`$mixAccept`	# `null`
`protected string`	`$strActiveClass`	# `null`
`protected boolean`	`$blnAddClasses`	# `null`
`protected boolean`	`$blnDisabled`	# `null`
`protected boolean`	`$blnGreedy`	# `null`
`protected string`	`$strHoverClass`	# `null`
`protected string`	`$strScope`	# `null`
`protected string`	`$strTolerance`	# `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 mixed`	`$Accept` Controls which draggable elements are accepted by the droppable.Multiple types supported: * Selector: A selector indicating which draggable elements are accepted. * Function: A function that will be called for each draggable on the page (passed as the first argument to the function). The function must return true if the draggable should be accepted.
`public string`	`$ActiveClass` If specified, the class will be added to the droppable while an acceptable draggable is being dragged.
`public boolean`	`$AddClasses` If set to false, will prevent the ui-droppable class from being added. This may be desired as a performance optimization when calling .droppable() init on hundreds of elements.
`public boolean`	`$Disabled` Disables the droppable if set to true.
`public boolean`	`$Greedy` By default, when an element is dropped on nested droppables, each droppable will receive the element. However, by setting this option to true, any parent droppables will not receive the element. The drop event will still bubble normally, but the event.target can be checked to see which droppable received the draggable element.
`public string`	`$HoverClass` If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.
`public string`	`$Scope` Used to group sets of draggable and droppable items, in addition to the accept option. A draggable with the same scope value as a droppable will be accepted.
`public string`	`$Tolerance` Specifies which mode to use for testing whether a draggable is hovering over a droppable. Possible values: * "fit": Draggable overlaps the droppable entirely. * "intersect": Draggable overlaps the droppable at least 50% in both directions. * "pointer": Mouse pointer overlaps the droppable. * "touch": Draggable overlaps the droppable any amount.

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 QDroppableGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides