ICEfaces-EE ACE Components
Tag tooltip


The Tooltip is a component that displays a tooltip with various events, effects and customization options.

For more information, see the Tooltip Wiki Documentation.


Client Events
NameDescriptionSupported classes for argument
displayFired before the tooltip is shown (default event).javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.tooltip.TooltipTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
converternotruejavax.faces.convert.ConverterConverter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.
delegateDisplayListenernotruejavax.el.MethodExpressionA server side listener to be invoked when a tooltip in delegate mode is about to be shown in the client. It must evaluate to a public void method with a TooltipDelegateDisplayEvent argument. This listener allows the possiblity of preventing the tooltip from being displayed by calling event.cancelDisplay().
displayListenernotruejavax.el.MethodExpressionA server side listener to be invoked when the tooltip is about to be shown in the client. It must evaluate to a public void method with no arguments.
fetchnotruejavax.el.ValueExpressionWhen using "forDelegate", an EL expression can be specified as the value of this attribute. Such expression will be evaluated at the same point (e.g. row) where the component that triggered the tooltip is located, allowing to retrieve row data in a table or iterative container. The result is saved in the bean property specified by the "store" attribute.
fornotruejava.lang.StringSpecifies the id of the component that will display the tooltip. Ignored if "global" is true. Multiple component ids can be specified separated by commas.
forContainernotruejava.lang.StringSpecifies the id of the component that contains the component referenced by the "for" attribute. This is to be used in cases where the target component is inside an iterative container such as a data table and the tooltip component itself is outside. A more robust solution is to use "forDelegate" instead of this attribute.
forDelegatenotruejava.lang.StringSpecifies the id of the component that will receive the tooltip listeners on behalf of the component specified in the "for" attribute. This is useful when the tooltip component is outside a data table or iterative container and references a component inside such container. This improves performance by avoiding the creation of tooltip objects in each each row. It also guards against dynamic updates that could replace the component and make it lose its tooltip listeners. Additionally, this method allows retrieving row data by using the "fetch" and "store" attributes. This is a better alternative to "forContainer".
forElementnotruejava.lang.StringSpecifies the id of the HTML element that will display the tooltip. Applicable only if "for" component is not specified. Ignored if "global" is true.
globalnotruebooleanBoolean value specifying whether to create tooltips for all elements with a title attribute using the title attribute value. Default = 'false'.
hideDelaynotrueintTime in milliseconds by which to delay the hiding of the tooltip. Default = '0'.
hideEffectnotruejava.lang.StringEffect to use upon hiding the tooltip e.g. fade, slide or grow. Default = 'fade'.
hideEffectLengthnotrueintLength of time in milliseconds the hide effect will last for. Default = '500'.
hideEventnotruejava.lang.StringEvent which will trigger the hiding of the tooltip. Possible values are DOM events, such as "mouseout", documented under jQuery's Event: bind(). Default = 'mouseout'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
positionnotruejava.lang.StringThe corner of the tooltip to position in relation to the target's corner. E.g. topLeft, bottomRight. See positioning for all possible values. Default = 'topLeft'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
showDelaynotrueintTime in milliseconds by which to delay the showing of the tooltip. Default = '140'.
showEffectnotruejava.lang.StringEffect to use upon showing the tooltip e.g. fade, slide or grow. Default = 'fade'.
showEffectLengthnotrueintLength of time in milliseconds the show effect will last for. Default = '500'.
showEventnotruejava.lang.StringEvent which will trigger the showing of the tooltip. Possible values are DOM events, such as "mouseover", documented under jQuery's Event: bind(). Default = 'mouseover'.
speechBubblenotruebooleanSpecifies whether the tooltip should be stylized as a speech bubble (i.e. with a speech bubble arrow tip pointing to the triggerer element). Default = 'false'.
storenotruejava.lang.ObjectThe result of evaluating the expression specified in "fetch" is stored in the bean property specified in this attribute.
stylenotruejava.lang.StringThe inline style of the component, rendered on the root div of the component.
styleClassnotruejava.lang.StringThe CSS style class of the component, rendered on the root div of the component.
targetPositionnotruejava.lang.StringThe corner of the target element by which to position the tooltip by. E.g. topLeft, bottomRight. See positioning for all possible values. Default = 'bottomRight'.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
widgetVarnotruejava.lang.StringName of the widget to access client side api

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.