0 follower

CFlexWidget

Package system.web.widgets
Inheritance class CFlexWidget » CWidget » CBaseController » CComponent
Since 1.0
Source Code framework/web/widgets/CFlexWidget.php
CFlexWidget embeds a Flex 3.x application into a page.

To use CFlexWidget, set name to be the Flex application name (without the .swf suffix), and set baseUrl to be URL (without the ending slash) of the directory containing the SWF file of the Flex application.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
actionPrefix string the prefix to the IDs of the actions. CWidget
align string align of the application region. CFlexWidget
allowFullScreen boolean whether to allow running the Flash in full screen mode. CFlexWidget
allowScriptAccess string the access method of the script. CFlexWidget
altHtmlContent string the HTML content to be displayed if Flash player is not installed. CFlexWidget
baseUrl string the base URL of the Flex application. CFlexWidget
bgColor string background color of the application region. CFlexWidget
controller CController Returns the controller that this widget belongs to. CWidget
enableHistory boolean whether history should be enabled. CFlexWidget
flashVars array parameters to be passed to the Flex application. CFlexWidget
flashVarsAsString string Generates the properly quoted flash parameter string. CFlexWidget
height string height of the application region. CFlexWidget
id string Returns the ID of the widget or generates a new one if requested. CWidget
name string name of the Flex application. CFlexWidget
owner CBaseController Returns the owner/creator of this widget. CWidget
quality string quality of the animation. CFlexWidget
skin mixed the name of the skin to be used by this widget. CWidget
viewPath string Returns the directory containing the view files for this widget. CWidget
width string width of the application region. CFlexWidget

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CWidget
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
actions() Returns a list of actions that are used by this widget. CWidget
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
beginCache() Begins fragment caching. CBaseController
beginClip() Begins recording a clip. CBaseController
beginContent() Begins the rendering of content that is to be decorated by the specified view. CBaseController
beginWidget() Creates a widget and executes it. CBaseController
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
createWidget() Creates a widget and initializes it. CBaseController
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
endCache() Ends fragment caching. CBaseController
endClip() Ends recording a clip. CBaseController
endContent() Ends the rendering of content. CBaseController
endWidget() Ends the execution of the named widget. CBaseController
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getController() Returns the controller that this widget belongs to. CWidget
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getFlashVarsAsString() Generates the properly quoted flash parameter string. CFlexWidget
getId() Returns the ID of the widget or generates a new one if requested. CWidget
getOwner() Returns the owner/creator of this widget. CWidget
getViewFile() Looks for the view script file according to the view name. CWidget
getViewPath() Returns the directory containing the view files for this widget. CWidget
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Initializes the widget. CWidget
raiseEvent() Raises an event. CComponent
registerClientScript() Registers the needed CSS and JavaScript. CFlexWidget
render() Renders a view. CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() Renders the widget. CFlexWidget
setId() Sets the ID of the widget. CWidget
widget() Creates a widget and executes it. CBaseController

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()
{return} string the flash parameter string.
Source Code: framework/web/widgets/CFlexWidget.php#114 (show)
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()
Source Code: framework/web/widgets/CFlexWidget.php#98 (show)
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()
Source Code: framework/web/widgets/CFlexWidget.php#81 (show)
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="https://www.adobe.com/go/getflash/">Adobe Flash Player</a>.');

    $this->registerClientScript();

    $this->render('flexWidget');
}

Renders the widget.