Класс yii\jui\Tabs
| Наследование | yii\jui\Tabs » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-jui/blob/master/Tabs.php |
Tabs отображает виджет jQuery UI «вкладки».
Например:
echo Tabs::widget([
'items' => [
[
'label' => 'Tab one',
'content' => 'Mauris mauris ante, blandit et, ultrices a, suscipit eget...',
],
[
'label' => 'Tab two',
'content' => 'Sed non urna. Phasellus eu ligula. Vestibulum sit amet purus...',
'options' => ['tag' => 'div'],
'headerOptions' => ['class' => 'my-class'],
],
[
'label' => 'Tab with custom id',
'content' => 'Morbi tincidunt, dui sit amet facilisis feugiat...',
'options' => ['id' => 'my-tab'],
],
[
'label' => 'Ajax tab',
'url' => ['ajax/content'],
],
],
'options' => ['tag' => 'div'],
'itemOptions' => ['tag' => 'div'],
'headerOptions' => ['class' => 'my-class'],
'clientOptions' => ['collapsible' => false],
]);
См. также http://api.jqueryui.com/tabs/.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединенных к этому компоненту поведений. | yii\base\Component |
| $clientEvents | массив | Обработчики событий для основного виджета jQuery UI. | yii\jui\Widget |
| $clientOptions | массив | Параметры для основного виджета jQuery UI. | yii\jui\Widget |
| $counter | целое число | Счетчик, используемый для генерации $id виджетов. | yii\base\Widget |
| $encodeLabels | логическое | Нужно ли кодировать метки элементов заголовка в HTML. | yii\jui\Tabs |
| $headerOptions | массив | Список атрибутов HTML для тегов контейнера заголовка. | yii\jui\Tabs |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $itemOptions | массив | Список атрибутов HTML для тегов контейнера элементов. | yii\jui\Tabs |
| $items | массив | Список элементов вкладок. | yii\jui\Tabs |
| $linkTemplate | строка | Шаблон по умолчанию для рендеринга ссылки. | yii\jui\Tabs |
| $options | массив | Атрибуты HTML для тега контейнера виджета. | yii\jui\Tabs |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время рендерятся (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Защищенные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $clientEventMap | массив | Имена событий, сопоставленные с тем, что должно быть указано в `. | yii\jui\Widget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызов метода, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начало выполнения виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли считать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершение работы виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики, прикрепленные к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\jui\Widget |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\jui\Tabs |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создает экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| registerClientEvents() | Регистрирует определенные события виджета jQuery UI. | yii\jui\Widget |
| registerClientOptions() | Регистрирует определенные параметры виджета jQuery UI. | yii\jui\Widget |
| registerWidget() | Регистрирует определенный пакет ресурсов виджета jQuery UI, инициализирует его с параметрами клиента и регистрирует связанные события | yii\jui\Widget |
| renderItems() | Рендерит элементы вкладок, как указано в $items. | yii\jui\Tabs |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает при инициализации виджета через init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$encodeLabels общедоступное свойство
Нужно ли кодировать метки для элементов заголовка в HTML.
public boolean $encodeLabels = true
$headerOptions общедоступное свойство
Список HTML-атрибутов для тегов контейнера заголовка. Этот список будет переопределён параметром "headerOptions", установленным в отдельных $items.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерируются атрибуты.
public array $headerOptions = []
$itemOptions общедоступное свойство
Список HTML-атрибутов для тегов контейнера элемента. Этот список будет переопределён параметром "options", установленным в отдельных $items. Распознаются следующие специальные параметры:
- tag: строка, по умолчанию "div", имя тега для тегов контейнера элемента.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерируются атрибуты.
public array $itemOptions = []
$items общественное свойство
Список элементов вкладок. Каждый элемент может быть массивом следующей структуры:
- label: строка, обязательная, задаёт метку для ссылки заголовка. Если $encodeLabels имеет значение true, метка будет закодирована HTML.
- content: строка, содержимое, которое отображается при нажатии на соответствующую вкладку. Может быть опущено, если указан url.
- url: смешанный тип, необязательный, url для загрузки содержимого вкладки через AJAX. Требуется, если содержимое не указано.
- template: строка, необязательная, шаблон для отображения ссылки заголовка. Если не указан, будет использован $linkTemplate.
- options: массив, необязательный, HTML-атрибуты заголовка.
- headerOptions: массив, необязательный, HTML-атрибуты тега контейнера заголовка.
public array $items = []
$linkTemplate общественное свойство
Шаблон по умолчанию для отображения ссылки.
public string $linkTemplate = '<a href="{url}">{label}</a>'
$options общественное свойство
HTML-атрибуты тега контейнера виджета. Признаются следующие специальные опции:
- tag: строка, по умолчанию "div", имя тега контейнера виджета.
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей об отображении атрибутов.
public array $options = []
Подробное описание методов
renderItems() защищённый метод
Отображает элементы вкладок согласно спецификации $items.
| защищённый строка renderItems ( ) | ||
|---|---|---|
| возвращает | строка |
Результат отображения. |
| бросает | \yii\jui\InvalidConfigException. | |
run() общественный метод
Отображает виджет.
| общественный void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-tabs.html