Spec-Zone.ru › Yii 2.0

Класс yii\bootstrap\Tabs

Все классы | Свойства | Методы | События
Наследование yii\bootstrap\Tabs » yii\bootstrap\Widget » yii\base\Widget » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Использует Трейты yii\bootstrap\BootstrapWidgetTrait
Доступна с версии 2.0
Исходный код https://github.com/yiisoft/yii2-bootstrap/blob/master/Tabs.php

Tabs отображает компонент Bootstrap JavaScript для вкладок.

Например:

echo Tabs::widget([
    'items' => [
        [
            'label' => 'One',
            'content' => 'Anim pariatur cliche...',
            'active' => true
        ],
        [
            'label' => 'Two',
            'content' => 'Anim pariatur cliche...',
            'headerOptions' => [...],
            'options' => ['id' => 'myveryownID'],
        ],
        [
            'label' => 'Example',
            'url' => 'http://www.example.com',
        ],
        [
            'label' => 'Dropdown',
            'items' => [
                 [
                     'label' => 'DropdownA',
                     'content' => 'DropdownA, Anim pariatur cliche...',
                 ],
                 [
                     'label' => 'DropdownB',
                     'content' => 'DropdownB, Anim pariatur cliche...',
                 ],
                 [
                     'label' => 'External Link',
                     'url' => 'http://www.example.com',
                 ],
            ],
        ],
    ],
]);

См. также http://getbootstrap.com/javascript/#tabs.

Общедоступные свойства

Свойство Тип Описание Определено
$autoIdPrefix строка Префикс для автоматически сгенерированных идентификаторов виджетов. yii\base\Widget
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$clientEvents массив Обработчики событий для базового плагина Bootstrap JS. yii\bootstrap\BootstrapWidgetTrait
$clientOptions массив Параметры для базового плагина Bootstrap JS. yii\bootstrap\BootstrapWidgetTrait
$counter целое число Счётчик, используемый для генерации $id для виджетов. yii\base\Widget
$dropdownClass строка Имя класса для отображения выпадающих списков в этом виджете. yii\bootstrap\Tabs
$encodeLabels логическое значение Нужно ли кодировать метки элементов заголовка в HTML. yii\bootstrap\Tabs
$headerOptions массив Список HTML атрибутов для тегов контейнера заголовка. yii\bootstrap\Tabs
$id строка Идентификатор виджета. yii\base\Widget
$itemOptions массив Список HTML атрибутов для тегов контейнера элемента. yii\bootstrap\Tabs
$items массив Список вкладок в виджете вкладок. yii\bootstrap\Tabs
$linkOptions массив Список HTML атрибутов для тегов ссылок заголовка вкладок. yii\bootstrap\Tabs
$navType строка Определяет стиль Bootstrap для вкладок. yii\bootstrap\Tabs
$options массив HTML атрибуты для тега контейнера виджета. yii\bootstrap\Widget
$renderTabContent логическое значение Отображать ли контейнер tab-content и его содержимое. yii\bootstrap\Tabs
$stack yii\base\Widget[] Виджеты, которые в данный момент отображаются (не завершены). yii\base\Widget
$tabContentOptions массив Список HTML атрибутов для контейнера tab-content. yii\bootstrap\Tabs
$view yii\web\View Объект представления, который можно использовать для отображения представлений или файлов представлений. yii\bootstrap\BootstrapWidgetTrait
$viewPath строка Директория, содержащая файлы представлений для этого виджета. yii\base\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() Возвращает ID виджета. yii\base\Widget
getView() yii\bootstrap\BootstrapWidgetTrait
getViewPath() Возвращает каталог, содержащий файлы представления для этого виджета. yii\base\Widget
hasEventHandlers() Возвращает значение, указывающее, есть ли какой-либо обработчик, присоединённый к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует виджет. yii\bootstrap\Tabs
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
render() Отображает представление. yii\base\Widget
renderFile() Отображает файл представления. yii\base\Widget
renderPanes() Отображает панели вкладок. yii\bootstrap\Tabs
run() Отображает виджет. yii\bootstrap\Tabs
setId() Устанавливает ID виджета. yii\base\Widget
setView() Устанавливает объект представления, который будет использоваться этим виджетом. yii\base\Widget
trigger() Вызывает событие. yii\base\Component
widget() Создаёт экземпляр виджета и запускает его. yii\base\Widget

Защищённые методы

Метод Описание Определено в
activateFirstVisibleTab() Устанавливает первую видимую вкладку как активную. yii\bootstrap\Tabs
hasActiveTab() yii\bootstrap\Tabs
registerClientEvents() Регистрирует обработчики событий JS, перечисленные в $clientEvents. yii\bootstrap\BootstrapWidgetTrait
registerPlugin() Регистрирует конкретный плагин Bootstrap и связанные с ним события yii\bootstrap\BootstrapWidgetTrait
renderDropdown() Нормализует параметры элементов выпадающего списка, удаляя специфичные для вкладок ключи content и contentOptions, а также настраивает panes соответственно. yii\bootstrap\Tabs
renderItems() Отображает элементы вкладок, как указано в $items. yii\bootstrap\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

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

