| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Tooltip |
| Handler Class | None |
| Renderer Type | org.primefaces.component.TooltipRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
at | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines which position on the target element to align the positioned element against: "horizontal vertical" alignment. See the my option for full details on possible values. Percentage offsets are relative to the target element. If set overrides the 'position' attribute. Example "right center". |
autoHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to hide tooltip when hovering over tooltip content, default is true. |
beforeShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute before tooltip is shown. Returning false will prevent display. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
delegate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| No Description |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Defines whether html would be escaped or not, defaults to true. |
for | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Id of the component to attach the tooltip. |
globalSelector | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| jquery selector for global tooltip, default is "a,:input,:button". |
hideDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay time to hide tooltip in milliseconds. Default is 0 |
hideEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to be used for hiding. Default is fade. |
hideEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event hiding the tooltip. Default is mouseout. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
my | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines which position on the element being positioned to align with the target element: "horizontal vertical" alignment. A single value such as "right" will be normalized to "right center", "top" will be normalized to "center top" (following CSS convention). Acceptable horizontal values: "left", "center", "right". Acceptable vertical values: "top", "center", "bottom". Example: "left top" or "center center". Each dimension can also contain offsets, in pixels or percent, e.g., "right+10 top-25%". Percentage offsets are relative to the element being positioned. If set overrides the 'position' attribute. Example "left center". |
onHide | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute after tooltip is hidden. |
onShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute after tooltip is shown. |
position | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the tooltip, valid values are right, left, top and bottom. Default is 'right'. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
showDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay time to show tooltip in milliseconds. Default is 150. |
showEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to be used for displaying. Default is fade. |
showEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event displaying the tooltip. Default is mouseover. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the tooltip. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the tooltip. |
trackMouse | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Tooltip position follows pointer on mousemove, default is false |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.