1.2
2.0
rich
http://richfaces.ajax4jsf.org/rich
dndParam
org.richfaces.taglib.DndParamTag
JSP
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.
value
false
value
type
false
type
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
name
true
false
id
false
Every component may have a unique id that is automatically created if
omitted
dragIndicator
org.richfaces.taglib.DragIndicatorTag
JSP
It's a component appearing under a mouse cursor during Drag'n'Drop operation and containing information on dragged element and elements.
acceptClass
false
Corresponds to the HTML class attribute and added to an indicator when a drop is accepted
styleClass
false
Corresponds to the HTML class attribute
rejectClass
false
Corresponds to the HTML class attribute and added to an indicator when a drop is rejected
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
dragSupport
org.richfaces.taglib.DragSupportTag
JSP
actionListener
false
actionListener
dragValue
false
Data to be sent to the drop zone after a drop event.
ondragend
false
A JavaScript event handler called after a drag operation.
oncomplete
false
oncomplete
rendered
false
If "false", this component is rendered.
reRender
false
reRender
id
false
Every component may have a unique id that is automatically created if
omitted
disableDefault
false
disableDefault
bypassUpdates
false
bypassUpdates
limitToList
false
limitToList
ajaxSingle
false
ajaxSingle
onsubmit
false
onsubmit
dragIndicator
false
Id of the dragIndicator component used as drag operation cursor.
parentProperties
false
parentProperties
value
false
value
action
false
action
dragListener
false
dragListener
timeout
false
timeout
dragType
false
Key of a drag object. It's used to define a necessity of processing the current dragged element on the drop zone side
status
false
status
requestDelay
false
requestDelay
eventsQueue
false
eventsQueue
immediate
false
immediate
data
false
data
event
false
event
ondragstart
false
A JavaScript event handler called before drag object.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ignoreDupResponses
false
ignoreDupResponses
dropSupport
org.richfaces.taglib.DropSupportTag
JSP
actionListener
false
actionListener
ondragenter
false
A JavaScript event handler called on enter draggable object to zone.
oncomplete
false
oncomplete
rendered
false
If "false", this component is rendered.
reRender
false
reRender
id
false
Every component may have a unique id that is automatically created if
omitted
disableDefault
false
disableDefault
bypassUpdates
false
bypassUpdates
ondropend
false
limitToList
false
limitToList
ajaxSingle
false
ajaxSingle
onsubmit
false
onsubmit
ondrop
false
A JavaScript event handler called after a drag object is dropped to zone.
parentProperties
false
parentProperties
value
false
value
action
false
action
timeout
false
timeout
acceptedTypes
false
List of drag types to be processd by the current drop zone.
dropValue
false
Data to be processed after a drop event.
dropListener
false
dropListener
status
false
status
requestDelay
false
requestDelay
eventsQueue
false
eventsQueue
ondragexit
false
A JavaScript event handler called after a drag object leaves zone.
immediate
false
immediate
data
false
data
event
false
event
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ignoreDupResponses
false
ignoreDupResponses
typeMapping
false
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name))
panel
org.richfaces.taglib.PanelTag
JSP
A skinnable panel that is rendered as a bordered rectangle. The header is
added using a facet with the attribute, name="header".
onkeyup
false
HTML: a script expression; a key is released
onclick
false
HTML: a script expression; a pointer button is clicked
bodyClass
false
A class that defines a style for a panel content
headerClass
false
A class that defines a style for a panel header
rendered
false
If "false", this component is rendered.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
id
false
Every component may have a unique id that is automatically created if
omitted
onmousedown
false
HTML: script expression; a pointer button is pressed down
styleClass
false
Corresponds to the HTML class attribute
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
onmouseover
false
HTML: a script expression; a pointer is moved onto
panelBar
org.richfaces.taglib.PanelBarTag
JSP
A component with categories sliding up and down to reveal and hide items under selected
categories (as used in Microsoft Outlook).
headerStyle
false
The component header style
width
false
The width of the slide panel. Might be defined as pixels or as percentage.
The default width is 100%
contentStyle
false
The component content style
rendered
false
If "false", this component is rendered.
headerClass
false
The component header style class
id
false
Every component may have a unique id that is automatically created if
omitted
headerClassActive
false
The component header style class active
contentClass
false
The component content style class
styleClass
false
The component style class
height
false
The height of the slide panel. Might be defined as pixels or as percentage.
The default height is 100%
style
false
The component style
headerStyleActive
false
The component header style active
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
panelBarItem
org.richfaces.taglib.PanelBarItemTag
JSP
A child component of a slide panel component
contentClass
false
The component content style class
headerStyle
false
The component header style
headerClassActive
false
The component header style class active
contentStyle
false
The component content style
label
false
Label text appears on a panel item header
headerStyleActive
false
The component header style active
headerClass
false
The component header style class
rendered
false
If "false", this component is rendered.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
dataFilterSlider
org.richfaces.taglib.DataFilterSliderTag
JSP
A slider-based action component used for filtering table data.
width
false
Width of the slider control
filterBy
false
A getter of an object member required to compare a slider value to. This is a
value that is used in results filtering.
startRange
false
A slider begin point
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
endRange
false
A slider end point.
storeResults
false
Specifies if the component will store a UIData object (your table rows) in session.
styleClass
false
The styleClass for the container div surrounding the component.
style
false
CSS style(s) is/are to be applied when this component is rendered
onSlide
false
If the slider value changes must submit a form, onSlide or OnChange can be true.
handleValue
false
Current handle value
sliderListener
false
sliderListener
trackStyleClass
false
The trackStyleClass for a background div
handleStyleClass
false
The handleStyleClass for a handle.
for
false
The component using UIData (datatable id)
active
false
active
increment
false
Amount to which a handle on each slide/move should be incremented
rangeStyleClass
false
The rangeStyleClass for the background div showing a full range
fieldStyleClass
false
The styleClass for input that displays the value : 'manualInput' must
be true
trailer
false
It shows or hides a trailer following a handle
manualInput
false
False value for this attribute makes text field "read-only" and "hidden".
Hence, the value can be changed only from a handle.
forValRef
false
This is a string which is used in a value attribute of the datatable. It is used for resetting
the datatable back to the original list provided by a backing bean.
onChange
false
If the slider value changes must submit a form, onSlide or OnChange can be true.
trailerStyleClass
false
The trailerStyleClass for a div following a handle.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
gmap
org.richfaces.taglib.GmapTag
JSP
It presents the google map in JSF applications
lat
false
Initial latitude coordinate in degrees, as a number between -90 and +90
zoom
false
Initial zoom level as a number between 1 and 18. The default value is 17
gmapKey
false
Google Map key. A single Maps API key is valid for a single "directory" on your web server
showGLargeMapControl
false
Shows the GLarge control. The default value is "true"
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
showGScaleControl
false
It shows the scale control. The default value is "true"
styleClass
false
Corresponds to the HTML class attribute
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
enableDoubleClickZoom
false
Enables zooming in by a double click. The default value is "false"
style
false
CSS style(s) is/are to be applied when this component is rendered
mapType
false
Initial map type. The possible values are G_NORMAL_MAP, G_SATELLITE_MAP,
G_HYBRID_MAP. The default value is G_SATELLITE_MAP
onmouseover
false
HTML: a script expression; a pointer is moved onto
enableInfoWindow
false
Enables Info Window. The default value is "true"
onkeyup
false
HTML: a script expression; a key is released
enableContinuousZoom
false
Enables continuous smooth zooming for selected browsers. The default value is "false"
warningMessage
false
The warning message that appears if a browser is not compatible with Google Map.
The default value is "Your browser does not support Google Maps"
onclick
false
HTML: a script expression; a pointer button is clicked
gmapVar
false
The javascript variable that is used to access the Google Map API. If you have
more than one Google Map components on the same page, use individual
key for each of them. The default variable name is "map" (without quotes)
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
enableDragging
false
Enables a map dragging with the mouse. The default value is "true"
showGMapTypeControl
false
Shows the Type switch control. The default value is "true"
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
lng
false
Initial longitude coordinate in degrees, as a number between -180 and +180
onmousemove
false
HTML: a script expression; a pointer is moved within
separator
org.richfaces.taglib.SeparatorTag
JSP
A horizontal line to use as a separator in a layout.
The line type can be customized with the lineType parameter.
onkeyup
false
HTML: a script expression; a key is released
width
false
The separator width that can be defined in pixels or in percents. The default value is 100%
title
false
HTML: An advisory title for this element. Often displayed as a tooltip
onclick
false
HTML: a script expression; a pointer button is clicked
rendered
false
If "false", this component is rendered.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
id
false
Every component may have a unique id that is automatically created if
omitted
styleClass
false
Corresponds to the HTML class attribute
height
false
The separator height. Default value is 6 pixels
lineType
false
A line type. The possible values are
bevieled (default), dotted, dashed, double and solid
onkeypress
false
HTML: a script expression; a key is pressed and released
align
false
left|center|right [CI]
This attribute specifies a position of the separator according to the document. Permitted values:
* left: The separator is to the left of the document.
* center: The separator is to the center of the document.
* right: The separator is to the right of the document
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
onmouseover
false
HTML: a script expression; a pointer is moved onto
spacer
org.richfaces.taglib.SpacerTag
JSP
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.
onkeyup
false
HTML: a script expression; a key is released
width
false
The width of the spacer defined in pixels. The default value is 1 pixel
title
false
HTML: An advisory title for this element. Often used by the user agent as a tooltip
onclick
false
HTML: a script expression; a pointer button is clicked
rendered
false
If "false", this component is rendered.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
id
false
Every component may have a unique id that is automatically created if
omitted
onmousedown
false
HTML: script expression; a pointer button is pressed down
styleClass
false
Corresponds to the HTML class attribute
height
false
The height of the spacer defined in pixels. The default value is 1 pixel
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
onmouseover
false
HTML: a script expression; a pointer is moved onto
paint2D
org.richfaces.taglib.Paint2DTag
JSP
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.
value
false
The initial value to set when rendered for the first time
width
false
Width in pixels of image (for paint canvas and HTML attribute)
converter
false
Id of Converter to be used or reference to a Converter
lang
false
Code describing the language used in the generated markup for this component
title
false
Advisory title information about markup elements generated for this component
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
styleClass
false
Corresponds to the HTML class attribute
height
false
Height in pixels of image (for paint canvas and HTML attribute)
data
false
Value calculated at render time and stored in Image URI (as part of cache Key),
at paint time passed to a paint method. It can be used for updating cache at change of image generating
conditions, and for creating paint beans as "Lightweight" pattern components (request scope).
IMPORTANT: Since serialized data stored in URI, avoid using big objects.
align
false
bottom|middle|top|left|right
Deprecated. This attribute specifies the position of an IMG, OBJECT, or APPLET with respect to its context.
The following values for align concern the object's position with respect to surrounding text:
* bottom: means that the bottom of the object should be vertically aligned with the current baseline. This is the default value.
* middle: means that the center of the object should be vertically aligned with the current baseline.
* top: means that the top of the object should be vertically aligned with the top of the current text line
hspace
false
Deprecated. This attribute specifies the amount of white space to be inserted to the left and right of an IMG, APPLET, or OBJECT. The default value is not specified, but is generally a small, non-zero length
vspace
false
Deprecated. This attribute specifies the amount of white space to be inserted above and below an IMG, APPLET, or OBJECT. The default value is not specified, but is generally a small, non-zero length
style
false
CSS style(s) is/are to be applied when this component is rendered
bgcolor
false
Background color of painted image. Default value is 'transparent' which means no background fill.
Hex colors can be used, as well as common color names.
Invalid values are treated as transparent.
Note, that JPEG format doesn't support transparency, and transparent background is painted black.
Also note, that several browsers (e.g. IE6) do not support PNG transparency.
cacheable
false
Supported (or not) client/server caching for generated images.
Caching on client supported by properly sending and processing of HTTP headers (Last-Modified, Expires, If-Modified-Since, etc.)
Server-side caching is supported by application-scope object cache.
For build of cache key use "value" attribute, serialized to URI.
border
false
Deprecated. This attribute specifies the width of an IMG or OBJECT border, in pixels. The default value for this attribute depends on the user agent
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
paint
false
The method calls expression to paint Image on prepared Buffered image. It must have two parameters with a type of java.awt.Graphics2D (graphics to paint) and Object (restored from URI "data" property).
For painting used 32-bit RGBA color model (for 8-bit images used Diffusion filtration before sending).
format
false
format Name of format for sending a generated image. It currently supports "jpeg" (24 bit, default), "gif" (8 bit with transparency), "png" (32 bit with transparency)
togglePanel
org.richfaces.taglib.TogglePanelTag
JSP
A wrapper component with named facets. Every facet is shown after activation corresponding toggleControl(the other is hidden).
value
false
The initial value to set when rendered for the first time.
It contains information about an active facet
stateOrder
false
Names of the facets in the switching order. If
ToggleControl doesn't contain information about a next facet to
be shown it is switched corresponding to this
attribute
converter
false
converter
required
false
required
localValueSet
false
localValueSet
valid
false
valid
valueChangeListener
false
valueChangeListener
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
initialState
false
It contains a name of the first active facet
validator
false
validator
switchType
false
Facets switch algorithm: "client", "server"(default), "ajax".
immediate
false
immediate
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
toggleControl
org.richfaces.taglib.ToggleControlTag
JSP
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.
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
title
false
Advisory title information about markup elements
generated for this component
oncomplete
false
JavaScript code for call after request completed on
client side
rendered
false
If "false", this component is rendered.
dir
false
Direction indication for text that does not inherit
directionality. Valid values are "LTR" (left-to-right)
and "RTL" (right-to-left)
id
false
Every component may have a unique id that is automatically created if
omitted
bypassUpdates
false
If "true", after process validations phase skip updates
of model beans an force render response. Can be used for
validate components input
styleClass
false
Space-separated list of CSS style class(es) to be
applied when this element is rendered. This value must
be passed through as the "class" attribute on generated
markup
accesskey
false
Access key that, when pressed, transfers focus to this
element
switchToState
false
Contains one of the facets names where target togglePanel is switched to
limitToList
false
If "true", updates on client side ONLY elements from this
'reRender' property. if "false" (default) updates all
rendered by ajax region components
onkeypress
false
JavaScript code executed when a key is pressed and
released over this element
ajaxSingle
false
if true, submit ONLY one field/link, instead of all
form controls
ondblclick
false
Javascript code executed when a pointer button is double
clicked over this element
style
false
CSS style(s) to be applied when this component is
rendered
panelId
false
onblur
false
Javascript code executed when this element loses focus
onmouseover
false
JavaScript code executed when a pointer button is moved
onto this element
for
false
String containing comma separated ids (in the format of a UIComponent.findComponent()
call) of the target components.
value
false
Initial value to set when rendered for the first time
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
onkeyup
false
JavaScript code executed when a key is released over
this element
tabindex
false
Position of this element in the tabbing order for the
current document. This value must be an integer between
0 and 32767
timeout
false
response waiting time on a particular request. If a response is not received during this time, the request is aborted
lang
false
Code describing the language used in the generated
markup for this component
onclick
false
Javascript code executed when a pointer button is
clicked over this element
status
false
ID (in format of call UIComopnent.findComponent()) of
Request status component
onmouseout
false
JavaScript code executed when a pointer button is moved
away from this element
onkeydown
false
JavaScript code executed when a key is pressed down over
this element
onmousedown
false
JavaScript code executed when a pointer button is
pressed down over this element
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript
event. In conjunction with events queue can reduce
number of requests on keyboard or mouse move events
eventsQueue
false
Name of requests queue to avoid send next request before
complete other from same event. Can be used to reduce
number of requests of frequently events (key press,
mouse move, etc.)
immediate
false
True means, that the default ActionListener should be executed
immediately (i.e. during Apply Request Values phase of the
request processing lifecycle), rather than waiting until the
Invoke Application phase
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
onfocus
false
JavaScript code executed when this element receives
focus
onmouseup
false
JavaScript code executed when a pointer button is
released over this element
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ignoreDupResponses
false
If true, unfinished request will be aborted on new event
onmousemove
false
JavaScript code executed when a pointer button is moved
within this element
tabPanel
org.richfaces.taglib.TabPanelTag
JSP
A tab panel displaying tabs for grouping content of a panel.
width
false
Width of a tab panel defined in pixels or in percents.
The default value is 100%
contentStyle
false
A CSS style is for the content of a tab panel
title
false
Advisory title information about markup elements generated for this component
activeTabClass
false
A CSS class to be applied to an active tab
tabClass
false
A CSS class to be applied to all tabs
rendered
false
If "false", this component is rendered.
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
styleClass
false
Corresponds to the HTML class attribute
switchType
false
Tab switch algorithm: "client", "server"(default), "ajax"
height
false
Height of a tab panel defined in pixels or in percents
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
headerAlignment
false
Sets tab headers alignment. It can be "left", "center" or "right".
"left" is used by default
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseover
false
HTML: a script expression; a pointer is moved onto
value
false
The initial value to set when rendered for the first time
onkeyup
false
HTML: a script expression; a key is released
disabledTabClass
false
A CSS class to be applied to a disabled tab
converter
false
Id of Converter to be used or reference to a Converter
required
false
If "true", this component is checked for non-empty input
lang
false
Code describing the language used in the generated markup for this component
onclick
false
HTML: a script expression; a pointer button is clicked
inactiveTabClass
false
CSS class to be applied to an inactive (but not disabled) tab
valueChangeListener
false
Listener for value changes
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
selectedTab
false
selectedTab
contentClass
false
A CSS class for content of a tab panel
validator
false
MethodBinding pointing at a method that is called during
Process Validations phase of the request processing lifecycle,
to validate the current value of this component
immediate
false
A flag indicating that this component value must be converted
and validated immediately (that is, during Apply Request Values
phase), rather than waiting until a Process Validations phase
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
headerSpacing
false
Sets tab headers spacing. It should be a valid size unit expression
tab
org.richfaces.taglib.TabTag
JSP
A tab section within a tab panel
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
title
false
title
oncomplete
false
JavaScript code for call after request completed on client side
rendered
false
If "false", this component is rendered.
reRender
false
Id['s] (in format of call UIComopnent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
id
false
Every component may have a unique id that is automatically created if
omitted
bypassUpdates
false
If true, after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
styleClass
false
Corresponds to the HTML class attribute
switchType
false
Tab switch algorithm: "client", "server", "ajax", "page"
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
onkeypress
false
HTML: a script expression; a key is pressed and released
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
name
false
name
onmouseover
false
HTML: a script expression; a pointer is moved onto
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
onkeyup
false
HTML: a script expression; a key is released
timeout
false
response waiting time on a particular request. If a response is not received during this time, the request is aborted
disabled
false
Disables a tab in a tab panel
onclick
false
HTML: a script expression; a pointer button is clicked
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
eventsQueue
false
Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.).
labelWidth
false
Length for the actual "tab" in a tab section defined in pixels. If it is not defined, the
length is calculated basing on a tab label text length
label
false
Text for the actual "tab" in a tab section.
immediate
false
True means, that the default ActionListener should be executed
immediately (i.e. during Apply Request Values phase of the
request processing lifecycle), rather than waiting until the
Invoke Application phase
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
ignoreDupResponses
false
If true, unfinished request will be aborted on new event
onmousemove
false
HTML: a script expression; a pointer is moved within
simpleTogglePanel
org.richfaces.taglib.SimpleTogglePanelTag
JSP
Wrapper component with named facets. Every facet will be shown after activation
corresponding toggleControl(the other will be hidden).
actionListener
false
MethodBinding pointing at method accepting an ActionEvent with return type void
width
false
Width of a simple toggle panel might be defined as pixels or in percents.
By default width is not defined
oncomplete
false
JavaScript code for call after request completed on client side
bodyClass
false
A class that defines a style for a panel header
rendered
false
If "false", this component is rendered.
reRender
false
Id['s] (in format of call UIComopnent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
id
false
Every component may have a unique id that is automatically created if
omitted
styleClass
false
Corresponds to the HTML class attribute
bypassUpdates
false
If true, after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
switchType
false
Facets switch algorithm: "client", "server"(default), "ajax".
height
false
Height of a simple toggle panel content area might be defined as pixels or in percents.
By default height is not defined
onkeypress
false
HTML: a script expression; a key is pressed and released
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
ajaxSingle
false
if true , submits ONLY one field/link, instead of all form controls.
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseover
false
HTML: a script expression; a pointer is moved onto
onkeyup
false
HTML: a script expression; a key is released
action
false
MethodBinding pointing at the application action to be invoked,
if this UIComponent is activated by the user, during the Apply
Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property
value
false
The current value for this component
timeout
false
response waiting time on a particular request. If a response is not received during this time, the request is aborted
onclick
false
HTML: a script expression; a pointer button is clicked
headerClass
false
Class that defines the style for panel header
status
false
ID (in format of call UIComopnent.findComponent()) of Request status component.
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
requestDelay
false
Delay (in ms.) for send ajax request on JavaScript event. In conjunction with events queue can reduce number of requests on keyboard or mouse move events.
opened
false
A false value for this attribute makes a panel closed as default
eventsQueue
false
Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.).
label
false
Marker to be rendered on a panel header
immediate
false
True means, that the default ActionListener should be executed
immediately (i.e. during Apply Request Values phase of the
request processing lifecycle), rather than waiting until the
Invoke Application phase
data
false
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via this.data
onmouseup
false
HTML: script expression; a pointer button is released
ignoreDupResponses
false
If true, unfinished request will be aborted on new event
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
toolBar
org.richfaces.taglib.ToolBarTag
JSP
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.
contentClass
false
A CSS style is to be applied to each element of tool bar content.
Use this style, for example, to setup parameters of the font.
styleClass
false
Corresponds to the HTML class attribute
width
false
A width of a bar that can be defined in pixels or as percentage. The default value is 100%.
height
false
A height of a bar in pixels. If a height is not defined,
a bar height depends of the "headerFontSize" skin parameter.
contentStyle
false
A CSS style is to be applied to each element of tool bar content.
style
false
CSS style(s) is/are to be applied when this component is rendered
rendered
false
If "false", this component is rendered.
separatorClass
false
A CSS class to be applied to menu bar group separators.
Use this property, for example, to setup parameters of a font.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
id
false
Every component may have a unique id that is automatically created if
omitted
itemSeparator
false
A separator between items on a bar. Possible values
are none, line, square, disc and grid.
toolBarGroup
org.richfaces.taglib.ToolBarGroupTag
JSP
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.
styleClass
false
Corresponds to the HTML class attribute
style
false
CSS style(s) is/are to be applied when this component is rendered
rendered
false
If "false", this component is rendered.
separatorClass
false
"A CSS class to be applied to menu bar group separators."
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
location
false
"A location of a group on a menu bar. Possible values are "left" and "right"."
id
false
Every component may have a unique id that is automatically created if
omitted
itemSeparator
false
"A separator for the items in a group. Possible
values are "none", "line", "square", "disc" and "grid"."
inputNumberSlider
org.richfaces.taglib.InputNumberSliderTag
JSP
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.
width
false
The width of a slider control.
id
false
Every component may have a unique id that is automatically created if
omitted
onchange
false
HTML: script expression; the element value was changed
showToolTip
false
If the current value will be shown in the tooltip when a handle control in a
"dragged" state.Default=true.
inputStyle
false
Style attribute for text field.
style
false
Styles for main div element of the slider control.
onmouseover
false
HTML: a script expression; a pointer is moved onto
onkeyup
false
HTML: a script expression; a key is released
tabindex
false
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
maxlength
false
When the type attribute has the value "text" or "password", this attribute specifies the maximum number of characters the user may enter. This number may exceed the specified size, in which case the user agent should offer a scrolling mechanism. The default value for this attribute is an unlimited number
converter
false
Id of Converter to be used or reference to a Converter
disabled
false
When set for a form control, this boolean attribute disables the control for user input.
valid
false
valid
onmouseout
false
HTML: a script expression; a pointer is moved away
validator
false
MethodBinding pointing at a method that is called during
Process Validations phase of the request processing lifecycle,
to validate the current value of this component
showInput
false
False value for this attribute makes text a field invisible.
onselect
false
HTML: script expression; The onselect event occurs when a user selects some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements
handleStyle
false
A style for control handle element.
barClass
false
A name of CSS class
onmouseup
false
HTML: script expression; a pointer button is released
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
enableManualInput
false
False value for this attribute makes a text field "read-only", so the value can be
changed only from a handle.
onerror
false
This error is called when a non-number value or a number value that is out of the range is input.
handleClass
false
A name of CSS class
inputClass
false
Style Class attribute for a text field.
rendered
false
If "false", this component is rendered.
styleClass
false
Name of a CSS class
accesskey
false
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
onkeypress
false
HTML: a script expression; a key is pressed and released
showBoundaryValues
false
If the min/max values are shown on the right/left borders of a control.
Default=true;
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
tipClass
false
A name of CSS class
onblur
false
HTML: script expression; the element lost the focus
value
false
The initial value to set when rendered for the first time
inputSize
false
Similar to the "Size" attribute of h:inputText.
maxValue
false
Attribute to set an "end" value
required
false
If "true", this component is checked for non-empty input
tipStyle
false
A style for the tool tip element.
onclick
false
HTML: a script expression; a pointer button is clicked
valueChangeListener
false
Listener for value changes
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
minValue
false
Attribute to set a "start" value
immediate
false
A flag indicating that this component value must be converted
and validated immediately (that is, during Apply Request Values
phase), rather than waiting until a Process Validations phase
onfocus
false
HTML: script expression; the element got the focus
step
false
Parameter that determines a step betwen the nearest values while using a handle
barStyle
false
Style for a slider control line.
inputNumberSpinner
org.richfaces.taglib.InputNumberSpinnerTag
JSP
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.
onerror
false
Error event
inputClass
false
Class attribute for text field.
rendered
false
If "false", this component is rendered.
onchange
false
HTML: script expression; the element value was changed
id
false
Every component may have a unique id that is automatically created if
omitted
styleClass
false
Corresponds to the HTML class attribute
inputStyle
false
Style attribute for text field.
accesskey
false
This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
onupclick
false
Up click event
onkeypress
false
HTML: a script expression; a key is pressed and released
ondblclick
false
HTML: a script expression; a pointer button is double-clicked
style
false
CSS style(s) is/are to be applied when this component is rendered
onmouseover
false
HTML: a script expression; a pointer is moved onto
onblur
false
HTML: script expression; the element lost the focus
onkeyup
false
HTML: a script expression; a key is released
value
false
The initial value to set when rendered for the first time
inputSize
false
Attribute specifies the intial length of input in characters. Default value is 10
cycled
false
If "true" after the current value reaches the border value it is reversed to another border value
after next increasing/decreasing. In other case possibilities of next increasing (or decreasing) will be locked
tabindex
false
This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
converter
false
Id of Converter to be used or reference to a Converter
required
false
If "true", this component is checked for non-empty input
maxValue
false
Maximum value.
disabled
false
When set for a form control, this boolean attribute disables the control for user input.
onclick
false
HTML: a script expression; a pointer button is clicked
ondownclick
false
Down click event
valueChangeListener
false
Listener for value changes
onmouseout
false
HTML: a script expression; a pointer is moved away
onkeydown
false
HTML: a script expression; a key is pressed down
onmousedown
false
HTML: script expression; a pointer button is pressed down
validator
false
MethodBinding pointing at a method that is called during
Process Validations phase of the request processing lifecycle,
to validate the current value of this component
minValue
false
Minimum value.
immediate
false
A flag indicating that this component value must be converted
and validated immediately (that is, during Apply Request Values
phase), rather than waiting until a Process Validations phase
onselect
false
HTML: script expression; The onselect event occurs when a user selects some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements
onfocus
false
HTML: script expression; the element got the focus
onmouseup
false
HTML: script expression; a pointer button is released
step
false
Parameter that determines the step betwen nearest values while using handler
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
onmousemove
false
HTML: a script expression; a pointer is moved within
enableManualInput
false
if "false" user's input to the text field using keyboard will be locked
tree
org.richfaces.taglib.TreeTag
JSP
dragValue
false
Data to be sent to the drop zone after a drop event.
ajaxSubmitSelection
false
If true, an Ajax request to be submit when selecting node
id
false
Every component may have a unique id that is automatically created if
omitted
onexpand
false
An action to be fired when expanding a node
switchType
false
Tree switch algorithm: "client", "server", "ajax"
preserveDataInRequest
false
If true, data is preserved in a request
ondropend
false
A Javascript handler for event fired on a drop even the drop for a given type is not available
treeDataLocator
false
style
false
CSS style(s) is/are to be applied when this component is rendered
oncollapse
false
An action to be fired when collapsing a node
var
false
var
showConnectingLines
false
If true, connecting lines are show
dragListener
false
dragListener
nodeSelectListener
false
nodeSelectListener
dropValue
false
Data to be processed after a drop event.
dropListener
false
dropListener
iconLeaf
false
iconLeaf
ondragexit
false
A JavaScript event handler called after a drag object leaves zone.
ondragstart
false
A JavaScript event handler called before drag object.
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
nodeFace
false
Node face facet name
ondragend
false
A JavaScript event handler called after a drag operation.
ondragenter
false
A JavaScript event handler called on enter draggable object to zone.
iconExpanded
false
The icon for expanded node
componentState
false
componentState
rendered
false
If "false", this component is rendered.
reRender
false
Id[s] (in format of call UIComopnent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Ids, or EL Expression with array or Collection
styleClass
false
Corresponds to the HTML class attribute
iconCollapsed
false
The icon for collapsed node
selectedClass
false
Corresponds to the HTML class attribute. Applied to selected node
icon
false
The icon for node
dragIndicator
false
dragIndicator
ondrop
false
It's an event that is called when something is dropped on a drop zone
changeExpandListener
false
changeExpandListener
preserveModel
false
It can be "state", "request", "none". The default is "request"
value
false
value
acceptedTypes
false
List of drag types to be processd by the current drop zone.
highlightedClass
false
Corresponds to the HTML class attribute. Applied to highlighted node
dragType
false
Key of a drag object. It's used to define a necessity of processing the current dragged element on the drop zone side
onselected
false
An action to be fired when selecting a node
immediate
false
A flag indicating that this component value must be
converted and validated immediately (during an
Apply Request Values phase), rather than waiting until a
Process Validations phase
typeMapping
false
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name))
treeNode
org.richfaces.taglib.TreeNodeTag
JSP
dragValue
false
Data to be sent to the drop zone after a drop event.
ondragend
false
A JavaScript event handler called after a drag operation.
ajaxSubmitSelection
false
An algorithm of AJAX request submission. "inherit", "true", "false" values are possible
ondragenter
false
A JavaScript event handler called on enter draggable object to zone.
iconExpanded
false
The icon for expanded node
rendered
false
rendered
reRender
false
Id[s] (in format of call UIComopnent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Ids, or EL Expression with array or Collection
id
false
id
iconCollapsed
false
The icon for collapsed node
ondropend
false
A Javascript handler for event fired on a drop even the drop for a given type is not available
icon
false
The icon for node
selectedClass
false
Corresponds to the HTML class attribute. Applied to selected node
ondrop
false
It's an event that is called when something is dropped on a drop zone
dragIndicator
false
Id of the dragIndicator component used as drag operation cursor.
changeExpandListener
false
changeExpandListener
dragListener
false
dragListener
nodeSelectListener
false
nodeSelectListener
acceptedTypes
false
List of drag types to be processd by the current drop zone.
type
true
false
A node type.
dropValue
false
Data to be processed after a drop event.
dropListener
false
dropListener
dragType
false
Key of a drag object. It's used to define a necessity of processing the current dragged element on the drop zone side
highlightedClass
false
Corresponds to the HTML class attribute. Applied to highlighted node
iconLeaf
false
iconLeaf
ondragexit
false
A JavaScript event handler called after a drag object leaves zone.
nodeClass
false
Name of node CSS class
ondragstart
false
A JavaScript event handler called before drag object.
oncontextmenu
false
JavaScript handler to be called on right click.
Returning false prevents default browser context menu from being displayed
binding
false
binding
typeMapping
false
Map between a draggable type and an indicator name on zone. it's defined with the pair (drag type:indicator name))
suggestionbox
org.richfaces.taglib.SuggestionBoxTag
JSP
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.
width
true
false
Width of the pop-up window in pixels
id
false
Every component may have a unique id that is automatically created if
omitted
dir
false
Alternate textual description of the element rendered by this component
bypassUpdates
false
If true, after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
popupClass
false
HTML CSS class attribute of element for pop-up
suggestion content
limitToList
false
If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components.
style
false
CSS style(s) is/are to be applied when this component is rendered
shadowOpacity
false
HTML CSS class attribute of element for pop-up
suggestion content
for
false
id (or full path of id's) of target components, for which this element must provide support.
If a target component inside of the same <code>NamingContainer</code> (UIForm, UIData in base implementstions), can be simple value of the "id" attribute.
For other cases must include id's of <code>NamingContainer</code> components, separated by ':'. For search from the root of components, must be started with ':'.
var
false
A request-scope attribute under which the data object for the
current row is exposed when iterating
summary
false
This attribute provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille
timeout
false
response waiting time on a particular request. If a response is not received during this time, the request is aborted
rows
false
A number of rows to display, or zero for all remaining
rows in the table
converter
false
Id of Converter to be used or reference to a Converter
lang
false
Code describing the language used in the generated markup for this component
first
false
A zero-relative row number of the first row to display
cellspacing
false
This attribute specifies how much space the user agent
should leave between the table and the column on all
four sides. The attribute also specifies the amount of
space to leave between cells
shadowDepth
false
Pop-up shadow depth for suggestion content
fetchValue
false
A value to set in the target input element on a choice
suggestion that isn't shown in the suggestion table. It
can be used for descriptive output comments for
suggestions. If not set, all text in the suggestion row
is set as a value
entryClass
false
Name of the CSS class for a suggestion entry element
(table row)
onselect
false
JavaScript code for call on select suggestion, after
update value of target element
binding
false
The attribute takes a value-binding expression for a component property of
a backing bean
selfRendered
false
If true, forces active Ajax region render response
directly from stored components tree, bypasses page
processing. Can be used for increase performance. Also,
must be set to 'true' inside iteration components, such
as dataTable
cellpadding
false
This attribute specifies the amount of space between the
border of the cell and its contents