From richfaces-svn-commits at lists.jboss.org Fri Apr 10 06:02:52 2009 Content-Type: multipart/mixed; boundary="===============1494807588469603076==" 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: r13484 - trunk/docs/userguide/en/src/main/docbook/included. Date: Fri, 10 Apr 2009 06:02:52 -0400 Message-ID: --===============1494807588469603076== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: msorokin Date: 2009-04-10 06:02:52 -0400 (Fri, 10 Apr 2009) New Revision: 13484 Modified: trunk/docs/userguide/en/src/main/docbook/included/rich_page.desc.xml trunk/docs/userguide/en/src/main/docbook/included/rich_page.xml Log: https://jira.jboss.org/jira/browse/RF-6593 Added descriptions of layout components Modified: trunk/docs/userguide/en/src/main/docbook/included/rich_page.desc.= 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 --- trunk/docs/userguide/en/src/main/docbook/included/rich_page.desc.xml 20= 09-04-10 10:02:31 UTC (rev 13483) +++ trunk/docs/userguide/en/src/main/docbook/included/rich_page.desc.xml 20= 09-04-10 10:02:52 UTC (rev 13484) @@ -1,17 +1,27 @@ -
+
- = - layouPanel - rich:layouPanel + + rich:page - - = - Description - The - <rich:page> - = - + +
+ Description + The + <rich:page> + component is used to create structured layouts contain= ing header, bottom, center and left or right layout areas as well as to d= efine the content of the <head/> element, declare DOCTYPE etc. + = = - = -
+
+
+ Key Features = + + = + = + Option to change the renderer of the component= + Possibility to define parameters of an HTML pa= ge + = + = + = +
+
\ No newline at end of file Modified: trunk/docs/userguide/en/src/main/docbook/included/rich_page.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 --- trunk/docs/userguide/en/src/main/docbook/included/rich_page.xml 2009-04= -10 10:02:31 UTC (rev 13483) +++ trunk/docs/userguide/en/src/main/docbook/included/rich_page.xml 2009-04= -10 10:02:52 UTC (rev 13484) @@ -1,5 +1,71 @@ - + +
+ + + rich:page + page + + + + Component identification parameters + + + + Name + Value + + + + + component-type + org.richfaces.component.html.HtmlPage + + + component-class + org.richfaces.component.html.HtmlPage + + + component-family + org.richfaces.Page + + + renderer-type + org.richfaces.PageRenderer + + + tag-class + org.richfaces.taglib.PageTag + + + +
+ Creating the Component with a Page Tag + To create the simplest variant on a page use the following s= yntax: + = + + Example: + + + + + = + +...]]> +
+
+ Creating the Component Dynamically Using Java + = + + Example: + + +
+
Details of Usage The <rich:page> = @@ -9,13 +75,26 @@ = = - In the first place, to declare the document type of the page y= ou should use the "markupType" attribute which has the following values: "html", &quo= t;xhtml", "html-transitional", "html-3.2". + In the first place, to declare the document type of the page y= ou should use the "markupType" attribute which has the following values: = + = + = + + "html" + "html-transitional" + "xhtml" + "xhtml-transitional" + "html-frameset" + "html-3.2" + + + = + The "contentType" allows to specify the type of the content and encoding for the page= . = = The title of the page can be set with the "pageTile" attribute. = - To place some other page parameters (like meta information, = links to CSS style sheets etc.) in the <head> part of an HTML page us= e "pageHeader" facet. = + To place some other page parameters (like meta information, = links to CSS style sheets etc.) in the <head> element of an HTML page= use "pageHeader" facet. = = @@ -34,7 +113,7 @@ ...]]> = = - The implementation of the = <rich:> component provides three facets that yo= u can use to arrange the layout of the page: "header", "side= bar" and "footer" . + The implementation of the = <rich:page> component provides three facets tha= t you can use to arrange the layout of the page: "header", "= subheader", "sidebar" and "footer". Their behavi= or is quite self-explanatory. The position of the panel rendered by a "sidebar" = facet can be set with the "sidebarPosition" attribute that can take either "right" or &q= uot;left" values, you can also specify width for this facet with the = "sidebarWidth" attribute. Example: @@ -63,6 +142,101 @@ = = Several templates are available for the <rich:page> component. A template= can be activated with the "theme"= attribute. - + The template defines the way the <rich:page> is rendered. Standard render= er(default) of the <rich:page> =
+ = +
+ Facets + + Facets + + + + Facet Name + Description + + + + + pageHeader + Creates the <head/> part of the HTML = page + + + header + Creates a header + + = + + subheader + Creates a horizontal panel under the header= + + + footer + Creates a footer + = + = + + sidebar + Creates a left/right panel + = + = + + +
+
+ = + = +
+ Component CSS Selectors + = + + CSS Selectors that define the representation of the com= ponent's blocks + + + + CSS Selector + Description + + + + = + = + + .rich-page + Defines styles for the whole page + = + = + = + + .rich-page-header + Defines styles for the header + + = + + .rich-page-subheader + Defines styles for the block under the head= er + + = + + .rich-page-sidebar + Defines styles for the sidebar + = + = + + .rich-page-body + Defines styles for the body part of the pag= e + = + = + + .rich-page-footer + Defines styles for the footer + = + = + = + + +
= + = +
+
\ No newline at end of file --===============1494807588469603076==--