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 syntax:

Example:

    ...
    <rich:page>
      <!-- page body -->
    </rich:page>
    ...

## Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlPage;
    ...
    HtmlPage myHtmlPage = new HtmlPage();
    ...

## Details of Usage

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>
    ...

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.

## 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

## Skin Parameters for the "simple" theme

Skin parameters for the <body/> HTML element

Skin parameters | CSS properties
--- | ---
generalFamilyFont | font-family

Skin parameters for the whole page

Skin parameters | CSS properties
--- | ---
generalSizeFont | font-size

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

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

Skin parameters for the footer

Skin parameters | CSS properties
--- | ---
generalBackgroundColor | border-top-color
panelBorderColor | background-color
generalFamilyFont | font-family
generalTextColor | color
generalSizeFont | font-size

Skin parameters for the side panel

Skin parameters | CSS properties
--- | ---
generalFamilyFont | font-family
generalTextColor | color
generalSizeFont | font-size

Skin parameters for h1,h2,h3 HTML tags

Skin parameters | CSS properties
--- | ---
headerFamilyFont | font-family
headTextColor | color

Skin parameters for p,ul,ol HTML tags

Skin parameters | CSS properties
--- | ---
generalFamilyFont | font-family
controlTextColor | color

Skin parameters for the hovered link

Skin parameters | CSS properties
--- | ---
hoverLinkColor | color

Skin parameters for the visited link

Skin parameters | CSS properties
--- | ---
visitedLinkColor | color

## Component CSS Selectors

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

## Relevant Resources Links

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