[richfaces-svn-commits] JBoss Rich Faces SVN: r4809 - branches/3.1.x/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Dec 13 08:40:48 EST 2007
Author: vkorluzhenko
Date: 2007-12-13 08:40:48 -0500 (Thu, 13 Dec 2007)
New Revision: 4809
Modified:
branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/modalPanel.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenu.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
branches/3.1.x/docs/userguide/en/src/main/docbook/included/toolTip.xml
Log:
http://jira.jboss.com/jira/browse/RF-1447 - updated section "JavaScript API"
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -338,7 +338,7 @@
<a4j:form id="form">
<rich:calendar popup="true" rendered="#{!bean.check}" value="#{bean.date}" id="c"/>
<!--The link which is used to call a calendar popup externally-->
- <a onclick="$('form:c').component.doExpand()" href="#">Show</a>
+ <a onclick="$('form:c').component.Expand()" href="#">Show</a>
</a4j:form>
...
]]></programlisting>
@@ -501,13 +501,13 @@
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapses calendar element</entry>
</row>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expands calendar element</entry>
</row>
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -302,6 +302,40 @@
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4064191"
>RichFaces Users Forum</ulink>.</para>
</section>
+
+ <section>
+ <title>JavaScript API</title>
+ <table>
+ <title>JavaScript API</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Function</entry>
+
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>Show()</entry>
+
+ <entry>Shows the corresponding tooltip</entry>
+ </row>
+
+ <row>
+ <entry>Hide()</entry>
+
+ <entry>Hides the corresponding tooltip</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
<section>
<title>Look-and-Feel Customization</title>
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenu.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -200,7 +200,7 @@
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation it's
- necessary to use doExpand()/doCollapse() function.</para>
+ necessary to use Expand()/Collapse() function.</para>
<table>
<title>JavaScript API</title>
@@ -216,13 +216,13 @@
<tbody>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expands group element</entry>
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapses group element</entry>
</row>
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -197,7 +197,7 @@
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation it's
- necessary to use doExpand()/doCollapse() function.</para>
+ necessary to use Expand()/Collapse() function.</para>
<table>
<title>JavaScript API</title>
@@ -213,13 +213,13 @@
<tbody>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expand group element</entry>
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapse group element</entry>
</row>
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -92,7 +92,7 @@
<para> The columns provides the possibility of expanding/collapsing on the client side through
the next JS API: <itemizedlist>
- <listitem>doCollapse(columnId) - Performs the collapse action for the column with the
+ <listitem>Collapse(columnId) - Performs the collapse action for the column with the
corresponding id</listitem>
</itemizedlist> It's possible to sort the table content after clicks on the header. The
feature is optional. Every column should be pointed to the comparator method that will be used
@@ -227,7 +227,7 @@
<tbody>
<row>
- <entry>doCollapse(columnId)</entry>
+ <entry>Collapse(columnId)</entry>
<entry>Performs a collapse action for column with corresponding Id</entry>
</row>
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/toolTip.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/toolTip.xml 2007-12-13 13:20:23 UTC (rev 4808)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/toolTip.xml 2007-12-13 13:40:48 UTC (rev 4809)
@@ -2,9 +2,9 @@
<section>
<sectioninfo>
<keywordset>
-<keyword>tooltip</keyword>
-<keyword>rich:tooltip</keyword>
-<keyword>HtmlTooltip</keyword>
+<keyword>toolTip</keyword>
+<keyword>rich:toolTip</keyword>
+<keyword>HtmltoolTip</keyword>
</keywordset>
</sectioninfo>
<table>
@@ -19,23 +19,23 @@
<tbody>
<row>
<entry>component-type</entry>
- <entry>org.richfaces.component.ToolTip</entry>
+ <entry>org.richfaces.component.toolTip</entry>
</row>
<row>
<entry>component-class</entry>
- <entry>org.richfaces.component.html.HtmlToolTip</entry>
+ <entry>org.richfaces.component.html.HtmltoolTip</entry>
</row>
<row>
<entry>component-family</entry>
- <entry>org.richfaces.component.ToolTip</entry>
+ <entry>org.richfaces.component.toolTip</entry>
</row>
<row>
<entry>renderer-type</entry>
- <entry>org.richfaces.renderkit.html.ToolTipRenderer</entry>
+ <entry>org.richfaces.renderkit.html.toolTipRenderer</entry>
</row>
<row>
<entry>tag-class</entry>
- <entry>org.richfaces.taglib.HtmlToolTipTag</entry>
+ <entry>org.richfaces.taglib.HtmltoolTipTag</entry>
</row>
</tbody>
</tgroup>
@@ -43,14 +43,14 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>To create the simplest variant of <property>tooltip</property> on a page, use the following syntax:</para>
+ <para>To create the simplest variant of <property>toolTip</property> on a page, use the following syntax:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
<h:commandButton value="Button">
- <rich:tooltip value="Tooltip content"/>
+ <rich:toolTip value="toolTip content"/>
</h:commandButton>
...
]]></programlisting>
@@ -61,9 +61,9 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlToolTip;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmltoolTip;
...
-HtmlToolTip myToolTip = new HtmlToolTip();
+HtmltoolTip mytoolTip = new HtmltoolTip();
...
]]></programlisting>
</section>
@@ -71,13 +71,13 @@
<section>
<title>Details of Usage</title>
<para>
-<property>Tooltip</property> main area is a simple rectangle area with any information inside. The content may be defined via
+<property>toolTip</property> main area is a simple rectangle area with any information inside. The content may be defined via
"value" attribute as text or via any nested content. When both are defined, the value is displayed as text and nested content
-after the text. <property>Tooltip</property> stretches if the content more than the <property>tooltip</property> sizes.
+after the text. <property>toolTip</property> stretches if the content more than the <property>toolTip</property> sizes.
</para>
<para>
There is possibility to define a facet with the name "defaultContent". This facet provides the default content to
-display while the main content is loaded to a page in an Ajax mode. Thus when <property>tooltip</property> called in an Ajax mode, it
+display while the main content is loaded to a page in an Ajax mode. Thus when <property>toolTip</property> called in an Ajax mode, it
appears with the content defined in the facet and when loading is completed, the content is changed to a loaded one.
</para>
<para>
@@ -91,7 +91,7 @@
<rich:toolTip followMouse="true" direction="top-right" mode="ajax" value="#{bean.toolTipContent}" horizontalOffset="5"
verticalOffset="5" layout="block">
<f:facet name="defaultContent">
- <f:verbatim>DEFAULT TOOLTIP CONTENT</f:verbatim>
+ <f:verbatim>DEFAULT toolTip CONTENT</f:verbatim>
</f:facet>
</rich:toolTip>
</h:commandLink>
@@ -102,41 +102,41 @@
This is the result:
</para>
<figure>
- <title>Tooltip component with default content</title>
+ <title>toolTip component with default content</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tooltip2.png"/>
+ <imagedata fileref="images/toolTip2.png"/>
</imageobject>
</mediaobject>
</figure>
<para>
-And after <property>tooltip</property> loaded it will be changed to next one:
+And after <property>toolTip</property> loaded it will be changed to next one:
</para>
<figure>
- <title>Tooltip component with loaded content</title>
+ <title>toolTip component with loaded content</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tooltip3.png"/>
+ <imagedata fileref="images/toolTip3.png"/>
</imageobject>
</mediaobject>
</figure>
<para>
-By default, <property>tooltip</property> appears smart positioned. But as you can see from the previous example, you
+By default, <property>toolTip</property> 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 possible to define vertical and horizontal
offsets relatively to a mouse position.
</para>
<para>
-<property>Tooltip</property> 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 a defined event (default=mouseover) on the parent component takes into consideration
-the "delay" attribute (default=0) or after calling JS API function doShow(). <property>Tooltip</property> deactivation occurs after mouseout 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 doHide().
+<property>toolTip</property> 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 a defined event (default=mouseover) on the parent component takes into consideration
+the "delay" attribute (default=0) or after calling JS API function Show(). <property>toolTip</property> deactivation occurs after mouseout 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 Hide().
</para>
<note>
<title>Note:</title>
-It is recommended to define parent component "id" for correction of <property>tooltip</property> work.
+It is recommended to define parent component "id" for correction of <property>toolTip</property> work.
</note>
- <para>The attribute <emphasis><property>"for"</property></emphasis> is used for defining the <emphasis><property>"id"</property></emphasis> of an element a tooltip should be attached to. Look at the example:
+ <para>The attribute <emphasis><property>"for"</property></emphasis> is used for defining the <emphasis><property>"id"</property></emphasis> of an element a toolTip should be attached to. Look at the example:
</para>
<para>
@@ -156,24 +156,24 @@
]]></programlisting>
<para>Here, the attribute <emphasis><property>"for"</property></emphasis> of a <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> component is required. Whithout it an example doesn’t work because HTML elements aren't presented in component tree built by facelets.
</para>
<para>
-The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <property>tooltip</property>. It has following values:
+The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <property>toolTip</property>. It has following values:
<itemizedlist>
<listitem>Client</listitem>
<listitem>Ajax</listitem>
</itemizedlist>
</para>
<para>
-In a client mode, <property>tooltip</property> content is rendered once on the server and could be reRendered only via external submit.
-In an Ajax mode, <property>tooltip</property> content is requested from server every activation.
+In a client mode, <property>toolTip</property> content is rendered once on the server and could be reRendered only via external submit.
+In an Ajax mode, <property>toolTip</property> content is requested from server every activation.
</para>
<para>
-Disabled <property>tooltip</property> is rendered to a page as usual but JS that responds for its activation is
-disabled until doEnable() is called.
+Disabled <property>toolTip</property> is rendered to a page as usual but JS that responds for its activation is
+disabled until Enable() is called.
</para>
<para>
Moreover, to add some JavaScript effects, client events defined on it are used:
@@ -191,11 +191,11 @@
<para>
Special:
<itemizedlist>
- <listitem>onshow - Called after the tooltip is called (some element hovered) but before its request
+ <listitem>onshow - Called after the toolTip is called (some element hovered) but before its request
</listitem>
- <listitem>oncomplete - Called just after the tooltip is shown
+ <listitem>oncomplete - Called just after the toolTip is shown
</listitem>
- <listitem>onhide - Called after the tooltip is hidden
+ <listitem>onhide - Called after the toolTip is hidden
</listitem>
</itemizedlist>
</para>
@@ -218,27 +218,27 @@
<tbody>
<row>
- <entry>doShow()</entry>
+ <entry>Show()</entry>
- <entry>Shows the corresponding tooltip</entry>
+ <entry>Shows the corresponding toolTip</entry>
</row>
<row>
- <entry>doHide()</entry>
+ <entry>Hide()</entry>
- <entry>Hides the corresponding tooltip</entry>
+ <entry>Hides the corresponding toolTip</entry>
</row>
<row>
- <entry>doEnable()</entry>
+ <entry>Enable()</entry>
- <entry>Enables the corresponding tooltip</entry>
+ <entry>Enables the corresponding toolTip</entry>
</row>
<row>
- <entry>doDisable()</entry>
+ <entry>Disable()</entry>
- <entry>Disables the corresponding tooltip</entry>
+ <entry>Disables the corresponding toolTip</entry>
</row>
</tbody>
@@ -257,7 +257,7 @@
</emphasis></para>
<para>There are two ways to redefine the appearance of all <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components at once:</para>
<itemizedlist>
@@ -269,7 +269,7 @@
<para>Add to your style sheets <emphasis>
<property>style classes</property>
</emphasis> used by a <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> component</para>
</listitem>
</itemizedlist>
@@ -328,25 +328,25 @@
<tbody>
<row>
<entry>rich-tool-tip</entry>
- <entry>Defines styles for a wrapper <span> or <div> element of a tooltip</entry>
+ <entry>Defines styles for a wrapper <span> or <div> element of a toolTip</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
- It depends on <emphasis role="bold"><property><rich:tooltip></property></emphasis> layout what a wrapper element <emphasis><property><span></property></emphasis> or <emphasis><property><div></property></emphasis>to choose.
+ It depends on <emphasis role="bold"><property><rich:toolTip></property></emphasis> layout what a wrapper element <emphasis><property><span></property></emphasis> or <emphasis><property><div></property></emphasis>to choose.
</para>
<para>In order to redefine styles for all <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components on a page using CSS, it's enough to create class with the
same name and define necessary properties in it.</para>
<para>To change styles of particular <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components define your own style class in the corresponding <emphasis
role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis>attributes</para>
</section>
<section>
More information about the richfaces-svn-commits
mailing list