Class QTabsGen

Generated QTabsGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QBlockControl

QPanel

QTabsGen

Direct known subclasses

QTabsBase

Indirect known subclasses

QTabs

Package: Controls\Base
See: QTabsBase
Located at includes/base_controls/QTabsGen.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`	# `Destroy( )` Removes the tabs functionality completely. This will return the element back to its pre-init state. Removes the tabs functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables all tabs. Disables all tabs. This signature does not accept any arguments.
`public`	# `Disable1( $index )` Disables a tab. The selected tab cannot be disabled. To disable more than one tab at once, set the disabled option: $( "#tabs" ).tabs( "option", "disabled", [ 1, 2, 3 ] ). Disables a tab. The selected tab cannot be disabled. To disable more than one tab at once, set the disabled option: $( "#tabs" ).tabs( "option", "disabled", [ 1, 2, 3 ] ). index Type: Number The zero-based index of the tab to disable. Parameters `$index`
`public`	# `Disable2( $href )` Disables a tab. The selected tab cannot be disabled. Disables a tab. The selected tab cannot be disabled. href Type: String The href of the tab to disable. Parameters `$href`
`public`	# `Enable( )` Enables all tabs. Enables all tabs. This signature does not accept any arguments.
`public`	# `Enable1( $index )` Enables a tab. To enable more than one tab at once reset the disabled property like: $( "#example" ).tabs( "option", "disabled", [] );. Enables a tab. To enable more than one tab at once reset the disabled property like: $( "#example" ).tabs( "option", "disabled", [] );. index Type: Number The zero-based index of the tab to enable. Parameters `$index`
`public`	# `Enable2( $href )` Enables a tab. Enables a tab. href Type: String The href of the tab to enable. Parameters `$href`
`public`	# `Instance( )` Retrieves the tabss instance object. If the element does not have an associated instance, undefined is returned. Retrieves the tabss 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 tabs plugin has loaded. * This method does not accept any arguments.
`public`	# `Load( $index )` Loads the panel content of a remote tab. Loads the panel content of a remote tab. index Type: Number The zero-based index of the tab to load. Parameters `$index`
`public`	# `Load1( $href )` Loads the panel content of a remote tab. Loads the panel content of a remote tab. href Type: String The href of the tab to load. Parameters `$href`
`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 tabs options hash. Gets an object containing key/value pairs representing the current tabs options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the tabs option associated with the specified optionName. Sets the value of the tabs 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 tabs. Sets one or more options for the tabs. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Refresh( )` Process any tabs that were added or removed directly in the DOM and recompute the height of the tab panels. Results depend on the content and the heightStyle option. Process any tabs that were added or removed directly in the DOM and recompute the height of the tab panels. Results depend on the content and the heightStyle option. This method does not accept any arguments. Overrides `QControlBase::Refresh()`
`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(), 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`	`$mixActive`	#
`protected boolean`	`$blnCollapsible`	# `null`
`protected mixed`	`$mixDisabled`	# `null`
`protected string`	`$strEvent`	# `null`
`protected string`	`$strHeightStyle`	# `null`
`protected mixed`	`$mixHide`	# `null`
`protected mixed`	`$mixShow`	# `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`	`$Active` Which panel is currently open.Multiple types supported: * Boolean: Setting active to false will collapse all panels. This requires the collapsible option to be true. * Integer: The zero-based index of the panel that is active (open). A negative value selects panels going backward from the last panel.
`public boolean`	`$Collapsible` When set to true, the active panel can be closed.
`public mixed`	`$Disabled` Which tabs are disabled.Multiple types supported: * Boolean: Enable or disable all tabs. * Array: An array containing the zero-based indexes of the tabs that should be disabled, e.g., [ 0, 2 ] would disable the first and third tab.
`public string`	`$Event` The type of event that the tabs should react to in order to activate the tab. To activate on hover, use "mouseover".
`public string`	`$HeightStyle` Controls the height of the tabs widget and each panel. Possible values: * "auto": All panels will be set to the height of the tallest panel. * "fill": Expand to the available height based on the tabs parent height. * "content": Each panel will be only as tall as its content.
`public mixed`	`$Hide` If and how to animate the hiding of the panel.Multiple types supported: * Boolean: When set to false, no animation will be used and the panel will be hidden immediately. When set to true, the panel will fade out with the default duration and the default easing. * Number: The panel will fade out with the specified duration and the default easing. * String: The panel 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 mixed`	`$Show` If and how to animate the showing of the panel.Multiple types supported: * Boolean: When set to false, no animation will be used and the panel will be shown immediately. When set to true, the panel will fade in with the default duration and the default easing. * Number: The panel will fade in with the specified duration and the default easing. * String: The panel 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.

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

Packages

Classes

Class QTabsGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides