Класс yii\jui\Widget
| Наследование | yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Подклассы | yii\jui\Accordion, yii\jui\AutoComplete, yii\jui\DatePicker, yii\jui\Dialog, yii\jui\Draggable, yii\jui\Droppable, yii\jui\InputWidget, yii\jui\ProgressBar, yii\jui\Resizable, yii\jui\Selectable, yii\jui\Slider, yii\jui\SliderInput, yii\jui\Sortable, yii\jui\Spinner, yii\jui\Tabs |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-jui/blob/master/Widget.php |
\yii\jui\Widget — базовый класс для всех виджетов jQuery UI.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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 |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $options | массив | Атрибуты HTML для тега контейнера виджета. | yii\jui\Widget |
| $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\base\Widget |
| 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 |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробности свойств
$clientEventMap защищённое свойство
Имена событий, сопоставленные с тем, что должно быть указано в .on(). Если пусто, предполагается, что событие, переданное clientEvents, имеет префикс имени виджета.
protected array $clientEventMap = []
$clientEvents общедоступное свойство
Обработчики событий для базового виджета jQuery UI. Обратитесь к соответствующей веб-странице виджета jQuery UI для возможных событий. Например, эта страница показывает, как использовать виджет «Accordion» и поддерживаемые события (например, «create»). Ключи — имена событий, а значения — javascript-код, который передаётся функции .on() в качестве обработчика события.
Например, вы можете написать следующее в вашей конфигурации виджета:
'clientEvents' => [
'change' => 'function () { alert('event "change" occured.'); }'
],
public array $clientEvents = []
$clientOptions общедоступное свойство
Параметры для базового виджета jQuery UI. Обратитесь к соответствующей веб-странице виджета jQuery UI для возможных параметров. Например, эта страница показывает, как использовать виджет «Accordion» и поддерживаемые параметры (например, «header»).
public array $clientOptions = []
$options общедоступное свойство
Атрибуты HTML для тега контейнера виджета.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты отображаются.
public array $options = []
Подробное описание методов
init() общедоступный метод
Инициализирует виджет.
Если вы переопределяете этот метод, убедитесь, что сначала вызываете родительскую реализацию.
| public void init ( ) |
|---|
registerClientEvents() защищённый метод
Регистрирует определённые события jQuery UI виджета
| protected void registerClientEvents ( $name, $id ) | ||
|---|---|---|
| $name | строка |
Название виджета jQuery UI |
| $id | строка |
Идентификатор виджета |
registerClientOptions() защищённый метод
Регистрирует определённые параметры виджета jQuery UI
| protected void registerClientOptions ( $name, $id ) | ||
|---|---|---|
| $name | строка |
Название виджета jQuery UI |
| $id | строка |
Идентификатор виджета |
registerWidget() защищённый метод
Регистрирует определённый пакет ресурсов jQuery UI виджета, инициализирует его с помощью клиентских параметров и регистрирует связанные события
| protected void registerWidget ( $name, $id = null ) | ||
|---|---|---|
| $name | строка |
Название виджета jQuery UI |
| $id | строка |
Идентификатор виджета. Если null, он будет использовать значение |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-widget.html
