Class QAccordionGen

Generated QAccordionGen class.

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

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QBlockControl

QPanel

QAccordionGen

Direct known subclasses

QAccordionBase

Indirect known subclasses

QAccordion

Package: Controls\Base
See: QAccordionBase
Located at includes/base_controls/QAccordionGen.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 accordion functionality completely. This will return the element back to its pre-init state. Removes the accordion functionality completely. This will return the element back to its pre-init state. This method does not accept any arguments.
`public`	# `Disable( )` Disables the accordion. Disables the accordion. This method does not accept any arguments.
`public`	# `Enable( )` Enables the accordion. Enables the accordion. This method does not accept any arguments.
`public`	# `Instance( )` Retrieves the accordions instance object. If the element does not have an associated instance, undefined is returned. Retrieves the accordions 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 accordion 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 accordion options hash. Gets an object containing key/value pairs representing the current accordion options hash. This signature does not accept any arguments.
`public`	# `Option2( $optionName, $value )` Sets the value of the accordion option associated with the specified optionName. Sets the value of the accordion 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 accordion. Sets one or more options for the accordion. options Type: Object A map of option-value pairs to set. Parameters `$options`
`public`	# `Refresh( )` Process any headers and panels that were added or removed directly in the DOM and recompute the height of the accordion panels. Results depend on the content and the heightStyle option. Process any headers and panels that were added or removed directly in the DOM and recompute the height of the accordion 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 mixed`	`$mixAnimate`	# `null`
`protected boolean`	`$blnCollapsible`	# `null`
`protected boolean`	`$blnDisabled`	# `null`
`protected string`	`$strEvent`	# `null`
`protected mixed`	`$mixHeader`	# `null`
`protected string`	`$strHeightStyle`	# `null`
`protected mixed`	`$mixIcons`	# `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 mixed`	`$Animate` If and how to animate changing panels.Multiple types supported: * Boolean: A value of false will disable animations. * Number: Duration in milliseconds with default easing. * String: Name of easing to use with default duration. * Object: An object containing easing and duration properties to configure animations. * Can also contain a down property with any of the above options. * "Down" animations occur when the panel being activated has a lower index than the currently active panel.
`public boolean`	`$Collapsible` Whether all the sections can be closed at once. Allows collapsing the active section.
`public boolean`	`$Disabled` Disables the accordion if set to true.
`public string`	`$Event` The event that accordion headers will react to in order to activate the associated panel. Multiple events can be specified, separated by a space.
`public mixed`	`$Header` Selector for the header element, applied via .find() on the main accordion element. Content panels must be the sibling immediately after their associated headers.
`public string`	`$HeightStyle` Controls the height of the accordion 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 accordions parent height. * "content": Each panel will be only as tall as its content.
`public mixed`	`$Icons` Icons to use for headers, matching an icon provided by the jQuery UI CSS Framework. Set to false to have no icons displayed. * header (string, default: "ui-icon-triangle-1-e") * activeHeader (string, default: "ui-icon-triangle-1-s")

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 QAccordionGen

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Overrides

Parameters

Parameters

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides