| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.Tooltip |
| Handler Class | None |
| Renderer Type | org.primefaces.extensions.component.TooltipRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
adjustX | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| A positive or negative pixel value by which to offset the tooltip in the horizontal plane (x-axis). Negative values cause a reduction in the value (moves tooltip to the left). Default value is 0. |
adjustY | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| A positive or negative pixel value by which to offset the tooltip in the vertical plane (y-axis). Negative values cause a reduction in the value (moves tooltip upwards). Default value is 0. |
atPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The corner of the target element to position the tooltips corner at. Default value is 'bottom right'. |
autoShow | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| This flag enables showing tooltips automatically after page loading. Auto shown tooltips can not be global or shared. Default value is false. |
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. |
fixed | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set to true, the tooltip will not hide if moused over, allowing the contents to be clicked and interacted with. Default value is false. |
for | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Id of the component to attach the tooltip. |
global | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| A global tooltip converts each title attribute to a tooltip. Default value is false. |
header | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Header or Titlebar of the tooltip. Not applicable on global tooltips. Default value is null. |
hideDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay time for hiding the tooltip. Default value is 0. |
hideEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to be used for hiding. Default value is fadeOut. |
hideEffectLength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Time in milliseconds to process the hide effect. Default value is 500. |
hideEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event hiding the tooltip. Default value is mouseleave. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
mouseTracking | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| This flag enables tooltip's positioning in relation to the mouse. Default value is false. |
myPosition | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The corner of the tooltip to position in relation to the target element. Default value is 'top left'. |
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. |
shared | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| A shared tooltip - one tooltip, multiple targets. Default value is false. |
showDelay | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Delay time for displaying the tooltip. Default value is 0. |
showEffect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to be used for displaying. Default value is fadeIn. |
showEffectLength | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Integer)
| Time in milliseconds to display the effect. Default value is 500. |
showEvent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Event displaying the tooltip. Default value is mouseenter. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the tooltip will override ThemeRoller theme. Default value is null. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component than can be either an EL expression of a literal text. |
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.