Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces

Standard Syntax:
`<%@ taglib prefix="rich" uri="http://richfaces.org/rich" %>
`
XML Syntax:
`<anyxmlelement xmlns:rich="http://richfaces.org/rich" />
`

No Description

Tag Library Information
Display Name | RichFaces
Version | 3.3.0
Short Name | rich
URI | http://richfaces.org/rich

Tag Summary
actionparam | A combination of the functionality of two JSF tags, <f:actionListener>; and <f:param>. At the render phase, it's decoded by parent component (<h:commandLink>; or like) as usual. <br /> At the process request phase, if the parent component performs an action event, update the value specified in the "assignTo" attribute as its value. <br /> If a converter attribute is specified, use it to encode and decode the value to a string stored in the html parameter. <br />
ajaxListener | This works the same as ActionListener or ValueChangeListener, but for an AJAX container. Add the specified class as a listener for AjaxEvent (sent in case of an AJAX request for this container).
ajaxValidator | The <rich:ajaxValidator> is a component designed to provide ajax validation inside for JSF inputs.
beanValidator | Validate Input by the Bean/Hibernate validator annotations
calendar | The <rich:calendar> component is a UI control used for creating graphical monthly calendar on a page.
changeExpandListener | No Description
column | The <rich:column> component for row rendering for a UIData component.
columnGroup | The <rich:columnGroup> component combines columns in one row to organize complex subparts of a table.
columns | The <rich:columns> is a component that allows to create a dynamic set of columns from your model.
comboBox | The <rich:comboBox> is a component, that provides editable combo box element on a page.
commandButton | Renders an HTML "input" element. <br /> During Decoding: Obtains the Map from the "requestParameterMap" property of the ExternalContext. If the value in the Map for the value of the "clientId" property of the component is not null, create a javax.faces.event.ActionEvent around the component, and pass it to the queueEvent() method of the component. If the request is Ajax-performed, add its target IDs of the reRender property to the rendered areas list of the nesting AjaxContainer. <br /> During Encoding: Builds an AJAX.Submit JavaScript call for the "onclick" event. Renders the clientId of the component as the value of the "name" attribute. Renders the current value of the component as the value of the "value" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Renders child components inside the HTML "input" element.
commandLink | Renders an HTML "a" anchor element that acts like a form submit button when clicked. <br /> During Decoding: Obtains the Map from the "requestParameterMap" property of the ExternalContext. If this Map contains non null value for the "clientId" key, creates a javax.faces.event.ActionEvent around the component and passes it to the queueEvent() method of the component. If the request is Ajax-performed, adds its target IDs from the reRender property to the rendered areas list of the nesting AjaxContainer. <br /> element for decoding as described above with the parameters of the component. (PARAM_NAME and PARAM_VALUE are the names and values, respectively, of any nested UIParameter children.) The name and the value must be URLEncoded. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Render any non-UIParameter children as normal inside of the "a" element. These will appear as the link text.
componentControl | The <rich:componentControl> allows to call JavaScript API functions on components after some defined events.
contextMenu | The <rich:contextMenu> component is used for creating multileveled context menus that are activated after a user defines an event ( "onmouseover" , "onclick" , etc.) on any element on the page.
dataDefinitionList | The <rich:dataDefinitionList> component for definition lists rendering that allows choosing data from a model and obtains built-in support of Ajax updates.
dataFilterSlider | A slider-based action component used for filtering table data.
dataGrid | The <rich:dataGrid> component to render data as a grid that allows choosing data from a model and obtains built-in support of Ajax updates.
dataList | The <rich:dataList> component for unordered lists rendering that allows choosing data from a model and obtains built-in support of Ajax updates.
dataOrderedList | The <rich:dataOrderedList> component for ordered lists rendering that allows choosing data from a model and obtains built-in support of Ajax updates.
dataTable | The <rich:dataTable> component for tables rendering that allows choosing data from a model and obtains built-in support of Ajax updates.
datascroller | The <rich:datascroller> component is designed for providing the functionality of tables scrolling using Ajax requests.
dndParam | A component is used for parameters transmission in Drag and Drop operations. It's also used for dragIndicator elements definition with transmitting some values for rendering in it.
dragIndicator | It's a component appearing under a mouse cursor during Drag'n'Drop operation and containing information on dragged element and elements.
dragListener | No Description
dragSupport | The <rich:dragSupport> component defines a subtree of the component tree as draggable for drag-and-drop operations. Within such a "drag zone", you can click the mouse button on an item and drag it to any component that supports drop operations (a "drop zone"). It encodes all the necessary JavaScript for supporting drag-and-drop operations.
dropDownMenu | The <rich:dropDownMenu> component is used for creating multilevel drop-down menus.
dropListener | No Description
dropSupport | The <rich:dropSupport> component transforms a parent component into a target zone for drag-and-drop operations. When a draggable element is moved and dropped onto the area of the parent component, Ajax request processing for this event is started.
editor | No Description
effect | The <rich:effect> utilizes a set of effects provided by the scriptaculous JavaScript library. It allows to attach effects to JSF components and html tags.
extendedDataTable | The <rich:extendedDataTable> component is used for tables extending standard component <rich:dataTable> .
fileUpload | Renders a file upload control. The following configuration options for ajax4jsf filter may be configured in web.xml: * createTempFiles - if this option is set to true, uploaded files are streamed to a temporary file instead of in memory. * maxRequestSize - the maximum size of a file upload request, in bytes. Here's an example: <filter> <display-name>Ajax4jsf Filter</display-name> <filter-name>ajax4jsf</filter-name> <filter-class>org.ajax4jsf.Filter</filter-class> <init-param> <param-name>createTempFiles</param-name> <param-value>false</param-value> </init-param> <init-param> <param-name>maxRequestSize</param-name> <param-value>20000000</param-value> </init-param> </filter>
form | Ajax-related version of html form. Main difference with original component - all hidden fields, necessary to command links alwais rendered, not depended of rendering links on initial page.
gmap | It presents the google map in JSF applications
graphValidator | The <rich:graphValidator> component allows to register Hibernate Validators for multiple input components.
hotKey | The <rich:hotKey> component allows to register hot keys for the page or particular elements and to define client side processing functions for these keys.
htmlCommandLink | Ajax-related version of html commandLink. Single difference with original component - all hidden fields, necessary to command links alwais rendered, not depended of rendering links on initial page.
include | include content of external view. Navigation cases in included file change only viewId of included page, and don't perform navigation in root view.
inplaceInput | The <rich:inplaceInput> is an input component used for displaying and editing data inputted.
inplaceSelect | The <rich:inplaceSelect> is used for creation select based inputs: it shows the value as text in one state and enables editing the value, providing a list of options in another state.
inputNumberSlider | A component that lets selecting a number from a numeric region. It is a horizontal aligned scroll-like control with its own input field (optional) present. The keyboard input in a field is possible (optional. Also it is possible to see the current value in the tool tip above a dragged handle control.
inputNumberSpinner | Spinner component - A single line input field that lets the user select a number using the controls near the text field. User can change value using Up/Down keyboard keys. The keyboard Input in field if it isn't locked by manualInput attribute is possible. After arrow controls pressed - cursor can be moved in any way without loosing draged state.
insert | The <rich:insert> component is used for highlighting, source code inserting and, optionally, format the file from the application context into the page.
jQuery | The <rich:jQuery> allows to apply styles and behaviour to DOM objects.
jsFunction | No Description
keepAlive | This tag get bean by EL expression '#{'+name+'}' and store bean instance in component tree. After restoring view state, bean is putted to request-scope attributes with name. Since, every view will be use own instance of bean for expressions '#{name....}'
listShuttle | The <rich:listShuttle> component is used for moving chosen items from one list into another with their optional reordering there.
loadBundle | Load a resource bundle localized for the Locale of the current view, and expose it (as a Map) in the request attributes of the current request. In difference of original f:loadBundle tag, stored in components tree and activate on ajax/non ajax responses
loadScript | No Description
loadStyle | No Description
log | Encode javaScript to open popup window with client-side Log information.
mediaOutput | Class for create any link-type elements to user-generated resources : images, sounds, video, active objects, applets etc. Method specified in "CreateContent" attribute will put the data from Data Bean specified in "value" attribute to the OutputStream. Important: Data Bean specified in "value" must implement Serializable.
menuGroup | The <rich:menuGroup> component is used to define an expandable group of items inside a pop-up list or another group.
menuItem | The <rich:menuItem> component is used for the definition of a single item inside a pop-up list.
menuSeparator | A horizontal separator to use in the menu.
message | The <rich:message> component is used for rendering a single message for a specific component.
messages | The <rich:messages> component is similar to <rich:message> component but used for rendering all messages for the components.
modalPanel | The <rich:modalPanel> component implements a modal dialog window. All operations in the main application window are locked out while this window is active. Opening and closing the window is done through client JavaScript code.
nodeSelectListener | No Description
orderingList | The <rich:orderingList> is a component for ordering items in a list. This component provides possibilities to reorder a list and sort it on the client side.
outputPanel | Creates an AJAX-enabled part of the page. For a normal request, render a &lt;span&gt; or &lt;div&gt; HTML element depending on the value of the "layout" attribute, "inline" or "block". (The "id" attribute will be the value of the clientId property.) For an AJAX request, the content of this element is included in the response if the value of the property, "ajaxRendered", is set to true.
page | This component renders a full HTML page structure. It must be the first (and only) child for the view root (JSP <f:view> tag). No HTML code can be outside of this component. It also has support for processing child components in AJAX requests, just like <a4j:region>. For a normal request, it will render the results of a <script> element with a client-side library at the page's <head>. If this component includes a "head" facet, the facet's content will also be rendered at the <head> element. For an AJAX request, only affected components in the full document structure will be rendered. Here's an example of using it in JSP (jspx version): <jsp:root xmlns:.... <f:view> <a4j:page><f:facet name="head"> ... </f:facet> <!-- page content here --> </a4j:page> </f:view></jsp:root>
paint2D | Create an image by paint in a managed bean, same as paint (Graphics g) in SWING components. It can be used as a cacheable or non-cacheable resource. With a cache support, a key is created in URI with a mix of size (width/height), paint method, format and data attributes.
panel | A skinnable panel that is rendered as a bordered rectangle. The header is added using a facet with the attribute, name="header".
panelBar | A component with categories sliding up and down to reveal and hide items under selected categories (as used in Microsoft Outlook).
panelBarItem | A child component of a slide panel component
panelMenu | Defines the menu on the page and the set of the child elements properties in layout.
panelMenuGroup | Defines expandable group of items inside the panel menu or other group.
panelMenuItem | Defines single Item inside popup list.
pickList | The <rich:pickList> component is used for moving selected item(s) from one list into another.
poll | Periodically perform AJAX request to server, to simulate 'poll' data.
portlet | No Description
progressBar | The <rich:progressBar> component is designed for displaying a progress bar which shows the current status of the process.
push | Periodically perform AJAX request to server, to simulate 'push' data.
queue | The <a4j:queue> tag.
recursiveTreeNodesAdaptor | The <rich:recursiveTreeNodesAdaptor> is an extension of a <rich:treeNodesAdaptor> component that provides the possibility to define data models and process nodes recursively.
region | This tag defines a part of the JSF Tree that is to be decoded on the server side during AJAX request processing
repeat | No Description
scrollableDataTable | The <rich:scrollableDataTable> component is used for the table-like component creation. The component just adds the set of additional features described below in comparison with the standard table.
separator | A horizontal line to use as a separator in a layout. The line type can be customized with the lineType parameter.
simpleTogglePanel | Wrapper component with named facets. Every facet will be shown after activation corresponding toggleControl(the other will be hidden).
spacer | A spacer to use in layout. It is rendered as a transparent image. The size is set up with width and height attributes. By default it is displayed as an inline element (i.e. word spacer). By using style='display:block' can be used as a line spacer.
status | Renders area for indicating Ajax request status on the client-side. <br /> During Encoding: Creates two "span" elements with id created as clientId of this component or of target AJAX region (pointed to by the "for" property) with appended ":status.start" and ":status:stop" strings. <br /> "start" span has "display:none" style (hidden). Inside this span, renders the value of the startText/stopText properties or, if they exist, the content of "start" and "stop" facets. <br /> On performing an AJAX request, the client-side script changes the visibility of the "start" span and hides "stop". After all requests for this indicator are completed, restores "stop" and hide "start" start[style,styleClass] and stop[style,styleClass] are rendered for spans as style and class atributes, respectivetly. <br /> During Encoding: Creates two "span" or "div"(depending on 'layout' attribute) elements with id created as clientId of this component or of target AJAX region (pointed to by the "for" property) with appended ":status.start" and ":status:stop" strings. "start" element has "display:none" style (hidden). Inside this element, renders the value of the startText/stopText properties or, if they exist, the content of "start" and "stop" facets. On performing an AJAX request, the client-side script changes the visibility of the "start" element and hides "stop". After all requests for this indicator are completed, restores "stop" and hide "start" <br /> start[style,styleClass] and stop[style,styleClass] are rendered for spans as style and class atributes, respectivetly.
subTable | The <rich:subTable> component is used for inserting subtables into tables with opportunity to choose data from a model and built-in Ajax updates support.
suggestionbox | This element adds "on-keypress" suggestions capabilites to any input text component (like <h:inputText>). It creates a pop-up window for a input field component pointed to by the "for" attribute. For an ordinary request, render a hidden HTML <div> element and the necessary JavaScript code. When input to the target field exceeds the "minChars" property (default is 1), perform an AJAX request with the value current entered. If the AJAX request is detected and the request parameters map contains the client ID of this component, call a method defined by suggestionAction, and use it to return a value as data for render table, same as <h:dataTable>. In this case, the component then works the same as an ordinary dataTable. The rendered table is inserted in the pop-up area and is used for suggestion prompts for input element. If a user clicks on such a table row, its text (or value defined by fetchValue) is inserted as the value of the input field.
support | Adds the AJAX functionality for those UIComponent-based component that have properties for JavaScript events. During Decoding: If a request is Ajax-performed, obtains the Map from the "requestParameterMap" property of the ExternalContext. If this Map contains non null value for the "clientId" key, creates a javax.faces.event.ActionEvent around the component, passes it to the queueEvent() method of the component, and then appends it's reRender components IDs to a list of rendered areas. During Encoding. Doesn't encode as a component. Instead, it adds ValueBinding for a property of the parent component with the name as a value of its "event" property. As a result, when rendered, the parent component builds JavaScript code for submitting an AJAX request on this event. If the component has child UIParameter components, appends it's name/value as additional request parameters. If a parent component is an instance of UIInput and the ajaxType property is "input", submits the value of the input field, also. In this case, you can submit a single input field outside of UIForm.
tab | A tab section within a tab panel
tabPanel | A tab panel displaying tabs for grouping content of a panel.
toggleControl | A link type control for switching betwen togglePanel's facets. The Target Panel is specified with the "for" attribute. It can be located even inside or outside the togglePanel. As the result of switching between facets, the previous facet is hidden and the next is shown.
togglePanel | A wrapper component with named facets. Every facet is shown after activation corresponding toggleControl(the other is hidden).
toolBar | A horizontal bar with items on it. If you want to use it as a standard top tool bar, point to each item with a ch:menu "for" attribute to link the appropriate drop-down menu with the item id on a tool bar. "toolBar" accepts any JSF components as children. They appear from left to right in the definition order. The children are separated from each other basing on the value of the "itemSeparator" attribute. If you want to put the items along the right side for a menu bar, you can use the "toolBarGroup" component as a wrapper and define the "location" attribute there. The items inside the group can have their own separator. See the "toolBarGroup" component description for details.
toolBarGroup | A group of items inside a tool bar. The group item is separated basing on the "itemSeparator" attribute. Location of a group on a tool bar is set up with the "location" attribute.
toolTip | Defines tooltip for parent component.
tree | The <rich:tree> component is designed for hierarchical data presentation and is applied for building a tree structure with a drag-and-drop capability.
treeNode | The <rich:treeNode> component is designed for creating sets of tree elements within a <rich:tree> component.
treeNodesAdaptor | The <rich:treeNodesAdaptor> provides the possibility to define data models and create representations for them.
virtualEarth | The <rich:virtualEarth> component presents the Microsoft Virtual Earth map in the JSF applications.

Function Summary
`java.lang.String` | `clientId( java.lang.String)` | No Description
`java.lang.String` | `component( java.lang.String)` | No Description
`java.lang.String` | `element( java.lang.String)` | No Description
`javax.faces.component.UIComponent` | `findComponent( java.lang.String)` | No Description

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-3 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.