CJuiButton

Package	zii.widgets.jui
Inheritance	class CJuiButton » CJuiInputWidget » CJuiWidget » CWidget » CBaseController » CComponent
Since	1.1.3
Source Code	framework/zii/widgets/jui/CJuiButton.php

CJuiButton displays a button widget.

CJuiButton encapsulates the JUI Button plugin.

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

$this->widget('zii.widgets.jui.CJuiButton',array(
    'buttonType'=>'submit',
    'name'=>'btnSubmit',
    'value'=>'1',
    'caption'=>'Submit form',
    'htmlOptions'=>array('class'=>'ui-button-primary')
    ),
));

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

$this->widget('zii.widgets.jui.CJuiButton',array(
    'buttonType'=>'button',
    'name'=>'btnSave',
    'caption'=>'Save',
    'onclick'=>new CJavaScriptExpression('function(){alert("Save button clicked"); this.blur(); return false;}'),
));

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

Public Properties

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
buttonType	string	The button type (possible types: submit, button, link, radio, checkbox, buttonset).	CJuiButton
caption	string	The button text	CJuiButton
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
htmlTag	string	The default html tag for the buttonset	CJuiButton
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
onclick	string	The javascript function to be raised when this item is clicked (client event).	CJuiButton
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
theme	string	the JUI theme name.	CJuiWidget
themeUrl	string	the root URL that contains all JUI theme folders.	CJuiWidget
url	mixed	a URL or an action route that can be used to create a URL.	CJuiButton
value	mixed	The value of the current item.	CJuiButton
viewPath	string	Returns the directory containing the view files for this widget.	CWidget

Public Methods

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()	(non-PHPdoc)	CJuiButton
raiseEvent()	Raises an event.	CComponent
render()	Renders a view.	CWidget
renderFile()	Renders a view file.	CBaseController
renderInternal()	Renders a view file.	CBaseController
run()	(non-PHPdoc)	CJuiButton
setId()	Sets the ID of the widget.	CWidget
widget()	Creates a widget and executes it.	CBaseController

Protected Methods

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

Property Details

buttonType property

public string $buttonType;

The button type (possible types: submit, button, link, radio, checkbox, buttonset). "submit" is used as default.

caption property

public string $caption;

The button text

htmlTag property

public string $htmlTag;

The default html tag for the buttonset

onclick property

public string $onclick;

The javascript function to be raised when this item is clicked (client event).

url property

public mixed $url;

a URL or an action route that can be used to create a URL. Used when a buttonType "link" is selected. See normalizeUrl for more details about how to specify this parameter.

value property

public mixed $value;

The value of the current item. Used only for "radio" and "checkbox"

Method Details

init() method

public void init()

Source Code: framework/zii/widgets/jui/CJuiButton.php#85 (show)

public function init()
{
    parent::init();

    if($this->buttonType=='buttonset')
    {
        if(!isset($this->htmlOptions['id']))
            $this->htmlOptions['id']=$this->getId();

        echo CHtml::openTag($this->htmlTag,$this->htmlOptions);
    }
}

(non-PHPdoc)

run() method

public void run()

Source Code: framework/zii/widgets/jui/CJuiButton.php#102 (show)

public function run()
{
    $cs=Yii::app()->getClientScript();
    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'];
    else
        $this->htmlOptions['name']=$name;

    if($this->buttonType=='buttonset')
    {
        echo CHtml::closeTag($this->htmlTag);
        $cs->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').buttonset();");
    }
    else
    {
        switch($this->buttonType)
        {
            case 'submit':
                echo CHtml::submitButton($this->caption,$this->htmlOptions)."\n";
                break;
            case 'button':
                echo CHtml::htmlButton($this->caption,$this->htmlOptions)."\n";
                break;
            case 'link':
                echo CHtml::link($this->caption,$this->url,$this->htmlOptions)."\n";
                break;
            case 'radio':
                if($this->hasModel())
                {
                    echo CHtml::activeRadioButton($this->model,$this->attribute,$this->htmlOptions);
                    echo CHtml::label($this->caption,CHtml::activeId($this->model,$this->attribute))."\n";
                }
                else
                {
                    echo CHtml::radioButton($name,$this->value,$this->htmlOptions);
                    echo CHtml::label($this->caption,$id)."\n";
                }
                break;
            case 'checkbox':
                if($this->hasModel())
                {
                    echo CHtml::activeCheckbox($this->model,$this->attribute,$this->htmlOptions);
                    echo CHtml::label($this->caption,CHtml::activeId($this->model,$this->attribute))."\n";
                }
                else
                {
                    echo CHtml::checkbox($name,$this->value,$this->htmlOptions);
                    echo CHtml::label($this->caption,$id)."\n";
                }
                break;
            default:
                throw new CException(Yii::t('zii','The button type "{type}" is not supported.',array('{type}'=>$this->buttonType)));
        }

        $options=CJavaScript::encode($this->options);
        if($this->onclick!==null)
        {
            if(!($this->onclick instanceof CJavaScriptExpression))
                $this->onclick=new CJavaScriptExpression($this->onclick);
            $click=CJavaScript::encode($this->onclick);
            $cs->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').button($options).click($click);");
        }
        else
            $cs->registerScript(__CLASS__.'#'.$id,"jQuery('#{$id}').button($options);");
    }
}