From richfaces-svn-commits at lists.jboss.org Mon Jun 16 13:16:52 2008 Content-Type: multipart/mixed; boundary="===============8013284754625290288==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r9059 - trunk/docs/userguide/en/src/main/docbook/included. Date: Mon, 16 Jun 2008 11:48:51 -0400 Message-ID: --===============8013284754625290288== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-1= 6 15:29:14 UTC (rev 9058) +++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-1= 6 15:48:51 UTC (rev 9059) @@ -72,15 +72,15 @@
Details of Usage - To specify text information, labeled on a tooltip, use "value" = attribute. = - Images, links, buttons and other RichFaces components also m= ay be put and composed inside tooltip. = + To specify text information, labeled on a <rich:toolTip>, use "value" attribute. = + Images, links, buttons and other RichFaces components also m= ay be put and composed inside <rich:to= olTip>. = Text, specified between tooltip's start = and end tags will be rendered in browser as simple text. = - Tooltip borders stretch to enclose it c= ontents. + <rich:toolTip> borders stretch to enclose it contents. - There are three ways to attach a tooltip= to a page element. = + There are three ways to attach a <rich:toolTip> to a page element. = One of them uses nesting (this way is shown on example above). = - In such cases tooltip is attached to the= parent component by default. + In such cases <rich:tool= Tip> is attached to the parent component by defaul= t. Note: @@ -95,7 +95,7 @@ - Tooltip may be attached to a page elemen= t by the use of "for" a= ttribute. In this case a tooltip may be defined separa= tely from a page element it is applied to. = + <rich:toolTip> may be attached to a page element by the use of <= property>"for" attribute. In this case a <rich:toolTip> = may be defined separately from a page element it is applied to. = "id" for = page element is necessary (see the example below). @@ -128,10 +128,10 @@ ... ]]> - Tooltip may also be invoked by JS API function. + <rich:toolTip> may also be invoked by JS API function. List of JS API functions available for <rich:toolTip> is listed below. - JS API functions are defined for a page element, the toolti= p is applied to. So, tooltip can be defined= separately from that page element. = - It is necessary to specify "ids" for both and set tooltip "attached" attribute's value to "false" (see the example be= low). = + JS API functions are defined for a page element, the <rich:toolTip> is applied t= o. So, <rich:toolTip> can be defined separately from that page element. = + It is necessary to specify "ids" for both and set <rich= :toolTip> "attached"= attribute's value to "false= " (see the example below). = @@ -141,11 +141,11 @@ ... ]]> - The "mode" attrib= ute is provided you to control the way of data loading to tooltip= . + The "mode" attrib= ute is provided you to control the way of data loading to <rich:toolTip>. The component works properly in client and Ajax modes. - In client mode toolTip content is rendered once = on the server and could be rerendered only via external submit. = - In Ajax mode toolTip content is requested from s= erver for every activation. = - For Ajax mode there is possibility to define a facet "defa= ultContent", which provides default tooltip content to be displayed, while main content is loading into the tooltip (see the example below). + In client mode <rich:toolTip>= content is rendered once on the server and could be = rerendered only via external submit. = + In Ajax mode <rich:toolTip> content is requested from server for every activation. = + For Ajax mode there is possibility to define a facet "defa= ultContent", which provides default <rich:toolTip> content to be displayed, = while main content is loading into the &l= t;rich:toolTip> (see the example below). Example: @@ -175,7 +175,7 @@ = - And after toolTip loaded it is changed to next o= ne: + And after <rich:toolTip> loaded it is changed to next one: =
@@ -188,18 +188,27 @@
= - toolTip appears attached to the corner dependent= on the "direction" att= ribute. = + <rich:toolTip> appears attached to the corner = + dependent on the "direction"= attribute. = By default it is positioned bottom-right. = - toolTip activation occurs after an event, define= d on the parent component, takes into consideration the "delay" a= ttribute or after calling JS API function show(). = - toolTip deactivation occurs after mous= eout event on the parent component (excepting the situation when= the mouse is hovered onto the tooltip itself) or afte= r calling JS API function hide(). - + <rich:toolTip> activation occurs after an event, = + defined on the parent component, takes into consideration the "d= elay" attribute = + or after calling JS API function show(). = + "hideEvent" attri= bute defines the way = + how <rich:toolTip>= disappears. = + It default value is "none", so the <rich:toolTip> does not dissapears. = + Deactivation may be set for example on mouseout = event on the parent component = + (excepting the situation when the mouse is hovered onto the = + <rich:toolTip> itself) = + or after calling JS API function hide(). = + - By default, tooltip appears smart positioned. Bu= t as you can see from the previous example, you + By default, <rich:toolTip> appears smart positioned. But as you can see from the p= revious example, you can define an appearance direction via the corresponding attribute "direction". = And also it's possible to define vertical and horizontal offsets rela= tively to a mouse position. = - Disabled tooltip is rendered to a page as usual = but JS that responds for its activation is disabled until enable() is called. = + Disabled <rich:toolTip> is rendered to a page as usual but JS that responds for it= s activation is disabled until enable() is called. = Moreover, to add some JavaScript effects, client events defined on i= t are used: --===============8013284754625290288==--