CJuiButton
| Package | zii.widgets.jui |
|---|---|
| Inheritance | class CJuiButton » CJuiInputWidget » CJuiWidget » CWidget » CBaseController » CComponent |
| Since | 1.1.3 |
| Version | $Id: CJuiButton.php 174 2010-05-06 14:51:15Z qiang.xue $ |
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:
To use this widget as a button, you may insert the following code in a view:
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 documentation for possible options (name-value pairs).
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(
'name'=>'submit',
'options'=>array(
'onclick'=>'js:function(){alert("Yes");}',
),
));
To use this widget as a button, you may insert the following code in a view:
$this->widget('zii.widgets.jui.CJuiButton',
array(
'name'=>'button',
'value'=>'asd',
'onclick'=>'js:function(){alert("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 documentation for possible options (name-value pairs).
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). | CJuiButton |
| caption | string | The button text | CJuiButton |
| controller | CController | 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 | id of the widget. | 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 | 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 | string | The url used when a buttonType "link" is selected. | CJuiButton |
| value | mixed | The value of the current item. | CJuiInputWidget |
| 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() | CWidget | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CWidget | |
| getOwner() | 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() | CJuiButton | |
| setId() | CWidget | |
| widget() | Creates a widget and executes it. | CBaseController |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| hasModel() | CJuiInputWidget | |
| registerCoreScripts() | Registers the core script files. | CJuiWidget |
| registerScriptFile() | Registers a JavaScript file under scriptUrl. | CJuiWidget |
| resolveNameID() | 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). For radio and checkbox you could add
caption
property
public string $caption;
The button text
onclick
property
public string $onclick;
The javascript function to be raised when this item is clicked (client event).
url
property
public string $url;
The url used when a buttonType "link" is selected.
Method Details
run()
method
|
public void run()
|