CJuiWidget

Подробное описание свойств

cssFile свойство

public mixed $cssFile;

имя файла CSS темы. По умолчанию 'jquery-ui.css'. Обратите внимание, что файл должен существовать по адресу, указанному в themeUrl/theme. Если вам нужно включить несколько файлов CSS темы (например, при разработке, вы хотите включить отдельные файлы CSS плагинов), вы можете установить это свойство как массив имён файлов CSS. Это свойство также может быть установлено как false, что означает, что виджет не будет включать никакой файл CSS темы, и вы сами должны явно включить его где-то ещё.

htmlOptions свойство

public array $htmlOptions;

HTML-атрибуты, которые должны быть отображены в HTML-теге, представляющем виджет JUI.

options свойство

public array $options;

Начальные параметры JavaScript, которые должны быть переданы в плагин JUI.

Свойство scriptFile

public mixed $scriptFile;

Основной файл JavaScript JUI. По умолчанию 'jquery-ui.min.js'. Обратите внимание, что файл должен существовать по адресу, указанному в scriptUrl. Если вам нужно включить несколько файлов скриптов (например, во время разработки, вы хотите включить отдельные файлы скриптов плагинов вместо сжатого файла скрипта JUI), вы можете установить это свойство как массив имён файлов скриптов. Это свойство также может быть установлено в значение false, что означает, что виджет не будет включать никакой файл скрипта, и вам нужно будет явно включить его где-то ещё.

Свойство scriptUrl

public string $scriptUrl;

Корневой URL, содержащий все файлы JavaScript JUI. Если это свойство не задано (по умолчанию), Yii опубликует пакет JUI, включенный в релиз zii, и использует его для определения корневого URL скрипта. Вы должны установить это свойство, если вы планируете использовать пакет JUI, версия которого отличается от версии, включенной в zii. Обратите внимание, что по этому URL должен существовать файл, имя которого указано в scriptFile. Не добавляйте символ косой черты к URL.

Свойство theme

public string $theme;

Имя темы JUI. По умолчанию 'base'. Убедитесь, что по адресу themeUrl существует директория с именем, совпадающим с этим значением свойства (регистрозависимо).

Свойство themeUrl

public string $themeUrl;

Корневой URL, содержащий все папки тем JUI. Если это свойство не задано (по умолчанию), Yii опубликует пакет JUI, включенный в релиз zii, и использует его для определения корневого URL темы. Вы должны установить это свойство, если вы хотите использовать тему, которая не найдена в пакете JUI, включённом в zii. Обратите внимание, что по этому URL должна существовать директория с именем, указанным в theme. Не добавляйте символ косой черты к URL.

Подробное описание методов

Метод init()

public void init()

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

Инициализирует виджет. Этот метод опубликует ресурсы JUI при необходимости. Он также зарегистрирует файлы JavaScript jQuery и JUI, а также файл CSS темы. Если вы переопределяете этот метод, убедитесь, что сначала вызываете родительскую реализацию.

Метод registerCoreScripts()

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

Регистрирует основные файлы скриптов. Этот метод регистрирует файлы JavaScript jQuery и JUI, а также файл CSS темы.

Метод registerScriptFile()

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

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

Регистрирует файл JavaScript по адресу scriptUrl. По умолчанию файл скрипта будет отображаться в конце страницы для улучшения скорости загрузки.

Метод resolvePackagePath()

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

Определяет путь установки пакета JUI. Этот метод определит корневой URL JavaScript и корневой URL темы. Если они не указаны явно, он опубликует включенный пакет JUI и использует его для определения необходимых путей.