JBoss.orgCommunity Documentation

Component Reference

A reference guide to the components of the RichFaces 4 (draft) framework

Logo

by Sean Rogers (Red Hat)

Abstract

This book details each component in the RichFaces 4 framework, including examples of their use in applications.

1. Introduction
1.1. Libraries
2. Common Ajax attributes
2.1. Data processing
2.1.1. execute
2.1.2. bypassUpdates
2.2. Rendering
2.2.1. render
2.2.2. ajaxRendered
2.2.3. limitRender
2.3. Queuing and traffic control
2.3.1. requestDelay
2.3.2. ignoreDupResponses
2.4. Events and JavaScript interactions
2.4.1. onsubmit
2.4.2. onbegin
2.4.3. onbeforedomupdate
2.4.4. oncomplete
2.4.5. onerror
I. Ajax control components
3. Actions
3.1. <a4j:ajax>
3.1.1. Basic usage
3.1.2. Reference data
3.2. <a4j:param>
3.2.1. Basic usage
3.2.2. Interoperability
3.2.3. Passing client-side parameters
3.2.4. Reference data
3.3. <a4j:commandButton>
3.3.1. Basic usage
3.3.2. Reference data
3.4. <a4j:commandLink>
3.4.1. Basic usage
3.4.2. Reference data
3.5. <a4j:jsFunction>
3.5.1. Basic usage
3.5.2. Parameters and JavaScript
3.5.3. Reference data
3.6. <a4j:poll>
3.6.1. Timing options
3.6.2. Reference data
3.7. <a4j:push>
3.7.1. Basic usage
3.7.2. Handling a push notification
3.7.3. Reference data
4. Containers
4.1. <a4j:outputPanel>
4.1.1. Aiding complex Ajax rendering
4.1.2. Panel appearance
4.1.3. Reference data
4.2. <a4j:region>
4.2.1. Reference data
5. Validation
5.1. <rich:validator> client-side validation
5.1.1. Basic usage
5.1.2. Messages from client-side validators
5.1.3. Validation triggers
5.1.4. Ajax fall-backs
5.1.5. Reference data
5.2. <rich:graphValidator> object validation
5.2.1. Basic usage
5.2.2. Reference data
6. Processing management
6.1. <a4j:queue>
6.1.1. Basic usage
6.1.2. Delaying requests
6.1.3. Duplicate responses
6.1.4. Queue scopes
6.1.5. <a4j:queue> client-side events
6.1.6. Reference data
6.1.7. <a4j:attachQueue>
6.2. <a4j:log>
6.2.1. Basic usage
6.2.2. Log monitoring
6.2.3. Reference data
6.2.4. Style classes and skin parameters
6.3. <a4j:status>
6.3.1. Customizing the text
6.3.2. Specifying a region
6.3.3. JavaScript API
6.3.4. Reference data
II. User interface components
7. Rich inputs
7.1. <rich:autocomplete>
7.1.1. Basic usage
7.1.2. Submission modes
7.1.3. Interactivity options
7.1.4. Customizing the filter in client and lazyClient modes
7.1.5. JavaScript API
7.1.6. Reference data
7.1.7. Style classes and skin parameters
7.2. <rich:calendar>
7.2.1. Basic usage
7.2.2. Behavior and appearance
7.2.3. Time of day
7.2.4. Localization and formatting
7.2.5. Using a data model
7.2.6. Client-side customization
7.2.7. JavaScript API
7.2.8. Reference data
7.2.9. Style classes and skin parameters
7.3. <rich:fileUpload>
7.3.1. Basic usage
7.3.2. Upload settings
7.3.3. Interactivity options
7.3.4. <rich:fileUpload> client-side events
7.3.5. Reference data
7.3.6. Style classes and skin parameters
7.4. <rich:inplaceInput>
7.4.1. Basic usage
7.4.2. Interactivity options
7.4.3. JavaScript API
7.4.4. Reference data
7.4.5. Style classes and skin parameters
7.5. <rich:inplaceSelect>
7.5.1. Basic usage
7.5.2. Interactivity options
7.5.3. JavaScript API
7.5.4. Reference data
7.5.5. Style classes and skin parameters
7.6. <rich:inputNumberSlider>
7.6.1. Basic usage
7.6.2. Interactivity options
7.6.3. JavaScript API
7.6.4. Reference data
7.6.5. Style classes and skin parameters
7.7. <rich:inputNumberSpinner>
7.7.1. Basic usage
7.7.2. Interactivity options
7.7.3. JavaScript API
7.7.4. Reference data
7.7.5. Style classes and skin parameters
7.8. <rich:select>
7.8.1. Basic usage
7.8.2. Using manual input
7.8.3. Advanced options
7.8.4. JavaScript API
7.8.5. Reference data
7.8.6. Style classes and skin parameters
8. Panels
8.1. <rich:panel>
8.1.1. Basic usage
8.1.2. Adding a header
8.1.3. Reference data
8.1.4. Style classes and skin parameters
8.2. <rich:accordion>
8.2.1. Basic usage
8.2.2. Switching panels
8.2.3. <rich:accordion> client-side events
8.2.4. <rich:accordion> server-side events
8.2.5. JavaScript API
8.2.6. Reference data
8.2.7. Style classes and skin parameters
8.2.8. <rich:accordionItem>
8.3. <rich:collapsiblePanel>
8.3.1. Basic usage
8.3.2. Expanding and collapsing the panel
8.3.3. Appearance
8.3.4. <rich:collapsiblePanel> server-side events
8.3.5. JavaScript API
8.3.6. Reference data
8.3.7. Style classes and skin parameters
8.4. <rich:popupPanel>
8.4.1. Basic usage
8.4.2. Showing and hiding the pop-up
8.4.3. Modal and non-modal panels
8.4.4. Size and positioning
8.4.5. Header and controls
8.4.6. Contents of the pop-up
8.4.7. JavaScript API
8.4.8. Reference data
8.4.9. Style classes and skin parameters
8.5. <rich:tabPanel>
8.5.1. Switching panels
8.5.2. <rich:tabPanel> client-side events
8.5.3. <rich:tabPanel> server-side events
8.5.4. JavaScript API
8.5.5. Reference data
8.5.6. Style classes and skin parameters
8.5.7. <rich:tab>
8.6. <rich:togglePanel>
8.6.1. Basic usage
8.6.2. Toggling between components
8.6.3. JavaScript API
8.6.4. Reference data
8.6.5. <rich:toggleControl>
8.6.6. <rich:togglePanelItem>
9. Tables and grids
9.1. <a4j:repeat>
9.1.1. Basic usage
9.1.2. Limited views and partial updates
9.1.3. Reference data
9.2. <rich:dataTable>
9.2.1. Basic usage
9.2.2. Customizing the table
9.2.3. Partial updates
9.2.4. JavaScript API
9.2.5. Reference data
9.2.6. Style classes and skin parameters
9.3. <rich:column>
9.3.1. Basic usage
9.3.2. Spanning columns
9.3.3. Spanning rows
9.3.4. Reference data
9.4. <rich:columnGroup>
9.4.1. Complex headers
9.4.2. Reference data
9.5. <rich:collapsibleSubTable>
9.5.1. Basic usage
9.5.2. Expanding and collapsing the sub-table
9.5.3. Reference data
9.5.4. Style classes
9.5.5. <rich:collapsibleSubTableToggler>
9.6. <rich:extendedDataTable>
9.6.1. Basic usage
9.6.2. Table appearance
9.6.3. Extended features
9.6.4. JavaScript API
9.6.5. Reference data
9.6.6. Style classes and skin parameters
9.7. <rich:dataGrid>
9.7.1. Basic usage
9.7.2. Customizing the grid
9.7.3. Partial updates
9.7.4. Reference data
9.7.5. Style classes and skin parameters
9.8. <rich:list>
9.8.1. Basic usage
9.8.2. Type of list
9.8.3. Bullet and numeration appearance
9.8.4. Customizing the list
9.8.5. Reference data
9.8.6. Style classes and skin parameters
9.9. <rich:dataScroller>
9.9.1. Basic usage
9.9.2. Appearance and interactivity
9.9.3. JavaScript API
9.9.4. Reference data
9.9.5. Style classes and skin parameters
9.10. Table filtering
9.10.1. Basic filtering
9.10.2. External filtering
9.11. Table sorting
9.11.1. External sorting
10. Trees
10.1. <rich:tree>
10.1.1. Basic usage
10.1.2. Appearance
10.1.3. Expanding and collapsing tree nodes
10.1.4. Selecting tree nodes
10.1.5. Identifying nodes with the rowKeyConverter attribute
10.1.6. Event handling
10.1.7. Reference data
10.1.8. Style classes
10.1.9. <rich:treeNode>
10.2. Tree adaptors
10.2.1. <rich:treeModelAdaptor>
10.2.2. <rich:treeModelRecursiveAdaptor>
11. Menus and toolbars
11.1. <rich:dropDownMenu>
11.1.1. Basic usage
11.1.2. Menu content
11.1.3. Appearance
11.1.4. Expanding and collapsing the menu
11.1.5. Reference data
11.1.6. Style classes and skin parameters
11.2. Menu sub-components
11.2.1. <rich:menuItem>
11.2.2. <rich:menuGroup>
11.2.3. <rich:menuSeparator>
11.3. <rich:panelMenu>
11.3.1. Basic usage
11.3.2. Interactivity options
11.3.3. Appearance
11.3.4. Submission modes
11.3.5. <rich:panelMenu> server-side events
11.3.6. JavaScript API
11.3.7. Reference data
11.3.8. Style classes and skin parameters
11.3.9. <rich:panelMenuGroup>
11.3.10. <rich:panelMenuItem>
11.4. <rich:toolbar>
11.4.1. Basic usage
11.4.2. Appearance
11.4.3. Grouping items
11.4.4. Reference data
11.4.5. Style classes and skin parameters
11.4.6. <rich:toolbarGroup>
12. Output and messages
12.1. <rich:message>
12.1.1. Basic usage
12.1.2. Appearance
12.1.3. Reference data
12.1.4. Style classes and skin parameters
12.2. <rich:messages>
12.2.1. Basic usage
12.2.2. Appearance
12.2.3. Reference data
12.2.4. Style classes and skin parameters
12.3. <rich:progressBar>
12.3.1. Basic usage
12.3.2. Customizing the appearance
12.3.3. Using set intervals
12.3.4. Update mode
12.3.5. JavaScript API
12.3.6. Reference data
12.3.7. Style classes and skin parameters
12.4. <rich:tooltip>
12.4.1. Basic usage
12.4.2. Attaching the tool-tip to another component
12.4.3. Appearance
12.4.4. Update mode
12.4.5. <rich:tooltip> client-side events
12.4.6. JavaScript API
12.4.7. Reference data
12.4.8. Style classes and skin parameters
13. Drag and drop
13.1. <rich:dragSource>
13.1.1. Basic usage
13.1.2. Dragging an object
13.1.3. Reference data
13.2. <rich:dropTarget>
13.2.1. Basic usage
13.2.2. Handling dropped data
13.2.3. Reference data
13.2.4. Style classes
13.3. <rich:dragIndicator>
13.3.1. Basic usage
13.3.2. Styling the indicator
13.3.3. Reference data
13.3.4. Style classes
14. Layout and appearance
14.1. <rich:jQuery>
14.1.1. Basic usage
14.1.2. Defining a selector
14.1.3. Event handlers
14.1.4. Timed queries
14.1.5. Named queries
14.1.6. Dynamic rendering
14.1.7. Reference data
15. Functions
15.1. <rich:componentControl>
15.1.1. Basic usage
15.1.2. Passing parameters to API methods
15.1.3. Reference data
15.2. rich:clientId
15.3. rich:component
15.4. rich:element
15.5. rich:findComponent
15.6. rich:isUserInRole