[richfaces-svn-commits] JBoss Rich Faces SVN: r5067 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Fri Dec 28 08:57:43 EST 2007
Author: vkorluzhenko
Date: 2007-12-28 08:57:43 -0500 (Fri, 28 Dec 2007)
New Revision: 5067
Modified:
trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
Log:
http://jira.jboss.com/jira/browse/RF-1797 - updated documentation, rewrote examples, changed pictures.
Modified: trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-12-28 13:57:16 UTC (rev 5066)
+++ trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-12-28 13:57:43 UTC (rev 5067)
@@ -241,8 +241,16 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
- <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr">
- <!--Nested menu components-->
+ <rich:dropDownMenu value="File" direction="bottom-right" jointPoint="tr">
+ <rich:menuItem submitMode="ajax" value="New" action="#{ddmenu.doNew}"/>
+ <rich:menuItem submitMode="ajax" value="Open" action="#{ddmenu.doOpen}"/>
+ <rich:menuGroup value="Save As...">
+ <rich:menuItem submitMode="ajax" value="Text File" action="#{ddmenu.doSaveText}"/>
+ <rich:menuItem submitMode="ajax" value="PDF File" action="#{ddmenu.doSavePDF}"/>
+ </rich:menuGroup>
+ <rich:menuItem submitMode="ajax" value="Close" action="#{ddmenu.doClose}"/>
+ <rich:menuSeparator id="menuSeparator11"/>
+ <rich:menuItem submitMode="ajax" value="Exit" action="#{ddmenu.doExit}"/>
</rich:dropDownMenu>
...
]]></programlisting>
@@ -274,8 +282,16 @@
</para>
<programlisting role="XML"><![CDATA[...
- <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0">
- <!--Nested menu components-->
+ <rich:dropDownMenu value="File" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0">
+ <rich:menuItem submitMode="ajax" value="New" action="#{ddmenu.doNew}"/>
+ <rich:menuItem submitMode="ajax" value="Open" action="#{ddmenu.doOpen}"/>
+ <rich:menuGroup value="Save As...">
+ <rich:menuItem submitMode="ajax" value="Text File" action="#{ddmenu.doSaveText}"/>
+ <rich:menuItem submitMode="ajax" value="PDF File" action="#{ddmenu.doSavePDF}"/>
+ </rich:menuGroup>
+ <rich:menuItem submitMode="ajax" value="Close" action="#{ddmenu.doClose}"/>
+ <rich:menuSeparator id="menuSeparator11"/>
+ <rich:menuItem submitMode="ajax" value="Exit" action="#{ddmenu.doExit}"/>
</rich:dropDownMenu>
...
]]></programlisting>
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2007-12-28 13:57:16 UTC (rev 5066)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2007-12-28 13:57:43 UTC (rev 5067)
@@ -142,9 +142,10 @@
</emphasis>. </para>
<para> Here is an example: </para>
<programlisting role="XML"><![CDATA[...
- <rich:menuGroup value="Active" direction="left-down"
- <!--Nested menu components-->
- </rich:menuGroup>
+ <rich:menuGroup value="Save As..." direction="left-down">
+ <rich:menuItem submitMode="ajax" value="Text File" action="#{ddmenu.doSaveText}"/>
+ <rich:menuItem submitMode="ajax" value="PDF File" action="#{ddmenu.doSavePDF}"/>
+ </rich:menuGroup>
...
]]></programlisting>
<para> This would be the result: </para>
@@ -156,6 +157,9 @@
</imageobject>
</mediaobject>
</figure>
+ <note><title>Note:</title> The <emphasis role="bold">
+ <property><rich:menuGroup></property>
+ </emphasis> component was designed to be used only for pop-up menu list creation.</note>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-12-28 13:57:16 UTC (rev 5066)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-12-28 13:57:43 UTC (rev 5067)
@@ -130,8 +130,8 @@
<property>"action"</property>
</emphasis> and <emphasis>
<property>"actionListener"</property>
- </emphasis> item's attributes are ignored. Menu items don' fire any submits themselves.
- The behavior is fully defined by the components nested into items.</para>
+ </emphasis> item's attributes are ignored. Menu items don' fire any
+ submits themselves. The behavior is fully defined by the components nested into items.</para>
<para> For example, you can put any content into an item, but, in this case, you should set
the <emphasis>
<property>"mode"</property>
@@ -159,36 +159,39 @@
<rich:dropDownMenu>
...
]]></programlisting>
+ <note><title>Note:</title> The <emphasis role="bold">
+ <property><rich:menuItem></property>
+ </emphasis> component was designed to be used only for pop-up menu list creation.</note>
</section>
<section>
<title>Look-and-Feel Customization</title>
-
+
<para>For skinnability implementation, the components use a <emphasis>
- <property>style class redefinition method.</property>
- </emphasis> Default style classes are mapped on <emphasis>
- <property>skin parameters.</property>
- </emphasis></para>
-
+ <property>style class redefinition method.</property>
+ </emphasis> Default style classes are mapped on <emphasis>
+ <property>skin parameters.</property>
+ </emphasis></para>
+
<para>There are two ways to redefine the appearance of all <emphasis role="bold">
- <property><rich:menuItem></property>
- </emphasis> components at once:</para>
-
+ <property><rich:menuItem></property>
+ </emphasis> components at once:</para>
+
<itemizedlist>
<listitem>
<para>Redefine the corresponding skin parameters</para>
</listitem>
-
+
<listitem>
<para>Add to your style sheets <emphasis>
- <property>style classes</property>
- </emphasis> used by a <emphasis role="bold">
- <property><rich:menuItem></property>
- </emphasis> component</para>
+ <property>style classes</property>
+ </emphasis> used by a <emphasis role="bold">
+ <property><rich:menuItem></property>
+ </emphasis> component</para>
</listitem>
</itemizedlist>
</section>
-
+
<section>
<title>Skin Parameters Redefinition</title>
<table>
@@ -295,7 +298,8 @@
<tbody>
<row>
<entry>rich-menu-item</entry>
- <entry>Defines styles for a wrapper <div> element for an item</entry>
+ <entry>Defines styles for a wrapper <div> element for an
+ item</entry>
</row>
<row>
<entry>rich-menu-item-label</entry>
@@ -308,8 +312,8 @@
</tbody>
</tgroup>
</table>
- <table>
- <title>Classes names that define different states</title>
+ <table>
+ <title>Classes names that define different states</title>
<tgroup cols="2">
<thead>
<row>
@@ -320,15 +324,18 @@
<tbody>
<row>
<entry>rich-menu-item-disabled</entry>
- <entry>Defines styles for a wrapper <div> element of an item</entry>
+ <entry>Defines styles for a wrapper <div> element of an
+ item</entry>
</row>
<row>
<entry>rich-menu-item-enabled</entry>
- <entry>Defines styles for a wrapper <div> element of an enabled item</entry>
+ <entry>Defines styles for a wrapper <div> element of an
+ enabled item</entry>
</row>
<row>
<entry>rich-menu-item-hover</entry>
- <entry>Defines styles for a wrapper <div> element of a hover item</entry>
+ <entry>Defines styles for a wrapper <div> element of a hover
+ item</entry>
</row>
<row>
@@ -359,21 +366,23 @@
</tgroup>
</table>
<para>In order to redefine styles for all <emphasis role="bold">
- <property><rich:menuItem></property>
- </emphasis> components on a page using CSS, it's enough to create classes with the
- same names and define necessary properties in them.</para>
-
+ <property><rich:menuItem></property>
+ </emphasis> components on a page using CSS, it's enough to create classes with
+ the same names and define necessary properties in them.</para>
+
<para>To change styles of particular <emphasis role="bold">
- <property><rich:menuItem></property>
- </emphasis> components, define your own style classes in the corresponding <emphasis
- role="bold">
- <property><rich:menuItem></property>
- </emphasis>attributes.</para>
+ <property><rich:menuItem></property>
+ </emphasis> components, define your own style classes in the corresponding <emphasis
+ role="bold">
+ <property><rich:menuItem></property>
+ </emphasis>attributes.</para>
</section>
<section>
<title>Relevant Resources Links</title>
- <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/dropDownMenu.jsf?c=menuItem"
- >Here</ulink> you can see the example of <emphasis role="bold"
- ><property><rich:menuItem></property></emphasis> usage and sources for the given example. </para>
- </section>
+ <para><ulink
+ url="http://livedemo.exadel.com/richfaces-demo/richfaces/dropDownMenu.jsf?c=menuItem"
+ >Here</ulink> you can see the example of <emphasis role="bold">
+ <property><rich:menuItem></property>
+ </emphasis> usage and sources for the given example. </para>
+ </section>
</section>
More information about the richfaces-svn-commits
mailing list