Index 3.x

TOCSTART

<div>
    <ul>
        <li><a href="#Index3.x-Overview">Overview</a></li>
        <li><a href="#Index3.x-SupportedEnvironments">Supported Environments</a></li>
        <ul>
            <li><a href="#Index3.x-SupportedBrowsers">Supported Browsers</a></li>
            <li><a href="#Index3.x-JDKVersions">JDK Versions</a></li>
            <li><a href="#Index3.x-JSFVersion">JSF Version</a></li>
            <li><a href="#Index3.x-ApplicationServers">Application Servers</a></li>
            <li><a href="#Index3.x-ViewDefinitionLanguagesSupport">View Definition Languages Support</a></li>
        </ul>
        <li><a href="#Index3.x-DocumentationConventions">Documentation Conventions</a></li>
    </ul>
</div>
<p>TOCEND<br>
    The OpenFaces Developer's Guide consists of the following:</p>
<ul>
    <li>Documentation Home (this document) providing the overview, supported environments and general
        characteristics of the OpenFaces components.
    </li>
    <li><a href="/display/OF/Installation+and+Configuration+2.x" title="Installation and Configuration 2.x">Installation
        and Configuration</a> providing getting-started information, installation steps, usage and
        OpenFaces-specific application context parameters.
    </li>
    <li><a href="/display/OF/Common+Concepts+2.x" title="Common Concepts 2.x">Common Concepts</a> 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.
    </li>
    <li><a href="/display/OF/Components+Index+2.x" title="Components Index 2.x">Components Index</a> listing all the
        OpenFaces components with their short descriptions and screenshots.
    </li>
    <li>Documentation on individual OpenFaces components describing their features, configuration, and code samples
        (see the sidebar for the components list).
    </li>
    <li>Documentation on the OpenFaces <a href="/display/OF/Ajax+Framework+2.x" title="Ajax Framework 2.x">Ajax
        Framework</a> providing the information on the Ajax support features and the Ajax related configuration
        settings.
    </li>
    <li>Documentation on the OpenFaces <a href="/display/OF/Validation+Framework+2.x"
                                          title="Validation Framework 2.x">Validation Framework</a> providing the
        overview, features, configuration, detailed API description, and code samples.
    </li>
</ul>


<h4><a name="Index3.x-Overview"></a>Overview</h4>

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

<p>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 <cite>DataTable</cite>,
    <cite>TreeTable</cite>, <cite>Calendar</cite>, <cite>DateChooser</cite>, <cite>Chart</cite>, <cite>TwoListSelection</cite>
    (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.</p>

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

<h4><a name="Index3.x-SupportedEnvironments"></a>Supported Environments</h4>


<h5><a name="Index3.x-SupportedBrowsers"></a>Supported Browsers</h5>

<p>All the OpenFaces components support the latest versions of the following browsers:</p>
<ul>
    <li>Microsoft Internet Explorer (6.0 and later)</li>
    <li>Mozilla Firefox (3.6 and later)</li>
    <li>Opera (10.5 and later)</li>
    <li>Apple Safari (5.0 and later)</li>
    <li>Google Chrome</li>
</ul>


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

<h5><a name="Index3.x-JDKVersions"></a>JDK Versions</h5>

<p>The OpenFaces components require JDK 1.5 or later on the server.</p>

<h5><a name="Index3.x-JSFVersion"></a>JSF Version</h5>

<p>The OpenFaces library requires the JavaServer Faces implementation conforming to the specification version
    2.0/2.1. This version of OpenFaces has been tested with Mojarra version 2.0.3 and Mojarra 2.1.11.</p>

<h5><a name="Index3.x-ApplicationServers"></a>Application Servers</h5>

<p>The current version of OpenFaces has been tested to work with the following application servers:</p>
<ul>
    <li>Apache Tomcat 6.0</li>
    <li>GlassFish v3</li>
    <li>JBoss AS 4.2 – 6.0</li>
</ul>


<h5><a name="Index3.x-ViewDefinitionLanguagesSupport"></a>View Definition Languages Support</h5>

<p>OpenFaces 3.0 requires an application to be written with Facelets view definition language. The support for JSP
    is discontinued in OpenFaces 3.0 due to the fact that JSF 2.0 deprecates the usage of JSP and standardizes
    Facelets as the primary view definition language.</p>

<h4><a name="Index3.x-DocumentationConventions"></a>Documentation Conventions</h4>

<p>The documentation on the OpenFaces components uses the following markup conventions:</p>

<div class="table-wrap">
    <table class="confluenceTable">
        <tbody>
        <tr>
            <th class="confluenceTh"> Element name</th>
            <th class="confluenceTh"> Example</th>
        </tr>
        <tr>
            <td class="confluenceTd"> Class names</td>
            <td class="confluenceTd"><tt>java.util.Date</tt></td>
        </tr>
        <tr>
            <td class="confluenceTd"> Attribute and property names</td>
            <td class="confluenceTd"><b>onclick</b></td>
        </tr>
        <tr>
            <td class="confluenceTd"> Value constants</td>
            <td class="confluenceTd"><i>ajax</i></td>
        </tr>
        <tr>
            <td class="confluenceTd"> UI elements</td>
            <td class="confluenceTd"><i><u>Add All</u></i></td>
        </tr>
        <tr>
            <td class="confluenceTd"> Component names</td>
            <td class="confluenceTd"><cite>TreeTable</cite></td>
        </tr>
        <tr>
            <td class="confluenceTd"> Tag names</td>
            <td class="confluenceTd"><u>&lt;o:dynamicImage&gt;</u></td>
        </tr>
        </tbody>
    </table>
</div>

<p>Please also note that whenever "list" and "collection" terms are used, <tt>java.util.List</tt> and <tt>java.util.Collection</tt>
    are meant.</p>