Author: cluts
Date: 2008-06-13 07:50:50 -0400 (Fri, 13 Jun 2008)
New Revision: 9026
Modified:
trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml
trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml
trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/pickList.xml
trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml
trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml
trunk/docs/userguide/en/src/main/docbook/included/tab.xml
trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml
trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
trunk/docs/userguide/en/src/main/docbook/included/tree.xml
trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml
Log:
RF-3161 - done changeExpandListener, modalPanel, nodeExpandListener, panelBar, panelMenu,
panelMenuGroup, pickList, progressBar, scrollableDataTable, suggestionbox, tab, tabPanel,
toggleControl, toolTip, tree, treeNode
Modified: trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml 2008-06-13
11:50:04 UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml 2008-06-13
11:50:50 UTC (rev 9026)
@@ -75,7 +75,7 @@
</para>
<para>
Attribute
<emphasis><property>"type"</property></emphasis>
defines the fully qualified Java class name for the listener.
- This class should implement org.richfaces.event.NodeExpandedListener <ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichface...;.
+ This class should implement
<code>org.richfaces.event.NodeExpandedListener</code> <ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichface...;.
</para>
<para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2008-06-13 11:50:04
UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2008-06-13 11:50:50
UTC (rev 9026)
@@ -251,7 +251,7 @@
<para>
<emphasis><property>"showWhenRendered"</property></emphasis>
- This boolean attribute is used if modalPanel should be rendered after
first page loading. </para>
<para><emphasis><property>
"keepVisualState"</property></emphasis> - Used if modalPanel
should save state after submission. If
- <emphasis><property>
"keepVisualState"</property></emphasis>=true then parameters
which modalPanel has during opening should be submitted
+ <code>keepVisualState="true"</code> then parameters
which modalPanel has during opening should be submitted
and passed to new page. </para>
<para>
@@ -306,9 +306,9 @@
</emphasis> attribute provides an association between a component, and the
message that the component (indirectly) produced.
This attribute defines the parameters of localized error and informational messages
that
occur as a result of conversion, validation, or other application actions during
the request
- processing lifecycle. With the help of this attribute you can replace the
- last parameter substitution token shown in the messages. For example, {1} for
“DoubleRangeValidator.MAXIMUM”, {2}
- for “ShortConverter.SHORT”.
+ processing lifecycle. With the help of this attribute you can replace the
+ last parameter substitution token shown in the messages. For example, {1} for
<code>"DoubleRangeValidator.MAXIMUM"</code>, {2}
+ for <code>"ShortConverter.SHORT"</code>.
</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml 2008-06-13
11:50:04 UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml 2008-06-13
11:50:50 UTC (rev 9026)
@@ -76,7 +76,7 @@
</para>
<para>
Attribute
<emphasis><property>"type"</property></emphasis>
defines the fully qualified Java class name for listener.
- This class should implement org.richfaces.event.NodeSelectedListener <ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichface...;.
+ This class should implement
<code>org.richfaces.event.NodeSelectedListener</code> <ulink
url="http://labs.jboss.com/file-access/default/members/jbossrichface...;.
</para>
<para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -98,8 +98,8 @@
This attribute defines the parameters of localized error and informational
messages that
occur as a result of conversion, validation, or other application actions
during the request
processing lifecycle. With the help of this attribute you can replace the
- last parameter substitution token shown in the messages. For example, {1} for
“DoubleRangeValidator.MAXIMUM”, {2}
- for “ShortConverter.SHORT”.
+ last parameter substitution token shown in the messages. For example, {1} for
<code>"DoubleRangeValidator.MAXIMUM"</code>, {2}
+ for <code>"ShortConverter.SHORT"</code>.
</para>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-06-13 11:50:04
UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-06-13 11:50:50
UTC (rev 9026)
@@ -121,7 +121,7 @@
<itemizedlist>
<listitem>
- <para>Server (default)</para>
+ <para><code>Server</code> (default)</para>
</listitem>
</itemizedlist>
@@ -140,7 +140,7 @@
...]]></programlisting>
<itemizedlist>
<listitem>
- <para>Ajax</para>
+ <para><code>Ajax</code></para>
</listitem>
</itemizedlist>
@@ -161,7 +161,7 @@
...]]></programlisting>
<itemizedlist>
<listitem>
- <para>None</para>
+ <para><code>None</code></para>
</listitem>
</itemizedlist>
@@ -232,15 +232,15 @@
This attribute defines the parameters of localized error and informational messages
that
occur as a result of conversion, validation, or other application actions during
the request
processing lifecycle. With the help of this attribute you can replace the
- last parameter substitution token shown in the messages. For example, {1} for
“DoubleRangeValidator.MAXIMUM”, {2}
- for “ShortConverter.SHORT”.
+ last parameter substitution token shown in the messages. For example, {1} for
<code>"DoubleRangeValidator.MAXIMUM"</code>, {2}
+ for <code>"ShortConverter.SHORT"</code>.
</para>
</section>
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation
it's
- necessary to use expand()/collapse() function.</para>
+ necessary to use
<code>expand()</code>/<code>collapse()</code>
function.</para>
<table>
<title>JavaScript API</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2008-06-13
11:50:04 UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2008-06-13
11:50:50 UTC (rev 9026)
@@ -100,7 +100,7 @@
<itemizedlist>
<listitem>
- <para>Server (default)</para>
+ <para><code>ServerM</code> (default)</para>
</listitem>
</itemizedlist>
@@ -108,7 +108,7 @@
<itemizedlist>
<listitem>
- <para>Ajax</para>
+ <para><code>Ajax</code></para>
</listitem>
</itemizedlist>
@@ -116,7 +116,7 @@
<itemizedlist>
<listitem>
- <para>None</para>
+ <para><code>None</code></para>
</listitem>
</itemizedlist>
@@ -199,7 +199,7 @@
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation
it's
- necessary to use Expand()/Collapse() function.</para>
+ necessary to use
<code>Expand()</code>/<code>Collapse()</code>
function.</para>
<table>
<title>JavaScript API</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/pickList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/pickList.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/pickList.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -173,10 +173,10 @@
<para>The <emphasis
role="bold"><property><rich:pickList></property></emphasis>
component allows to use internationalization method
to redefine and localize the labels. You could use application resource
bundle and define
- <property>RICH_PICK_LIST_COPY_ALL_LABEL</property>,
- <property>RICH_PICK_LIST_COPY_LABEL</property>,
- <property>RICH_PICK_LIST_REMOVE_ALL_LABEL</property>,
- <property>RICH_PICK_LIST_REMOVE_LABEL</property> there.
+ <code>RICH_PICK_LIST_COPY_ALL_LABEL</code>,
+ <code>RICH_PICK_LIST_COPY_LABEL</code>,
+ <code>RICH_PICK_LIST_REMOVE_ALL_LABEL</code>,
+ <code>RICH_PICK_LIST_REMOVE_LABEL</code> there.
</para>
<table>
Modified: trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-06-13 11:50:04
UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/progressBar.xml 2008-06-13 11:50:50
UTC (rev 9026)
@@ -280,13 +280,13 @@
<itemizedlist>
<listitem>
-
<para><emphasis><property>{value}</property></emphasis>
contains the current value</para>
+ <para><code>{value}</code> contains the current
value</para>
</listitem>
<listitem>
-
<para><emphasis><property>{minValue}</property></emphasis>
contains min value</para>
+ <para><code>{minValue}</code> contains min
value</para>
</listitem>
<listitem>
-
<para><emphasis><property>{maxValue}</property></emphasis>
contains max value</para>
+ <para><code>{maxValue}</code> contains max
value</para>
</listitem>
</itemizedlist>
@@ -328,7 +328,7 @@
The
<emphasis><property>"parameters"</property></emphasis>
is also a special attribute which defines parameters that can be to get
additional data from server (e.g. additional info about process status).
All you need is to define the value of your own parameter
- (e.g parameters="param:'#{bean.incValue1}'")
+ (e.g
<code>parameters="param:'#{bean.incValue1}'"</code>)
and you can use it to pass the data.
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2008-06-13
11:50:04 UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2008-06-13
11:50:50 UTC (rev 9026)
@@ -129,7 +129,7 @@
</emphasis> attribute allows to get the row data when using
<property>one and multi-selection
rows mode</property>.</para>
<para>This attribute is a reference to object to the instace of
- <property>org.richfaces.model.selection.Selection</property>
interface, containing current
+ <code>org.richfaces.model.selection.Selection</code> interface,
containing current
collection of objects selected by you.</para>
<para>In the following example when you submit the form, current collection of
the selected objects
is placed in the object's property. Then on complete action the <emphasis
role="bold">
Modified: trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml 2008-06-13
11:50:04 UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/suggestionbox.xml 2008-06-13
11:50:50 UTC (rev 9026)
@@ -59,7 +59,7 @@
...
]]></programlisting>
<para>Here is the <emphasis>
- <property>bean.autocomplete</property>
+ <code>bean.autocomplete</code>
</emphasis> method that returns the collection to pop up:</para>
<para>
@@ -141,7 +141,7 @@
</mediaobject>
</figure>
<para>When some string is chosen input receives the corresponding value
from the second
- column containing <property>#{cit.text}</property></para>
+ column containing <code>#{cit.text}</code></para>
<para>There is also one more important attribute named <emphasis>
<property>"tokens"</property>
</emphasis> that specifies separators after which a set of some
characters sequence is
@@ -168,7 +168,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>For a multiple definition use either ",.; " syntax
as a value for
+ <para>For a multiple definition use either
"<code>,.;</code> " syntax as a value for
tokens or link a parameter to some bean property transmitting separators
collection.</para>
<para>The component also encompasses <emphasis>
<property>"layout"</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/tab.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tab.xml 2008-06-13 11:50:04 UTC (rev
9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/tab.xml 2008-06-13 11:50:50 UTC (rev
9026)
@@ -155,7 +155,7 @@
</rich:tabPanel>
...]]></programlisting>
<para>
- The following example shows how on the client side to get the names of entered/left
tabs.
+ The following example shows how on the client side to get the names of
<code>entered</code>/<code>left</code> tabs.
</para>
<programlisting
role="JAVA"><![CDATA[ontabenter="alert(leftTabName)"]]></programlisting>
<para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -151,8 +151,8 @@
This attribute defines the parameters of localized error and informational messages
that
occur as a result of conversion, validation, or other application actions during
the request
processing lifecycle. With the help of this attribute you can replace the
- last parameter substitution token shown in the messages. For example, {1} for
“DoubleRangeValidator.MAXIMUM”, {2}
- for “ShortConverter.SHORT”.
+ last parameter substitution token shown in the messages. For example, {1} for
<code>"DoubleRangeValidator.MAXIMUM"</code>, {2}
+ for <code>"ShortConverter.SHORT"</code>.
</para>
<para>Except the specific attributes, the component has all necessary
attributes for JavaScript
events definition.</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-06-13 11:50:04
UTC (rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-06-13 11:50:50
UTC (rev 9026)
@@ -146,8 +146,8 @@
This attribute defines the parameters of localized error and informational messages
that
occur as a result of conversion, validation, or other application actions during
the request
processing lifecycle. With the help of this attribute you can replace the
- last parameter substitution token shown in the messages. For example, {1} for
“DoubleRangeValidator.MAXIMUM”, {2}
- for “ShortConverter.SHORT”.
+ last parameter substitution token shown in the messages. For example, {1} for
<code>"DoubleRangeValidator.MAXIMUM"</code>, {2}
+ for <code>"ShortConverter.SHORT"</code>.
</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -145,7 +145,7 @@
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
"defaultContent", which provides default
<property>tooltip</property> content to be displayed, while main content is
loading into the <property>tooltip</property> (see the example below).
+ 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).
</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -190,8 +190,8 @@
<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 an event, defined
on the parent component, takes into consideration the "delay" attribute
or after calling JS API function <emphasis>show()</emphasis>.
- <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 <emphasis>hide()</emphasis>.
+ <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>
<para>
By default, <property>tooltip</property> appears smart positioned. But
as you can see from the previous example, you
@@ -199,7 +199,7 @@
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
<emphasis>enable()</emphasis> is called.
+ 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.
</para>
<para>
Moreover, to add some JavaScript effects, client events defined on it are used:
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -399,7 +399,7 @@
</imageobject>
</mediaobject>
</figure>
- <para>In the example above, when each node of data model is processed, data
contained in the <property>"data"</property> property
+ <para>In the example above, when each node of data model is processed, data
contained in the <code>"data"</code> property
of
<property>"TreeNode"</property> interface is assigned
to a request scope variable, which name is defined with <emphasis>
<property>"var"</property>
@@ -416,12 +416,12 @@
<property>"var"</property>
</emphasis> attribute. Then the value of <emphasis>
<property>"nodeFace"</property>
- </emphasis> attribute was evaluated as "artist". Thus, for
the node
+ </emphasis> attribute was evaluated as
<code>"artist"</code>. Thus, for the node
representation the <emphasis role="bold">
<property><rich:treeNode></property>
</emphasis> with <emphasis>
<property>"type"</property>
- </emphasis> equal to "artist" was used.</para>
+ </emphasis> equal to "<code>artist</code>" was
used.</para>
<para>You can also assign an EL-expression as value of the <emphasis>
<property>"nodeFace"</property>
</emphasis> attribute. See an example below: </para>
@@ -713,12 +713,10 @@
<para>
In the shown example a song from one album can be dragged into another because attribute
- <emphasis><property>"acceptedTypes"</property>
</emphasis>="song" defined in the second
<property>treeNode</property>
- with
<emphasis><property>"type"</property></emphasis>="album".
Its value is equal to the value of the<emphasis>
+ <code>acceptedTypes="song"</code> defined in the second
<property>treeNode</property>
+ with <code>type="album"</code>. Its value is equal to the
value of the<emphasis>
<property>"type"</property></emphasis>attribute
defined in the third <property>treeNode</property> (see picture below). An
album can be also
- dragged into <property>treeNode</property> with <emphasis>
- <property>"type"</property>
- </emphasis>="artist" property.
+ dragged into <property>treeNode</property> with
<code>type="artist"</code> property.
</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml 2008-06-13 11:50:04 UTC
(rev 9025)
+++ trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml 2008-06-13 11:50:50 UTC
(rev 9026)
@@ -107,7 +107,7 @@
]]></programlisting>
<para>As it has been mentioned <link
linkend="treeNode">above</link>, <emphasis
role="bold"><property><rich:treeNode></property></emphasis>
defines a template for nodes
rendering in a tree. Thus, during XML document rendering (a web.xml application) as
a tree,
- the following nodes output (passed via var="data" on a tree)
happens:</para>
+ the following nodes output (passed via
<code>var="data"</code> on a tree) happens:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -128,8 +128,8 @@
</imageobject>
</mediaobject>
</figure>
- <para>Hence,<property> <![CDATA[<h:outputText
/>]]></property> tag outputs the "context-param" string
and
- then the <property><![CDATA[<h:inputText/>]]></property>
outputs the data.name element of this node.
+ <para>Hence,<code><h:outputText /></code> tag
outputs the <code>"context-param"</code> string and
+ then the <code><h:inputText/></code> outputs the
<code>data.name</code> element of this node.
</para>
<para>Different nodes for rendering could be defined depending on some
conditions on the tree
level. Each condition represents some rendering template. To get more information
on various