JBoss.orgCommunity Documentation
There have been several changes made to the RichFaces framework for version 4 that may affect migrated projects.
RichFaces 4 has full support for JavaServer Faces (JSF) 2. Due to limited support for JavaServer Pages (JSP) in JSF2, RichFaces no longer fully supports JSP either.
Several component and event attribute names have been changed from those used in previous versions of RichFaces. The names have been changed to be more consistent with attribute names used by JavaServer Faces 2, so as to provide standardized usage. Many of the name changes also provide more consistency and cleanliness within the framework itself. Other attributes have been deprecated in favor of consistent functionality.
process
Changed to execute in 4.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
| |
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:autocomplete>
|
<rich:menuItem>
|
<rich:toggleControl>
|
<rich:calendar>
|
<rich:panelMenuGroup>
|
<rich:togglePanel>
|
<rich:dataFilterSlider>
|
<rich:panelMenuItem>
|
<rich:togglePanelItem>
|
<rich:dataScroller>
|
<rich:progressBar>
|
<rich:tree>
|
<rich:dropSupport>
|
<rich:tab>
|
<rich:treeNode>
|
reRender
Changed to render in 4.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
| |
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:autocomplete>
|
<rich:dragSupport>
|
<rich:progressBar>
|
<rich:ajaxValidator>
|
<rich:dropSupport>
|
<rich:tab>
|
<rich:calendar>
|
<rich:extendedDataTable>
|
<rich:togglePanel>
|
<rich:dataFilterSlider>
|
<rich:menuItem>
|
<rich:tree>
|
<rich:dataScroller>
|
<rich:panelMenuGroup>
|
<rich:treeNode>
|
<rich:dataTable>
|
<rich:panelMenuItem>
|
eventsQueue
Changed to queue in 4.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
| |
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:ajaxValidator>
|
<rich:dropSupport>
|
<rich:toggleControl>
|
<rich:autocomplete>
|
<rich:menuItem>
|
<rich:togglePanel>
|
<rich:calendar>
|
<rich:panelMenuGroup>
|
<rich:togglePanelItem>
|
<rich:dataFilterSlider>
|
<rich:panelMenuItem>
|
<rich:tree>
|
<rich:dataScroller>
|
<rich:progressBar>
| |
<rich:dragSupport>
|
<rich:tab>
|
limitToList
Changed to limitRender in 4.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
| |
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:ajaxValidator>
|
<rich:dropSupport>
|
<rich:toggleControl>
|
<rich:autocomplete>
|
<rich:menuItem>
|
<rich:togglePanel>
|
<rich:calendar>
|
<rich:panelMenuGroup>
|
<rich:togglePanelItem>
|
<rich:dataFilterSlider>
|
<rich:panelMenuItem>
|
<rich:tree>
|
<rich:dataScroller>
|
<rich:progressBar>
|
<rich:treeNode>
|
<rich:dragSupport>
|
<rich:tab>
|
onbeforedomupdate
Changed to onsuccess in 4.
a4j componentsAll components.
rich componentsAll components.
ignoreDupResponses
Deprecated. Functionality moved to queue in 4.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
|
<a4j:queue>
|
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:ajaxValidator>
|
<rich:dropSupport>
|
<rich:toggleControl>
|
<rich:autocomplete>
|
<rich:menuItem>
|
<rich:togglePanel>
|
<rich:calendar>
|
<rich:panelMenuGroup>
|
<rich:togglePanelItem>
|
<rich:dataFilterSlider>
|
<rich:panelMenuItem>
|
<rich:tree>
|
<rich:dataScroller>
|
<rich:progressBar>
|
<rich:treeNode>
|
<rich:dragSupport>
|
<rich:tab>
|
requestDelay
Deprecated. Functionality moved to queue in 4.
a4j components
<a4j:support>
|
<a4j:commandLink>
|
<a4j:jsFunction>
|
<a4j:commandButton>
|
<a4j:form>
|
<a4j:queue>
|
rich components
<rich:ajaxValidator>
|
<rich:dragSupport>
|
<rich:togglePanel>
|
<rich:autocomplete>
|
<rich:dropSupport>
|
<rich:tab>
|
<rich:calendar>
|
<rich:menuItem>
|
<rich:tree>
|
<rich:dataFilterSlider>
|
<rich:panelMenuGroup>
| |
<rich:dataScroller>
|
<rich:panelMenuItem>
|
ajaxSingle
Deprecated. Use execute="@this" in 4 instead.
a4j components
<a4j:support>
|
<a4j:form>
|
<a4j:push>
|
<a4j:commandButton>
|
<a4j:jsFunction>
| |
<a4j:commandLink>
|
<a4j:poll>
|
rich components
<rich:calendar>
|
<rich:panelMenuGroup>
|
<rich:togglePanel>
|
<rich:dataFilterSlider>
|
<rich:panelMenuItem>
|
<rich:togglePanelItem>
|
<rich:dataScroller>
|
<rich:progressBar>
|
<rich:toolTip>
|
<rich:dropSupport>
|
<rich:suggestionBox>
|
<rich:tree>
|
<rich:fileUpload>
|
<rich:tab>
|
<rich:treeNode>
|
<rich:menuItem>
|
<rich:toggleControl>
|
The RichFaces framework has been extensively refined to provide better performance for applications. This includes improvements to bandwidth requirements for generated markup, size and number of required resources for Javascript and Cascading Style Sheets (CSS), and other general performance improvements.
Several considerations have been made to improve the use of bandwidth when generating markup.
XHTML markup has been simplified and streamlined using best practices, such as avoiding tables for layout.
Default attribute values are not rendered.
Javascript use has been simplified with shorter function names and only one proxy call per form.
The three Javascript libraries previously used by the RichFaces framework have been consolidated and standardized into a single library for better performance.
Usage of Cascading Style Sheets (CSS) has been simplified, trimming out duplicate or otherwise unnecessary entries and better utilizing the cascading approach for style values.
Features have been altered or added to existing components and behaviors in the RichFaces 4 framework. Refer to the Developer Guide for full details on how to make use of any new features.
Some of the mechanisms for server-side processing and rendering have been altered.
It is now possible to define zones for processing on the server-side without specifying execute definitions for every component. The execute="@region" property can be used to process regions defined on the server side.
This approach is different to that in JSF 2, which uses default values of execute="@this" and render="@this" if no other value is defined.
The execute property has been extended to include the @region keyword, which facilitates the region rendering changes described in Section 3.4.1.1, “Regions”.
The onbegin attribute has been added to support JSF events with the type begin.
Both the <a4j:commandButton> and <a4j:commandLink> components use the onclick event attribute instead of the onbegin attribute.
The <a4j:log> component has had several features modified.
It is now possible to switch levels on the client side.
The log can now be displayed inline with page markup, in a new browser window, or in the browser console.
An application context parameter can now be defined to log all application pages.
Both the <rich:message> and <rich:messages> components can be automatically updated by any Ajax request, except those requests with limitRender = true. Attributes from previously-passed states are now cleared.
The <a4j:outputPanel> component has had several features modified.
The default value for the layout attribute is now block.
The default value for the ajaxRendered attribute is now false.
If a child component is not to be rendered, a placeholder element will be included to preserve the layout.
Both the <a4j:push> and <a4j:poll> components now raise a client-side event. For <a4j:push>, this is the ondataavailable event, while for <a4j:poll> it is the ontimeevent.
The <a4j:status> component has had several features modified.
The <a4j:status> component now has a representation in the Document Object Model (DOM) tree.
The <a4j:status> component no longer needs to be associated with a <a4j:region>.
The <a4j:status> component can now report request errors. An additional errorText attribute and error facet have been added to show if an error was raised when a request completed.
The event attributes now include onstart, onstop, onerror, and onsuccess.
Multiple statuses can be presented for the same view or form, or a separate status attached to each component.
The <rich:popupPanel> component replaces the old <rich:modalPanel>. It allows the pop-up window to be presented as either a modal or non-modal window.
Several new components and behaviors have been added to RichFaces 4, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the Component Reference.
The <rich:autocomplete> component replaces the old <rich:suggestionBox> component.
The <rich:accordion> component replaces the old <rich:panelBar> component. The <rich:accordionItem> component replaces the old <rich:panelBarItem> component.
The <rich:collapsiblePanel> component replaces the old <rich:simpleTogglePanel> component.
The <rich:dragBehavior> behavior replaces the old <rich:dragSupport> component. The <rich:dropBehavior> behavior replaces the old <rich:dropSupport> component.
The <rich:extendedDataTable> component now includes the functionality of the old <rich:scrollableDataTable> component.
The <rich:list> component now combines the functionality of the old <rich:dataList>, <rich:dataDefinitionList>, and <rich:dataOrderedList> components.
Previously, the bullet styles for the <rich:dataList> component and the numeration styles for the <rich:dataOrderedList> component were specified with the type attribute. The type attribute for the <rich:list> component is now used to specify the type of list, and the bullet and numeration styles are now handled in CSS. Refer to the <rich:list> component section in the RichFaces Component Reference for details.
The <rich:popupPanel> component replaces the old <rich:modalPanel> component.
Several new components and behaviors have been added to RichFaces 4, some of which replace the functionality of deprecated elements. For full details on how to use these new components and behaviors, refer to the Developer Guide.
The <rich:busyBehavior> component is used when heavy processing takes place to provide feedback to the user. It can be attached to a component's events to trigger appropriate messages.
The <rich:togglePanel> component now manages multiple <rich:togglePanelItem> components instead of using facets for the switchable panels. Refer to Section 3.5.9, “<rich:togglePanel> and <rich:togglePanelItem>” and the components' descriptions in the Component Reference for further details.
Some components and behaviors have been deprecated in RichFaces 4. For the most part these items have their functionality replicated by another component or behavior. Refer to Section 3.5, “Consolidated or renamed components” for further details on consolidated functionality.
RichFaces 4 drops support for the <a4j:page> component. The component was previously used for solving incompatibility in the JavaServer Pages (JSP) environment with Apache MyFaces in early Ajax4jsf versions.
The functionality of the old <rich:comboBox> component is now available through the <rich:select> component.
The functionality of the old <rich:dataList>, <rich:dataDefinitionList>, and <rich:dataOrderedList> components is now available through the <rich:list> component.
The functionality of the old <rich:dragSupport> component is now available through the <rich:dragBehavior> behavior. The functionality of the old <rich:dropSupport> component is now available through the <rich:dropBehavior> behavior.
The functionality of the old <rich:modalPanel> component is now available through the <rich:popupPanel> component.
The functionality of the old <rich:panelBar> component is now available through the <rich:accordion> component. The functionality of the old <rich:panelBarItem> component is now available through the <rich:accordionItem> component.
The functionality of the old <rich:scrollableDataTable> component is now available through the <rich:extendedDataTable> component.
The functionality of the old <rich:simpleTogglePanel> component is now available through the <rich:collapsiblePanel> component.