Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
The <rich:page> component is used to create basic (X)HTML markup and define document parameters like DOCTYPE, title etc. The component also allows to build top level layout: header, bottom, center and left or right layout areas.
Option to change the renderer of the component (themes support)
Possibility to define parameters of an HTML page
Possibility to create page layout with facets
Provides styling based on RichFaces skinnability
Table 6.554. rich : page attributes
| Attribute Name |
Description
|
|---|---|
| binding | JSF: The attribute takes a value-binding expression for a component property of a backing bean |
| bodyClass | Assigns one or more space-separated CSS class names to the body part of the page |
| contentType | Set custom mime content type to response |
| dir | HTML: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left) |
| footerClass | Assigns one or more space-separated CSS class names to the component footer |
| headerClass | Assigns one or more space-separated CSS class names to the component header |
| id | JSF: Every component may have a unique id that is automatically created if omitted |
| lang | HTML: Code describing the language used in the generated markup for this component |
| markupType | Page layout format ( html, xhtml, html-transitional, html-3.2 ) for encoding DOCTYPE, namespace and Content-Type definitions |
| namespace | Set html element default namespace |
| oncontextmenu | The client-side script method to be called when the right mouse button is clicked over the component |
| onload | The client-side script method to be called before a page is loaded |
| onunload | The client-side script method to be called when a page is unloaded |
| pageTitle | String for output as a page title. |
| rendered | JSF: If "false", this component is not rendered |
| sidebarClass | Assigns one or more space-separated CSS class names to the component side panel |
| sidebarPosition | Defines the position of the side panel. Possible values are "left", "right". Default value is "left". |
| sidebarWidth | Defines width for the side panel. Default value is "160". |
| style | HTML: CSS style rules to be applied to the component |
| styleClass | JSF: Assigns one or more CSS class names to the component. Corresponds to the HTML "class" attribute. |
| theme | Specifies the way of the component rendering |
| title | HTML: Advisory title information about markup elements generated for this component |
| width | HTML: Sets the width of the page |
Table 6.555. 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 |
To create the simplest variant on a page use the following syntax:
Example:
...
<rich:page>
<!-- page body -->
</rich:page>
...
Example:
import org.richfaces.component.html.HtmlPage;
...
HtmlPage myHtmlPage = new HtmlPage();
...
The <rich:page> component together with the <rich:layout> component provides a full-fledged mechanism for markup creation.
First of all, to declare the document type of the page you should use the "markupType" attribute which has the following values:
"html"
"html-transitional"
"xhtml"
"xhtml-transitional"
"html-frameset"
"html-3.2"
The default value is "html".
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> element of an HTML page use "pageHeader" facet.
Example:
...
<rich:page pageTitle="The title of the page" markupType="xhtml">
<f:facet name="pageHeader">
<meta content="The rich:page component" name="keywords" />
<link rel="shortcut icon" href="/images/favicon.ico" />
<link href="/css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="/js/menu.js"></script>
</f:facet>
<!-- page content -->
</rich:page>
...
Note, the <rich:page> component encodes the full page structure. Therefore, be sure you don't use the doctype declaration, root html element, head and body elements on the same page where you've put this component.
The implementation of the <rich:page> component provides four facets that you can use to arrange the layout of the page: "header", "subheader", "sidebar" and "footer". Their behavior is quite self-explanatory.
The position of the panel rendered by the "sidebar" facet can be set with the "sidebarPosition" attribute that can take either "right" or "left" as values, you can also specify the width for this facet with the "sidebarWidth" attribute.
Example:
...
<rich:page sidebarPosition="left" sidebarWidth="300">
<f:facet name="header">
<!-- header content -->
</f:facet>
<f:facet name="sidebar">
<!-- side panel content -->
</f:facet>
<!-- body content -->
<f:facet name="footer">
<!-- footer content -->
</f:facet>
</rich:page>
...
The <rich:page> component also provides attributes to define CSS classes for each nested facet as well as a body part of the page created with the component.
Several templates are available for the <rich:page> component. A template can be activated with the "theme" attribute.
The theme defines the way the <rich:page> is rendered. Default renderer(default theme) of the <rich:page> has no mappings to skin parameters and just provides CSS classes for the page part. However, the simple theme, which is an extension of the default theme, has mappings to skin parameters and adds the RichFaces skinning for the page elements.
As a whole, RichFaces provides 4 themes for the <rich:page> component out-of-the-box: "simple", "violetRays", "oldschool", "smooth". The Creating a Theme for <rich:page> article tells how you can create your custom theme for the <rich:page> component.
Table 6.556. 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 |
Table 6.557. Skin parameters for the <body/> HTML element
| Skin parameters | CSS properties |
|---|---|
| generalFamilyFont | font-family |
Table 6.558. Skin parameters for the whole page
| Skin parameters | CSS properties |
|---|---|
| generalSizeFont | font-size |
Table 6.559. Skin parameters for the header
| Skin parameters | CSS properties |
|---|---|
| generalSizeFont | border-bottom-color |
| headerGradientColor | background-color |
| trimColor | color |
| headerFamilyFont | font-family |
| headerTextColor | color |
| headerSizeFont | font-size |
Table 6.560. Skin parameters for the content area of the page
| Skin parameters | CSS properties |
|---|---|
| generalBackgroundColor | background-color |
| panelBorderColor | border-top-color |
| trimColor | color |
| generalFamilyFont | font-family |
| generalTextColor | color |
| generalSizeFont | font-size |
Table 6.561. Skin parameters for the footer
| Skin parameters | CSS properties |
|---|---|
| generalBackgroundColor | border-top-color |
| panelBorderColor | background-color |
| generalFamilyFont | font-family |
| generalTextColor | color |
| generalSizeFont | font-size |
Table 6.562. Skin parameters for the side panel
| Skin parameters | CSS properties |
|---|---|
| generalFamilyFont | font-family |
| generalTextColor | color |
| generalSizeFont | font-size |
Table 6.563. Skin parameters for h1,h2,h3 HTML tags
| Skin parameters | CSS properties |
|---|---|
| headerFamilyFont | font-family |
| headTextColor | color |
Table 6.564. Skin parameters for p,ul,ol HTML tags
| Skin parameters | CSS properties |
|---|---|
| generalFamilyFont | font-family |
| controlTextColor | color |
Table 6.567. CSS Selectors that define the representation of the component'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 header |
| .rich-page-sidebar | Defines styles for the sidebar |
| .rich-page-body | Defines styles for the body part of the page |
| .rich-page-footer | Defines styles for the footer |
On the component Live Demo page you can see the example of <rich:page> component usage and sources for the given example.
The Layout components for RichFaces 3.3.1 on the JBoss.org Wiki