[richfaces-svn-commits] JBoss Rich Faces SVN: r6436 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Feb 28 14:14:15 EST 2008
Author: vsukhov
Date: 2008-02-28 14:14:15 -0500 (Thu, 28 Feb 2008)
New Revision: 6436
Modified:
trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml
trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml
trunk/docs/userguide/en/src/main/docbook/included/modalPanel.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/tabPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml
Log:
http://jira.jboss.com/jira/browse/RF-2004 added information about label attribute in detail of usage.
http://jira.jboss.com/jira/browse/RF-2205 I've added additional information about Panel Menu mode attribute usage.
Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -210,7 +210,20 @@
</itemizedlist>
<para> By default, the <emphasis>
<property>"jointPoint"</property>
- </emphasis> attribute is set to "bottom-left".</para>
+ </emphasis> attribute is set to "bottom-left".</para>
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
<para>The <emphasis role="bold">
<property><rich:calendar></property>
</emphasis> component allows to use <emphasis>
@@ -233,7 +246,7 @@
{elementId} elements. {weekNumber}, {weekDayLabel}, {weekDayLabelShort}, {weekDayNumber}
elements could be used for labels output, {isWeekend}, {elementId} - for additional processing
in JavaScript code.</para>
- <para>These elements are shown on the picture below.</para>
+ <para>These elements are shown on the picture below.</para>
<figure>
<title>Available elements</title>
@@ -406,7 +419,7 @@
<property>RICH_CALENDAR_CLOSE_LABEL</property>,
<property>RICH_CALENDAR_OK_LABEL</property>,
<property>RICH_CALENDAR_CLEAN_LABEL</property>,
- <property>RICH_CALENDAR_CANCEL_LABEL </property> there.
+ <property>RICH_CALENDAR_CANCEL_LABEL </property> there.
</para>
<para>You could also pack <property>org.richfaces.renderkit.calendar</property> <ulink url="http://labs.jboss.com/file-access/default/members/jbossrichfaces/freezone/docs/apidoc/org/richfaces/renderkit/CalendarRendererBase.html#CALENDAR_BUNDLE"
>resource</ulink> bundle with your JARs defining the same properties.
Modified: trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -135,6 +135,19 @@
<listitem> onmouseout </listitem>
<listitem> etc. </listitem>
</itemizedlist>
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/inputNumberSpinner.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -122,7 +122,19 @@
<listitem> onmouseout </listitem>
<listitem> etc. </listitem>
</itemizedlist>
-
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
<title>Look-and-Feel Customization</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -299,6 +299,19 @@
<para>See also discussion about this problem on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4064191"
>RichFaces Users Forum</ulink>.</para>
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelBar.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -88,6 +88,19 @@
<para><property>panelBar</property> could contain any number of child
<property>panelBarItem</property> components inside, which content is uploaded onto the
client and headers are controls to open the corresponding child element.</para>
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -113,7 +113,11 @@
<property>"mode"</property>
</emphasis> and <emphasis>
<property>"expandMode"</property>
- </emphasis> attributes could be used with three possible parameters.</para>
+ </emphasis> attributes could be used with three possible parameters. The <emphasis>
+ <property>"mode"</property>
+ </emphasis> attribute defines parameters for all included <emphasis role="bold">
+ <property><rich:panelMenuItem></property>
+ </emphasis> elements.</para>
<itemizedlist>
<listitem>
@@ -121,22 +125,46 @@
</listitem>
</itemizedlist>
- <para>Regular form submission request is used.</para>
-
+ <para>The common submission of the form is performed and a page is completely refreshed.</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+ <rich:panelMenu mode="server">
+ <rich:panelMenuGroup label="test Group" action="#{bean.action}">
+ <rich:panelMenuItem label="test" action="#{capitalsBean.action}">
+ <f:param value="test value" name="test"/>
+ </rich:panelMenuItem>
+ </rich:panelMenuGroup>
+ </rich:panelMenu>
+...]]></programlisting>
<itemizedlist>
<listitem>
<para>Ajax</para>
</listitem>
</itemizedlist>
- <para>Ajax submission is used for switching.</para>
-
+ <para>An Ajax form submission is performed, and additionally specified elements in the <emphasis>
+ <property>"reRender"</property>
+ </emphasis> attribute are reRendered.</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+ <rich:panelMenu mode="ajax">
+ <rich:panelMenuGroup label="test Group" action="#{bean.action}">
+ <rich:panelMenuItem label="test" reRender="test" action="#{capitalsBean.action}">
+ <f:param value="test value" name="test"/>
+ </rich:panelMenuItem>
+ </rich:panelMenuGroup>
+ </rich:panelMenu>
+...]]></programlisting>
<itemizedlist>
<listitem>
<para>None</para>
</listitem>
</itemizedlist>
-
+
<para><emphasis>
<property>"Action"</property>
</emphasis> and <emphasis>
@@ -149,7 +177,7 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:panelMenu event="onclick" submitMode="none">
- < rich:panelMenuItem label="Link to external page">
+ <rich:panelMenuItem label="Link to external page">
<h:outputLink ... >
<rich:panelMenuItem>
</rich:panelMenu>
@@ -193,7 +221,20 @@
<!--Nested panelMenu components-->
</rich:panelMenuGroup>
</rich:panelMenu>
-...]]></programlisting>
+ ...]]></programlisting>
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -141,7 +141,19 @@
</imageobject>
</mediaobject>
</figure>
-
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
<para>Except the specific attributes, the component has all necessary attributes for JavaScript
events definition.</para>
<itemizedlist>
Modified: trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-02-28 19:03:43 UTC (rev 6435)
+++ trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-02-28 19:14:15 UTC (rev 6436)
@@ -136,7 +136,19 @@
]]></programlisting>
<para>The example shows a <property>togglePanel</property> initial state when the second facet
(panelB) is rendered and successive switching from the first to the second happens.</para>
-
+ <para>
+ The <emphasis>
+ <property>"label"</property>
+ </emphasis> attribute is a generic attribute.
+ The <emphasis>
+ <property>"label"</property>
+ </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”.
+ </para>
</section>
<section>
<title>Look-and-Feel Customization</title>
More information about the richfaces-svn-commits
mailing list