Class QMenuGen

Generated QMenuGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QBlockControl

QPanel

QMenuGen

Direct known subclasses

QMenuBase

Indirect known subclasses

QMenu

Package: Controls\Base
See: QMenuBase
Located at includes/base_controls/QMenuGen.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`	# `Blur( $event = null )` Removes focus from a menu, resets any active element styles and triggers the menus blur event. Removes focus from a menu, resets any active element styles and triggers the menus blur event. event Type: Event What triggered the menu to blur. Parameters `$event`
`public`	# `Collapse( $event = null )` Closes the currently active sub-menu. Closes the currently active sub-menu. event Type: Event What triggered the menu to collapse. Parameters `$event`
`public`	# `CollapseAll( $event = null, $all = null )` Closes all open sub-menus. Closes all open sub-menus. event Type: Event What triggered the menu to collapse. * all Type: Boolean Indicates whether all sub-menus should be closed or only sub-menus below and including the menu that is or contains the target of the triggering event. Parameters `$event` `$all`
`public`	# `Destroy( )` Removes the menu functionality completely. This will return the element back to its pre-init state. Removes the menu functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the menu. Disables the menu. This method does not accept any arguments.
`public`	# `Enable( )` Enables the menu. Enables the menu. This method does not accept any arguments.
`public`	# `Expand( $event = null )` Opens the sub-menu below the currently active item, if one exists. Opens the sub-menu below the currently active item, if one exists. event Type: Event What triggered the menu to expand. Parameters `$event`
`public`	# `Focus( $event, $item )` Activates a particular menu item, begins opening any sub-menu if present and triggers the menus focus event. Activates a particular menu item, begins opening any sub-menu if present and triggers the menus focus event. event Type: Event What triggered the menu item to gain focus. * item Type: jQuery The menu item to focus/activate. Parameters `$event` `$item` Overrides `QControlBase::Focus()`
`public`	# `Instance( )` Retrieves the menus instance object. If the element does not have an associated instance, undefined is returned. Retrieves the menus 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 menu plugin has loaded. * This method does not accept any arguments.
`public`	# `IsFirstItem( )` Returns a boolean value stating whether or not the currently active item is the first item in the menu. Returns a boolean value stating whether or not the currently active item is the first item in the menu. This method does not accept any arguments.
`public`	# `IsLastItem( )` Returns a boolean value stating whether or not the currently active item is the last item in the menu. Returns a boolean value stating whether or not the currently active item is the last item in the menu. This method does not accept any arguments.
`public`	# `Next( $event = null )` Moves active state to next menu item. Moves active state to next menu item. event Type: Event What triggered the focus to move. Parameters `$event`
`public`	# `NextPage( $event = null )` Moves active state to first menu item below the bottom of a scrollable menu or the last item if not scrollable. Moves active state to first menu item below the bottom of a scrollable menu or the last item if not scrollable. event Type: Event What triggered the focus to move. Parameters `$event`
`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 menu options hash. Gets an object containing key/value pairs representing the current menu options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the menu option associated with the specified optionName. Sets the value of the menu 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 menu. Sets one or more options for the menu. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Previous( $event = null )` Moves active state to previous menu item. Moves active state to previous menu item. event Type: Event What triggered the focus to move. Parameters `$event`
`public`	# `PreviousPage( $event = null )` Moves active state to first menu item above the top of a scrollable menu or the first item if not scrollable. Moves active state to first menu item above the top of a scrollable menu or the first item if not scrollable. event Type: Event What triggered the focus to move. Parameters `$event`
`public`	# `Refresh( )` Initializes sub-menus and menu items that have not already been initialized. New menu items, including sub-menus can be added to the menu or all of the contents of the menu can be replaced and then initialized with the refresh() method. Initializes sub-menus and menu items that have not already been initialized. New menu items, including sub-menus can be added to the menu or all of the contents of the menu can be replaced and then initialized with the refresh() method. This method does not accept any arguments. Overrides `QControlBase::Refresh()`
`public`	# `Select( $event = null )` Selects the currently active menu item, collapses all sub-menus and triggers the menus select event. Selects the currently active menu item, collapses all sub-menus and triggers the menus select event. event Type: Event What triggered the selection. Parameters `$event`
`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(), 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(), 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 boolean`	`$blnDisabled`	# `null`
`protected mixed`	`$mixIcons`	# `null`
`protected string`	`$strItems`	# `null`
`protected string`	`$strMenus`	# `null`
`protected mixed`	`$mixPosition`	# `null`
`protected string`	`$strRole`	# `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 boolean`	`$Disabled` Disables the menu if set to true.
`public mixed`	`$Icons` Icons to use for submenus, matching an icon provided by the jQuery UI CSS Framework. * submenu (string, default: "ui-icon-carat-1-e")
`public string`	`$Items` Selector for the elements that serve as the menu items. Note: The items option should not be changed after initialization. (version added: 1.11.0)
`public string`	`$Menus` Selector for the elements that serve as the menu container, including sub-menus. Note: The menus option should not be changed after initialization. Existing submenus will not be updated.
`public mixed`	`$Position` Identifies the position of submenus in relation to the associated parent menu item. The of option defaults to the parent menu item, but you can specify another element to position against. You can refer to the jQuery UI Position utility for more details about the various options.
`public string`	`$Role` Customize the ARIA roles used for the menu and menu items. The default uses "menuitem" for items. Setting the role option to "listbox" will use "option" for items. If set to null, no roles will be set, which is useful if the menu is being controlled by another element that is maintaining focus. Note: The role option should not be changed after initialization. Existing (sub)menus and menu items will not be updated.

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

Packages

Classes

Class QMenuGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Parameters

Overrides

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Overrides

Parameters

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides