Class CJuiAutoComplete

CJuiAutoComplete displays an autocomplete field.

CJuiAutoComplete encapsulates the JUI autocomplete plugin.

To use this widget, you may insert the following code in a view:

$this->widget('zii.widgets.jui.CJuiAutoComplete',array(
    'name'=>'city',
    'source'=>array('ac1','ac2','ac3'),
    // additional javascript options for the autocomplete plugin
    'options'=>array(
        'minLength'=>'2',
    ),
    'htmlOptions'=>array(
        'style'=>'height:20px;',
    ),
));

By configuring the CJuiWidget::$options property, you may specify the options that need to be passed to the JUI autocomplete plugin. Please refer to the JUI AutoComplete API documentation for possible options (name-value pairs) and JUI AutoComplete page for general description and demo.

By configuring the CJuiAutoComplete::$source property, you may specify where to search the autocomplete options for each item. If source is an array, the list is used for autocomplete. You may also configure CJuiAutoComplete::$sourceUrl to retrieve autocomplete items from an ajax response.

CComponent

CBaseController

CWidget

CJuiWidget

CJuiInputWidget

CJuiAutoComplete

Package: zii\widgets\jui
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Sebastian Thierer <sebathi@gmail.com>
Since: 1.1.2
Located at x2engine/framework/zii/widgets/jui/CJuiAutoComplete.php

Methods summary
`public`	# `run( )` Run this widget. This method registers necessary javascript and renders the needed HTML code. Run this widget. This method registers necessary javascript and renders the needed HTML code. Overrides `CWidget::run()`

Methods inherited from CJuiInputWidget
`hasModel(), resolveNameID()`

Methods inherited from CJuiWidget
`getScriptFile(), init(), registerCoreScripts(), registerScriptFile(), resolvePackagePath(), setScriptFile()`

Methods inherited from CWidget
`__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), 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 mixed`	`$source`	`array()`	# the entries that the autocomplete should choose from. This can be an Array with local data a String, specifying a URL that returns JSON data as the entries. a javascript callback. Please make sure you wrap the callback with `CJavaScriptExpression` in this case. the entries that the autocomplete should choose from. This can be an Array with local data a String, specifying a URL that returns JSON data as the entries. a javascript callback. Please make sure you wrap the callback with `CJavaScriptExpression` in this case.
`public mixed`	`$sourceUrl`		# the URL that will return JSON data as the autocomplete items. CHtml::normalizeUrl() will be applied to this property to convert the property into a proper URL. When this property is set, the `CJuiAutoComplete::$source` property will be ignored. the URL that will return JSON data as the autocomplete items. CHtml::normalizeUrl() will be applied to this property to convert the property into a proper URL. When this property is set, the `CJuiAutoComplete::$source` property will be ignored.

Properties inherited from CJuiInputWidget
`$attribute, $model, $name, $value`

Properties inherited from CJuiWidget
`$_scriptFile, $cssFile, $htmlOptions, $options, $scriptUrl, $theme, $themeUrl`

Properties inherited from CWidget
`$actionPrefix, $skin`

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

Packages

Classes

Class CJuiAutoComplete

Overrides