The <rich:tooltip> component provides an informational tool-tip. The tool-tip can be attached to any control and
is displayed when hovering the mouse cursor over the control.
@author amarkhel
| Attributes |
| Name |
Required |
Type |
Description |
| attached |
false |
boolean |
If the value of the "attached" attribute is "true", a component is attached to the parent component; if "false", component
does not listen to activating browser events, but could be activated externally. Default value is "true"
|
| binding |
false |
javax.faces.component.UIComponent |
The value binding expression used to wire up this component to a component property of a JavaBean class |
| converter |
false |
javax.faces.convert.Converter |
Converter instance registered with this component. |
| data |
false |
java.lang.Object |
Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data"
syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
|
| dir |
false |
java.lang.String |
Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
| direction |
false |
org.richfaces.component.Positioning |
Set the direction of the popup. Possible values are:
AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB
(bottomRight, LA (autoLeft), RA (autoRight), AT (topAuto), AB (bottomAuto) Default value is auto
|
| followMouse |
false |
boolean |
If "true" tooltip should follow the mouse while it moves over the parent element. Default value is "false" |
| hideDelay |
false |
int |
Delay in milliseconds before tooltip will be hidden. Default value is "0" |
| hideEvent |
false |
java.lang.String |
Event that triggers the tooltip disappearance. Default value is "mouseleave" |
| horizontalOffset |
false |
int |
Sets the horizontal offset between pop-up list and mouse pointer. Default value is "10" |
| id |
false |
java.lang.String |
The component identifier for this component. This value must be unique within the closest parent component that is a naming
container.
|
| jointPoint |
false |
org.richfaces.component.Positioning |
Set the corner attachment point with which the popup should be connected. Possible values are:
AA (auto), LT (topLeft),
RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft), RA (autoRight), AT (topAuto), AB (bottomAuto) Default
value is auto
|
| lang |
false |
java.lang.String |
Code describing the language used in the generated markup for this component. |
| layout |
false |
org.richfaces.TooltipLayout |
Block/inline mode flag. Possible value are: "inline" or "block". Default value is "inline". Tooltip will contain div/span
elements respectively.
|
| limitRender |
false |
boolean |
If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels |
| mode |
false |
org.richfaces.TooltipMode |
Controls the way of data loading to a tooltip. May have following values: "client" (default) and "ajax" |
| onbeforedomupdate |
false |
java.lang.String |
The client-side script method to be called after the ajax response comes back, but before the DOM is updated |
| onbeforehide |
false |
java.lang.String |
The client-side code executed before the popup disappears. |
| onbeforeshow |
false |
java.lang.String |
The client-side code executed before this component is shown. |
| onbegin |
false |
java.lang.String |
The client-side script method to be called before an ajax request. |
| onclick |
false |
java.lang.String |
Javascript code executed when a pointer button is clicked over this element. |
| oncomplete |
false |
java.lang.String |
The client-side script method to be called after the DOM is updated |
| ondblclick |
false |
java.lang.String |
Javascript code executed when a pointer button is double clicked over this element. |
| onhide |
false |
java.lang.String |
The client-side code executed after the popup disappears. |
| onmousedown |
false |
java.lang.String |
Javascript code executed when a pointer button is pressed down over this element. |
| onmousemove |
false |
java.lang.String |
Javascript code executed when a pointer button is moved within this element. |
| onmouseout |
false |
java.lang.String |
Javascript code executed when a pointer button is moved away from this element. |
| onmouseover |
false |
java.lang.String |
Javascript code executed when a pointer button is moved onto this element. |
| onmouseup |
false |
java.lang.String |
Javascript code executed when a pointer button is released over this element. |
| onshow |
false |
java.lang.String |
The client-side code executed after the popup is shown. |
| render |
false |
java.lang.Object |
Ids of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single id, a
space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this",
"@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
|
| rendered |
false |
boolean |
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent
form submit. The default value for this property is true.
|
| showDelay |
false |
int |
Delay in milliseconds before tooltip will be displayed. Default value is "0" |
| showEvent |
false |
java.lang.String |
Event that triggers the tooltip. Default value is "mouseenter" |
| status |
false |
java.lang.String |
Name of the request status component that will indicate the status of the Ajax request |
| style |
false |
java.lang.String |
CSS style(s) to be applied when this component is rendered. |
| styleClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
|
| target |
false |
java.lang.String |
Component ID of the target component or "null" if the component should be attached to the parent component. |
| title |
false |
java.lang.String |
Advisory title information about markup elements generated for this component. |
| value |
false |
java.lang.Object |
The current value of this component. |
| verticalOffset |
false |
int |
Sets the vertical offset between pop-up list and mouse pointer. Default value is "10" |
| zindex |
false |
int |
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value
is "3".
|