CTreeView

Property Details

animated property

public string|integer $animated;

animation speed. This can be one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). If not set, no animation is used.

clientOptions property read-only

protected array getClientOptions()

the javascript options

collapsed property

public boolean $collapsed;

whether the tree should start with all branches collapsed. Defaults to false.

control property

public string $control;

container for a tree-control, allowing the user to expand, collapse and toggle all branches with one click. In the container, clicking on the first hyperlink will collapse the tree; the second hyperlink will expand the tree; while the third hyperlink will toggle the tree. The property should be a valid jQuery selector (e.g. '#treecontrol' where 'treecontrol' is the ID of the 'div' element containing the hyperlinks.)

cookieId property

public string $cookieId;

The cookie name to use when persisting via persist:"cookie". Defaults to 'treeview'.

cssFile property

public mixed $cssFile;

the CSS file used for the widget. Defaults to null, meaning using the default CSS file included together with the widget. If false, no CSS file will be used. Otherwise, the specified CSS file will be included when using this widget.

data property

public array $data;

the data that can be used to generate the tree view content. Each array element corresponds to a tree view node with the following structure:

• text: string, required, the HTML text associated with this node.
• expanded: boolean, optional, whether the tree view node is expanded.
• id: string, optional, the ID identifying the node. This is used in dynamic loading of tree view (see url).
• hasChildren: boolean, optional, defaults to false, whether clicking on this node should trigger dynamic loading of more tree view nodes from server. The url property must be set in order to make this effective.
• children: array, optional, child nodes of this node.
• htmlOptions: array, additional HTML attributes (see CHtml::tag). This option has been available since version 1.1.7.

htmlOptions property

public array $htmlOptions;

additional HTML attributes that will be rendered in the UL tag. The default tree view CSS has defined the following CSS classes which can be enabled by specifying the 'class' option here:

• treeview-black
• treeview-gray
• treeview-red
• treeview-famfamfam
• filetree

options property

public array $options;

additional options that can be passed to the constructor of the treeview js object.

persist property

public string $persist;

Persist the tree state in cookies or the page location. If set to "location", looks for the anchor that matches location.href and activates that part of the treeview it. Great for href-based state-saving. If set to "cookie", saves the state of the tree on each click to a cookie and restores that state on page load.

prerendered property

public boolean $prerendered;

Set to skip rendering of classes and hitarea divs, assuming that is done by the serverside. Defaults to false.

toggle property

public string $toggle;

Callback when toggling a branch. Arguments: "this" refers to the UL that was shown or hidden

unique property

public boolean $unique;

set to allow only one branch on one level to be open (closing siblings which opening). Defaults to false.

url property

public string|array $url;

the URL to which the treeview can be dynamically loaded (in AJAX). See CHtml::normalizeUrl for possible URL formats. Setting this property will enable the dynamic treeview loading. When the page is displayed, the browser will request this URL with a GET parameter named 'root' whose value is 'source'. The server script should then generate the needed tree view data corresponding to the root of the tree (see saveDataAsJson.) When a node has a CSS class 'hasChildren', then expanding this node will also cause a dynamic loading of its child nodes. In this case, the value of the 'root' GET parameter is the 'id' property of the node.

Method Details

getClientOptions() method

protected array getClientOptions()

protected function getClientOptions()
{
    $options=$this->options;
    foreach(array('url','animated','collapsed','control','unique','toggle','persist','cookieId','prerendered') as $name)
    {
        if($this->$name!==null)
            $options[$name]=$this->$name;
    }
    return $options;
}

init() method

public void init()

public function init()
{
    if(isset($this->htmlOptions['id']))
        $id=$this->htmlOptions['id'];
    else
        $id=$this->htmlOptions['id']=$this->getId();
    if($this->url!==null)
        $this->url=CHtml::normalizeUrl($this->url);
    $cs=Yii::app()->getClientScript();
    $cs->registerCoreScript('treeview');
    $options=$this->getClientOptions();
    $options=$options===array()?'{}' : CJavaScript::encode($options);
    $cs->registerScript('Yii.CTreeView#'.$id,"jQuery(\"#{$id}\").treeview($options);");
    if($this->cssFile===null)
        $cs->registerCssFile($cs->getCoreScriptUrl().'/treeview/jquery.treeview.css');
    elseif($this->cssFile!==false)
        $cs->registerCssFile($this->cssFile);

    echo CHtml::tag('ul',$this->htmlOptions,false,false)."\n";
    echo self::saveDataAsHtml($this->data);
}

Initializes the widget. This method registers all needed client scripts and renders the tree view content.

run() method

public void run()

public function run()
{
    echo "</ul>";
}

Ends running the widget.

saveDataAsHtml() method

public static string saveDataAsHtml(array $data)

public static function saveDataAsHtml($data)
{
    $html='';
    if(is_array($data))
    {
        foreach($data as $node)
        {
            if(!isset($node['text']))
                continue;

            if(isset($node['expanded']))
                $css=$node['expanded'] ? 'open' : 'closed';
            else
                $css='';

            if(isset($node['hasChildren']) && $node['hasChildren'])
            {
                if($css!=='')
                    $css.=' ';
                $css.='hasChildren';
            }

            $options=isset($node['htmlOptions']) ? $node['htmlOptions'] : array();
            if($css!=='')
            {
                if(isset($options['class']))
                    $options['class'].=' '.$css;
                else
                    $options['class']=$css;
            }

            if(isset($node['id']))
                $options['id']=$node['id'];

            $html.=CHtml::tag('li',$options,$node['text'],false);
            if(!empty($node['children']))
            {
                $html.="\n<ul>\n";
                $html.=self::saveDataAsHtml($node['children']);
                $html.="</ul>\n";
            }
            $html.=CHtml::closeTag('li')."\n";
        }
    }
    return $html;
}

Generates tree view nodes in HTML from the data array.

saveDataAsJson() method

public static string saveDataAsJson(array $data)

public static function saveDataAsJson($data)
{
    if(empty($data))
        return '[]';
    else
        return CJavaScript::jsonEncode($data);
}

Saves tree view data in JSON format. This method is typically used in dynamic tree view loading when the server code needs to send to the client the dynamic tree view data.