Class \Prado\Web\UI\WebControls\TAccordion

Class TAccordion.

TAccordion displays an accordion control. Users can click on the view headers to switch among different accordion views. Each accordion view is an independent panel that can contain arbitrary content.

A TAccordion control consists of one or several TAccordionView controls representing the possible accordion views. At any time, only one accordion view is visible (active), which is specified by any of the following properties:

\Prado\Web\UI\WebControls\setActiveViewIndex - the zero-based integer index of the view in the view collection.
\Prado\Web\UI\WebControls\setActiveViewID - the text ID of the visible view.
\Prado\Web\UI\WebControls\setActiveView - the visible view instance. If both \Prado\Web\UI\WebControls\setActiveViewIndex and \Prado\Web\UI\WebControls\setActiveViewID are set, the latter takes precedence.

TAccordion uses CSS to specify the appearance of the accordion headers and panel. By default, an embedded CSS file will be published which contains the default CSS for TTabPanel. You may also use your own CSS file by specifying the \Prado\Web\UI\WebControls\setCssUrl property. The following properties specify the CSS classes used for elements in a TAccordion:

\Prado\Web\UI\WebControls\setCssClass - the CSS class name for the outer-most div element (defaults to 'accordion');
\Prado\Web\UI\WebControls\setHeaderCssClass - the CSS class name for nonactive accordion div elements (defaults to 'accordion-header');
\Prado\Web\UI\WebControls\setActiveHeaderCssClass - the CSS class name for the active accordion div element (defaults to 'accordion-header-active');
\Prado\Web\UI\WebControls\setViewCssClass - the CSS class for the div element enclosing view content (defaults to 'accordion-view');

When the user clicks on a view header, the switch between the old visible view and the clicked one is animated. You can use the \Prado\Web\UI\WebControls\setAnimationDuration property to set the animation length in seconds; it defaults to 1 second, and when set to 0 it will produce an immediate switch with no animation.

The TAccordion auto-sizes itself to the largest of all views, so it can encompass all of them without scrolling. If you want to specify a fixed height (in pixels), use the \Prado\Web\UI\WebControls\setViewHeight property. When a TAccordion is nested inside another, it's adviced to manually specify a \Prado\Web\UI\WebControls\setViewHeight for the internal TAccordion

To use TAccordion, write a template like following:

<com:TAccordion>
  <com:TAccordionView Caption="View 1">
    content for view 1
  </com:TAccordionView>
  <com:TAccordionView Caption="View 2">
    content for view 2
  </com:TAccordionView>
  <com:TAccordionView Caption="View 3">
    content for view 3
  </com:TAccordionView>
</com:TAccordion>

Class hierarchy

\Prado\Web\UI\WebControls\TAccordion implements IPostBackDataHandler

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Gabor Berczi, DevWorx Hungary <gabor.berczi@devworx.hu>
Since: 3.2

Methods summary
`public`	`addParsedObject(mixed $object) : mixed` Adds object parsed from template to the control. This method adds only TAccordionView objects into the \Prado\Web\UI\WebControls\getViews collection. All other objects are ignored.
`public`	`getActiveHeaderCssClass() : string`
`public`	`getActiveHeaderStyle() : TStyle`
`public`	`getActiveView() : TAccordionView` Returns the currently active view. This method will examin the ActiveViewID, ActiveViewIndex and Views collection to determine which view is currently active. It will update ActiveViewID and ActiveViewIndex accordingly.
`public`	`getActiveViewID() : string` Returns the ID of the active accordion view. Note, this property may not return the correct ID. To ensure the correctness, call getActiveView() first.
`public`	`getActiveViewIndex() : int` Returns the index of the active accordion view. Note, this property may not return the correct index. To ensure the correctness, call getActiveView() first.
`public`	`getAnimationDuration() : string`
`public`	`getCssClass() : string`
`public`	`getCssUrl() : string`
`public`	`getDataChanged() : bool` Returns a value indicating whether postback has caused the control data change. This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
`public`	`getHeaderCssClass() : string`
`public`	`getHeaderStyle() : TStyle`
`public`	`getViewCssClass() : string`
`public`	`getViewHeight() : int`
`public`	`getViews() : TAccordionViewCollection`
`public`	`getViewStyle() : TStyle`
`public`	`loadPostData(string $key, array<string\|int, mixed> $values) : bool` Loads user input data. This method is primarly used by framework developers.
`public`	`onPreRender(mixed $param) : mixed` Registers CSS and JS. This method is invoked right before the control rendering, if the control is visible.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method is required by IPostBackDataHandler interface. It is invoked by the framework when \Prado\Web\UI\WebControls\getActiveViewIndex property is changed on postback. This method is primarly used by framework developers.
`public`	`render(mixed $writer) : mixed` Renders the control. This method overrides the parent implementation by replacing it with the following sequence: renderBeginTag renderContents renderEndTag
`public`	`renderContents(THtmlWriter $writer) : mixed` Renders body contents of the accordion control.
`public`	`setActiveHeaderCssClass(string $value) : mixed`
`public`	`setActiveView(TAccordionView $view) : mixed`
`public`	`setActiveViewID(string $value) : mixed`
`public`	`setActiveViewIndex(int $value) : mixed`
`public`	`setAnimationDuration(string $value) : mixed`
`public`	`setCssUrl(string $value) : mixed`
`public`	`setHeaderCssClass(string $value) : mixed`
`public`	`setViewCssClass(string $value) : mixed`
`public`	`setViewHeight(int $value) : mixed`
`protected`	`activateView(TAccordionView $view) : mixed` Activates the specified view. If there is any other view currently active, it will be deactivated.
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds attributes to renderer.
`protected`	`createControlCollection() : TAccordionViewCollection` Creates a control collection object that is to be used to hold child controls
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getClientOptions() : array<string\|int, mixed>`
`protected`	`getTagName() : string` Returns the tag name used for this control.
`protected`	`registerClientScript() : mixed` Registers the relevant JavaScript.
`protected`	`registerStyleSheet() : mixed` Registers the CSS relevant to the TAccordion. It will register the CSS file specified by \Prado\Web\UI\WebControls\getCssUrl. If that is not set, it will use the default CSS.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TAccordion

Class hierarchy