CJuiAccordion

Package	zii.widgets.jui
Inheritance	class CJuiAccordion » CJuiWidget » CWidget » CBaseController » CComponent
Since	1.1
Source Code	framework/zii/widgets/jui/CJuiAccordion.php

CJuiAccordion displays an accordion widget.

CJuiAccordion encapsulates the JUI Accordion plugin.

To use this widget, you may insert the following code in a view:

$this->widget('zii.widgets.jui.CJuiAccordion',array(
    'panels'=>array(
        'panel 1'=>'content for panel 1',
        'panel 2'=>'content for panel 2',
        // panel 3 contains the content rendered by a partial view
        'panel 3'=>$this->renderPartial('_partial',null,true),
    ),
    // additional javascript options for the accordion plugin
    'options'=>array(
        'animate'=>'bounceslide',
    ),
));

By configuring the options property, you may specify the options that need to be passed to the JUI accordion plugin. Please refer to the JUI Accordion API documentation for possible options (name-value pairs) and JUI Accordion page for general description and demo.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
actionPrefix	string	the prefix to the IDs of the actions.	CWidget
contentTemplate	string	the template that is used to generated every panel content.	CJuiAccordion
controller	CController	Returns the controller that this widget belongs to.	CWidget
cssFile	mixed	the theme CSS file name.	CJuiWidget
headerTemplate	string	the template that is used to generated every panel header.	CJuiAccordion
htmlOptions	array	the HTML attributes that should be rendered in the HTML tag representing the JUI widget.	CJuiWidget
id	string	Returns the ID of the widget or generates a new one if requested.	CWidget
options	array	the initial JavaScript options that should be passed to the JUI plugin.	CJuiWidget
owner	CBaseController	Returns the owner/creator of this widget.	CWidget
panels	array	list of panels (panel title=>panel content).	CJuiAccordion
scriptFile	mixed	the main JUI JavaScript file.	CJuiWidget
scriptUrl	string	the root URL that contains all JUI JavaScript files.	CJuiWidget
skin	mixed	the name of the skin to be used by this widget.	CWidget
tagName	string	the name of the container element that contains all panels.	CJuiAccordion
theme	string	the JUI theme name.	CJuiWidget
themeUrl	string	the root URL that contains all JUI theme folders.	CJuiWidget
viewPath	string	Returns the directory containing the view files for this widget.	CWidget

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	CComponent
__construct()	Constructor.	CWidget
__get()	Returns a property value, an event handler list or a behavior based on its name.	CComponent
__isset()	Checks if a property value is null.	CComponent
__set()	Sets value of a component property.	CComponent
__unset()	Sets a component property to be null.	CComponent
actions()	Returns a list of actions that are used by this widget.	CWidget
asa()	Returns the named behavior object.	CComponent
attachBehavior()	Attaches a behavior to this component.	CComponent
attachBehaviors()	Attaches a list of behaviors to the component.	CComponent
attachEventHandler()	Attaches an event handler to an event.	CComponent
beginCache()	Begins fragment caching.	CBaseController
beginClip()	Begins recording a clip.	CBaseController
beginContent()	Begins the rendering of content that is to be decorated by the specified view.	CBaseController
beginWidget()	Creates a widget and executes it.	CBaseController
canGetProperty()	Determines whether a property can be read.	CComponent
canSetProperty()	Determines whether a property can be set.	CComponent
createWidget()	Creates a widget and initializes it.	CBaseController
detachBehavior()	Detaches a behavior from the component.	CComponent
detachBehaviors()	Detaches all behaviors from the component.	CComponent
detachEventHandler()	Detaches an existing event handler.	CComponent
disableBehavior()	Disables an attached behavior.	CComponent
disableBehaviors()	Disables all behaviors attached to this component.	CComponent
enableBehavior()	Enables an attached behavior.	CComponent
enableBehaviors()	Enables all behaviors attached to this component.	CComponent
endCache()	Ends fragment caching.	CBaseController
endClip()	Ends recording a clip.	CBaseController
endContent()	Ends the rendering of content.	CBaseController
endWidget()	Ends the execution of the named widget.	CBaseController
evaluateExpression()	Evaluates a PHP expression or callback under the context of this component.	CComponent
getController()	Returns the controller that this widget belongs to.	CWidget
getEventHandlers()	Returns the list of attached event handlers for an event.	CComponent
getId()	Returns the ID of the widget or generates a new one if requested.	CWidget
getOwner()	Returns the owner/creator of this widget.	CWidget
getViewFile()	Looks for the view script file according to the view name.	CWidget
getViewPath()	Returns the directory containing the view files for this widget.	CWidget
hasEvent()	Determines whether an event is defined.	CComponent
hasEventHandler()	Checks whether the named event has attached handlers.	CComponent
hasProperty()	Determines whether a property is defined.	CComponent
init()	Initializes the widget.	CJuiWidget
raiseEvent()	Raises an event.	CComponent
render()	Renders a view.	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	Run this widget.	CJuiAccordion
setId()	Sets the ID of the widget.	CWidget
widget()	Creates a widget and executes it.	CBaseController

Protected Methods

Hide inherited methods

Method	Description	Defined By
registerCoreScripts()	Registers the core script files.	CJuiWidget
registerScriptFile()	Registers a JavaScript file under scriptUrl.	CJuiWidget
resolvePackagePath()	Determine the JUI package installation path.	CJuiWidget

Property Details

contentTemplate property

public string $contentTemplate;

the template that is used to generated every panel content. The token "{content}" in the template will be replaced with the panel content.

headerTemplate property

public string $headerTemplate;

the template that is used to generated every panel header. The token "{title}" in the template will be replaced with the panel title. Note that if you make change to this template, you may also need to adjust the 'header' setting in options.

panels property

public array $panels;

list of panels (panel title=>panel content). Note that neither panel title nor panel content will be HTML-encoded.

tagName property

public string $tagName;

the name of the container element that contains all panels. Defaults to 'div'.

Method Details

run() method

public void run()

Source Code: framework/zii/widgets/jui/CJuiAccordion.php#76 (show)


public function run()
{
    $id=$this->getId();
    if(isset($this->htmlOptions['id']))
        $id=$this->htmlOptions['id'];
    else
        $this->htmlOptions['id']=$id;

    echo CHtml::openTag($this->tagName,$this->htmlOptions)."\n";
    foreach($this->panels as $title=>$content)
    {
        echo strtr($this->headerTemplate,array('{title}'=>$title))."\n";
        echo strtr($this->contentTemplate,array('{content}'=>$content))."\n";
    }
    echo CHtml::closeTag($this->tagName);

    $options=CJavaScript::encode($this->options);
    Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').accordion($options);");
}

Run this widget. This method registers necessary javascript and renders the needed HTML code.

User Contributed Notes