ICEfaces Components

The ICEfaces Components are an ICEfaces 2-compatible version of the ICEfaces 1.x ICEfaces Component Suite.

You should include this library if you want to use the ICEfaces Component Suite components in your application or if you are porting an existing ICEfaces 1.8.x application to ICEfaces 2.

See the [ICEfaces 1.x Compatibility] section for more information on porting an existing ICEfaces 1.x application to ICEfaces 2.

Configurations Details

Required web.xml entries

<?xml version='1.0' encoding='UTF-8'?>

<!-- Have the proper schema version -->
<web-app version="2.5"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
                             http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

    <!-- More efficient, in an AJAX environment, to have server side state saving -->
    <context-param>
        <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
        <param-value>server</param-value>
    </context-param>

    <!-- HTML comments become components unless they're stripped -->
    <context-param>
        <param-name>javax.faces.FACELETS_SKIP_COMMENTS</param-name>
        <param-value>true</param-value>
    </context-param>

    <!-- If you're using ice:gmap component, you'll need your own key here -->
    <context-param>
        <param-name>com.icesoft.faces.gmapKey</param-name>
        <param-value>ABQIAAAADlu0ZiSTam64EKaCQr9eTRTOTuQNzJNXRlYRLknj4cQ89tFfpxTEqxQnVWL4k55OPICgF5_SOZE06A
        </param-value>
    </context-param>

    <!-- The JSF servlet -->
    <servlet>
        <servlet-name>Faces Servlet</servlet-name>
        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    </servlet>

    <!-- Many of the ICEfaces Components make use of the Resource Servlet -->
    <servlet>
        <servlet-name>Resource Servlet</servlet-name>
        <servlet-class>com.icesoft.faces.webapp.CompatResourceServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- The standard mapping. Can use other extensions, or path mappings -->
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.jsf</url-pattern>
    </servlet-mapping>

    <!-- This specific mapping is necessary for the Resource Servlet to function properly -->
    <servlet-mapping>
        <servlet-name>Resource Servlet</servlet-name>
        <url-pattern>/xmlhttp/*</url-pattern>
    </servlet-mapping>
</web-app>

Add icefaces-compat.jar to your application project
```
[icefaces2.dir]/icefaces/lib/icefaces-compat.jar
```

3rd Party Dependencies
If you are using the ICEfaces Components you will also require additional 3rd party libraries. See Appendix A - ICEfaces Library/App. Server Dependencies in the ICEfaces 1.8 Developer's Guide for details.

Component List

checkbox	checkbox for a selectManyCheckbox component when the layout of the selectManyCheckbox component is "spread"
column	single column of data within a parent UIData component
columnGroup	used to create multiple dataTable headers or footers with allowable colspan and rowspan
columns	used to render multiple table columns
commandButton	submit or reset button
commandLink	HTML "a" anchor element that acts like a form submit button when clicked
commandSortHeader	clickable column header allowing user to toggle the sort order of data in table
dataExporter	export the data contents of an table component into a variety of formats
dataPaginator	used to render a set of page navigation controls for a table
dataTable	HTML table tied to underlying data model
effect	add effects to parent component
form	HTML form width added features
gMap	Google map
gMapControl	adds control to the gMap
gMapDirection	direction from point A to point B
gMapGeoXml	supports the KML and GeoRSS data formats for displaying geographic information
gMapLatLng	wrapper for google map's GLatLng API
gMapLatLngs	list of gMapLatLng components
gMapMarker	uses google map's GMarker API to display points on the map
graphicImage	HTML "img" element
headerRow	header row for a table
inputHidden	HTML "input" element of "type" "hidden"
inputRichText	JSF based rich text component
inputSecret	HTML "input" element of "type" "password"
inputText	HTML "input" element of "type" "text"
inputTextarea	HTML "textarea" element
jsEventListener	used to capture javascript events and optionally send a notification to server and fire an action event
loadBundle	similar to f:loadBundle but allows change to messages dynamically
menuBar	provides a robust menu system
menuItem	menu items contained by a menuBar
menuItems	dynamic heirarchy of menu items
menuItemSeparator	separates groups of menu items
menuPopup	context sensitive popup menu providing popup nested child menus
message	single message for a specific component
messages	all the messages for a specific component
outputChart	charts of various types
outputConnectionStatus	displays information about the status of the network connection
outputFormat	renders parameterized text
outputLabel	HTML "label" element
outputLink	HTML "a" anchor element
outputMedia	plays a media object
outputProgress	report progress to users in cases where a long running server-side task is necessary
outputResource	expose resources for opening or downloading
outputStyle	link desired ICEfaces theme CSS stylesheets
outputText	span element for displaying text.

ICEfaces Components