CJuiProgressBar
| Пакет | zii.widgets.jui |
|---|---|
| Наследование | class CJuiProgressBar » CJuiWidget » CWidget » CBaseController » CComponent |
| С версии | 1.1 |
| Исходный код | framework/zii/widgets/jui/CJuiProgressBar.php |
CJuiProgressBar отображает виджет прогресс-бара.
CJuiProgressBar инкапсулирует плагин JUI Progressbar.
Для использования этого виджета, вы можете вставить следующий код в представление:
Настроив свойство options, вы можете указать опции, которые необходимо передать плагину JUI progressbar. Обратитесь к документации JUI ProgressBar для возможных опций (имя-значение) и к странице JUI ProgressBar для общего описания и демо.
CJuiProgressBar инкапсулирует плагин JUI Progressbar.
Для использования этого виджета, вы можете вставить следующий код в представление:
$this->widget('zii.widgets.jui.CJuiProgressBar',array(
'value'=>75,
// additional javascript options for the progress bar plugin
'options'=>array(
'change'=>new CJavaScriptExpression('function(event, ui) {...}'),
),
'htmlOptions'=>array(
'style'=>'height:20px;',
),
));
Настроив свойство options, вы можете указать опции, которые необходимо передать плагину JUI progressbar. Обратитесь к документации JUI ProgressBar для возможных опций (имя-значение) и к странице JUI ProgressBar для общего описания и демо.
Общедоступные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| controller | CController | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| cssFile | смешанный тип | имя файла CSS темы. | CJuiWidget |
| htmlOptions | массив | HTML атрибуты, которые должны быть отображены в HTML тэге, представляющем виджет JUI. | CJuiWidget |
| id | строка | Возвращает ID виджета или генерирует новый, если запрошено. | CWidget |
| options | массив | исходные JavaScript опции, которые должны быть переданы плагину JUI. | CJuiWidget |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| scriptFile | смешанный тип | основной JUI JavaScript файл. | CJuiWidget |
| scriptUrl | строка | корневой URL, содержащий все JUI JavaScript файлы. | CJuiWidget |
| skin | смешанный тип | имя скина, которое должно использоваться этим виджетом. | CWidget |
| tagName | строка | имя контейнерного элемента, содержащего полосу прогресса. | CJuiProgressBar |
| theme | строка | имя темы JUI. | CJuiWidget |
| themeUrl | строка | корневой URL, содержащий все папки темы JUI. | CJuiWidget |
| value | целое число | процент выполнения. | CJuiProgressBar |
| viewPath | строка | Возвращает директорию, содержащую файлы представления для этого виджета. | CWidget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение по его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| actions() | Возвращает список действий, используемых этим виджетом. | CWidget |
| asa() | Возвращает объект именованного поведения. | CComponent |
| attachBehavior() | Присоединяет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Присоединяет список поведений к компоненту. | CComponent |
| attachEventHandler() | Присоединяет обработчик событий к событию. | CComponent |
| beginCache() | Начинает кэширование фрагмента. | CBaseController |
| beginClip() | Начинает запись клипа. | CBaseController |
| beginContent() | Начинает отображение содержимого, которое должно быть отформатировано указанным представлением. | CBaseController |
| beginWidget() | Создаёт виджет и выполняет его. | CBaseController |
| canGetProperty() | Определяет, можно ли считать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| createWidget() | Создаёт виджет и инициализирует его. | CBaseController |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все поведения, присоединённые к этому компоненту. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые к этому компоненту поведения. | CComponent |
| endCache() | Заканчивает кэширование фрагмента. | CBaseController |
| endClip() | Заканчивает запись клипа. | CBaseController |
| endContent() | Заканчивает отображение содержимого. | CBaseController |
| endWidget() | Заканчивает выполнение указанного виджета. | CBaseController |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| getController() | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| getEventHandlers() | Возвращает список прикреплённых обработчиков событий для события. | CComponent |
| getId() | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getViewFile() | Ищет файл сценария представления в соответствии с именем представления. | CWidget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикреплённые обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует виджет. | CJuiWidget |
| raiseEvent() | Вызывает событие. | CComponent |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Запустить этот виджет. | CJuiProgressBar |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| registerCoreScripts() | Регистрирует основные файлы скриптов. | CJuiWidget |
| registerScriptFile() | Регистрирует файл JavaScript по scriptUrl. | CJuiWidget |
| resolvePackagePath() | Определяет путь установки пакета JUI. | CJuiWidget |
Подробное описание свойств
tagName свойство
public string $tagName;
название контейнерного элемента, содержащего полосу прогресса. По умолчанию «div».
value свойство
public integer $value;
процент прогресса. Должно быть целым числом от 0 до 100. По умолчанию 0.
Подробное описание методов
run() метод
public void run() |
Исходный код: framework/zii/widgets/jui/CJuiProgressBar.php#59 (показать)
public function run()
{
$id=$this->getId();
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
echo CHtml::openTag($this->tagName,$this->htmlOptions);
echo CHtml::closeTag($this->tagName);
$this->options['value']=$this->value;
$options=CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').progressbar($options);");
}
Запустите этот виджет. Этот метод регистрирует необходимый javascript и отрисовывает необходимый HTML-код.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiProgressBar
