Composant JQuery UI Menu. More...
Inheritance diagram for Tooltip:
Public Member Functions | |
| __construct (JsUtils $js) | |
| setContent ($value) | |
| The content of the tooltip. | |
| setDisabled ($value) | |
| Disables the tooltip if set to true. | |
| setHide ($value) | |
| If and how to animate the hiding of the tooltip. | |
| setItems ($value) | |
| A selector indicating which items should show tooltips. | |
| setPosition (Position $position) | |
| Identifies the position of the tooltip in relation to the associated target element. | |
| setShow ($value) | |
| If and how to animate the showing of the tooltip. | |
| setTooltipClass ($value) | |
| A class to add to the widget, can be used to display various tooltip types, like warnings or errors. | |
| setTrack ($value) | |
| Whether the tooltip should track (follow) the mouse. | |
| onClose ($jsCode) | |
| Triggered when a tooltip is closed, triggered on focusout or mouseleave. | |
| onOpen ($jsCode) | |
| Triggered when a tooltip is shown, triggered on focusin or mouseover. | |
| 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 Tooltip.php.
Member Function Documentation
◆ onClose()
| onClose | ( | $jsCode | ) |
Triggered when a tooltip is closed, triggered on focusout or mouseleave.
- Parameters
-
string $jsCode
- Returns
- $this
Definition at line 121 of file Tooltip.php.
◆ onOpen()
| onOpen | ( | $jsCode | ) |
Triggered when a tooltip is shown, triggered on focusin or mouseover.
- Parameters
-
string $jsCode
- Returns
- $this
Definition at line 131 of file Tooltip.php.
◆ setContent()
| setContent | ( | $value | ) |
The content of the tooltip.
- Parameters
-
string $value string or function default : function returning the title attribute
- Returns
- $this
Definition at line 29 of file Tooltip.php.
◆ setDisabled()
| setDisabled | ( | $value | ) |
Disables the tooltip if set to true.
- Parameters
-
mixed $value default : false
- Returns
- $this
Definition at line 40 of file Tooltip.php.
◆ setHide()
| setHide | ( | $value | ) |
If and how to animate the hiding of the tooltip.
- Parameters
-
mixed $value default : true
- Returns
- $this
Definition at line 51 of file Tooltip.php.
◆ setItems()
| setItems | ( | $value | ) |
A selector indicating which items should show tooltips.
Customize if you're using something other then the title attribute for the tooltip content, or if you need a different selector for event delegation.
- Parameters
-
string $value default : title
- Returns
- $this
Definition at line 64 of file Tooltip.php.
◆ setPosition()
| setPosition | ( | Position | $position | ) |
Identifies the position of the tooltip in relation to the associated target element.
The of option defaults to the target element, but you can specify another element to position against. You can refer to the jQuery UI Position utility for more details about the various options.
- Parameters
-
Position $position default : { my: "left top+15", at: "left bottom", collision: "flipfit" }
- Returns
- $this
Definition at line 77 of file Tooltip.php.
◆ setShow()
| setShow | ( | $value | ) |
If and how to animate the showing of the tooltip.
- Parameters
-
mixed $value default : true
- Returns
- $this
Definition at line 88 of file Tooltip.php.
◆ setTooltipClass()
| setTooltipClass | ( | $value | ) |
A class to add to the widget, can be used to display various tooltip types, like warnings or errors.
This may get replaced by the classes option.
- Parameters
-
string $value default : null
- Returns
- $this
Definition at line 100 of file Tooltip.php.
◆ setTrack()
| setTrack | ( | $value | ) |
Whether the tooltip should track (follow) the mouse.
- Parameters
-
Boolean $value default :false
- Returns
- $this
Definition at line 111 of file Tooltip.php.
The documentation for this class was generated from the following file:
- Ajax/ui/components/Tooltip.php