[richfaces-svn-commits] JBoss Rich Faces SVN: r4592 - 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
Fri Dec 7 10:49:27 EST 2007
Author: vkorluzhenko
Date: 2007-12-07 10:49:27 -0500 (Fri, 07 Dec 2007)
New Revision: 4592
Modified:
branches/3.1.x/docs/userguide/en/src/main/docbook/included/contextMenu.xml
Log:
http://jira.jboss.com/jira/browse/RF-1298 - improved description
Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/contextMenu.xml
===================================================================
--- branches/3.1.x/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2007-12-07 13:44:31 UTC (rev 4591)
+++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2007-12-07 15:49:27 UTC (rev 4592)
@@ -61,6 +61,7 @@
HtmlContextMenu myContextMenu = new HtmlContextMenu();
...]]></programlisting>
</section>
+
<section>
<title>Details of Usage</title>
<para>All attributes except <emphasis>
@@ -72,7 +73,59 @@
<property>"label"</property>
</emphasis> facet.</para>
- <para> It's possible to define the direction for list appear in the <emphasis>
+ <para>The <emphasis role="bold">
+ <property><rich:contexMenu></property>
+ </emphasis>
+ <emphasis>
+ <property>"submitMode"</property>
+ </emphasis> attribute can be set to three possible parameters:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Server (default)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Regular form submition request is used</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Ajax</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Ajax submission is used for switching</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>None</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The <emphasis>
+ <property>"action"</property>
+ </emphasis> and <emphasis>
+ <property>"actionListener"</property>
+ </emphasis> item's attributes are ignored. Menu items don't fire any submits themselves.
+ The behavior is fully defined by the components nested inside items.</para>
+
+ <note><title>Note:</title> As the <emphasis role="bold">
+ <property><rich:contexMenu></property>
+ </emphasis> component doesn't provide its own form, use it between
+ <h:form> and </h:form> tags.</note>
+
+ <para><emphasis role="bold">
+ <property><rich:menuGroup></property>
+ </emphasis>, <emphasis role="bold">
+ <property><rich:menuItem></property>
+ </emphasis> and <emphasis role="bold">
+ <property><rich:menuSeparator></property>
+ </emphasis> components is used as nested elements for <emphasis role="bold">
+ <property><rich:contexMenu></property>
+ </emphasis>.</para>
+
+ <!-- Will be done for latest version -->
+ <!--para> It's possible to define the direction for list appear in the <emphasis>
<property>"direction"</property>
</emphasis>attribute. If the accordance of the popup corner to corner of the label isn’t
set <emphasis>
@@ -128,15 +181,14 @@
</listitem>
</itemizedlist>
- <!--ADD EXAMPLE and SCREENSHOT -->
-
<para>In order to set the offset for the menu popup relatively to label, you can use <emphasis>
<property>"horizontalOffset"</property>
</emphasis> and <emphasis>
<property>"verticalOffset"</property>
- </emphasis> attributes. Values can be negative.</para>
+ </emphasis> attributes. Values can be negative.</para-->
- <para><property>menuItem</property> provides <emphasis>
+ <!-- For menuItem, not for contexMenu -->
+ <!--para><property>menuItem</property> provides <emphasis>
<property>"submitMode"</property>
</emphasis> attribute to define the way of submission. Possible values : <itemizedlist>
<listitem>
@@ -163,16 +215,15 @@
<property>"actionListener"</property>
</emphasis> item's attributes are ignored. Menu items don't fire any submits
themselves. The behavior is fully defined by the components nested inside items.</para>
- <!-- template
+ <template
<para>emphasis role="bold">
<property><contextMenu></property>
</emphasis> could not be generated for every component where it's defined. Templating could
be used instead. So only representation data could be loaded from server. And markup
could be evaluated on client side. So it's should accept macrosubstitutions like
{value} </para>
-
- -->
- </para>
+
+ </para-->
</section>
<section>
<title>JavaScript API</title>
@@ -198,7 +249,7 @@
<entry>Show component or group</entry>
<entry>Component, group</entry>
</row>
- <row>
+ <!--row>
<entry>doEnable()</entry>
<entry>Enable component, item, group</entry>
<entry>Component, Item, Group</entry>
@@ -207,189 +258,9 @@
<entry>doDisable()</entry>
<entry>Disable component, item or group</entry>
<entry>Component, Item, Group</entry>
- </row>
+ </row-->
</tbody>
</tgroup>
</table>
</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>
-
- <para>There are two ways to redefine the appearance of all <emphasis role="bold">
- <property><rich:contextMenu></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:contextMenu></property>
- </emphasis> component</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Skin Parameters Redefinition</title>
- </section>
- <section>
- <title>Definition of Custom Style Classes</title>
-
- <para>On the screenshot there are classes names that define styles for component elements.</para>
-
- <!-- ADD SCREENSHOT -->
-
- <table>
- <title>Classes names that define a menu item</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-item</entry>
- <entry>Defines styles for menu item</entry>
- </row>
- <row>
- <entry>rich-menu-item-disabled</entry>
- <entry>Defines styles for menu item in disabed state</entry>
- </row>
- <row>
- <entry>rich-menu-item-enabled</entry>
- <entry>Defines styles for menu item in enabled state</entry>
- </row>
- <row>
- <entry>rich-menu-item-hover</entry>
- <entry>Defines styles for menu item on hover event</entry>
- </row>
- <row>
- <entry>rich-menu-item-icon</entry>
- <entry>Defines styles for icon in menu item</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a menu item label</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-item-label</entry>
- <entry>Defines styles for menu item label</entry>
- </row>
- <row>
- <entry>rich-menu-item-label-disabled</entry>
- <entry>Defines styles for menu item label in disabled state</entry>
- </row>
- <row>
- <entry>rich-menu-item-label-selected</entry>
- <entry>Defines styles for menu item label already selected</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a menu item icon</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-item-icon-disabled</entry>
- <entry>Defines styles for icon of menu item in disabled state</entry>
- </row>
- <row>
- <entry>rich-menu-item-icon-selected</entry>
- <entry>Defines styles for icon of menu item in selected state</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a group element</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-group</entry>
- <entry>Defines styles for menu group</entry>
- </row>
- <row>
- <entry>rich-menu-group-disabled</entry>
- <entry>Defines styles for menu group in disabled state</entry>
- </row>
- <row>
- <entry>rich-menu-group-selected</entry>
- <entry>Defines styles for menu group in selected state</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a separator</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-separator</entry>
- <entry>Defines styles for menu separator</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a popup element</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-popup</entry>
- <entry>Defines styles for popup element</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
</section>
More information about the richfaces-svn-commits
mailing list