Class QSelectMenuGen

Generated QSelectMenuGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QListControl uses QListItemManager

QListBoxBase

QListBox

QSelectMenuGen

Direct known subclasses

QSelectMenuBase

Indirect known subclasses

QSelectMenu

Package: Controls\Base
See: QSelectMenuBase
Located at includes/base_controls/QSelectMenuGen.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`	# `Close( )` Closes the menu. Closes the menu. This method does not accept any arguments.
`public`	# `Destroy( )` Removes the selectmenu functionality completely. This will return the element back to its pre-init state. Removes the selectmenu functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the selectmenu. Disables the selectmenu. This method does not accept any arguments.
`public`	# `Enable( )` Enables the selectmenu. Enables the selectmenu. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the selectmenus instance object. If the element does not have an associated instance, undefined is returned. Retrieves the selectmenus 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 selectmenu plugin has loaded. * This method does not accept any arguments.
`public`	# `MenuWidget( )` Returns a jQuery object containing the menu element. Returns a jQuery object containing the menu element. This method does not accept any arguments.
`public`	# `Open( )` Opens the menu. Opens the menu. 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 selectmenu options hash. Gets an object containing key/value pairs representing the current selectmenu options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the selectmenu option associated with the specified optionName. Sets the value of the selectmenu 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 selectmenu. Sets one or more options for the selectmenu. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Refresh( )` Parses the original element and re-renders the menu. Processes any elements that were added, removed or disabled. Parses the original element and re-renders the menu. Processes any elements that were added, removed or disabled. This method does not accept any arguments. Overrides `QControlBase::Refresh()`
`public mixed`	# `__get( string $strName )` PHP magic function PHP magic function Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QListBoxBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QListBoxBase::__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 `QListBoxBase::GetModelConnectorParams()`

Methods inherited from QListBox
`GetResetButtonHtml()`

Methods inherited from QListBoxBase
`GetControlHtml(), GetItemHtml(), ParsePostData(), PutState(), RefreshSelection(), RenderInnerHtml(), Validate(), __construct()`

Methods inherited from QListControl
`AddItem(), AddItems(), GetFirstSelectedItem(), GetId(), GetSelectedItems(), GetState(), SetSelectedItemsById(), SetSelectedItemsByIndex(), SetSelectedItemsByName(), SetSelectedItemsByValue(), UnselectAllItems()`

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(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), 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()

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()`

Methods used from QListItemManager
`AddItemAt(), AddListItem(), AddListItems(), FindItem(), FindItemByValue(), GetAllItems(), GetItem(), GetItemCount(), MarkAsModified(), Reindex(), RemoveAllItems(), RemoveItem(), ReplaceItem()`

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`	`$blnDisabled`	# `null`
`protected mixed`	`$mixIcons`	# `null`
`protected mixed`	`$mixPosition`	# `null`
`protected integer`	`$intWidth`	# `null`

Properties inherited from QListBox
`$strCssClass`

Properties inherited from QListBoxBase
`$strLabelForRequired, $strLabelForRequiredUnnamed`

Properties inherited from QListControl
`$objItemStyle`

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

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Properties used from QListItemManager
`$objListItemArray`

Magic properties summary
`public mixed`	`$AppendTo` Which element to append the menu to. When the value is null, the parents of the
`public boolean`	`$Disabled` Disables the selectmenu if set to true.
`public mixed`	`$Icons` Icons to use for the button, matching an icon defined by the jQuery UI CSS Framework. * button (string, default: "ui-icon-triangle-1-s")
`public mixed`	`$Position` Identifies the position of the menu in relation to the associated button element. You can refer to the jQuery UI Position utility for more details about the various options.
`public integer`	`$Width` The width of the menu, in pixels. When the value is null, the width of the native select is used.

Magic properties inherited from QListBoxBase
`$LabelForRequired, $LabelForRequiredUnnamed, $Rows, $SelectionMode`

Magic properties inherited from QListControl
`$ItemCount, $ItemStyle, $SelectedIndex, $SelectedItem, $SelectedItems, $SelectedName, $SelectedNames, $SelectedValue, $SelectedValues`

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, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign`

Packages

Classes

Class QSelectMenuGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides