Spec-Zone.ru › Yii 2.0

Класс yii\jui\ProgressBar

Все классы | Свойства | Методы | События
Наследование yii\jui\ProgressBar » 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/ProgressBar.php

ProgressBar отображает виджет jQuery UI progressbar.

Например:

echo ProgressBar::widget([
    'clientOptions' => [
        'value' => 75,
    ],
]);

Следующий пример отобразит содержимое, заключенное между вызовами begin() и end() внутри контейнера виджета:

ProgressBar::begin([
    'clientOptions' => ['value' => 75],
]);

echo '<div class="progress-label">Loading...</div>';

ProgressBar::end();

См. также http://api.jqueryui.com/progressbar/.

Публичные свойства

Свойство Тип Описание Определено в
$autoIdPrefix string Префикс для автоматически сгенерированных идентификаторов виджета. yii\base\Widget
$behaviors yii\base\Behavior[] Список поведенческих правил, прикрепленных к этому компоненту yii\base\Component
$clientEvents array Обработчики событий для базового виджета jQuery UI. yii\jui\Widget
$clientOptions array Параметры для базового виджета jQuery UI. yii\jui\Widget
$counter integer Счётчик, используемый для генерации $id виджетов. yii\base\Widget
$id string Идентификатор виджета. yii\base\Widget
$options array HTML атрибуты для тега контейнера виджета. yii\jui\Widget
$stack yii\base\Widget[] Виджеты, которые в данный момент отрисовываются (не завершены). yii\base\Widget
$view yii\web\View Объект представления, который может использоваться для отрисовки представлений или файлов представлений. yii\base\Widget
$viewPath string Директория, содержащая файлы представлений для этого виджета. yii\base\Widget

Защищенные свойства

Свойство Тип Описание Определено в
$clientEventMap array Имена событий, отображенные в том, что должно быть указано в `. 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\ProgressBar
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
render() Рендерит представление. yii\base\Widget
renderFile() Рендерит файл представления. yii\base\Widget
run() Рендерит виджет. yii\jui\ProgressBar
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

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

init() публичный метод

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

public void init ( )

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-jui-progressbar.html

Spec-Zone.ru

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