| 包 | system.web.widgets |
|---|---|
| 继承 | class CFlexWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CFlexWidget.php 3515 2011-12-28 12:29:24Z mdomba $ |
| 源码 |
CFlexWidget 嵌入一个 Flex 3.x 应用到一个页面中。
要使用CFlexWidget, 设置name为 Flex 应用的名字 （不包括 .swf 扩展名），设置baseUrl 为包含 Flex 应用的 Swf 文件的目录的URL（不包括结尾的斜杠）。
要使用CFlexWidget, 设置name为 Flex 应用的名字 （不包括 .swf 扩展名），设置baseUrl 为包含 Flex 应用的 Swf 文件的目录的URL（不包括结尾的斜杠）。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| align | string | Flex应用所占区域的对齐方式。默认值是“middle”。 | CFlexWidget |
| allowFullScreen | boolean | 是否允许Flash在全屏模式下运行。默认值是false。 | CFlexWidget |
| allowScriptAccess | string | 脚本的访问方式。默认值是“sameDomain”。 | CFlexWidget |
| altHtmlContent | string | 如果Flash播放器未安装时显示的HTML内容。 | CFlexWidget |
| baseUrl | string | Flex应用的基本URL。 这个值指向包含SWF文件的目录的URL。 | CFlexWidget |
| bgColor | string | Flex应用所占区域的背景色。默认值是“#FFFFFF”，表示白色。 | CFlexWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| enableHistory | boolean | 历史记录是否可用。默认值是true。 | CFlexWidget |
| flashVars | array | 需要传递给Flex应用的参数。 | CFlexWidget |
| flashVarsAsString | string | 生成正确的被 flash 引用的参数的字符串。 | CFlexWidget |
| height | string | Flex应用所占区域的高度。默认值是300。 | CFlexWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| name | string | Flex应用的名字。 这个值是一个SWF文件的名字（不包括. | CFlexWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| quality | string | 动画的品质。默认值是“high”。 | CFlexWidget |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
| width | string | Flex应用所占区域的宽度。默认值是450。 | CFlexWidget |
公共方法
属性详细
align
属性
public string $align;
Flex应用所占区域的对齐方式。默认值是“middle”。
allowFullScreen
属性
（可用自 v1.1.1）
public boolean $allowFullScreen;
是否允许Flash在全屏模式下运行。默认值是false。
allowScriptAccess
属性
public string $allowScriptAccess;
脚本的访问方式。默认值是“sameDomain”。
altHtmlContent
属性
public string $altHtmlContent;
如果Flash播放器未安装时显示的HTML内容。
baseUrl
属性
public string $baseUrl;
Flex应用的基本URL。 这个值指向包含SWF文件的目录的URL。
bgColor
属性
public string $bgColor;
Flex应用所占区域的背景色。默认值是“#FFFFFF”，表示白色。
enableHistory
属性
public boolean $enableHistory;
历史记录是否可用。默认值是true。
flashVars
属性
public array $flashVars;
需要传递给Flex应用的参数。
flashVarsAsString
属性
只读
public string getFlashVarsAsString()
生成正确的被 flash 引用的参数的字符串。
height
属性
public string $height;
Flex应用所占区域的高度。默认值是300。
name
属性
public string $name;
Flex应用的名字。 这个值是一个SWF文件的名字（不包括.swf扩展名）。
quality
属性
public string $quality;
动画的品质。默认值是“high”。
width
属性
public string $width;
Flex应用所占区域的宽度。默认值是450。
方法详细
getFlashVarsAsString()
方法
|
public string getFlashVarsAsString()
| ||
| {return} | string | 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');
}
渲染一个小物件。