Composant JQuery UI Button. More...
Inheritance diagram for Button:
Public Member Functions | |
| __construct (JsUtils $js) | |
| setDisabled ($value) | |
| Disables the button if set to true. | |
| setIcons ($value) | |
| Icons to display, with or without text (see text option). | |
| setText ($value) | |
| Whether to show the label. | |
| setLabel ($value) | |
| Text to show in the button. | |
| Public Member Functions inherited from SimpleComponent | |
| getScript () | |
| attach ($identifier) | |
| addEvent ($event, $jsCode) | |
| on ($event, $jsCode) | |
| getAttachTo () | |
| getItemSelector () | |
| setItemSelector ($itemSelector) | |
| Public Member Functions inherited from BaseComponent | |
| setParam ($key, $value) | |
| getParam ($key) | |
| getParams () | |
| compile (JsUtils $js=NULL) | |
| setParams ($params) | |
| addParams ($params) | |
| setDebug ($value) | |
| setVerbose ($value) | |
Additional Inherited Members | |
| Data Fields inherited from BaseComponent | |
| $jquery_code_for_compile =array () | |
| Protected Member Functions inherited from SimpleComponent | |
| compileEvents () | |
| _createSelector ($itemSelector, $selector) | |
| compileJQueryCode () | |
| setParamCtrl ($key, $value, $typeCtrl) | |
| Protected Member Functions inherited from BaseComponent | |
| getParamsAsJSON ($params) | |
| Protected Attributes inherited from SimpleComponent | |
| $attachTo | |
| $itemSelector | |
| $uiName | |
| $events | |
| Protected Attributes inherited from BaseComponent | |
| $params =array () | |
| $js | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | JsUtils | $js | ) |
Reimplemented from SimpleComponent.
Definition at line 16 of file Button.php.
Member Function Documentation
◆ setDisabled()
| setDisabled | ( | $value | ) |
Disables the button if set to true.
- Parameters
-
Boolean $value default : false
- Returns
- $this
Definition at line 28 of file Button.php.
◆ setIcons()
| setIcons | ( | $value | ) |
Icons to display, with or without text (see text option).
By default, the primary icon is displayed on the left of the label text and the secondary is displayed on the right. The positioning can be controlled via CSS. The value for the primary and secondary properties must match an icon class name, e.g., "ui-icon-gear". For using only one icon: icons: { primary: "ui-icon-locked" }. For using two icons: icons: { primary: "ui-icon-gear", secondary: "ui-icon-triangle-1-s" }.
- Parameters
-
String $value default : { primary: null, secondary: null }
- Returns
- $this
Definition at line 43 of file Button.php.
◆ setLabel()
| setLabel | ( | $value | ) |
Text to show in the button.
When not specified (null), the element's HTML content is used, or its value attribute if the element is an input element of type submit or reset, or the HTML content of the associated label element if the element is an input of type radio or checkbox.
- Parameters
-
string $value default : null
- Returns
- $this
Definition at line 72 of file Button.php.
◆ setText()
| setText | ( | $value | ) |
Whether to show the label.
When set to false no text will be displayed, but the icons option must be enabled, otherwise the text option will be ignored.
- Parameters
-
Boolean $value default : false
- Returns
- $this
Definition at line 59 of file Button.php.
The documentation for this class was generated from the following file:
- Ajax/ui/components/Button.php