CTreeView

Подробное описание свойств

animated свойство

public string|integer $animated;

Скорость анимации. Может быть одним из трех предопределенных значений ("медленно", "нормально" или "быстро") или числом миллисекунд для выполнения анимации (например, 1000). Если не задано, анимация не используется.

clientOptions свойство только для чтения

protected array getClientOptions()

javascript параметры

collapsed свойство

public boolean $collapsed;

Указывает, должны ли все ветви дерева начинаться в свернутом виде. По умолчанию false.

control свойство

public string $control;

Контейнер для древовидного управления, позволяющий пользователю раскрывать, сворачивать и переключать все ветви одним щелчком. В контейнере щелчок по первой гиперссылке свернёт дерево; второй гиперссылке — развернёт дерево; а третья — переключит дерево. Свойство должно быть корректным селектором jQuery (например, '#treecontrol', где 'treecontrol' — ID элемента 'div', содержащего гиперссылки.)

cookieId свойство

public string $cookieId;

Имя cookie, используемое при сохранении состояния с помощью persist:"cookie". По умолчанию 'treeview'.

cssFile свойство

public mixed $cssFile;

Файл CSS, используемый для виджета. По умолчанию null, что означает использование файла CSS по умолчанию, включённого вместе с виджетом. Если false, файл CSS не будет использоваться. В противном случае, указанный файл CSS будет включён при использовании этого виджета.

data свойство

public array $data;

данные, которые могут быть использованы для генерации содержимого виджета дерева. Каждый элемент массива соответствует узлу виджета дерева со следующей структурой:

• text: строка, обязательная, HTML-текст, связанный с этим узлом.
• expanded: булево, необязательное, расширен ли узел виджета дерева.
• id: строка, необязательная, идентификатор, определяющий узел. Используется при динамической загрузке дерева (см. url).
• hasChildren: булево, необязательное, по умолчанию false, указывает, должно ли нажатие на этот узел инициировать динамическую загрузку дополнительных узлов дерева с сервера. Свойство url должно быть установлено для корректной работы.
• children: массив, необязательный, дочерние узлы этого узла.
• htmlOptions: массив, дополнительные атрибуты HTML (см. CHtml::tag). Доступно с версии 1.1.7.

htmlOptions свойство

public array $htmlOptions;

дополнительные атрибуты HTML, которые будут отображаться в теге UL. В стандартной CSS-стилизации виджета дерева определены следующие классы CSS, которые могут быть включены путём указания параметра 'class' здесь:

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

options свойство

public array $options;

дополнительные параметры, которые могут быть переданы в конструктор объекта js treeview.

persist свойство

public string $persist;

Сохранять состояние дерева в куки или в местоположении страницы. Если установлено "location", ищет якорь, соответствующий location.href, и активирует соответствующую часть дерева. Идеально подходит для сохранения состояния с помощью href. Если установлено "cookie", сохраняет состояние дерева при каждом щелчке в куки и восстанавливает это состояние при загрузке страницы.

prerendered свойство

public boolean $prerendered;

Устанавливается для пропуска рендеринга классов и областей клика, предполагая, что это выполняется на стороне сервера. По умолчанию false.

toggle свойство

public string $toggle;

Обработчик событий при переключении ветви. Аргументы: "this" ссылается на UL, который был показан или скрыт.

unique свойство

public boolean $unique;

Устанавливается для разрешения открытия только одной ветви на одном уровне (закрытие родственных элементов при открытии). По умолчанию false.

url свойство

public string|array $url;

URL, на который виджет дерева может быть динамически загружен (с помощью AJAX). Смотрите CHtml::normalizeUrl для возможных форматов URL. Установка этого свойства активирует динамическую загрузку дерева. При отображении страницы браузер запросит этот URL с параметром GET под названием 'root' со значением 'source'. Скрипт на сервере должен затем сгенерировать необходимые данные дерева, соответствующие корню дерева (см. saveDataAsJson). Если у узла есть CSS-класс 'hasChildren', то раскрытие этого узла также вызовет динамическую загрузку его дочерних узлов. В этом случае значение параметра GET 'root' будет равным свойству 'id' узла.

Подробное описание методов

getClientOptions() метод

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() метод

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);
}

Инициализирует виджет. Этот метод регистрирует все необходимые скрипты клиента и рендерит содержимое дерева.

run() метод

public void run()

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

Завершает выполнение виджета.

saveDataAsHtml() метод

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;
}

Генерирует узлы дерева в формате HTML из массива данных.

saveDataAsJson() метод

public static string saveDataAsJson(array $data)

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

Сохраняет данные дерева в формате JSON. Этот метод обычно используется при динамической загрузке дерева, когда серверу необходимо отправить клиенту данные динамического дерева.