Class QDialogGen

Generated QDialogGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QBlockControl

QPanel

QDialogGen

Direct known subclasses

QDialogBase

Indirect known subclasses

CalculatorWidget, QDialog, QFileAssetDialog, QModelConnectorEditDlg

Package: Controls\Base
See: QDialogBase
Located at includes/base_controls/QDialogGen.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`	# `Close( )` Closes the dialog. Closes the dialog. This method does not accept any arguments.
`public`	# `Destroy( )` Removes the dialog functionality completely. This will return the element back to its pre-init state. Removes the dialog functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the dialogs instance object. If the element does not have an associated instance, undefined is returned. Retrieves the dialogs 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 dialog plugin has loaded. * This method does not accept any arguments.
`public`	# `IsOpen( )` Whether the dialog is currently open. Whether the dialog is currently open. This method does not accept any arguments.
`public`	# `MoveToTop( )` Moves the dialog to the top of the dialog stack. Moves the dialog to the top of the dialog stack. This method does not accept any arguments.
`public`	# `Open( )` Opens the dialog. Opens the dialog. 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 dialog options hash. Gets an object containing key/value pairs representing the current dialog options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the dialog option associated with the specified optionName. Sets the value of the dialog 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 dialog. Sets one or more options for the dialog. 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` 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(), 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(), 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 boolean`	`$blnAutoOpen`	# `null`
`protected mixed`	`$mixButtons`	# `null`
`protected boolean`	`$blnCloseOnEscape`	# `null`
`protected string`	`$strCloseText`	# `null`
`protected string`	`$strDialogClass`	# `null`
`protected boolean`	`$blnDraggable`	# `null`
`protected mixed`	`$mixHeight`	# `null`
`protected mixed`	`$mixHide`	# `null`
`protected integer`	`$intMaxHeight`	# `null`
`protected integer`	`$intMaxWidth`	# `null`
`protected integer`	`$intMinHeight`	# `null`
`protected integer`	`$intMinWidth`	# `null`
`protected boolean`	`$blnModal`	# `null`
`protected mixed`	`$mixPosition`	# `null`
`protected boolean`	`$blnResizable`	# `null`
`protected mixed`	`$mixShow`	# `null`
`protected string`	`$strTitle`	# `null`
`protected integer`	`$intWidth`	# `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` Which element the dialog (and overlay, if modal) should be appended to. Note: The appendTo option should not be changed while the dialog is open. (version added: 1.10.0)
`public boolean`	`$AutoOpen` If set to true, the dialog will automatically open upon initialization. If false, the dialog will stay hidden until the open() method is called.
`public mixed`	`$Buttons` Specifies which buttons should be displayed on the dialog. The context of the callback is the dialog element; if you need access to the button, it is available as the target of the event object.Multiple types supported: * Object: The keys are the button labels and the values are the callbacks for when the associated button is clicked. * Array: Each element of the array must be an object defining the attributes, properties, and event handlers to set on the button. In addition, a key of icons can be used to control buttons icons option, and a key of showText can be used to control buttons text option.
`public boolean`	`$CloseOnEscape` Specifies whether the dialog should close when it has focus and the user presses the escape (ESC) key.
`public string`	`$CloseText` Specifies the text for the close button. Note that the close text is visibly hidden when using a standard theme.
`public string`	`$DialogClass` The specified class name(s) will be added to the dialog, for additional theming.
`public boolean`	`$Draggable` If set to true, the dialog will be draggable by the title bar. Requires the jQuery UI Draggable widget to be included.
`public mixed`	`$Height` The height of the dialog.Multiple types supported: * Number: The height in pixels. * String: The only supported string value is "auto" which will allow the dialog height to adjust based on its content.
`public mixed`	`$Hide` If and how to animate the hiding of the dialog.Multiple types supported: * Boolean: When set to false, no animation will be used and the dialog will be hidden immediately. When set to true, the dialog will fade out with the default duration and the default easing. * Number: The dialog will fade out with the specified duration and the default easing. * String: The dialog will be hidden using the specified effect. The value can either be the name of a built-in jQuery animation method, such as "slideUp", or the name of a jQuery UI effect, such as "fold". In either case the effect will be used with the default duration and the default easing. * Object: If the value is an object, then effect, delay, duration, and easing properties may be provided. If the effect property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If duration or easing is omitted, then the default values will be used. If effect is omitted, then "fadeOut" will be used. If delay is omitted, then no delay is used.
`public integer`	`$MaxHeight` The maximum height to which the dialog can be resized, in pixels.
`public integer`	`$MaxWidth` The maximum width to which the dialog can be resized, in pixels.
`public integer`	`$MinHeight` The minimum height to which the dialog can be resized, in pixels.
`public integer`	`$MinWidth` The minimum width to which the dialog can be resized, in pixels.
`public boolean`	`$Modal` If set to true, the dialog will have modal behavior; other items on the page will be disabled, i.e., cannot be interacted with. Modal dialogs create an overlay below the dialog but above other page elements.
`public mixed`	`$Position` Specifies where the dialog should be displayed when opened. The dialog will handle collisions such that as much of the dialog is visible as possible. The of property defaults to the window, but you can specify another element to position against. You can refer to the jQuery UI Position utility for more details about the available properties.
`public boolean`	`$Resizable` If set to true, the dialog will be resizable. Requires the jQuery UI Resizable widget to be included.
`public mixed`	`$Show` If and how to animate the showing of the dialog.Multiple types supported: * Boolean: When set to false, no animation will be used and the dialog will be shown immediately. When set to true, the dialog will fade in with the default duration and the default easing. * Number: The dialog will fade in with the specified duration and the default easing. * String: The dialog will be shown using the specified effect. The value can either be the name of a built-in jQuery animation method, such as "slideDown", or the name of a jQuery UI effect, such as "fold". In either case the effect will be used with the default duration and the default easing. * Object: If the value is an object, then effect, delay, duration, and easing properties may be provided. If the effect property contains the name of a jQuery method, then that method will be used; otherwise it is assumed to be the name of a jQuery UI effect. When using a jQuery UI effect that supports additional settings, you may include those settings in the object and they will be passed to the effect. If duration or easing is omitted, then the default values will be used. If effect is omitted, then "fadeIn" will be used. If delay is omitted, then no delay is used.
`public string`	`$Title` Specifies the title of the dialog. If the value is null, the title attribute on the dialog source element will be used.
`public integer`	`$Width` The width of the dialog, in pixels.

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

Packages

Classes

Class QDialogGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides