CFlexWidget
| Пакет | system.web.widgets |
|---|---|
| Наследование | class CFlexWidget » CWidget » CBaseController » CComponent |
| С версии | 1.0 |
| Исходный код | framework/web/widgets/CFlexWidget.php |
Для использования CFlexWidget, установите имя для имени приложения Flex (без окончания .swf), и установите baseUrl в URL (без конечного слэша) каталога, содержащего SWF-файл приложения Flex.
Общедоступные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| align | строка | выравнивание области приложения. | CFlexWidget |
| allowFullScreen | булево | разрешить запуск Flash в полноэкранном режиме. | CFlexWidget |
| allowScriptAccess | строка | метод доступа к скрипту. | CFlexWidget |
| altHtmlContent | строка | HTML-контент, отображаемый, если Flash Player не установлен. | CFlexWidget |
| baseUrl | строка | базовый URL приложения Flex. | CFlexWidget |
| bgColor | строка | цвет фона области приложения. | CFlexWidget |
| controller | CController | Возвращает контроллер, которому принадлежит этот виджет. | CWidget |
| enableHistory | булево | включить историю. | CFlexWidget |
| flashVars | массив | параметры, передаваемые приложению Flex. | CFlexWidget |
| flashVarsAsString | строка | Генерирует строку параметров flash с правильными кавычками. | CFlexWidget |
| height | строка | высота области приложения. | CFlexWidget |
| id | строка | Возвращает ID виджета или генерирует новый, если необходимо. | CWidget |
| name | строка | имя приложения Flex. | CFlexWidget |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| quality | строка | качество анимации. | CFlexWidget |
| skin | смешанный тип | имя скина, используемого этим виджетом. | CWidget |
| viewPath | строка | Возвращает каталог, содержащий файлы представления для этого виджета. | CWidget |
| width | строка | ширина области приложения. | CFlexWidget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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 |
| getFlashVarsAsString() | Создаёт строку параметров Flash с правильными кавычками. | CFlexWidget |
| getId() | Возвращает идентификатор виджета или генерирует новый, если это необходимо. | CWidget |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getViewFile() | Ищет файл скрипта представления по имени представления. | CWidget |
| getViewPath() | Возвращает директорию, содержащую файлы представления для данного виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, имеются ли присоединённые обработчики для события с заданным именем. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует виджет. | CWidget |
| raiseEvent() | Вызывает событие. | CComponent |
| registerClientScript() | Регистрирует необходимые CSS и JavaScript. | CFlexWidget |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Отображает виджет. | CFlexWidget |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Подробное описание свойств
align свойство
public string $align;
Выравнивание области приложения. По умолчанию 'middle'.
allowFullScreen свойство (доступно начиная с v1.1.1)
public boolean $allowFullScreen;
Разрешить запуск Flash в полноэкранном режиме. По умолчанию false.
allowScriptAccess свойство
public string $allowScriptAccess;
Способ доступа к скрипту. По умолчанию 'sameDomain'.
altHtmlContent свойство
public string $altHtmlContent;
HTML-контент, который будет отображаться, если Flash Player не установлен.
baseUrl свойство
public string $baseUrl;
Базовый URL Flex-приложения. Относится к URL-адресу каталога, содержащего SWF-файл.
bgColor свойство
public string $bgColor;
Цвет фона области приложения. По умолчанию '#FFFFFF', что означает белый цвет.
enableHistory свойство
public boolean $enableHistory;
Включить историю. По умолчанию true.
flashVars свойство
public array $flashVars;
параметры, которые должны быть переданы в приложение Flex.
flashVarsAsString свойство только для чтения
public string getFlashVarsAsString()
Генерирует строку параметров flash с правильными кавычками.
height свойство
public string $height;
высота области приложения. По умолчанию 300.
name свойство
public string $name;
имя приложения Flex. Должно быть именем файла SWF без суффикса ".swf".
quality свойство
public string $quality;
качество анимации. По умолчанию 'high'.
width свойство
public string $width;
ширина области приложения. По умолчанию 450.
Подробное описание методов
getFlashVarsAsString() метод
public string getFlashVarsAsString() | ||
| {return} | строка | строка параметров flash. |
public function getFlashVarsAsString()
{
$params=array();
foreach($this->flashVars as $k=>$v)
$params[]=urlencode($k).'='.urlencode($v);
return CJavaScript::quote(implode('&',$params));
}
Генерирует строку параметров flash с правильными кавычками.
registerClientScript() метод
public void registerClientScript() |
public function registerClientScript()
{
$cs=Yii::app()->getClientScript();
$cs->registerScriptFile($this->baseUrl.'/AC_OETags.js');
if($this->enableHistory)
{
$cs->registerCssFile($this->baseUrl.'/history/history.css');
$cs->registerScriptFile($this->baseUrl.'/history/history.js');
}
}
Регистрирует необходимые CSS и JavaScript.
run() метод
public void run() |
public function run()
{
if(empty($this->name))
throw new CException(Yii::t('yii','CFlexWidget.name cannot be empty.'));
if(empty($this->baseUrl))
throw new CException(Yii::t('yii','CFlexWidget.baseUrl cannot be empty.'));
if($this->altHtmlContent===null)
$this->altHtmlContent=Yii::t('yii','This content requires the <a href="http://www.adobe.com/go/getflash/">Adobe Flash Player</a>.');
$this->registerClientScript();
$this->render('flexWidget');
}
Отображает виджет.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CFlexWidget