Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

A summary page is a page in XHTML file format screen that is used to display data in a tabular format based on multiple filter criteria.

Note

The template that is used in summary page is summary_template.xhtml. 

A summary page should be used only the following Components for its content:

  • crm:summaryMultipleFiltersArea
  • crm:summaryMultipleFilterSearchButton
  • crm:summaryResultArea


Note

The managed bean class of a summary page should be extend SummaryView class.


Note

Search criteria can be configured through the settings button next to search button.

Results can be configured and exported in XLS, CSV and XML format through the settings button in the first column of the data table. 


Getting Started

The following namespaces of URI are defined in html root element of the summary page.

Tag Library

URIPrefixContentsXHTML namespacehttp://www.w3.org/1999/xhtmlTags for xhtmlJavaServer Faces Facelets Tag Libraryhttp://xmlns.jcp.org/jsf/facelets

ui:

Tags for templatingPrimeFaces componentshttp://primefaces.org/ui

p:

Tags for PrimeFaces componentsJavaServer Faces Core Tag Libraryhttp://java.sun.com/jsf/core

f:

Tags for JavaServer Faces custom actions that are independent of any particular render kitPass-through Attributes Tag Libraryhttp://xmlns.jcp.org/jsf/passthrough

p:

Tags to support HTML5-friendly markupJavaServer Faces HTML Tag Libraryhttp://java.sun.com/jsf/html

h:

JavaServer Faces component tags for all UIComponent objectsJSTL Functions Tag Libraryhttp://java.sun.com/jsp/jstl/functions

fn:

JSTL 1.2 Functions TagsJSTL Core Tag Libraryhttp://java.sun.com/jsp/jstl/core

c:

JSTL 1.2 Core TagsCRM Composite Components Tag Libraryhttp://java.sun.com/jsf/composite/crm

crm:

Tags for CRM Components

The template that is used in summary page is the crm custom template template.xhtml. 

By default the template provides the base interface layout of the page (header, footer, topbar, main menu, content) as well as the following tags:

  • "managedBean" parameter - contains the name of the managed bean that will be used from template
  • "back-button" placeholder - defines the back button of the page that will be inserted in the left side of the topbar before the title

  • "title" placeholder -  defines the title of the page that will be inserted n the left side of the topbar

  • "viewname" placeholder -  defines the view name in breadcrumb of the page

  • "actions" placeholder - defines the actions of the page that will be inserted in the right side of the topbar

  • "content" placeholder - defines the actual content of the page

Simple Example

The following example shows a summary page of Countries.example illustrates a summary page of Countries.

A back button component is added in "back-button" ui:define placeholder that may be selected in order to return to the crm template pages landing page.

A new button component is added in"actions" ui:define placeholder that may be selected in order to create a new country.

The content of the page is added in "content" ui:define placeholder and consists of:

  • A summary multiple filters area component used to display multiple criteria.
  • A summary multiple filter search button used to display a search button.
  • A summary result area used to display the countries based on the selected criteria.

Actions "New", "View" and "Edit"