A collapsible panel, which content shows/hides after activating a header control.
Highly customizable look and feel
Support for any content inside
Collapsing expanding content
Three modes of collapsing/expanding
Server
Client
Ajax
Table 6.416. rich : simpleTogglePanel attributes
Attribute Name | Description |
---|---|
action | MethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property |
actionListener | MethodBinding pointing at method accepting an ActionEvent with return type void |
ajaxSingle | if "true", submits ONLY one field/link, instead of all form controls |
binding | The attribute takes a value-binding expression for a component property of a backing bean |
bodyClass | A class that defines a style for a panel content |
bypassUpdates | 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 |
data | Serialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax |
eventsQueue | 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.) |
focus | id of element to set focus after request completed on client side |
headerClass | Class that defines the style for panel header |
height | Height of a simple toggle panel content area might be defined as pixels or in percents. By default height is not defined |
id | Every component may have a unique id that is automatically created if omitted |
ignoreDupResponses | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now |
immediate | 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 |
label | Marker to be rendered on a panel header |
limitToList | If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components |
onbeforedomupdate | JavaScript code for call before DOM has been updated on client side |
onclick | HTML: a script expression; a pointer button is clicked |
oncollapse | Event must occurs on befor panel collapsed |
oncomplete | JavaScript code for call after request completed on client side |
ondblclick | HTML: a script expression; a pointer button is double-clicked |
onexpand | Event must occurs on befor panel expanded |
onkeydown | HTML: a script expression; a key is pressed down |
onkeypress | HTML: a script expression; a key is pressed and released |
onkeyup | HTML: a script expression; a key is released |
onmousedown | HTML: script expression; a pointer button is pressed down |
onmousemove | HTML: a script expression; a pointer is moved within |
onmouseout | HTML: a script expression; a pointer is moved away |
onmouseover | HTML: a script expression; a pointer is moved onto |
onmouseup | HTML: script expression; a pointer button is released |
opened | A false value for this attribute makes a panel closed as default |
process | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 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 |
rendered | If "false", this component is not rendered |
requestDelay | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already |
reRender | Id['s] (in format of call UIComponent.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 |
status | ID (in format of call UIComponent.findComponent()) of Request status component |
style | CSS style(s) is/are to be applied when this component is rendered |
styleClass | Corresponds to the HTML class attribute |
switchType | Facets switch algorithm: "client", "server"(default), "ajax" |
timeout | Response waiting time on a particular request. If a response is not received during this time, the request is aborted |
value | The current value for this component |
width | Width of a simple toggle panel might be defined as pixels or in percents. By default width is not defined |
Table 6.417. Component identification parameters
Name | Value |
---|---|
component-type | org.richfaces.SimpleTogglePanel |
component-class | org.richfaces.component.html.HtmlSimpleTogglePanel |
component-family | org.richfaces.SimpleTogglePanel |
renderer-type | org.richfaces.SimpleTogglePanelRenderer |
tag-class | org.richfaces.taglib.SimpleTogglePanelTag |
To create the simplest variant on a page use the following syntax:
Example:
...
<rich:simpleTogglePanel>
...
</rich:simpleTogglePanel>
...
Example:
import org.richfaces.component.html.HtmlSimpleTogglePanel;
...
HtmlSimpleTogglePanel myPanel = new HtmlSimpleTogglePanel();
...
The component is a simplified version of toggle panel that initially has a defined layout as a panel with a header playing a role of a mode switching control. On a component header element, it's possible to define a label using an attribute with the same name.
Switching mode could be defined with the "switchType" attribute with three possible parameters.
Server (DEFAULT)
The common submission is performed around simpleTogglePanel and a page is completely rendered on a called panel. Only one at a time panel is uploaded onto the client side.
Ajax
AJAX form submission is performed around the panel, content of the called panel is uploaded on Ajax request and additionally specified elements in the "reRender" attribute are rendered. Only one at a time panel is uploaded on the client side.
Client
All panels are uploaded on the client side. Switching from the active to the hidden panel is performed with client JavaScript.
The <rich:simpleTogglePanel> component also has an "opened" attribute responsible for keeping a panel state. It gives an opportunity to manage state of the component from a model. If the value of this attribute is"true" the component is expanded.
onmouseover
onclick
onmouseout
etc.
Information about the "process" attribute usage you can find here.
For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.
There are two ways to redefine the appearance of all <rich:simpleTooglePanel> components at once:
Redefine the corresponding skin parameters
Add to your style sheets style classes used by a <rich:simpleTooglePanel> component
Table 6.418. Skin parameters for a whole component
Skin parameters | CSS properties |
---|---|
generalBackgroundColor | background-color |
panelBorderColor | border-color |
Table 6.419. Skin parameters for a header element
Skin parameters | CSS properties |
---|---|
headerBackgroundColor | background-color |
headerBackgroundColor | border-color |
headerSizeFont | font-size |
headTextColor | color |
headerWeightFont | font-weight |
headerFamilyFont | font-family |
Table 6.420. Skin parameters for a body element
Skin parameters | CSS properties |
---|---|
generalBackgroundColor | background-color |
generalSizeFont | font-size |
panelTextColor | color |
generalFamilyFont | font-family |
On the screenshot there are classes names that define styles for component elements.
Table 6.421. Classes names that define a component appearance
Class name | Class description |
---|---|
rich-stglpanel | Defines styles for a wrapper <div> element of a component |
rich-stglpanel-header | Defines styles for header element of a component |
rich-stglpnl-marker | Defines styles for a wrapper <div> element of a marker |
rich-stglpanel-body | Defines styles for a component content |
Table 6.422. Style component classes
Class name | Class description |
---|---|
styleClass | The class defines panel common style. It's used in the outside <div> element |
bodyClass | applicable to panels body elements |
headerClass | applicable to header elements |
In order to redefine styles for all <rich:simpleTogglePanel> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.
Example:
...
.rich-stglpanel-header{
font-style:italic;
}
...
This is a result:
In the example the font style for header was changed.
Also it’s possible to change styles of particular <rich:simpleTogglePanel> component. In this case you should create own style classes and use them in corresponding <rich:simpleTogglePanel> styleClass attributes. An example is placed below:
Example:
...
.myClass{
background-color:#ffead9;
}
...
The "bodyClass" attribute for <rich:simpleTogglePanel> is defined as it’s shown in the example below:
Example:
<rich:simpleTogglePanel ... bodyClass="myClass"/>
This is a result:
As it could be seen on the picture above,background color for body was changed.
Here you can see the example of <rich:simpleTogglePanel> usage and sources for the given example.