Chapter 16. Functions

16.1. rich:clientId
16.2. rich:component
16.3. rich:element
16.4. rich:jQuery
16.5. rich:findComponent
16.6. rich:isUserInRole

Read this chapter for details on special functions for use with particular components. Using JavaServer Faces Expression Language ( JSF EL), these functions can be accessed through the data attribute of components. Refer to Section 2.4.4.1, “data” for details on the data attribute.

16.1. `rich:clientId`

The rich:clientId('id') function returns the client identifier related to the passed component identifier ('id'). If the specified component identifier is not found, null is returned instead.

16.2. `rich:component`

The rich:component('id') function is equivalent to the RichFaces.component('clientId') code. It returns the client object instance based on the passed server-side component identifier ( 'id'). If the specified component identifier is not found, null is returned instead. The function can be used to get an object from a component to call a JavaScript API function without using the <rich:componentControl> component.

16.3. `rich:element`

The rich:element('id') function is a shortcut for the equivalent document.getElementById(#{rich:clientId('id')}) code. It returns the element from the client, based on the passed server-side component identifier. If the specified component identifier is not found, null is returned instead.

16.4. `rich:jQuery`

The rich:jQuery('id') function is a shortcut for the equivalent jQuery('##{rich:clientId('id')}) code. It returns the jQuery object for the element located by the passed server-side component identifier. If the specified component identifier is not found, null is returned instead.

16.5. `rich:findComponent`

The rich:findComponent('id') function returns the a UIComponent instance of the passed component identifier. If the specified component identifier is not found, null is returned instead.

Example 16.1. rich:findComponent example


<h:inputText id="myInput">

   <rich:support event="keyup" render="outtext"/>

</h:inputText>

<h:outputText id="outtext" value="#{rich:findComponent('myInput').value}" />

16.6. `rich:isUserInRole`

The rich:isUserInRole(Object) function checks whether the logged-in user belongs to a certain user role, such as being an administrator. User roles are defined in the web.xml settings file.

Example 16.2. rich:isUserInRole example

The rich:isUserInRole(Object) function can be used in conjunction with the rendered attribute of a component to only display certain controls to authorized users.


<rich:editor value="#{bean.text}" rendered="#{rich:isUserInRole('admin')}"/>