CJuiWidget

Property Details

cssFile property

public mixed $cssFile;

the theme CSS file name. Defaults to 'jquery-ui.css'. Note the file must exist under the URL specified by themeUrl/theme. If you need to include multiple theme CSS files (e.g. during development, you want to include individual plugin CSS files), you may set this property as an array of the CSS file names. This property can also be set as false, which means the widget will not include any theme CSS file, and it is your responsibility to explicitly include it somewhere else.

htmlOptions property

public array $htmlOptions;

the HTML attributes that should be rendered in the HTML tag representing the JUI widget.

options property

public array $options;

the initial JavaScript options that should be passed to the JUI plugin.

scriptFile property

public mixed $scriptFile;

the main JUI JavaScript file. Defaults to 'jquery-ui.min.js'. Note the file must exist under the URL specified by scriptUrl. If you need to include multiple script files (e.g. during development, you want to include individual plugin script files rather than the minized JUI script file), you may set this property as an array of the script file names. This property can also be set as false, which means the widget will not include any script file, and it is your responsibility to explicitly include it somewhere else.

scriptUrl property

public string $scriptUrl;

the root URL that contains all JUI JavaScript files. If this property is not set (default), Yii will publish the JUI package included in the zii release and use that to infer the root script URL. You should set this property if you intend to use a JUI package whose version is different from the one included in zii. Note that under this URL, there must be a file whose name is specified by scriptFile. Do not append any slash character to the URL.

theme property

public string $theme;

the JUI theme name. Defaults to 'base'. Make sure that under themeUrl there is a directory whose name is the same as this property value (case-sensitive).

themeUrl property

public string $themeUrl;

the root URL that contains all JUI theme folders. If this property is not set (default), Yii will publish the JUI package included in the zii release and use that to infer the root theme URL. You should set this property if you intend to use a theme that is not found in the JUI package included in zii. Note that under this URL, there must be a directory whose name is specified by theme. Do not append any slash character to the URL.

Method Details

init() method

public void init()

public function init()
{
    $this->resolvePackagePath();
    $this->registerCoreScripts();
    parent::init();
}

Initializes the widget. This method will publish JUI assets if necessary. It will also register jquery and JUI JavaScript files and the theme CSS file. If you override this method, make sure you call the parent implementation first.

registerCoreScripts() method

protected void registerCoreScripts()

protected function registerCoreScripts()
{
    $cs=Yii::app()->getClientScript();
    if(is_string($this->cssFile))
        $cs->registerCssFile($this->themeUrl.'/'.$this->theme.'/'.$this->cssFile);
    elseif(is_array($this->cssFile))
    {
        foreach($this->cssFile as $cssFile)
            $cs->registerCssFile($this->themeUrl.'/'.$this->theme.'/'.$cssFile);
    }

    $cs->registerCoreScript('jquery');
    if(is_string($this->scriptFile))
        $this->registerScriptFile($this->scriptFile);
    elseif(is_array($this->scriptFile))
    {
        foreach($this->scriptFile as $scriptFile)
            $this->registerScriptFile($scriptFile);
    }
}

Registers the core script files. This method registers jquery and JUI JavaScript files and the theme CSS file.

registerScriptFile() method

protected void registerScriptFile(string $fileName, integer $position=2)

protected function registerScriptFile($fileName,$position=CClientScript::POS_END)
{
    Yii::app()->getClientScript()->registerScriptFile($this->scriptUrl.'/'.$fileName,$position);
}

Registers a JavaScript file under scriptUrl. Note that by default, the script file will be rendered at the end of a page to improve page loading speed.

resolvePackagePath() method

protected void resolvePackagePath()

protected function resolvePackagePath()
{
    if($this->scriptUrl===null || $this->themeUrl===null)
    {
        $cs=Yii::app()->getClientScript();
        if($this->scriptUrl===null)
            $this->scriptUrl=$cs->getCoreScriptUrl().'/jui/js';
        if($this->themeUrl===null)
            $this->themeUrl=$cs->getCoreScriptUrl().'/jui/css';
    }
}

Determine the JUI package installation path. This method will identify the JavaScript root URL and theme root URL. If they are not explicitly specified, it will publish the included JUI package and use that to resolve the needed paths.