OpenFaces Developer’s Guide

The OpenFaces Developer's Guide consists of the following:

  • Documentation Home (this document) providing the overview, supported environments and general characteristics of the OpenFaces components.
  • Installation and Configuration providing getting-started information, installation steps, usage and OpenFaces-specific application context parameters.
  • Common Concepts introductory material, which describes the main aspects of OpenFaces design, information common for all components, and it gives you the general understanding of the OpenFaces library.
  • Components Index listing all the OpenFaces components with their short descriptions and screenshots.
  • Documentation on individual OpenFaces components describing their features, configuration, and code samples (see the sidebar for the components list).
  • Documentation on the OpenFaces Ajax Framework providing the information on the Ajax support features and the Ajax related configuration settings.
  • Documentation on the OpenFaces Validation Framework providing the overview, features, configuration, detailed API description, and code samples.

Overview

The OpenFaces library includes an extended set of JSF components for building rich Web user interfaces and a validation framework that shifts the traditional JSF validation logic to the client side.

The standard JSF UI components are not enough to create a feature-rich and responsive Web application. The OpenFaces library extends this set with such advanced components as DataTable, TreeTable, Calendar, DateChooser, Chart, TwoListSelection (and many others) and provides richer client-side functionality for them. Thanks to such features as Ajax support and keyboard navigation, the OpenFaces library not only simplifies development of Web applications but as a result, makes them highly interactive and user-friendly.

With the OpenFaces validation framework, you can now use standard JSF validators on the client side by assigning them to any input component, both from JSF and OpenFaces library. Or, by the same token, use additionally provided OpenFaces validators that work equally well on the client and server side. The OpenFaces validation framework supports a variety of usage scenarios where data should be validated, ensuring that validation rules are met and data types are correct already on the client, promptly notifying the user of any possible errors. In addition, it provides a flexible mechanism to configure the default validation errors presentation in many different ways.

Supported Environments

Supported Browsers

All the OpenFaces components support the latest versions of the following browsers:

  • Microsoft Internet Explorer (6.0 and later)
  • Mozilla Firefox (2.0 and later)
  • Opera (9.6 and later)
  • Apple Safari (3.0 and later)
  • Google Chrome

The OpenFaces components operate well in quirks and standards-compliant browser modes. Please also note that the OpenFaces library requires enabled JavaScript in the client browser.

JDK Versions

The OpenFaces components require JDK 1.5 or later on the server.

JSF Version

The OpenFaces library requires the JavaServer Faces implementation conforming to the specification version 2.0. This version of the OpenFaces has been tested with Mojarra version 2.0.3.

Application Servers

The current version of OpenFaces has been tested to work with the following application servers:

  • Apache Tomcat 6.0
  • GlassFish v3

Facelets/JSP View Definition Languages Support

OpenFaces 3.0 and later can be used with both view definition languages supported by JSF 2.0: Facelets and JSP.

Documentation Conventions

The documentation on the OpenFaces components uses the following markup conventions:

Element name Example
Class names java.util.Date
Attribute and property names onclick
Value constants ajax
UI elements Add All
Component names TreeTable
Tag names <o:dynamicImage>

Please also note that whenever "list" and "collection" terms are used, java.util.List and java.util.Collection are meant.

OpenFaces