From richfaces-svn-commits at lists.jboss.org Wed Jun 4 11:52:00 2008 Content-Type: multipart/mixed; boundary="===============5092114277453488602==" 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: r8902 - trunk/docs/userguide/en/src/main/docbook/included. Date: Wed, 04 Jun 2008 11:51:58 -0400 Message-ID: --===============5092114277453488602== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2008-06-04 11:51:58 -0400 (Wed, 04 Jun 2008) New Revision: 8902 Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml Log: RF-3550-- component "Details of usage" section rewriting 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-0= 4 14:58:48 UTC (rev 8901) +++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-0= 4 15:51:58 UTC (rev 8902) @@ -70,58 +70,81 @@ =
- Details of Usage - + 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. = 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. - = - + + There are three ways to attach a 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. = - - - Note: - + In such cases tooltip is attached to the= parent component by default. + + + Note: + It is recommended to specify "i= d" for parent page element to ensure t= ooltip's correct work. - - - - Note: - - If parent component contains more than one child, it is = recommended to define <rich:toolTip>= ; the last one. - - = - - Second way uses the attribute "for&q= uot;. In this case a tooltip may= be defined separately from a page element it is applied to. = + + + + Note: + + If parent component contains more than one child, it is = recommended to define <rich:toolTip>= ; as the last one. + + + + 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. = "id" for = page element is necessary (see the example below). - - + + Example: - - -=E2=80=A6 + + +... - + ... -]]> = - Here, the attribute "for" of a - <rich:toolTip> - component is required. Without it an example doesn't w= ork because HTML elements aren't presented in component tree built by facel= ets. - = - = +]]> -There is possibility to define a facet with the name "defaultContent&= quot;. This facet provides the default content to -display while the main content is loaded to a page in an Ajax mode. Thus w= hen toolTip called in an Ajax mode, it -appears with the content defined in the facet and when loading is complete= d, the content is changed to a loaded one. - - - Here is an example: = - - + Because HTML elements are not presented in components tree built by f= acelets, = + use the attribute "for" with HTML elements as shown in example below. + + + Example: + + + Using a toolTip +

The first simple example

+ +... +
+

The second simple example

+
+Using a toolTip +... +]]> + + 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). = + + +... + + +... +]]> + + The component works properly in client and Ajax modes. = + For Ajax mode there is possibility to define a facet "defaultCon= tent", which provides default tooltip content to be displayed, while m= ain content is loading into the tooltip (see the examp= le below). + + Example: toolTip deactivation occurs after mouseou= t event on the parent component (excepting the situation when the mouse is = hovered onto the toolTip itself) or after calling JS A= PI function hide(). = - The attribute "for" is used for defining the "id" of an element a toolTip should be attached to. Look at the e= xample: - + = = - - Example: - - - Using a toolTip -

The first simple example

- -... -
-

The second simple example

-
-Using a toolTip -... -]]> - = = = --===============5092114277453488602==--