• Home
• Prado
• Web
• UI
• WebControls
• TAccordion

PHP Class Prado\Web\UI\WebControls\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 {@link 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: - {@link setActiveViewIndex ActiveViewIndex} - the zero-based integer index of the view in the view collection. - {@link setActiveViewID ActiveViewID} - the text ID of the visible view. - {@link setActiveView ActiveView} - the visible view instance. If both {@link setActiveViewIndex ActiveViewIndex} and {@link setActiveViewID ActiveViewID} 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 {@link setCssUrl CssUrl} property. The following properties specify the CSS classes used for elements in a TAccordion: - {@link setCssClass CssClass} - the CSS class name for the outer-most div element (defaults to 'accordion'); - {@link setHeaderCssClass HeaderCssClass} - the CSS class name for nonactive accordion div elements (defaults to 'accordion-header'); - {@link setActiveHeaderCssClass ActiveHeaderCssClass} - the CSS class name for the active accordion div element (defaults to 'accordion-header-active'); - {@link setViewCssClass ViewCssClass} - 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 {@link setAnimationDuration AnimationDuration} 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 {@link setViewHeight ViewHeight} property. When a TAccordion is nested inside another, it's adviced to manually specify a {@link setViewHeight ViewHeight} for the internal TAccordion To use TAccordion, write a template like following: content for view 1 content for view 2 content for view 3 Datei anzeigen Open project: pradosoft/prado

Public Methods

Method	Description
addParsedObject ( $object )	Adds object parsed from template to the control.
getActiveHeaderCssClass ( ) : string
getActiveHeaderStyle ( ) : TStyle
getActiveView ( ) : TAccordionView	Returns the currently active view.
getActiveViewID ( ) : string	Returns the ID of the active accordion view.
getActiveViewIndex ( ) : integer	Returns the index of the active accordion view.
getAnimationDuration ( ) : string
getCssClass ( ) : string
getCssUrl ( ) : string
getDataChanged ( ) : boolean	Returns a value indicating whether postback has caused the control data change.
getHeaderCssClass ( ) : string
getHeaderStyle ( ) : TStyle
getViewCssClass ( ) : string
getViewHeight ( ) : integer
getViewStyle ( ) : TStyle
getViews ( ) : TAccordionViewCollection
loadPostData ( $key, $values ) : boolean	Loads user input data.
onPreRender ( $param )	Registers CSS and JS.
raisePostDataChangedEvent ( )	Raises postdata changed event.
render ( $writer )
renderContents ( $writer )	Renders body contents of the accordion control.
setActiveHeaderCssClass ( $value )
setActiveView ( $view )
setActiveViewID ( $value )
setActiveViewIndex ( $value )
setAnimationDuration ( $value )
setCssUrl ( $value )
setHeaderCssClass ( $value )
setViewCssClass ( $value )
setViewHeight ( $value )

Protected Methods

Method	Description
activateView ( $view )	Activates the specified view.
addAttributesToRender ( $writer )	Adds attributes to renderer.
createControlCollection ( ) : TAccordionViewCollection	Creates a control collection object that is to be used to hold child controls
getClientClassName ( ) : string	Gets the name of the javascript class responsible for performing postback for this control.
getClientOptions ( ) : array
getTagName ( ) : string
registerClientScript ( )	Registers the relevant JavaScript.
registerStyleSheet ( )	Registers the CSS relevant to the TAccordion.

Method Details