Package | zii.widgets.jui |
---|---|
Inheritance | class CJuiAutoComplete » CJuiInputWidget » CJuiWidget » CWidget » CBaseController » CComponent |
Since | 1.1.2 |
Source Code | framework/zii/widgets/jui/CJuiAutoComplete.php |
$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;', ), ));
Property | Type | Description | Defined By |
---|---|---|---|
actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
attribute | string | the attribute associated with this widget. | CJuiInputWidget |
controller | CController | Returns the controller that this widget belongs to. | CWidget |
cssFile | mixed | the theme CSS file name. | CJuiWidget |
htmlOptions | array | the HTML attributes that should be rendered in the HTML tag representing the JUI widget. | CJuiWidget |
id | string | Returns the ID of the widget or generates a new one if requested. | CWidget |
model | CModel | the data model associated with this widget. | CJuiInputWidget |
name | string | the input name. | CJuiInputWidget |
options | array | the initial JavaScript options that should be passed to the JUI plugin. | CJuiWidget |
owner | CBaseController | Returns the owner/creator of this widget. | CWidget |
scriptFile | mixed | the main JUI JavaScript file. | CJuiWidget |
scriptUrl | string | the root URL that contains all JUI JavaScript files. | CJuiWidget |
skin | mixed | the name of the skin to be used by this widget. | CWidget |
source | mixed | the entries that the autocomplete should choose from. | CJuiAutoComplete |
sourceUrl | mixed | the URL that will return JSON data as the autocomplete items. | CJuiAutoComplete |
theme | string | the JUI theme name. | CJuiWidget |
themeUrl | string | the root URL that contains all JUI theme folders. | CJuiWidget |
value | string | the input value. | CJuiInputWidget |
viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
Method | Description | Defined 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 |
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. | CJuiWidget |
raiseEvent() | Raises an event. | CComponent |
render() | Renders a view. | CWidget |
renderFile() | Renders a view file. | CBaseController |
renderInternal() | Renders a view file. | CBaseController |
run() | Run this widget. | CJuiAutoComplete |
setId() | Sets the ID of the widget. | CWidget |
widget() | Creates a widget and executes it. | CBaseController |
Method | Description | Defined By |
---|---|---|
hasModel() | Determines whether this widget is associated with a data model. | CJuiInputWidget |
registerCoreScripts() | Registers the core script files. | CJuiWidget |
registerScriptFile() | Registers a JavaScript file under scriptUrl. | CJuiWidget |
resolveNameID() | Resolves name and ID of the input. Source property of the name and/or source property of the attribute | CJuiInputWidget |
resolvePackagePath() | Determine the JUI package installation path. | CJuiWidget |
public mixed $source;
the entries that the autocomplete should choose from. This can be
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 source property will be ignored.
public void run() |
public function run()
{
list($name,$id)=$this->resolveNameID();
if(isset($this->htmlOptions['id']))
$id=$this->htmlOptions['id'];
else
$this->htmlOptions['id']=$id;
if(isset($this->htmlOptions['name']))
$name=$this->htmlOptions['name'];
if($this->hasModel())
echo CHtml::activeTextField($this->model,$this->attribute,$this->htmlOptions);
else
echo CHtml::textField($name,$this->value,$this->htmlOptions);
if($this->sourceUrl!==null)
$this->options['source']=CHtml::normalizeUrl($this->sourceUrl);
else
$this->options['source']=$this->source;
$options=CJavaScript::encode($this->options);
Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').autocomplete($options);");
}
Run this widget. This method registers necessary javascript and renders the needed HTML code.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CJuiAutoComplete