CFlexWidget

Property Details

align property

public string $align;

align of the application region. Defaults to 'middle'.

allowFullScreen property (available since v1.1.1)

public boolean $allowFullScreen;

whether to allow running the Flash in full screen mode. Defaults to false.

allowScriptAccess property

public string $allowScriptAccess;

the access method of the script. Defaults to 'sameDomain'.

altHtmlContent property

public string $altHtmlContent;

the HTML content to be displayed if Flash player is not installed.

baseUrl property

public string $baseUrl;

the base URL of the Flex application. This refers to the URL of the directory containing the SWF file.

bgColor property

public string $bgColor;

background color of the application region. Defaults to '#FFFFFF', meaning white.

enableHistory property

public boolean $enableHistory;

whether history should be enabled. Defaults to true.

flashVars property

public array $flashVars;

parameters to be passed to the Flex application.

flashVarsAsString property read-only

public string getFlashVarsAsString()

Generates the properly quoted flash parameter string.

height property

public string $height;

height of the application region. Defaults to 300.

name property

public string $name;

name of the Flex application. This should be the SWF file name without the ".swf" suffix.

quality property

public string $quality;

quality of the animation. Defaults to 'high'.

width property

public string $width;

width of the application region. Defaults to 450.

Method Details

getFlashVarsAsString() method

public string getFlashVarsAsString()

public function getFlashVarsAsString()
{
    $params=array();
    foreach($this->flashVars as $k=>$v)
        $params[]=urlencode($k).'='.urlencode($v);
    return CJavaScript::quote(implode('&',$params));
}

Generates the properly quoted flash parameter string.

registerClientScript() method

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');
    }
}

Registers the needed CSS and JavaScript.

run() method

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');
}

Renders the widget.