Класс yii\bootstrap\ButtonDropdown
| Наследование | yii\bootstrap\ButtonDropdown » 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/ButtonDropdown.php |
ButtonDropdown отображает группу или разделительную кнопку выпадающего списка компонента Bootstrap.
Например,
// a button group using Dropdown widget
echo ButtonDropdown::widget([
'label' => 'Action',
'dropdown' => [
'items' => [
['label' => 'DropdownA', 'url' => '/'],
['label' => 'DropdownB', 'url' => '#'],
],
],
]);
См. также:
Публичные Свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | строка | Префикс для автоматически сгенерированных идентификаторов виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений. | yii\base\Component |
| $clientEvents | массив | Обработчики событий для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $clientOptions | массив | Параметры для базового плагина Bootstrap JS. | yii\bootstrap\BootstrapWidgetTrait |
| $containerOptions | массив | Атрибуты HTML для тега контейнера. | yii\bootstrap\ButtonDropdown |
| $counter | целое число | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $dropdown | массив | Конфигурационный массив для yii\bootstrap\Dropdown. | yii\bootstrap\ButtonDropdown |
| $dropdownClass | строка | Имя класса для использования при отрисовке выпадающих списков в этом виджете. | yii\bootstrap\ButtonDropdown |
| $encodeLabel | логическое значение | Нужно ли кодировать метку HTML. | yii\bootstrap\ButtonDropdown |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $label | строка | Текст кнопки. | yii\bootstrap\ButtonDropdown |
| $options | массив | Атрибуты HTML кнопки. | yii\bootstrap\ButtonDropdown |
| $split | логическое значение | Отображать группу кнопок в стиле разделенных кнопок. | yii\bootstrap\ButtonDropdown |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $tagName | строка | Тег для отрисовки кнопки. | yii\bootstrap\ButtonDropdown |
| $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() | Возвращает идентификатор виджета. | 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\BootstrapWidgetTrait |
| off() | Открепляет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Отображает представление. | yii\base\Widget |
| renderFile() | Отображает файл представления. | yii\base\Widget |
| run() | Отображает виджет. | yii\bootstrap\ButtonDropdown |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerClientEvents() | Регистрирует обработчики JS-событий, перечисленные в $clientEvents. | yii\bootstrap\BootstrapWidgetTrait |
| registerPlugin() | Регистрирует конкретный плагин Bootstrap и связанные с ним события | yii\bootstrap\BootstrapWidgetTrait |
| renderButton() | Генерирует кнопку с выпадающим списком. | yii\bootstrap\ButtonDropdown |
| renderDropdown() | Генерирует меню выпадающего списка. | yii\bootstrap\ButtonDropdown |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$containerOptions общедоступное свойство (доступно с версии 2.0.1)
Атрибуты HTML для тега контейнера. Распознаются следующие специальные опции:
- tag: строка, по умолчанию "div", имя тега контейнера.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.
public array $containerOptions = []
$dropdown общедоступное свойство
Массив конфигурации для yii\bootstrap\Dropdown.
public array $dropdown = []
$dropdownClass общедоступное свойство (доступно с версии 2.0.7)
Имя класса для использования при отображении выпадающих списков в этом виджете. По умолчанию yii\bootstrap\Dropdown.
public string $dropdownClass = 'yii\bootstrap\Dropdown'
$encodeLabel public property
Является ли метка HTML-кодированной.
public boolean $encodeLabel = true
$label public property
Метка кнопки.
public string $label = 'Button'
$options public property
Атрибуты HTML кнопки.
См. также yii\helpers\Html::renderTagAttributes() для получения подробностей о том, как рендерятся атрибуты.
public array $options = []
$split public property
Отображать ли группу кнопок в стиле разделителей.
public boolean $split = false
$tagName public property
Тег для рендера кнопки.
public string $tagName = 'button'
Подробное описание методов
renderButton() защищенный метод
Генерирует выпадающий список кнопок.
| protected string renderButton ( ) | ||
|---|---|---|
| return | string |
Результат рендера. |
renderDropdown() защищенный метод
Генерирует выпадающее меню.
| protected string renderDropdown ( ) | ||
|---|---|---|
| return | string |
Результат рендера. |
run() public method
Отображает виджет.
| 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-buttondropdown.html
