From richfaces-svn-commits at lists.jboss.org Thu Jun 5 08:41:10 2008 Content-Type: multipart/mixed; boundary="===============1030932427234194344==" 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: r8911 - trunk/docs/userguide/en/src/main/docbook/included. Date: Thu, 05 Jun 2008 08:41:10 -0400 Message-ID: --===============1030932427234194344== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2008-06-05 08:41:09 -0400 (Thu, 05 Jun 2008) New Revision: 8911 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= 5 12:24:31 UTC (rev 8910) +++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-0= 5 12:41:09 UTC (rev 8911) @@ -41,8 +41,8 @@ = -
- Creating the Component with a Page Tag +
+ Creating the Component with a Page Tag To create the simplest variant of <rich:toolTip> = component on a page, use the following syntax: = @@ -141,111 +141,97 @@ ... ]]> - 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). + The "mode" attrib= ute is provided you to control the way of data loading to 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 "defaultCon= tent", which provides default tooltip content to = be displayed, while main content is loading into the tooltip (see the example below). Example: - - + - DEFAULT toolTip CONTENT + DEFAULT TOOLTIP CONTENT ... ]]> - - -This is the result: - -
- <emphasis role=3D"bold"><property><rich:toolTip></prope= rty></emphasis> component with default content - = - - - - -
- -And after toolTip loaded it is changed to next one: - -
- <emphasis role=3D"bold"><property><rich:toolTip></prope= rty></emphasis> component with loaded content - = - - - - -
- = - -By default, toolTip appears smart positioned. But as = you can see from the previous example, you - can define an appearance direction via the corresponding attribute "direction". And also it's p= ossible to define vertical and horizontal -offsets relatively to a mouse position. = - - -toolTip appears attached to the corner dependent on t= he "direction" attribut= e. By default it is positioned bottom-right. -toolTip activation occurs after a defined event (defa= ult=3Dmouseover) on the parent component takes into consideration -the "delay" attribute (default=3D0) or after calling JS API func= tion show(). 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 "mode" attribute i= s provided you to control the way of data loading to toolTip. It has following values: - - Client - Ajax - = - - -In a client mode, toolTip content is rendered once on= the server and could be reRendered only via external submit. -In an Ajax mode, toolTip content is requested from se= rver every activation. - - -Disabled toolTip is rendered to a page as usual but J= S that responds for its activation is -disabled until enable() is called. - - -Moreover, to add some JavaScript effects, client events defined on it are= used: - - - Standart: - - onclick - ondblclick - onmouseout - onmousemove - onmouseover - = - = - - Special: - - onshow - Called after the toolTip is called (some elemen= t hovered) but before its request - - oncomplete - Called just after the toolTip is shown - - onhide - Called after the toolTip is hidden - - = - + + This is the result: + + = +
+ <emphasis role=3D"bold"><property><rich:toolTip></proper= ty></emphasis> component with default content + + + + + +
+ = + + And after toolTip loaded it is changed to next o= ne: + + = +
+ <emphasis role=3D"bold"><property><rich:toolTip></proper= ty></emphasis> component with loaded content + + + + + +
+ = + + toolTip appears attached to the corner dependent= on the "direction" att= ribute. = + 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(). + + + By default, tooltip appears smart positioned. Bu= t as you can see from the previous 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. = + + + Moreover, to add some JavaScript effects, client events defined on i= t are used: + + + Standart: + + onclick + ondblclick + onmouseout + onmousemove + onmouseover + + + + Special: + + onshow - Called after the tooltip is called (some e= lement hovered) but before its request + oncomplete - Called just after the tooltip is shown= + onhide - Called after the tooltip is hidden<= /listitem> + +
= -
+
+ JavaScript API + JavaScript API -
- JavaScript API = - + every acti Function = Description --===============1030932427234194344==--