[richfaces-svn-commits] JBoss Rich Faces SVN: r9059 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Mon Jun 16 11:48:51 EDT 2008
Author: atsebro
Date: 2008-06-16 11:48:51 -0400 (Mon, 16 Jun 2008)
New Revision: 9059
Modified:
trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
Log:
RF-3518--Tooltip hideEvent attribute value
Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-16 15:29:14 UTC (rev 9058)
+++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-16 15:48:51 UTC (rev 9059)
@@ -72,15 +72,15 @@
<section>
<title>Details of Usage</title>
<para>
- To specify text information, labeled on a <property>tooltip</property>, use <emphasis><property>"value"</property></emphasis> attribute.
- Images, links, buttons and other RichFaces components also may be put and composed inside <property>tooltip</property>.
+ To specify text information, labeled on a <emphasis role="bold"><property><rich:toolTip></property></emphasis>, use <emphasis><property>"value"</property></emphasis> attribute.
+ Images, links, buttons and other RichFaces components also may be put and composed inside <emphasis role="bold"><property><rich:toolTip></property></emphasis>.
Text, specified between <property>tooltip's</property> start and end tags will be rendered in browser as simple text.
- <property>Tooltip</property> borders stretch to enclose it contents.
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> borders stretch to enclose it contents.
</para>
<para>
- There are three ways to attach a <property>tooltip</property> to a page element.
+ There are three ways to attach a <emphasis role="bold"><property><rich:toolTip></property></emphasis> to a page element.
One of them uses nesting (this way is shown on example <link linkend="tab_ccpt">above</link>).
- In such cases <property>tooltip</property> is attached to the parent component by default.
+ In such cases <emphasis role="bold"><property><rich:toolTip></property></emphasis> is attached to the parent component by default.
</para>
<note>
<title>Note:</title>
@@ -95,7 +95,7 @@
</para>
</note>
<para>
- <property>Tooltip</property> may be attached to a page element by the use of <emphasis><property>"for"</property></emphasis> attribute. In this case a <property>tooltip</property> may be defined separately from a page element it is applied to.
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> may be attached to a page element by the use of <emphasis><property>"for"</property></emphasis> attribute. In this case a <emphasis role="bold"><property><rich:toolTip></property></emphasis> may be defined separately from a page element it is applied to.
<emphasis><property>"id"</property></emphasis> for page element is necessary (see the example below).
</para>
<para>
@@ -128,10 +128,10 @@
...
]]></programlisting>
<para>
- <property>Tooltip</property> may also be invoked by JS API function.
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> may also be invoked by JS API function.
List of JS API functions available for <emphasis role="bold"><property><rich:toolTip></property></emphasis> is listed <link linkend="tab_jsapi">below</link>.
- JS API functions are defined for a page element, the <property>tooltip</property> is applied to. So, <property>tooltip</property> can be defined separately from that page element.
- It is necessary to specify <emphasis><property>"ids"</property></emphasis> for both and set <property>tooltip</property> <emphasis><property>"attached"</property></emphasis> attribute's value to <emphasis><property>"false"</property></emphasis> (see the example below).
+ JS API functions are defined for a page element, the <emphasis role="bold"><property><rich:toolTip></property></emphasis> is applied to. So, <emphasis role="bold"><property><rich:toolTip></property></emphasis> can be defined separately from that page element.
+ It is necessary to specify <emphasis><property>"ids"</property></emphasis> for both and set <emphasis role="bold"><property><rich:toolTip></property></emphasis> <emphasis><property>"attached"</property></emphasis> attribute's value to <emphasis><property>"false"</property></emphasis> (see the example below).
</para>
<programlisting role="XML"><![CDATA[...
<rich:panel id="paneld" onclick="#{rich:component("tooltipId")}.show();">
@@ -141,11 +141,11 @@
...
]]></programlisting>
<para>
- The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <property>tooltip</property>.
+ The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <emphasis role="bold"><property><rich:toolTip></property></emphasis>.
The component works properly in client and Ajax modes.
- In client mode <property>toolTip</property> content is rendered once on the server and could be rerendered only via external submit.
- In Ajax mode <property>toolTip</property> content is requested from server for every activation.
- For Ajax mode there is possibility to define a facet <code>"defaultContent"</code>, which provides default <property>tooltip</property> content to be displayed, while main content is loading into the <property>tooltip</property> (see the example below).
+ In client mode <emphasis role="bold"><property><rich:toolTip></property></emphasis> content is rendered once on the server and could be rerendered only via external submit.
+ In Ajax mode <emphasis role="bold"><property><rich:toolTip></property></emphasis> content is requested from server for every activation.
+ For Ajax mode there is possibility to define a facet <code>"defaultContent"</code>, which provides default <emphasis role="bold"><property><rich:toolTip></property></emphasis> content to be displayed, while main content is loading into the <emphasis role="bold"><property><rich:toolTip></property></emphasis> (see the example below).
</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -175,7 +175,7 @@
</figure>
<para>
- And after <property>toolTip</property> loaded it is changed to next one:
+ And after <emphasis role="bold"><property><rich:toolTip></property></emphasis> loaded it is changed to next one:
</para>
<figure>
@@ -188,18 +188,27 @@
</figure>
<para>
- <property>toolTip</property> appears attached to the corner dependent on the <emphasis><property>"direction"</property></emphasis> attribute.
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> appears attached to the corner
+ dependent on the <emphasis><property>"direction"</property></emphasis> attribute.
By default it is positioned bottom-right.
- <property>toolTip</property> activation occurs after an event, defined on the parent component, takes into consideration the "delay" attribute or after calling JS API function <code>show()</code>.
- <property>toolTip</property> deactivation occurs after <emphasis>mouseout</emphasis> event on the parent component (excepting the situation when the mouse is hovered onto the <property>tooltip</property> itself) or after calling JS API function <code>hide()</code>.
- </para>
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> activation occurs after an event,
+ defined on the parent component, takes into consideration the "delay" attribute
+ or after calling JS API function <code>show()</code>.
+ <emphasis><property>"hideEvent"</property></emphasis> attribute defines the way
+ how <emphasis role="bold"><property><rich:toolTip></property></emphasis> disappears.
+ It default value is <emphasis><property>"none"</property></emphasis>, so the <emphasis role="bold"><property><rich:toolTip></property></emphasis> does not dissapears.
+ Deactivation may be set for example on <emphasis>mouseout</emphasis> event on the parent component
+ (excepting the situation when the mouse is hovered onto the
+ <emphasis role="bold"><property><rich:toolTip></property></emphasis> itself)
+ or after calling JS API function <code>hide()</code>.
+ </para>
<para>
- By default, <property>tooltip</property> appears smart positioned. But as you can see from the previous example, you
+ By default, <emphasis role="bold"><property><rich:toolTip></property></emphasis> appears smart positioned. But as you can see from the previous example, you
can define an appearance direction via the corresponding attribute <emphasis><property>"direction"</property></emphasis>.
And also it's possible to define vertical and horizontal offsets relatively to a mouse position.
</para>
<para>
- Disabled <property>tooltip</property> is rendered to a page as usual but JS that responds for its activation is disabled until <code>enable()</code> is called.
+ Disabled <emphasis role="bold"><property><rich:toolTip></property></emphasis> is rendered to a page as usual but JS that responds for its activation is disabled until <code>enable()</code> is called.
</para>
<para>
Moreover, to add some JavaScript effects, client events defined on it are used:
More information about the richfaces-svn-commits
mailing list