$dropdownClass общедоступное свойство (доступно начиная с версии 2.0.7)

Имя класса, используемого для отображения выпадающих списков в этом виджете. По умолчанию yii\bootstrap\Dropdown.

public string $dropdownClass = 'yii\bootstrap\Dropdown'

$encodeLabels открытая переменная

Определяет, нужно ли кодировать теги заголовков.

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: строка, обязательная, метка заголовка вкладки.
  • encode: логическое значение, необязательное, определяет, нужно ли кодировать эту метку. Этот параметр переопределяет глобальный параметр $this->encodeLabels.
  • headerOptions: массив, необязательный, HTML-атрибуты заголовка вкладки.
  • linkOptions: массив, необязательный, HTML-атрибуты тегов ссылки заголовка вкладки.
  • content: строка, необязательная, содержимое (HTML) панели вкладки.
  • url: строка, необязательная, внешний URL. При указании этого параметра щелчок по этой вкладке перенаправит браузер на этот URL. Этот параметр доступен начиная с версии 2.0.4.
  • options: массив, необязательный, HTML-атрибуты контейнера панели вкладки.
  • active: логическое значение, необязательное, определяет, активны ли заголовок и панель вкладки. Если ни один элемент не помечен как «активный» явно, первой будет активирована первая вкладка.
  • visible: логическое значение, необязательное, определяет, отображается ли заголовок и панель вкладки. По умолчанию значение true.
  • items: массив, необязательный, может быть использован вместо content для указания конфигурационного массива элементов выпадающего списка. Каждый элемент может содержать три дополнительных ключа помимо вышеперечисленных:
    • active: boolean, необязательный, определяет, активна ли вкладка.
    • content: строка, обязательная, если items не задано. Содержимое (HTML) панели вкладки.
    • contentOptions: необязательный, массив, HTML-атрибуты контейнера содержимого.
public array $items = []

$linkOptions открытая переменная

Список HTML-атрибутов для тегов ссылки заголовка вкладки. Он будет перезаписан атрибутом «linkOptions», заданным в отдельных $items.

См. также yii\helpers\Html::renderTagAttributes() для подробностей о том, как рендерятся атрибуты.

public array $linkOptions = []

$navType открытая переменная

Определяет стиль вкладок Bootstrap.

public string $navType = 'nav-tabs'

$renderTabContent открытая переменная (доступна с версии 2.0.1)

Определяет, следует ли рендерить контейнер tab-content и его содержимое. Вы можете установить эту переменную в false, чтобы вручную рендерить tab-content в случае сложного содержимого вкладок.

public boolean $renderTabContent = true

$tabContentOptions открытая переменная (доступна с версии 2.0.7)

Список HTML-атрибутов для контейнера tab-content. Он всегда будет содержать CSS-класс tab-content.

См. также yii\helpers\Html::renderTagAttributes() для подробностей о том, как рендерятся атрибуты.

public array $tabContentOptions = []

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

activateFirstVisibleTab() защищённый метод (доступен с версии 2.0.7)

Устанавливает первую видимую вкладку как активную.

Этот метод активирует первую видимую вкладку, которая не была явно отмечена как неактивная ('active' => false).

protected void activateFirstVisibleTab ( )

hasActiveTab() защищённый метод

protected boolean hasActiveTab ( )
возвращает boolean

Если определена активная вкладка

init() открытый метод

Инициализирует виджет.

public void init ( )

renderDropdown() защищённый метод

Нормализует параметры элементов выпадающего списка, удаляя специфичные для вкладок ключи content и contentOptions, а также соответствующим образом настраивает panes.

protected boolean renderDropdown ( $itemNumber, &$items, &$panes )
$itemNumber строка

Номер элемента

$items массив

Конфигурация элементов выпадающего списка.

$panes массив

Массив ссылок на панели.

возвращает boolean

Является ли какой-либо из элементов выпадающего списка active или нет.

бросает yii\base\InvalidConfigException

renderItems() защищённый метод

Рендерит элементы вкладок, как указано в $items.

protected строка renderItems ( )
возвращает строка

Результат рендеринга.

бросает \yii\bootstrap\InvalidConfigException.

renderPanes() открытый метод (доступен с версии 2.0.7)

Рендерит панели вкладок.

public строка renderPanes ( $panes )
$panes массив
возвращает строка

Результат рендеринга.

run() открытый метод

Рендерит виджет.

public void run ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-bootstrap-tabs.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API