From richfaces-svn-commits at lists.jboss.org Mon Apr 4 20:21:23 2011 Content-Type: multipart/mixed; boundary="===============3912862943333643697==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r22365 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory. Date: Mon, 04 Apr 2011 20:21:23 -0400 Message-ID: <201104050021.p350LN93016498@svn01.web.mwc.hst.phx2.redhat.com> --===============3912862943333643697== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2011-04-04 20:21:23 -0400 (Mon, 04 Apr 2011) New Revision: 22365 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exa= m-Component_Reference-richtreeNode-Basic_usage.xml_sample Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Menus_and_toolbars.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Trees.xml Log: Completed part 3 of revisions for Engineering review: RFPL-1380 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Menus_and_toolbars.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Menus_and_toolbars.xml 2011-04-04 16:12:14 UTC (rev 22364) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Menus_and_toolbars.xml 2011-04-05 00:21:23 UTC (rev 22365) @@ -103,7 +103,7 @@
Expanding and collapsing the menu - By default, the menu drops down when the title is clicked. To drop dow= n with a different event, use the eventShow attribute to= define the event instead. + By default, the menu drops down when the title is clicked. To drop dow= n with a different event, use the showEvent attribute to= define the event instead. Menus can be navigated using the keyboard. Additionally, menus can be = navigated programmatically using the JavaScript API. The= JavaScript API allows the following methods: @@ -310,7 +310,7 @@
Basic usage - The <rich:menuGroup> component requires the = value attribute for basic usage. The value attribute is the text label for the menu item. + The <rich:menuGroup> component requires the = label attribute for basic usage. The label attribute is the text label for the menu item. Alternatively, use the= label facet to define content for the label. Additionally, the <rich:menuGroup> component= must contain child <rich:menuItem> components or = <rich:menuGroup> components. @@ -811,14 +811,14 @@
Submission modes - If the mode attribute is unspecified, the submissi= on behavior for the group is inherited from the parent <rich:pa= nelMenu>. Otherwise, the mode setting is us= ed instead of the parent's behavior. Refer to for submission mode setting= s. + If the mode attribute is unspecified, the submissi= on behavior for the group is inherited from the parent <rich:pa= nelMenu>. Otherwise, the groupMode setting = of the panel menu is used instead of the parent's behavior. Refer to for = submission mode settings.
=
<sgmltag><rich:panelMenuGroup></sgmltag> server-side even= ts - The <rich:panelMenuGroup> component fires th= e ActionEvent event on the server side when the menu gro= up receives a user action. The event only fires in the server and ajax submission modes. The event provides the = action attribute to specify the user action performed, a= nd the actionListener attribute to reference the event l= istener. + The <rich:panelMenuGroup> component fires th= e ActionEvent event on the server side when the menu gro= up receives a user action. The event only fires in the server and ajax submission modes. The event provides the = action attribute to specify the user action method, and = the actionListener attribute to reference the event list= ener.
= @@ -956,7 +956,7 @@
Submission modes - If the mode is unspecified, the submission behavio= r for the item is inherited from the parent <rich:panelMenu>= . Otherwise, the mode setting is used instead = of the parent's behavior. + If the mode is unspecified, the submission behavio= r for the item is inherited from the parent <rich:panelMenu>= . Otherwise, the itemMode setting from the pan= el menu is used instead of the parent's behavior.
= Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Trees.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Trees.xml 2011-04-04 16:12:14 UTC (rev 22364) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Trees.xml 2011-04-05 00:21:23 UTC (rev 22365) @@ -122,7 +122,7 @@ server - The <rich:tree> component performs a commo= n submission, completely re-rendering the page. + The <rich:tree> component performs a commo= n submission, completely refreshing the page. @@ -130,13 +130,13 @@ client - The <rich:tree> component updates on the c= lient side, re-rendering itself and any additional components listed with t= he render attribute. + The <rich:tree> component updates on the c= lient side through JavaScript, without any additional requests or updates. = All nodes are rendered to the client during the initial page rendering. - By default, the event to expand or collapse a tree node is a mouse cli= ck. To specify a different event, use the toggleNodeEvent attribute. + By default, tree nodes are expanded and collapsed through the + and - controls. To expand or collap= se a tree node using an action event such as a mouse click, specify the eve= nt with the toggleNodeEvent attribute.
= @@ -158,7 +158,7 @@ server - The <rich:tree> component performs a commo= n submission, completely re-rendering the page. + The <rich:tree> component performs a commo= n submission, completely refreshing the page. @@ -166,7 +166,7 @@ client - The <rich:tree> component updates on the c= lient side, re-rendering itself and any additional components listed with t= he render attribute. + The <rich:tree> component updates on the c= lient side using JavaScript, without any additional requests or updates. @@ -363,8 +363,15 @@
Basic usage - The <rich:treeNode> component must be a chil= d of a <rich:tree> component. It does not need any= attributes declared for basic usage, but can provide markup templates for = tree nodes of particular types. Refer to for an example of basic <rich:= treeNode> component usage. + The <rich:treeNode> component must be a chil= d of a <rich:tree> component or a tree adaptor com= ponent. It does not need any attributes declared for basic usage, but can p= rovide markup templates for tree nodes of particular types. Default markup = is used if the tree node type is not specified. Refer to for an example of basic <rich:treeNode> component usage. + + Basic usage + + + The example renders a simple tree of countries. Each country node ex= pands to show state nodes for that country, and each state node expands to = show city nodes for that state. + +
=
@@ -373,8 +380,9 @@ Refer to for the <rich:tree> component for details an= d examples on styling nodes and icons. Icon styling for individual <rich:treeNode> components uses the same attributes as the= parent <rich:tree> component: iconLeaf, iconExpanded, and iconCollapsed. Icon-related attributes specified for child <rich:treeNod= e> components overwrite any global icon attributes of the pare= nt <rich:tree> component. - Use the rendered attribute to determine whether th= e node should actually be rendered in the tree or not. Using the r= endered attribute in combination with the <rich:treeN= ode> type attribute can allow further style= differentiation between node content, as shown in . + Use the rendered attribute to determine whether th= e node should actually be rendered in the tree or not. Using the r= endered attribute in combination with the <rich:treeN= ode> type attribute can allow further style= differentiation between node content. +
=
@@ -469,7 +478,7 @@ <rich:treeModelAdaptor> components can furth= er be nested in other <rich:treeModelAdaptor> comp= onents to subsequently populate lower levels of the tree. - To access the current element at each iteration, use the var= attribute of either the parent <rich:tree> component or the <rich:treeModelAdaptor> compo= nent itself. demonstrates a series of nested= <rich:treeModelAdaptor> components, each using th= e parent's var attribute to reference the current elemen= t. + To access the current element at each iteration, use the var= attribute of either the parent <rich:tree> component. demonstrates a series of= nested <rich:treeModelAdaptor> components, each u= sing the parent's var attribute to reference the current= element. <sgmltag>Nested <rich:treeModelAdaptor> components</sgml= tag> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras= /exam-Component_Reference-richtreeNode-Basic_usage.xml_sample =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richtreeNode-Basic_usage.xml_sample = (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/ex= am-Component_Reference-richtreeNode-Basic_usage.xml_sample 2011-04-05 00:21= :23 UTC (rev 22365) @@ -0,0 +1,12 @@ + + + #{node.name} + + + #{node.name} + + + #{node.name} + + --===============3912862943333643697==--