Class CJuiWidget

This is the base class for all JUI widget classes.

CComponent

CBaseController

CWidget

CJuiWidget

Direct known subclasses

CJuiAccordion, CJuiDialog, CJuiTabs, SortableWidgets, CJuiDraggable, CJuiDroppable, CJuiInputWidget, CJuiProgressBar, CJuiResizable, CJuiSelectable, CJuiSlider, CJuiSortable

Indirect known subclasses

CJuiAutoComplete, CJuiButton, CJuiDatePicker, CJuiSliderInput

Abstract
Package: zii\widgets\jui
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Sebastian Thierer <sebathi@gmail.com>
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.1
Located at x2engine/framework/zii/widgets/jui/CJuiWidget.php

Methods summary
`public`	# `setScriptFile( mixed $scriptFile )`
`public`	# `getScriptFile( mixed $scriptFile = null )`
`public`	# `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. 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. Overrides `CWidget::init()`
`protected`	# `resolvePackagePath( )` 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. 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.
`protected`	# `registerCoreScripts( )` Registers the core script files. This method registers jquery and JUI JavaScript files and the theme CSS file. Registers the core script files. This method registers jquery and JUI JavaScript files and the theme CSS file.
`protected`	# `registerScriptFile( string $fileName, integer $position = CClientScript::POS_END )` Registers a JavaScript file under `CJuiWidget::$scriptUrl`. Note that by default, the script file will be rendered at the end of a page to improve page loading speed. Registers a JavaScript file under `CJuiWidget::$scriptUrl`. Note that by default, the script file will be rendered at the end of a page to improve page loading speed. Parameters `$fileName` `string` $fileName JavaScript file name `$position` `integer` $position the position of the JavaScript file. Valid values include the following: CClientScript::POS_HEAD : the script is inserted in the head section right before the title element. CClientScript::POS_BEGIN : the script is inserted at the beginning of the body section. CClientScript::POS_END : the script is inserted at the end of the body section.

Methods inherited from CWidget
`__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), run(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`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. 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.
`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 `CJuiWidget::$theme`. Do not append any slash character to the URL. 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 `CJuiWidget::$theme`. Do not append any slash character to the URL.
`public string`	`$theme`	`'base'`	# the JUI theme name. Defaults to 'base'. Make sure that under `CJuiWidget::$themeUrl` there is a directory whose name is the same as this property value (case-sensitive). the JUI theme name. Defaults to 'base'. Make sure that under `CJuiWidget::$themeUrl` there is a directory whose name is the same as this property value (case-sensitive).
`protected mixed`	`$_scriptFile`		#
`public mixed`	`$cssFile`	`'jquery-ui.css'`	# the theme CSS file name. Defaults to 'jquery-ui.css'. Note the file must exist under the URL specified by `CJuiWidget::$themeUrl`/`CJuiWidget::$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. the theme CSS file name. Defaults to 'jquery-ui.css'. Note the file must exist under the URL specified by `CJuiWidget::$themeUrl`/`CJuiWidget::$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.
`public array`	`$options`	`array()`	# the initial JavaScript options that should be passed to the JUI plugin. the initial JavaScript options that should be passed to the JUI plugin.
`public array`	`$htmlOptions`	`array()`	# the HTML attributes that should be rendered in the HTML tag representing the JUI widget. the HTML attributes that should be rendered in the HTML tag representing the JUI widget.

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CJuiWidget

Direct known subclasses

Indirect known subclasses

Overrides

Parameters