Класс yii\jui\Menu
| Наследование | yii\jui\Menu » yii\widgets\Menu » 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/Menu.php |
Menu отображает виджет jQuery UI меню.
См. также http://api.jqueryui.com/menu/.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $activateItems | boolean | Автоматически активировать элементы в зависимости от того, соответствует ли их маршрут текущему запрошенному маршруту. | yii\widgets\Menu |
| $activateParents | boolean | Активировать родительские элементы меню, когда один из соответствующих дочерних элементов меню активен. | yii\widgets\Menu |
| $activeCssClass | string | Класс CSS, который будет добавлен к активному элементу меню. | yii\widgets\Menu |
| $autoIdPrefix | string | Префикс к автоматически сгенерированным идентификаторам виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту | yii\base\Component |
| $clientEvents | array | Обработчики событий для основного виджета jQuery UI. | yii\jui\Menu |
| $clientOptions | array | Параметры для основного виджета jQuery UI. | yii\jui\Menu |
| $counter | integer | Счетчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $encodeLabels | boolean | Нужно ли кодировать метки элементов меню в HTML. | yii\widgets\Menu |
| $firstItemCssClass | string | Класс CSS, который будет назначен первому элементу в главном меню или каждом подменю. | yii\widgets\Menu |
| $hideEmptyItems | boolean | Скрыть пустые элементы меню. | yii\widgets\Menu |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $itemOptions | array | Список атрибутов HTML, общих для всех элементов меню $items. | yii\widgets\Menu |
| $items | array | Список элементов меню. | yii\widgets\Menu |
| $labelTemplate | string | Шаблон, используемый для отображения тела меню, которое НЕ является ссылкой. | yii\widgets\Menu |
| $lastItemCssClass | string | Класс CSS, который будет назначен последнему элементу в главном меню или каждом подменю. | yii\widgets\Menu |
| $linkTemplate | string | Шаблон, используемый для отображения тела меню, которое является ссылкой. | yii\widgets\Menu |
| $options | array | Атрибуты HTML для тега контейнера меню. | yii\widgets\Menu |
| $params | array | Параметры, используемые для определения, активен ли элемент меню или нет. | yii\widgets\Menu |
| $route | string | Маршрут, используемый для определения, активен ли элемент меню или нет. | yii\widgets\Menu |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $submenuTemplate | string | Шаблон, используемый для отображения списка подменю. | yii\widgets\Menu |
| $view | yii\web\View | Объект представления, который может использоваться для отображения представлений или файлов представления. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | 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\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представления для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\jui\Menu |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Рендерит виджет. | yii\jui\Menu |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| isItemActive() | Проверяет, является ли пункт меню активным. | yii\widgets\Menu |
| normalizeItems() | Нормализует свойство $items, удаляя невидимые элементы и активируя определённые. | yii\widgets\Menu |
| renderItem() | Рендерит содержимое элемента меню. | yii\widgets\Menu |
| renderItems() | Рекурсивно рендерит элементы меню (без тега контейнера). | yii\widgets\Menu |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$clientEvents общественное свойство
Обработчики событий для подлежащего виджета jQuery UI. Обратитесь к соответствующей веб-странице виджета jQuery UI для возможных событий. Например, эта страница демонстрирует использование виджета «Accordion» и поддерживаемых событий (например, «create»).
public array $clientEvents = []
$clientOptions общественное свойство
Параметры для подлежащего виджета jQuery UI. Обратитесь к соответствующей веб-странице виджета jQuery UI для возможных параметров. Например, эта страница демонстрирует использование виджета «Accordion» и поддерживаемых параметров (например, «header»).
public array $clientOptions = []
Подробное описание методов
init() public method
Инициализирует виджет.
Если вы переопределяете этот метод, убедитесь, что сначала вызывается реализация родительского класса.
| public void init ( ) |
|---|
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-jui-menu.html
