PrimeFaces Software User Guide
Below you will find brief information for Software PrimeFaces. PrimeFaces is an open-source JSF component suite, offering a rich set of UI components, built-in AJAX capabilities, and a lightweight, zero-configuration approach. It simplifies web application development with JSF, providing features like push support, a mobile UI kit, and a skinning framework.
Advertisement
Advertisement
USER GUIDE
5.1
Author
Çağatay Çivici
First Edition
PrimeFaces User Guide
Table of Contents
2
PrimeFaces User Guide
3
PrimeFaces User Guide
4
PrimeFaces User Guide
5
PrimeFaces User Guide
6
PrimeFaces User Guide
7
PrimeFaces User Guide
8
PrimeFaces User Guide
About the Author
Çağatay Çivici is a member of JavaServer Faces Expert Group, the founder of PrimeFaces and
PMC member of open source JSF implementation Apache MyFaces. He is a recognized speaker in international conferences including JavaOne, SpringOne, Jazoon, JAX, W-JAX, JSFSummit,
JSFDays, Con-Fess and many local events such as JUGs.
Çağatay is also an author and technical reviewer of a couple books regarding web application development with Java and JSF. As an experienced trainer, he has trained over 300 developers on
Java EE technologies mainly JSF, Spring, EJB 3.x and JPA.
Çağatay is also known as Optimus Prime in JavaServer Faces Community.
9
PrimeFaces User Guide
1. Introduction
1.1 What is PrimeFaces?
PrimeFaces is an open source JSF component suite with various extensions.
• Rich set of components (HtmlEditor, Dialog, AutoComplete, Charts and many more).
• Built-in Ajax based on standard JSF 2.0 Ajax APIs.
• Lightweight, one jar, zero-configuration and no required dependencies.
• Push support via Atmosphere Framework.
• Mobile UI kit to create mobile web applications.
• Skinning Framework with 35+ built-in themes and support for visual theme designer tool.
• Extensive documentation.
• Large, vibrant and active user community.
• Developed with "passion" from application developers to application developers.
10
PrimeFaces User Guide
2. Setup
2.1 Download
PrimeFaces has a single jar called primefaces-{version}.jar. There are two ways to download this jar, you can either download from PrimeFaces homepage or if you are a maven user you can define it as a dependency.
Download Manually
Three different artifacts are available for each PrimeFaces version, binary, sources and bundle.
Bundle contains binary, sources and javadocs.
http://www.primefaces.org/downloads
Download with Maven
Group id is org.primefaces and artifact id is primefaces.
<dependency>
<groupId>org.primefaces</groupId>
<artifactId>primefaces</artifactId>
<version>5.1</version>
</dependency>
11
PrimeFaces User Guide
2.2 Dependencies
PrimeFaces only requires a JAVA 5+ runtime and a JSF 2.x implementation as mandatory dependencies. There’re some optional libraries for certain features. Licenses of all dependencies and any 3rd part work incorporated are compatible with the PrimeFaces Licenses.
Dependency
JSF runtime itext apache poi rome commons-fileupload commons-io atmosphere barcode4j-light qrgen
1.0
1.3
2.2
Version *
2.0, 2.1 or 2.2
2.1.7
3.7
2.2.2
2.1
1.4
Type
Required
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Description
Apache MyFaces or Oracle Mojarra
DataExporter (PDF)
DataExporter (Excel)
FeedReader
FileUpload
FileUpload
PrimeFaces Push
Barcode
QR Code support for Barcode
* Listed versions are tested and known to be working with PrimeFaces, other versions of these dependencies may also work but not tested.
JSF Runtime
PrimeFaces supports JSF 2.0, 2.1 and 2.2 runtimes at the same time using feature detection and by not having compile time dependency to a specific version. As a result some features are only available depending on the runtime.
A good example for runtime compatibility is the passthrough attributes, a JSF 2.2 specific feature to display dynamic attributes. In following page, pass through attribute placeholder only gets rendered if the runtime is JSF 2.2.
<!DOCTYPE html>
<html xmlns="http://www.w3c.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:p="http://primefaces.org/ui" xmlns:pt="http://xmlns.jcp.org/jsf/passthrough">
<h:head>
</h:head>
<h:body>
<p:inputText value="#{bean.value}" pt:placeholder="Watermark here"/>
</h:body>
</html>
12
PrimeFaces User Guide
2.3 Configuration
PrimeFaces does not require any mandatory configuration and follows configuration by exception pattern of Java EE. Here is the list of all configuration options defined with a contex-param such as;
<context-param>
<param-name>primefaces.THEME</param-name>
<param-value>bootstrap</param-value>
</context-param>
THEME mobile.THEME
PUSH_SERVER_URL
SUBMIT
DIR
RESET_VALUES
SECRET
Name
CLIENT_SIDE_VALIDATION false
UPLOADER auto
TRANSFORM_METADATA
LEGACY_WIDGET_
NAMESPACE false false
Default
aristo null
Description
Theme of the application.
Theme of the mobile application.
null full ltr false
Custom server url for PrimeFaces Push.
Defines ajax submit mode, full or partial.
Defines orientation, ltr or rtl.
When enabled, ajax updated inputs are reset.
primefaces Secret key to encrypt-decrypt value expressions exposed in rendering StreamedContents.
Controls client side validatation.
Defines uploader mode; auto, native or commons.
Transforms bean validation metadata to html attributes.
Enables window scope so that widgets can be accessed using widgetVar.method() in addition to default PF namespace approach like PF('widgetVar').method().
2.4 Hello World
Once you have added the primefaces jar to your classpath, you need to add the PrimeFaces namespace to your page to begin using the components. Here is a simple page like test.xhtml;
<!DOCTYPE html>
<html xmlns="http://www.w3c.org/1999/xhtml" xmlns:h="http://xmlns.jcp.org/jsf/html" xmlns:p="http://primefaces.org/ui">
<h:head></h:head>
<h:body>
<p:editor />
</h:body>
</html>
When you run this page through Faces Servlet mapping e.g. *.jsf, you should see a rich text editor when you run the page with test.jsf.
13
PrimeFaces User Guide
3. Component Suite
3.1 AccordionPanel
AccordionPanel is a container component that displays content in stacked format.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
accordionPanel org.primefaces.component.accordionpanel.Accordionpanel
org.primefaces.component.AccordionPanel
org.primefaces.component
org.primefaces.component.AccordionPanelRenderer
org.primefaces.component.accordionpanel.AccordionPanelRenderer
Attributes
Name
id rendered binding activeIndex
Default
null true null
Type
String boolean
Object false String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component.
An EL expression that maps to a server side
UIComponent instance in a backing bean.
Index of the active tab or a comma separated string of indexes when multiple mode is on.
14
Name
style styleClass onTabChange onTabShow dynamic cache value var multiple dir prependId widgetVar null null false ltr true
Default
null null null null false true null
Type
String
String
String
String
Boolean
Boolean
List
String
Boolean
String
Boolean
String
PrimeFaces User Guide
Description
Inline style of the container element.
Style class of the container element.
Client side callback to invoke when an inactive tab is clicked.
Client side callback to invoke when a tab gets activated.
Defines the toggle mode.
Defines if activating a dynamic tab should load the contents from server again.
List to iterate to display dynamic number of tabs.
Name of iterator to use in a dynamic number of tabs.
Controls multiple selection.
Defines text direction, valid values are ltr and rtl.
AccordionPanel is a naming container thus prepends its id to its children by default, a false value turns this behavior off except for dynamic tabs.
Name of the client side widget.
Getting Started with Accordion Panel
Accordion panel consists of one or more tabs and each tab can group any content. Titles can also be defined with “title” facet.
<p:accordionPanel>
<p:tab title="First Tab Title">
<h:outputText value= "Lorem"/>
...More content for first tab
</p:tab>
<p:tab title="Second Tab Title">
<h:outputText value="Ipsum" />
</p:tab>
//any number of tabs
</p:accordionPanel>
Dynamic Content Loading
AccordionPanel supports lazy loading of tab content, when dynamic option is set true, only active tab contents will be rendered to the client side and clicking an inactive tab header will do an ajax request to load the tab contents.
This feature is useful to reduce bandwidth and speed up page loading time. By default activating a previously loaded dynamic tab does not initiate a request to load the contents again as tab is cached.
To control this behavior use cache option.
15
PrimeFaces User Guide
<p:accordionPanel dynamic="true">
//..tabs
</p:accordionPanel>
Client Side Callbacks
onTabChange is called before a tab is shown and onTabShow is called after. Both receive container element of the tab to show as the parameter.
<p:accordionPanel onTabChange="handleChange(panel)">
//..tabs
</p:accordionPanel>
<script type="text/javascript"> function handleChange(panel) {
//panel: new tab content container
}
</script>
Ajax Behavior Events
tabChange is the one and only ajax behavior event of accordion panel that is executed when a tab is toggled.
<p:accordionPanel>
<p:ajax event=”tabChange” listener=”#{bean.onChange}” />
</p:accordionPanel> public void onChange(TabChangeEvent event) {
//Tab activeTab = event.getTab();
//...
}
Your listener(if defined) will be invoked with an org.primefaces.event.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself.
Dynamic Number of Tabs
When the tabs to display are not static, use the built-in iteration feature similar to ui:repeat.
<p:accordionPanel value=”#{bean.list}” var=”listItem”>
<p:tab title="#{listItem.propertyA}">
<h:outputText value= "#{listItem.propertyB}"/>
...More content
</p:tab>
</p:accordionPanel>
16
PrimeFaces User Guide
Disabled Tabs
A tab can be disabled by setting disabled attribute to true.
<p:accordionPanel>
<p:tab title="First Tab Title" disabled=”true”>
<h:outputText value= "Lorem"/>
...More content for first tab
</p:tab>
<p:tab title="Second Tab Title">
<h:outputText value="Ipsum" />
</p:tab>
//any number of tabs
</p:accordionPanel>
Multiple Selection
By default, only one tab at a time can be active, enable multiple mode to activate multiple tabs.
<p:accordionPanel multiple=”true”>
//tabs
</p:accordionPanel>
Client Side API
Widget: PrimeFaces.widget.AccordionPanel
Method
select(index) unselect(index)
Params
index: Index of tab index: Index of tab
Return Type
void void
Description
Activates tab with given index.
Deactivates tab with given index.
Skinning
AccordionPanel resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Class
.ui-accordion
.ui-accordion-header
.ui-accordion-content
Main container element
Tab header
Tab content
Applies
17
async process update onstart oncomplete onsuccess onerror global delay
PrimeFaces User Guide
3.2 AjaxBehavior
AjaxBehavior is an extension to standard f:ajax.
Info
Tag
Behavior Id
Behavior Class
ajax org.primefaces.component.AjaxBehavior
org.primefaces.component.behavior.ajax.AjaxBehavior
Attributes
listener
Name
immediate partialSubmit disabled event resetValues null null null null true false null null
Default
null false null false false null false
Type
Method
Expr
Description
Method to process in partial request.
boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
Boolean When set to true, ajax requests are not queued.
String
String
String
String
Component(s) to process in partial request.
Component(s) to update with ajax.
Callback to execute before ajax request is begins.
Callback to execute when ajax request is completed.
String
String
Callback to execute when ajax request succeeds.
Callback to execute when ajax request fails.
Boolean Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
String If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Boolean Enables serialization of values belonging to the partially processed components only.
Boolean Disables ajax behavior.
String Client side event to trigger ajax request.
Boolean If true, local values of input components to be updated within the ajax request would be reset.
18
PrimeFaces User Guide
Name Default
ignoreAutoUpdate false
Type Description
Boolean If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Getting Started with AjaxBehavior
AjaxBehavior is attached to the component to ajaxify.
<h:inputText value="#{bean.text}">
<p:ajax update="out" />
</h:inputText>
<h:outputText id="out" value="#{bean.text}" />
In the example above, each time the input changes, an ajax request is sent to the server. When the response is received output text with id "out" is updated with value of the input.
Listener
In case you need to execute a method on a backing bean, define a listener;
<h:inputText id="counter">
<p:ajax update="out" listener="#{counterBean.increment}"/>
</h:inputText>
<h:outputText id="out" value="#{counterBean.count}" /> public class CounterBean { private int count;
//getter setter public void increment() { count++;
}
}
Events
Default client side events are defined by components that support client behaviors, for input components it is onchange and for command components it is onclick. In order to override the dom event to trigger the ajax request use event option. In following example, ajax request is triggered when key is up on input field.
<h:inputText id="firstname" value="#{bean.text}">
<p:ajax update="out" event="keyup"/>
</h:inputText>
<h:outputText id="out" value="#{bean.text}" />
19
PrimeFaces User Guide
3.3 AjaxExceptionHandler
AjaxExceptionHandler is a utility component for the built-in ExceptionHandler.
Info
Tag
Component Class
ajaxExceptionHandler org.primefaces.component.ajaxexceptionhandler.AjaxExceptionHandler
Component Type
org.primefaces.component.AjaxExceptionHandler
Component Family
org.primefaces.component
Attributes
Name
id rendered null true
Default
binding null onexception null update type null null
Type
String
Boolean
Object
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component.
An el expression that maps to a server side
UIComponent instance in a backing bean
Client side callback to execute after a exception with this type occured.
Components to update after a exception with this type occured.
Exception type to handle.
Getting Started with AjaxExceptionHandler
Please find the detailed information about this component at ExceptionHandler section at Utilities chapter.
20
PrimeFaces User Guide
3.4 AjaxStatus
AjaxStatus is a global notifier for ajax requests.
Info
Tag
Component Class
Component Type
ajaxStatus org.primefaces.component.ajaxstatus.AjaxStatus
org.primefaces.component.AjaxStatus
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.AjaxStatusRenderer
Renderer Class
org.primefaces.component.ajaxstatus.AjaxStatusRenderer
Attributes
Name
id rendered null true
Default
binding onstart null null oncomplete null onsuccess onerror style styleClass widgetVar null null null null null
String
String
String
String
String
Type
String
Boolean
Object
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component.
An el expression that maps to a server side
UIComponent instance in a backing bean
Client side callback to execute after ajax requests start.
Client side callback to execute after ajax requests complete.
Client side callback to execute after ajax requests completed succesfully.
Client side callback to execute when an ajax request fails.
Inline style of the component.
Style class of the component.
Name of the client side widget.
21
PrimeFaces User Guide
Getting Started with AjaxStatus
AjaxStatus uses facets to represent the request status. Most common used facets are start and
complete. Start facet will be visible once ajax request begins and stay visible until it’s completed.
Once the ajax response is received and page is updated, start facet gets hidden and complete facet shows up.
<p:ajaxStatus>
<f:facet name="start">
<p:graphicImage value="ajaxloading.gif" />
</f:facet>
<f:facet name="complete">
<h:outputText value="Done!" />
</f:facet>
</p:ajaxStatus>
Events
Here is the full list of available event names;
default: Initially visible when page is loaded.
start: Before ajax request begins.
success: When ajax response is received without error.
error: When ajax response is received with an http error.
complete: When everything finishes.
<p:ajaxStatus>
<f:facet name="error">
<h:outputText value="Error" />
</f:facet>
<f:facet name="success">
<h:outputText value="Success" />
</f:facet>
<f:facet name="default">
<h:outputText value="Idle" />
</f:facet>
<f:facet name="start">
<h:outputText value="Sending" />
</f:facet>
<f:facet name="complete">
<h:outputText value="Done" />
</f:facet>
</p:ajaxStatus>
Custom Events
Facets are the declarative way to use, if you’d like to implement advanced cases with scripting you can take advantage of on* callbacks which are the event handler counterparts of the facets.
<p:ajaxStatus onstart="alert('Start')" oncomplete="alert('End')"/>
22
PrimeFaces User Guide
A comman usage of programmatic approach is to implement a custom status dialog;
<p:ajaxStatus onstart="PF('status').show()" oncomplete="PF('status').hide()"/>
<p:dialog widgetVar="status" modal="true" closable="false">
Please Wait
</p:dialog>
Client Side API
Widget: PrimeFaces.widget.AjaxStatus
Method
trigger(event)
Params Return Type
event: Name of event. void
Description
Triggers given event.
Skinning
AjaxStatus is equipped with style and styleClass. Styling directly applies to a container element which contains the facets.
<p:ajaxStatus style="width:32px;height:32px" ... />
Tips
• Avoid updating ajaxStatus itself to prevent duplicate facet/callback bindings.
• Provide a fixed width/height to an inline ajaxStatus to prevent page layout from changing.
• Components like commandButton has an attribute (global) to control triggering of AjaxStatus.
• AjaxStatus also supports core JSF ajax requests of f:ajax as well.
23
3.4 AutoComplete
AutoComplete provides live suggestions while an input is being typed.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
autoComplete org.primefaces.component.autocomplete.AutoComplete
org.primefaces.component.AutoComplete
org.primefaces.component
org.primefaces.component.AutoCompleteRenderer
org.primefaces.component.autocomplete.AutoCompleteRenderer
Attributes
id rendered
Name
binding value converter null true
Default
null null null
Type
String
Description
Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component.
Object An el expression that maps to a server side
UIComponent instance in a backing bean.
Object Value of the component than can be either an EL expression of a literal text.
Object An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id.
24
Name
immediate false
Default
required validator false null valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar completeMethod var itemLabel itemValue maxResults minQueryLength queryDelay forceSelection scrollHeight effect effectDuration dropdown panelStyle panelStyleClass multiple accesskey alt null null null null null null null null unlimited true
300 false null null null null null null
400 false null
PrimeFaces User Guide
String
String
String
Method
Expr
String
Type Description
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required.
Method
Expr
A method expression that refers to a method validationg the input.
Method
Expr
A method expression that refers to a method for handling a valuchangeevent.
String Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fails.
Name of the client side widget.
Method providing suggestions.
Name of the iterator used in pojo based suggestion.
String
String
Label of the item.
Value of the item.
Integer Maximum number of results to be displayed.
Integer Number of characters to be typed before starting to query.
Integer Delay to wait in milliseconds before sending each query to the server.
Boolean When enabled, autoComplete only accepts input from the selection list.
Integer Defines the height of the items viewport.
String Effect to use when showing/hiding suggestions.
Integer Duration of effect in milliseconds.
Boolean Enables dropdown mode when set true.
String
String
Inline style of the items container element.
Style class of the items container element.
Boolean When true, enables multiple selection.
String Access key that when pressed transfers focus to the input element.
String Alternate textual description of the input field.
25
onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect
Name
autocomplete dir disabled label lang maxlength onblur onchange null null null null null null null null null null null null null null
Default
false null null null null null
PrimeFaces User Guide
Type
String
String
Boolean Disables input field
String A localized user presentable name.
String Code describing the language used in the generated markup for this component.
Integer Maximum number of characters that may be entered in this field.
String
String
String
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
Client side callback to execute when input element is clicked.
String
Description
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
String
String
String
String
String
String
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
String
String
String
String
Client side callback to execute when a pointer button is moved away from input element.
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
26
Name
placeholder readonly size style styleClass tabindex title itemTipMyPosition itemTipAtPosition cache cacheTimeout emptyMessage appendTo resultsMessage groupBy null false
Default
null null null null null left top right bottom false
300000 null null null null
PrimeFaces User Guide
Type
String
Description
Specifies a short hint.
Boolean Flag indicating that this component will prevent changes by the user.
Integer Number of characters used to determine the width of the input element.
String Inline style of the container element.
String Style class of the container element.
Integer Position of the input element in the tabbing order.
String
String
String
String
Advisory tooltip informaton.
Position of itemtip corner relative to item.
String Position of item corner relative to itemtip.
Boolean When enabled autocomplete caches the searched result list.
Integer Timeout value for cached results.
Text to display when there is no data to display.
Appends the overlay to the element defined by search expression. Defaults to document body.
String Hint text for screen readers to provide information about the search results.
Object Value to group items in categories.
Getting Started with AutoComplete
AutoComplete is an input component so it requires a value as usual. Suggestions are loaded by calling a server side completeMethod that takes a single string parameter which is the text entered.
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" /> public class Bean { private String text; public List<String> complete(String query) {
List<String> results = new ArrayList<String>(); for (int i = 0; i < 10; i++) results.add(query + i); return results;
}
//getter setter
}
27
PrimeFaces User Guide
Pojo Support
Most of the time, instead of simple strings you would need work with your domain objects, autoComplete supports this common use case with the use of a converter and data iterator.
Following example loads a list of players, itemLabel is the label displayed as a suggestion and itemValue is the submitted value. Note that when working with pojos, you need to plug-in your own converter.
<p:autoComplete value="#{playerBean.selectedPlayer}" completeMethod="#{playerBean.completePlayer}" var="player" itemLabel="#{player.name}" itemValue="#{player}" converter="playerConverter"/> public class PlayerBean { private Player selectedPlayer; public Player getSelectedPlayer() { return selectedPlayer;
} public void setSelectedPlayer(Player selectedPlayer) { this.selectedPlayer = selectedPlayer;
} public List<Player> complete(String query) {
List<Player> players = readPlayersFromDatasource(query); return players;
}
} public class Player { private String name;
//getter setter
}
Limiting the Results
Number of results shown can be limited, by default there is no limit.
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" maxResults="5" />
Minimum Query Length
By default queries are sent to the server and completeMethod is called as soon as users starts typing at the input text. This behavior is tuned using the minQueryLength attribute.
28
PrimeFaces User Guide
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" minQueryLength="3" />
With this setting, suggestions will start when user types the 3rd character at the input field.
Query Delay
AutoComplete is optimized using queryDelay option, by default autoComplete waits for 300 milliseconds to query a suggestion request, if you’d like to tune the load balance, give a longer value. Following autoComplete waits for 1 second after user types an input.
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" queryDelay="1000" />
Custom Content
AutoComplete can display custom content by nesting columns.
<p:autoComplete value="#{autoCompleteBean.selectedPlayer}" completeMethod="#{autoCompleteBean.completePlayer}" var="p" itemValue="#{p}" converter="player">
<p:column>
<p:graphicImage value="/images/barca/#{p.photo}" width="40" height="50"/>
</p:column>
<p:column>
#{p.name} - #{p.number}
</p:column>
</p:autoComplete>
Dropdown Mode
When dropdown mode is enabled, a dropdown button is displayed next to the input field, clicking this button will do a search with an empty query, a regular completeMethod implementation should load all available items as a response.
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" dropdown="true" />
Multiple Selection
AutoComplete supports multiple selection as well, to use this feature set multiple option to true and define a list as your backend model. Following example demonstrates multiple selection with custom content support.
29
PrimeFaces User Guide
<p:autoComplete id="advanced" value="#{autoCompleteBean.selectedPlayers}" completeMethod="#{autoCompleteBean.completePlayer}"
var="p" itemLabel="#{p.name}" itemValue="#{p}" converter="player" multiple="true">
<p:column style="width:20%;text-align:center">
<p:graphicImage value="/images/barca/#{p.photo}"/>
</p:column>
<p:column style="width:80%">
#{p.name} - #{p.number}
</p:column>
</p:autoComplete> public class AutoCompleteBean { private List<Player> selectedPlayers;
//...
}
Caching
Suggestions can be cached on client side so that the same query does not do a request which is likely to return same suggestions again. To enable this, set cache option to true. There is also a
cacheTimeout option to configure how long it takes to clear a cache automatically.
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" cache="true"/>
Ajax Behavior Events
Instead of waiting for user to submit the form manually to process the selected item, you can enable instant ajax selection by using the itemSelect ajax behavior. Example below demonstrates how to display a message about the selected item instantly.
30
PrimeFaces User Guide
<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}">
<p:ajax event="itemSelect" listener="bean.handleSelect" update="msg" />
</p:autoComplete>
<p:messages id=”msg” /> public class Bean { public void handleSelect(SelectEvent event) {
Object item = event.getObject();
FacesMessage msg = new FacesMessage("Selected", "Item:" + item);
}
//...
}
Your listener(if defined) will be invoked with an org.primefaces.event.Select instance that contains a reference to the selected item. Note that autoComplete also supports events inherited from regular input text such as blur, focus, mouseover in addition to itemSelect. Similarly, itemUnselect event is provided for multiple autocomplete when an item is removed by clicking the remove icon. In this case org.primefaces.event.Unselect instance is passed to a listener if defined.
Event
itemSelect itemUnselect query
Listener Parameter
org.primefaces.event.SelectEvent
org.primefaces.event.UnselectEvent
-
Fired
On item selection.
On item unselection.
On query.
ItemTip
Itemtip is an advanced built-in tooltip when mouse is over on suggested items. Content of the tooltip is defined via the itemtip facet.
31
PrimeFaces User Guide
<p:autoComplete value="#{autoCompleteBean.selectedPlayer1}" id="basicPojo" completeMethod="#{autoCompleteBean.completePlayer}" var="p" itemLabel="#{p.name}" itemValue="#{p}" converter="player">
<f:facet name="itemtip">
<h:panelGrid columns="2" cellpadding="5">
<f:facet name="header">
<p:graphicImage value="/images/barca/#{p.photo}" />
</f:facet>
<h:outputText value="Name: " />
<h:outputText id="modelNo" value="#{p.name}" />
<h:outputText value="Number " />
<h:outputText id="year" value="#{p.number}" />
</h:panelGrid>
</f:facet>
</p:autoComplete>
<h:outputText value="Position " />
<h:outputText value="#{p.position}"/>
Client Side API
Widget: PrimeFaces.widget.AutoComplete
Method
search(value) close() disable() enable() deactivate() activate()
Params
value: keyword for search
-
-
-
-
-
Skinning
Following is the list of structural style classes;
Return Type
void void void void void void
Description
Initiates a search with given value
Hides suggested items menu
Disables the input field
Enables the input field
Deactivates search behavior
Activates search behavior
Class
.ui-autocomplete
.ui-autocomplete-input
.ui-autocomplete-panel
.ui-autocomplete-items
.ui-autocomplete-item
.ui-autocomplete-query
Applies
Container element.
Input field.
Container of suggestions list.
List of items
Each item in the list.
Highlighted part in suggestions.
32
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
Tips
• Do not forget to use a converter when working with pojos.
• Enable forceSelection if you would like to accept values only from suggested list.
• Increase query delay to avoid unnecessary load to server as a result of user typing fast.
• Use emptyMessage option to provide feedback to the users that there are no suggestions.
• Enable caching to avoid duplicate queries.
33
3.5 Barcode
Barcode component is used to display various barcode formats.
PrimeFaces User Guide binding value type cache format orientation alt url
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
barcode org.primefaces.component.barcode.Barcode
org.primefaces.component.Barcode
org.primefaces.component
org.primefaces.component.BarcodeRenderer
org.primefaces.component.barcode.BarcodeRenderer
Attributes
Name
id rendered
Default
null true
String
Type
boolean null null null true svg
0 null null
Object
Object
String
Boolean
String
Integer
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Binary data to stream or context relative path.
Type of the barcode.
Controls browser caching mode of the resources.
Format of the generated barcode, valid values are
"svg" (default) and "png".
Orientation in terms of angle. (0, 90, 180, 270)
Alternate text for the image
Alias to value attribute
34
width height title
Name
dir lang ismap usemap style styleClass onclick ondblclick onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup
String
String
String
String
String
String
String
String
String
String
String
String
Type
String
String
String
String
Boolean
String
String null null null null null null null null null null null null null false null null
Default
null null null
PrimeFaces User Guide
Width of the image
Height of the image
Title of the image
Description
Direction of the text displayed
Language code
Specifies to use a server-side image map
Name of the client side map
Style of the image
Style class of the image onclick dom event handler ondblclick dom event handler onkeydown dom event handler onkeypress dom event handler onkeyup dom event handler onmousedown dom event handler onmousemove dom event handler onmouseout dom event handler onmouseover dom event handler onmouseup dom event handler
Getting started with Barcode
Barcode type should be provided along with the value to display. Supported formats are;
• int2of5
• codabar
• code39
• code128
• ean8
• ean13
• upca
• postnet
• pdf417
• datamatrix
• qr
35
PrimeFaces User Guide
<p:barcode value="0123456789" type="int2of5" />
Value can also be retrieved from a backend value.
<p:barcode value="#{bean.barcodeValue}" type="int2of5" />
Format
Default display format is svg and other possible option is png. In case the client browser does not support svg e.g. IE8, barcode automatically chooses png format.
<p:barcode value="#{bean.barcodeValue}" type="int2of5" format="png" />
Orientation
In order to change the orientation, choose the angle from the 4 pre-defined values.
<p:barcode value="#{bean.barcodeValue}" type="int2of5" orientation="90"/>
Dependencies
Barcode component uses barcode4j library underneath except QR code support, which is handled by qrgen library. Following versions are supported officially.
<dependency>
<groupId>net.glxn</groupId>
<artifactId>qrgen</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>net.sf.barcode4j</groupId>
<artifactId>barcode4j-light</artifactId>
<version>2.1</version>
</dependency>
* barcode4j 2.1 does not exist in maven central repository so manual installation is necessary for maven users.
36
PrimeFaces User Guide
3.6 BlockUI
BlockUI is used to block interactivity of JSF components with optional ajax integration.
Info
Tag
Component Class
Component Type
blockUI org.primefaces.component.blockui.BlockUI
org.primefaces.component.BlockUI
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.BlockUIRenderer
Renderer Class
org.primefaces.component.blockui.BlockUIRenderer
Attributes
Name
id rendered binding widgetVar trigger
Default
null true
Type
String
Boolean null null null
Object
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Identifier of the component(s) to bind.
37
Name
block blocked
Default
null false
Type
String
Boolean
PrimeFaces User Guide
Description
Identifier of the component to block.
Blocks the UI by default when enabled.
Getting Started with BlockUI
BlockUI requires trigger and block attributes to be defined. With the special ajax integration, ajax requests whose source are the trigger components will block the ui onstart and unblock oncomplete.
Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received.
<p:panel id="pnl" header="My Panel">
//content
<p:commandButton id="saveBtn" value="Save" />
</p:panel>
<p:blockUI block="pnl" trigger="saveBtn" />
Multiple triggers are defined as a comma separated list.
<p:blockUI block="pnl" trigger="saveBtn,deleteBtn,updateBtn" />
Custom Content
In order to display custom content like a loading text and animation, place the content inside the blockUI.
<p:dataTable id="dataTable" var="car" value="#{tableBean.cars}"
paginator="true" rows="10">
<p:column>
<f:facet name="header">
<h:outputText value="Model" />
</f:facet>
<h:outputText value="#{car.model}" />
</p:column>
//more columns
</p:dataTable>
<p:blockUI block="dataTable" trigger="dataTable">
LOADING<br />
<p:graphicImage value="/images/ajax-loader.gif"/>
</p:blockUI>
38
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.BlockUI show() hide()
Method Params
-
-
Skinning
Following is the list of structural style classes;
Return Type
void void
Description
Blocks the UI.
Unblocks the UI
.ui-blockui
.ui-blockui-content
Class Applies
Container element.
Container for custom content.
As skinning style classes are global, see the main theming section for more information.
Tips
• BlockUI does not support absolute or fixed positioned components. e.g. dialog.
39
PrimeFaces User Guide
3.7 BreadCrumb
Breadcrumb is a navigation component that provides contextual information about page hierarchy in the workflow.
Info
Tag
Component Class
breadCrumb org.primefaces.component.breadcrumb.BreadCrumb
Component Type
org.primefaces.component.BreadCrumb
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.BreadCrumbRenderer
org.primefaces.component.breadcrumb.BreadCrumbRenderer
Attributes
Name
id rendered binding widgetVar model style styleClass homeDisplay
Default
null true
Type
String
Boolean null null null null null icon
Object
String
MenuModel
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
MenuModel instance to create menus programmatically
Style of main container element.
Style class of main container
Defines display mode of root link, valid values are
"icon" default and "text".
40
PrimeFaces User Guide
Getting Started with BreadCrumb
Steps are defined as child menuitem components in breadcrumb.
<p:breadCrumb>
<p:menuitem label="Categories" url="#" />
<p:menuitem label="Sports" url="#" />
//more menuitems
</p:breadCrumb>
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
Breadcrumb resides in a container element that style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-breadcrumb
.ui-breadcrumb .ui-menu-item-link
.ui-breadcrumb .ui-menu-item-text
.ui-breadcrumb-chevron
Applies
Main breadcrumb container element.
Each menuitem.
Each menuitem label.
Seperator of menuitems.
As skinning style classes are global, see the main theming section for more information.
Tips
• If there is a dynamic flow, use model option instead of creating declarative p:menuitem components and bind your MenuModel representing the state of the flow.
• Breadcrumb can do ajax/non-ajax action requests as well since p:menuitem has this option. In this case, breadcrumb must be nested in a form.
• url option is the key for a menuitem, if it is defined, it will work as a simple link. If you’d like to use menuitem to execute command with or without ajax, do not define the url option.
41
PrimeFaces User Guide
3.8 Button
Button is an extension to the standard h:button component with skinning capabilities.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
button org.primefaces.component.button.Button
org.primefaces.component.Button
org.primefaces.component
org.primefaces.component.ButtonRenderer
org.primefaces.component.button.ButtonRenderer
Attributes
id
Name
rendered binding widgetVar value outcome
Default Type
null String true null
Description
Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component.
Object An el expression that maps to a server side UIComponent instance in a backing bean.
null null includeViewParams false fragment null null
String Name of the client side widget.
Object Value of the component than can be either an EL expression of a literal text.
String Used to resolve a navigation case.
Boolean Whether to include page parameters in target URI
String Identifier of the target page which should be scrolled to.
disabled accesskey alt dir image lang false null null null null null
Boolean Disables button.
String
String
String
String
String
Access key that when pressed transfers focus to button.
Alternate textual description.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Style class for the button icon. (deprecated: use icon)
Code describing the language used in the generated markup
42
Name
onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup style styleClass readOnly tabindex title href icon iconPos target escape inline
PrimeFaces User Guide null null null null left null null false
_self true false
Default Type
null null null null null null null null null null null null null
Description
for this component.
String
String
String
String
String
String
String
String
String
Client side callback to execute when button loses focus.
Client side callback to execute when button loses focus and its value has been modified since gaining focus.
Client side callback to execute when button is clicked.
Client side callback to execute when button is double clicked.
Client side callback to execute when button receives focus.
Client side callback to execute when a key is pressed down over button.
Client side callback to execute when a key is pressed and released over button.
Client side callback to execute when a key is released over button.
Client side callback to execute when a pointer button is pressed down over button.
String
String
String
Client side callback to execute when a pointer button is moved within button
Client side callback to execute when a pointer button is moved away from button.
Client side callback to execute when a pointer button is moved onto button.
String Client side callback to execute when a pointer button is released over button.
Inline style of the button.
String
String Style class of the button.
Boolean Makes button read only.
Integer Position in the tabbing order.
String Advisory tooltip informaton.
String Resource to link directly to implement anchor behavior.
String
String
Icon of the button.
Position of the button icon.
String The window target.
Boolean Defines whether label would be escaped or not.
String Displays as inline instead of 100% width, mobile only.
43
PrimeFaces User Guide
Name Default Type
disableClientWindow false
Description
Boolean Disable appending the ClientWindow on the rendering of this element.
Getting Started with Button
p:button usage is same as standard h:button, an outcome is necessary to navigate using GET requests. Assume you are at source.xhtml and need to navigate target.xhtml.
<p:button outcome="target" value="Navigate"/>
Parameters
Parameters in URI are defined with nested <f:param /> tags.
<p:button outcome="target" value="Navigate">
<f:param name="id" value="10" />
</p:button>
Icons
Icons for button are defined via css and icon attribute, if you use title instead of value, only icon will be displayed and title text will be displayed as tooltip on mouseover. You can also use icons from PrimeFaces themes such ui-icon-check.
<p:button outcome="target" icon="star" value="With Icon"/>
<p:button outcome="target" icon="star" title="With Icon"/>
.star { background-image: url("images/star.png");
}
Skinning
Button renders a button tag which style and styleClass applies. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-button
.ui-button-text-only
.ui-button-text
Applies
Button element
Button element when icon is not used
Label of button
44
PrimeFaces User Guide
3.9 Cache
Cache component is used to reduce page load time by caching the content after initial rendering.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
cache org.primefaces.component.cache.UICache
org.primefaces.component.Cache
org.primefaces.component
org.primefaces.component.UICacheRenderer
org.primefaces.component.cache.UICacheRenderer
Attributes
Name
id rendered binding disabled region key
Default
null true null false
View Id null
Type
String
Description
Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side UIComponent instance in a backing bean.
Boolean Disables caching.
String
String
Unique id of the cache region, defaults to view id.
Unique id of the cache entry in region, defaults to client id of component.
Getting Started with Cache
A cache store is required to use the cache component, two different providers are supported as cache implementation; EHCache and Hazelcast. Provider is configured via a context-param.
<context-param>
<param-name>primefaces.CACHE_PROVIDER</param-name>
<param-value>org.primefaces.cache.EHCacheProvider</param-value>
</context-param>
Here is a sample ehcache.xml to configure cache regions, there are two regions in this configuration.
45
PrimeFaces User Guide
<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="ehcache.xsd"
updateCheck="true" monitoring="autodetect"
dynamicConfig="true">
<diskStore path="java.io.tmpdir"/>
<defaultCache
maxEntriesLocalHeap="10000"
eternal="false"
timeToIdleSeconds="120"
timeToLiveSeconds="120"
diskSpoolBufferSizeMB="30"
maxEntriesLocalDisk="10000000"
diskExpiryThreadIntervalSeconds="120"
memoryStoreEvictionPolicy="LRU">
<persistence strategy="localTempSwap"/>
</defaultCache>
<cache name="testcache"
maxEntriesLocalHeap="10000"
eternal="false"
timeToIdleSeconds="120"
timeToLiveSeconds="120"
diskSpoolBufferSizeMB="30"
maxEntriesLocalDisk="10000000"
diskExpiryThreadIntervalSeconds="120"
memoryStoreEvictionPolicy="LRU">
<persistence strategy="localTempSwap"/>
</cache>
</ehcache>
After the configuration, at UI side, the cached part needs to be wrapped inside the p:cache component.
<p:cache>
//content to cache
</p:cache>
Once the page is loaded initially, content inside p:cache component is cached inside the cache region of the cache provider. Postbacks on the same page or reopening the page retrieve the output from cache instead of rendering the content regularly.
Cache Provider API
CacheProvider can be accessed via;
RequestContext.getCurrentInstance().getApplicationContext().getCacheProvider()
For example using this API, all cache regions can be cleaned using clear() method. Refer to javadoc of CacheProvider for the full list of available methods.
46
PrimeFaces User Guide
3.10 Calendar
Calendar is an input component used to select a date featuring display modes, paging, localization, ajax selection and more.
Info
Tag
Component Class
Component Type
calendar org.primefaces.component.calendar.Calendar
org.primefaces.component.Calendar
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.CalendarRenderer
Renderer Class
org.primefaces.component.calendar.CalendarRenderer
Attributes
id rendered
Name
binding value converter immediate required null
Default
true null null null false false
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component.
Object An el expression that maps to a server side
UIComponent instance in a backing bean java.util
.Date
Value of the component
Convert er/Strin g
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
47
validator
Name
valueChangeListener requiredMessage converterMessage validatorMessage widgetVar mindate maxdate pages disabled mode pattern locale navigator timeZone readonlyInput showButtonPanel effect effectDuration showOn showWeek disabledWeekends showOtherMonths selectOtherMonths yearRange
PrimeFaces User Guide false false false false null null null null null
Default
false false normal both
Type
Method
Expr
Method
Expr
String
String null null null null
1 false popup
String
String
Date or
String
Date or
String
Integer
String
MM/dd/yyyy String
Message to be displayed when validation fails.
Name of the client side widget.
Sets calendar's minimum visible date
Sets calendar's maximum visible date
Enables multiple page rendering.
Boolean Disables the calendar when set to true.
Defines how the calendar will be displayed.
DateFormat pattern for localization null false null
Description
A method expression that refers to a method validationg the input
A method expression that refers to a method for handling a valuchangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Object Locale to be used for labels and conversion.
Boolean Enables month/year navigator
Time
Zone
String or a java.util.TimeZone instance to specify the timezone used for date conversion, defaults to
TimeZone.getDefault()
Boolean Makes input text of a popup calendar readonly.
Boolean Visibility of button panel containing today and done buttons.
String Effect to use when displaying and showing the popup calendar.
String
String
Duration of the effect.
Client side event that displays the popup calendar.
null
Boolean Displays the week number next to each week.
Boolean Disables weekend columns.
Boolean Displays days belonging to other months.
Boolean Enables selection of days belonging to other months.
String Year range for the navigator, default "c-10:c+10"
48
timeOnly
Name
stepHour stepMinute stepSecond minHour maxHour minMinute maxMinute minSecond maxSecond pagedate accesskey alt autocomplete dir label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown onkeypress null null null null null null null null null null
59
0
59 null null
1
0
23
0
1
1
Default
false null null null
PrimeFaces User Guide
Type Description
Boolean Shows only timepicker without date.
Integer Hour steps.
Integer Minute steps.
Integer Second steps.
Integer Minimum boundary for hour selection.
Integer Maximum boundary for hour selection.
Integer Minimum boundary for minute selection.
Integer Maximum boundary for hour selection.
Integer Minimum boundary for second selection.
Integer Maximum boundary for second selection.
Object Initial date to display if value is null.
String Access key that when pressed transfers focus to the input element.
String
String
String
Alternate textual description of the input field.
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
String
String
Integer Maximum number of characters that may be entered in this field.
String Client side callback to execute when input element loses focus.
String
A localized user presentable name.
Code describing the language used in the generated markup for this component.
String
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
Client side callback to execute onclick event.
String
String
String
String
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is
49
Name
onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly style styleClass size tabindex title beforeShowDay mask timeControlType null null null null false null null null null null null null null null null null slider
Default
PrimeFaces User Guide
Type
String
String
String
Description
pressed and released over input element.
String
String
String
String
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
String
String
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
String Client side callback to execute when text within input element is selected by user.
Specifies a short hint.
String
Boolean Flag indicating that this component will prevent changes by the user.
String Inline style of the component.
String Style class of the component.
Integer Number of characters used to determine the width of the input element.
Integer Position of the input element in the tabbing order.
Advisory tooltip informaton.
Client side callback to execute before displaying a date, used to customize date display.
Applies a mask using the pattern.
String Defines the type of element to use for time picker, valid values are "slider" and "select".
Getting Started with Calendar
Value of the calendar should be a java.util.Date.
<p:calendar value="#{dateBean.date}"/>
50
public class DateBean { private Date date;
//Getter and Setter
}
Display Modes
Calendar has two main display modes, popup (default) and inline.
Inline
<p:calendar value="#{dateBean.date}" mode="inline" />
PrimeFaces User Guide
Popup
<p:calendar value="#{dateBean.date}" mode="popup" />
showOn option defines the client side event to display the calendar. Valid values are;
• focus: When input field receives focus
• button: When popup button is clicked
• both: Both focus and button cases
Popup Button
<p:calendar value="#{dateBean.date}" mode="popup" showOn="button" />
51
PrimeFaces User Guide
Popup Icon Only
<p:calendar value="#{dateBean.date}" mode="popup" showOn="button" popupIconOnly="true" />
Paging
Calendar can also be rendered in multiple pages where each page corresponds to one month. This feature is tuned with the pages attribute.
<p:calendar value="#{dateController.date}" pages="3"/>
Localization
By default locale information is retrieved from the view’s locale and can be overridden by the locale attribute. Locale attribute can take a locale key as a String or a java.util.Locale instance. Default language of labels are English and you need to add the necessary translations to your page manually as PrimeFaces does not include language translations. PrimeFaces Wiki Page for
PrimeFacesLocales is a community driven page where you may find the translations you need.
Please contribute to this wiki with your own translations.
https://code.google.com/p/primefaces/wiki/PrimeFacesLocales
Translation is a simple javascript object, we suggest adding the code to a javascript file and include in your application. Following is a Turkish calendar.
52
PrimeFaces User Guide
<h:outputScript name=”path_to_your_translations.js” />
<p:calendar value="#{dateController.date}" locale="tr" navigator="true" showButtonPanel="true"/>
To override calculated pattern from locale, use the pattern option;
<p:calendar value="#{dateController.date1}" pattern="dd.MM.yyyy"/>
<p:calendar value="#{dateController.date2}" pattern="yy, M, d"/>
<p:calendar value="#{dateController.date3}" pattern="EEE, dd MMM, yyyy"/>
Effects
Various effects can be used when showing and hiding the popup calendar, options are; show, slideDown, fadeIn, blind, bounce, clip, drop, fold and slide.
Ajax Behavior Events
Calendar provides a dateSelect ajax behavior event to execute an instant ajax selection whenever a date is selected. If you define a method as a listener, it will be invoked by passing an
org.primefaces.event.SelectEvent instance.
<p:calendar value="#{calendarBean.date}">
<p:ajax event=”dateSelect” listener=”#{bean.handleDateSelect}” update=”msg” />
</p:calendar>
<p:messages id="msg" />
53
PrimeFaces User Guide public void handleDateSelect(SelectEvent event) {
Date date = (Date) event.getObject();
//Add facesmessage
}
In popup mode, calendar also supports regular ajax behavior events like blur, keyup and more.
Another handy event is the viewChange that is fired when month and year changes. An instance of
org.primefaces.event.DateViewChangeEvent is passed to the event listener providing the current month and year information.
Date Ranges
Using mindate and maxdate options, selectable dates can be restricted. Values for these attributes can either be a string or a java.util.Date.
<p:calendar value="#{dateBean.date}" mode="inline"
mindate="07/10/2010" maxdate="07/15/2010"/>
Navigator
Navigator is an easy way to jump between months/years quickly.
<p:calendar value="#{dateBean.date}" mode="inline" navigator="true" />
TimePicker
TimePicker functionality is enabled by adding time format to your pattern.
<p:calendar value="#{dateBean.date}" pattern=”MM/dd/yyyy HH:mm” />
54
PrimeFaces User Guide
Advanced Customization
Use beforeShowDay javascript callback to customize the look of each date. The function returns an array with two values, first one is flag to indicate if date would be displayed as enabled and second parameter is the optional style class to add to date cell. Following example disabled tuesdays and fridays.
<p:calendar value="#{dateBean.date}" beforeShowDay="tuesdaysAndFridaysOnly" />
Function tuesdaysAndFridaysDisabled(date) { var day = date.getDay(); return [(day != 2 && day != 5), '']
}
Mask
Calendar has a built-in mask feature similar to the InputMask component. Set mask option to true to enable mask support.
Client Side API
Widget: PrimeFaces.widget.Calendar
Method
getDate() setDate(date) disable() enable()
Params
date: Date to display
-
-
Return Type
Date void void void
Description
Return selected date
Sets display date
Disables calendar
Enables calendar
Skinning
Calendar resides in a container element which style and styleClass options apply.
Following is the list of structural style classes;
55
PrimeFaces User Guide
Style Class
.ui-datepicker
.ui-datepicker-header
.ui-datepicker-prev
.ui-datepicker-next
.ui-datepicker-title
.ui-datepicker-month
.ui-datepicker-table
.ui-datepicker-week-end
.ui-datepicker-other-month
.ui-datepicker td
.ui-datepicker-buttonpane
.ui-datepicker-current
.ui-datepicker-close
Applies
Main container
Header container
Previous month navigator
Next month navigator
Title
Month display
Date table
Label of weekends
Dates belonging to other months
Each cell date
Button panel
Today button
Close button
As skinning style classes are global, see the main theming section for more information.
56
3.11 Captcha
Captcha is a form validation component based on Recaptcha API.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
captcha org.primefaces.component.captcha.Captcha
org.primefaces.component.Captcha
org.primefaces.component
org.primefaces.component.CaptchaRenderer
org.primefaces.component.captcha.CaptchaRenderer
Attributes
id rendered
Name
binding value converter immediate required
Default
null true null null null false false
Type
Boolean
Description
String
Boolean
Object
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Object
Converter/Stri ng
Value of the component than can be either an EL expression of a literal text.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance.
In case it’s a static text, it must refer to a converter id.
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required.
57
validator theme language tabindex label secure
Name
valueChangeListener requiredMessage converterMessage validatorMessage publicKey null null null red en null null false
Default
null null null
PrimeFaces User Guide
Type Description
MethodExpr A method binding expression that refers to a method validationg the input.
ValueChange
Listener
String
A method binding expression that refers to a method for handling a valuchangeevent.
Message to be displayed when required field validation fails.
String
String
String
String
String
Integer
String
Boolean
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Public recaptcha key for a specific domain
(deprecated)
Theme of the captcha.
Key of the supported languages.
Position of the input element in the tabbing order.
User presentable field name.
Enables https support
Getting Started with Captcha
Catpcha is implemented as an input component with a built-in validator that is integrated with reCaptcha. First thing to do is to sign up to reCaptcha to get public&private keys. Once you have the keys for your domain, add them to web.xml as follows;
<context-param>
<param-name>primefaces.PRIVATE_CAPTCHA_KEY</param-name>
<param-value>YOUR_PRIVATE_KEY</param-value>
</context-param>
<context-param>
<param-name>primefaces.PUBLIC_CAPTCHA_KEY</param-name>
<param-value>YOUR_PUBLIC_KEY</param-value>
</context-param>
That is it, now you can use captcha as follows;
<p:captcha />
Themes
Captcha features following built-in themes for look and feel customization;
- red (default)
- white
- blackglass
- clean
Themes are applied via the theme attribute.
58
PrimeFaces User Guide
<p:captcha theme="white"/>
Languages
Text instructions displayed on captcha is customized with the language attribute. Below is a captcha with Turkish text.
<p:captcha language="tr"/>
Overriding Validation Messages
By default captcha displays it’s own validation messages, this can be easily overridden by the JSF message bundle mechanism. Corresponding keys are;
Summary
Detail primefaces.captcha.INVALID
primefaces.captcha.INVALID_detail
Tips
• Use label option to provide readable error messages in case validation fails.
• Enable secure option to support https otherwise browsers will give warnings.
• See http://www.google.com/recaptcha/learnmore to learn more about how reCaptcha works.
59
PrimeFaces User Guide
3.12 Carousel
Carousel is a multi purpose component to display a set of data or general content with slide effects.
Info
Tag
Component Class
carousel org.primefaces.component.carousel.Carousel
Component Type
org.primefaces.component.Carousel
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.CarouselRenderer
org.primefaces.component.carousel.CarouselRenderer
Attributes
Name
id rendered binding value var numVisible firstVisible widgetVar circular vertical autoPlayInterval null null null
3
0 null false false
0 null
Default
true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
Object
An el expression that maps to a server side
UIComponent instance in a backing bean
A value expression that refers to a collection
String
Integer
Name of the request scoped iterator
Number of visible items per page
Integer
String
Index of the first element to be displayed
Name of the client side widget.
Boolean Sets continuous scrolling
Boolean Sets vertical scrolling
Integer Sets the time in milliseconds to have Carousel start
60
Name Default
pageLinks effect easing effectDuration
3 slide
Integer
String easeInOutCirc String
500 Integer dropdownTemplate.
{page} style null styleClass itemStyle itemStyleClass headerText footerText null null null null null
String
String
String
String
String
String
String
Type
PrimeFaces User Guide
Description
scrolling automatically after being initialized
Defines the number of page links of paginator.
Name of the animation, could be “fade” or “slide”.
Name of the easing animation.
Duration of the animation in milliseconds.
Template string for dropdown of paginator.
Inline style of the component..
Style class of the component..
Inline style of each item.
Style class of each item.
Label for header.
Label for footer.
Getting Started with Carousel
Carousel has two main use-cases; data and general content display. To begin with data iteration let’s use a list of cars to display with carousel.
public class Car { private String model; private int year; private String manufacturer; private String color;
...
} public class CarBean { private List<Car> cars; public CarListController() { cars = new ArrayList<Car>(); cars.add(new Car("myModel", 2005, "ManufacturerX", "blue"));
//add more cars
}
//getter setter
}
61
PrimeFaces User Guide
<p:carousel value="#{carBean.cars}" var="car" itemStyle="width:200px">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
<h:outputText value="Model: #{car.model}" />
<h:outputText value="Year: #{car.year}" />
<h:outputText value="Color: #{car.color}" />
</p:carousel>
Carousel iterates through the cars collection and renders it’s children for each car, note that you also need to define a width for each item.
Limiting Visible Items
Bu default carousel lists its items in pages with size 3. This is customizable with the rows attribute.
<p:carousel value="#{carBean.cars}" var="car" numVisible="1" itemStyle="width:200px" >
...
</p:carousel>
Effects
Paging happens with a slider effect by default and following easing options are supported.
• backBoth
• backIn
• backOut
• bounceBoth
• bounceIn
• bounceOut
• easeBoth
• easeBothStrong
• easeIn
• easeInStrong
• easeNone
• easeOut
• easeInOutCirc
• easeOutStrong
• elasticBoth
• elasticIn
• elasticOut
62
PrimeFaces User Guide
SlideShow
Carousel can display the contents in a slideshow, for this purpose autoPlayInterval and circular attributes are used. Following carousel displays a collection of images as a slideshow.
<p:carousel autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” >
<p:graphicImage value="/images/nature1.jpg"/>
<p:graphicImage value="/images/nature2.jpg"/>
<p:graphicImage value="/images/nature3.jpg"/>
<p:graphicImage value="/images/nature4.jpg"/>
</p:carousel>
Content Display
Another use case of carousel is tab based content display.
<p:carousel rows="1" itemStyle="height:200px;width:600px;">
<p:tab title="Godfather Part I">
<h:panelGrid columns="2" cellpadding="10">
<p:graphicImage value="/images/godfather/godfather1.jpg" />
<h:outputText value="The story begins as Don Vito ..." />
</h:panelGrid>
</p:tab>
<p:tab title="Godfather Part II">
<h:panelGrid columns="2" cellpadding="10">
<p:graphicImage value="/images/godfather/godfather2.jpg" />
<h:outputText value="Francis Ford Coppola's ..."/>
</h:panelGrid>
</p:tab>
<p:tab title="Godfather Part III">
<h:panelGrid columns="2" cellpadding="10">
<p:graphicImage value="/images/godfather/godfather3.jpg" />
<h:outputText value="After a break of ..." />
</h:panelGrid>
</p:tab>
</p:carousel>
63
PrimeFaces User Guide
Item Selection
Sample below selects an item from the carousel and displays details within a dialog.
<h:form id=”form">
<p:carousel value="#{carBean.cars}" var="car" itemStyle=”width:200px” >
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
<p:commandLink update=":form:detail" oncomplete="PF('dlg').show()">
<h:outputText value="Model: #{car.model}" />
<f:setPropertyActionListener value="#{car}" target="#{carBean.selected}" />
</p:commandLink>
</p:carousel>
<p:dialog widgetVar="dlg">
<h:outputText id="detail" value="#{carBean.selected}" />
</p:dialog>
</h:form> public class CarBean { private List<Car> cars; private Car selected;
//getters and setters
}
Header and Footer
Header and Footer of carousel can be defined in two ways either, using headerText and footerText options that take simple strings as labels or by header and footer facets that can take any custom content.
Client Side API
Widget: PrimeFaces.widget.Carousel
Method
next() prev() setPage() startAutoplay() stopAutoplay()
Params
-
index
-
-
Return Type
void void void void void
Description
Displays next page.
Displays previous page.
Displays page with given index.
Starts slideshow.
Stops slideshow.
64
PrimeFaces User Guide
Skinning
Carousel resides in a container element which style and styleClass options apply. itemStyle and
itemStyleClass attributes apply to each item displayed by carousel. Following is the list of structural style classes;
Style Class
.ui-carousel
.ui-carousel-header
.ui-carousel-header-title
.ui-carousel-viewport
.ui-carousel-button
.ui-carousel-next-button
.ui-carousel-prev-button
.ui-carousel-page-links
.ui-carousel-page-link
.ui-carousel-item
Applies
Main container
Header container
Header content
Content container
Navigation buttons
Next navigation button of paginator
Prev navigation button of paginator
Page links of paginator.
Each page link of paginator.
Each item.
As skinning style classes are global, see the main theming section for more information.
65
PrimeFaces User Guide
3.13 CellEditor
CellEditor is a helper component of datatable used for incell editing.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
cellEditor org.primefaces.component.celleditor.CellEditor
org.primefaces.component.CellEditor
org.primefaces.component
org.primefaces.component.CellEditorRenderer
org.primefaces.component.celleditor.CellEditorRenderer
Attributes
Name
id rendered binding
Default
null true
Type
String
Boolean null Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Getting Started with CellEditor
See inline editing section in datatable documentation for more information about usage.
66
PrimeFaces User Guide
3.14 Chart
Chart component is a generic graph component to create various types of charts using jqplot library.
Each chart type has its own subsection with code examples and section 3.12.10 documents the full charting API.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
chart org.primefaces.component.chart.Chart
org.primefaces.component.Chart
org.primefaces.component
org.primefaces.component.ChartRenderer
org.primefaces.component.chart.ChartRenderer
Attributes
Name
id rendered binding type model style styleClass widgetVar null null null null null null
Default
null true
Type
String
Boolean
Object
String
ChartModel
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Type of the chart.
Model object of data and settings.
Inline style of the component.
Style class of the component.
Name of the client side widget.
67
3.14.1 PieChart
PieChart is created with PieChartModel.
Basic
<p:chart type="pie" model="#{bean.model}" /> public class Bean { private PieChartModel model; public Bean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421); model.setTitle("Simple Pie"); model.setLegendPosition("w");
} public PieChartModel getModel() { return model;
}
}
PrimeFaces User Guide
Customized
<p:chart type="pie" model="#{bean.model}" />
68
public class Bean { private PieChartModel model; public Bean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421);
} model.setTitle("Custom Pie"); model.setLegendPosition("e"); model.setFill(false); model.setShowDataLabels(true); model.setDiameter(150); public PieChartModel getModel() { return model;
}
}
PrimeFaces User Guide
69
3.14.2 LineChart
LineChartModel is used to create a line chart.
Basic
<p:chart type="line" model="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();
LineChartSeries series1 = new LineChartSeries(); series1.setLabel("Series 1"); series1.set(1, 2); series1.set(2, 1); series1.set(3, 3); series1.set(4, 6); series1.set(5, 8);
LineChartSeries series2 = new LineChartSeries(); series2.setLabel("Series 2"); series2.set(1, 6); series2.set(2, 3); series2.set(3, 2); series2.set(4, 7); series2.set(5, 9);
} model.addSeries(series1); model.addSeries(series2); model.setTitle("Linear Chart"); model.setLegendPosition("e");
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(10); public LineChartModel getModel() { return model;
}
}
PrimeFaces User Guide
70
PrimeFaces User Guide
Customized
<p:chart type="line" model="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();
ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);
ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 90); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Category Chart"); model.setLegendPosition("e"); model.setShowPointLabels(true); model.getAxes().put(AxisType.X, new CategoryAxis("Years"));
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(200);
} public LineChartModel getModel() { return model;
}
}
71
Area
<p:chart type="line" model="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();
LineChartSeries boys = new LineChartSeries(); boys.setFill(true); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);
LineChartSeries girls = new LineChartSeries(); girls.setFill(true); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 90); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Area Chart"); model.setLegendPosition("ne"); model.setStacked(true); model.setShowPointLabels(true); model.getAxis(AxisType.X).setLabel("Years");
Axis yAxis = model.getAxis(AxisType.Y);
} yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(300); public CartesianChartModel getModel() { return model;
}
}
PrimeFaces User Guide
72
3.14.3 BarChart
BarChartModel is used to created a BarChart.
Basic
<p:chart type="bar" model="#{bean.model}" /> public class Bean { private BarChartModel model; public ChartBean() { model = new BarChartModel();
ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);
ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 135); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Bar Chart"); model.setLegendPosition("ne");
}
Axis xAxis = model.getAxis(AxisType.X); xAxis.setLabel("Gender");
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(200); public BarChartModel getModel() { return model; }
}
PrimeFaces User Guide
73
Horizontal and Stacked
<p:chart type="bar" model="#{bean.model}" /> public class Bean { private HorizontalBarChartModel model;
} public ChartBean() { model = new HorizontalBarChartModel();
ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 50); boys.set("2005", 96); boys.set("2006", 44); boys.set("2007", 55); boys.set("2008", 25);
ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 82); girls.set("2007", 35); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Horizontal and Stacked"); model.setLegendPosition("e"); model.setStacked(true);
Axis xAxis = model.getAxis(AxisType.X); xAxis.setLabel("Births"); xAxis.setMin(0); xAxis.setMax(200);
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Gender"); public HorizontalBarChartModel getModel() { return model; }
}
PrimeFaces User Guide
74
PrimeFaces User Guide
3.14.4 DonutChart
DonutChart is generated using DonutChartModel.
Basic
<p:chart type="donut" model="#{bean.model}" /> public class Bean { private DonutChartModel model; public ChartBean() { model = new DonutChartModel();
Map<String, Number> circle1 = new LinkedHashMap<String, Number>(); circle1.put("Brand 1", 150); circle1.put("Brand 2", 400); circle1.put("Brand 3", 200); circle1.put("Brand 4", 10); model.addCircle(circle1);
Map<String, Number> circle2 = new LinkedHashMap<String, Number>(); circle2.put("Brand 1", 540); circle2.put("Brand 2", 125); circle2.put("Brand 3", 702); circle2.put("Brand 4", 421); model.addCircle(circle2);
Map<String, Number> circle3 = new LinkedHashMap<String, Number>(); circle3.put("Brand 1", 40); circle3.put("Brand 2", 325); circle3.put("Brand 3", 402); circle3.put("Brand 4", 421); model.addCircle(circle3);
} model.setTitle("Donut Chart"); model.setLegendPosition("w"); public DonutChartModel getModel() { return model; }
}
75
PrimeFaces User Guide
Customized
<p:chart type="donut" model="#{bean.model}" /> public class Bean { private DonutChartModel model; public ChartBean() { model = new DonutChartModel();
Map<String, Number> circle1 = new LinkedHashMap<String, Number>(); circle1.put("Brand 1", 150); circle1.put("Brand 2", 400); circle1.put("Brand 3", 200); circle1.put("Brand 4", 10); model.addCircle(circle1);
Map<String, Number> circle2 = new LinkedHashMap<String, Number>(); circle2.put("Brand 1", 540); circle2.put("Brand 2", 125); circle2.put("Brand 3", 702); circle2.put("Brand 4", 421); model.addCircle(circle2);
Map<String, Number> circle3 = new LinkedHashMap<String, Number>(); circle3.put("Brand 1", 40); circle3.put("Brand 2", 325); circle3.put("Brand 3", 402); circle3.put("Brand 4", 421); model.addCircle(circle3);
} model.setTitle("Donut Chart"); model.setLegendPosition("w"); model.setTitle("Custom Options"); model.setLegendPosition("e"); model.setSliceMargin(5); model.setShowDataLabels(true); model.setDataFormat("value"); model.setShadow(false); public DonutChartModel getModel() { return model; }
}
76
PrimeFaces User Guide
3.14.5 BubbleChart
BubbleChart is created with a BubbleChartModel.
Basic
<p:chart type="bubble" model="#{bean.model}" /> public class Bean { private BubbleChartModel model; public ChartBean() { model = new BubbleChartModel(); model.add(new BubbleChartSeries("Acura", 70, 183,55)); model.add(new BubbleChartSeries("Alfa Romeo", 45, 92, 36)); model.add(new BubbleChartSeries("AM General", 24, 104, 40)); model.add(new BubbleChartSeries("Bugatti", 50, 123, 60)); model.add(new BubbleChartSeries("BMW", 15, 89, 25)); model.add(new BubbleChartSeries("Audi", 40, 180, 80)); model.add(new BubbleChartSeries("Aston Martin", 70, 70, 48));
} model.setTitle("Bubble Chart"); model.getAxis(AxisType.X).setLabel("Price");
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(250); yAxis.setLabel("Labels"); public BubbleChartModel getModel() { return model; }
}
77
PrimeFaces User Guide
Customized
<p:chart type="bubble" model="#{bean.model}" /> public class Bean { private BubbleChartModel model; public ChartBean() { model = new BubbleChartModel(); model.add(new BubbleChartSeries("Acura", 70, 183,55)); model.add(new BubbleChartSeries("Alfa Romeo", 45, 92, 36)); model.add(new BubbleChartSeries("AM General", 24, 104, 40)); model.add(new BubbleChartSeries("Bugatti", 50, 123, 60)); model.add(new BubbleChartSeries("BMW", 15, 89, 25)); model.add(new BubbleChartSeries("Audi", 40, 180, 80)); model.add(new BubbleChartSeries("Aston Martin", 70, 70, 48));
} model = initBubbleModel(); model.setTitle("Custom Options"); model.setShadow(false); model.setBubbleGradients(true); model.setBubbleAlpha(0.8); model.getAxis(AxisType.X).setTickAngle(-50);
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(250); yAxis.setTickAngle(50); public BubbleChartModel getModel() { return model; }
}
78
PrimeFaces User Guide
3.14.6 Ohlc Chart
OhlcChartModel is used to display Ohlc Charts.
Basic
<p:chart type="ohlc" model="#{bean.model}" /> public class Bean { private OhlcChartModel model; public ChartBean() {
ohlcModel = new OhlcChartModel();
ohlcModel.add(new OhlcChartSeries(2007, 143.82, 144.56, 136.04, 136.97));
ohlcModel.add(new OhlcChartSeries(2008, 138.7, 139.68, 135.18, 135.4));
ohlcModel.add(new OhlcChartSeries(2009, 143.46, 144.66, 139.79, 140.02));
ohlcModel.add(new OhlcChartSeries(2010, 140.67, 143.56, 132.88, 142.44));
ohlcModel.add(new OhlcChartSeries(2011, 136.01, 139.5, 134.53, 139.48));
ohlcModel.add(new OhlcChartSeries(2012, 124.76, 135.9, 124.55, 135.81));
ohlcModel.add(new OhlcChartSeries(2012, 123.73, 129.31, 121.57, 122.5));
ohlcModel.setTitle("OHLC Chart");
ohlcModel.getAxis(AxisType.X).setLabel("Year");
ohlcModel.getAxis(AxisType.Y).setLabel("Price Change $K/Unit");
} public OhlcChartModel getModel() { return model; }
}
79
PrimeFaces User Guide
Candlestick
<p:chart type="ohlc" model="#{bean.model}" /> public class Bean { private OhlcChartModel model; public ChartBean() {
model = new OhlcChartModel();
for( int i=1 ; i < 41 ; i++) {
ohlcModel2.add(new OhlcChartSeries(i, Math.random() * 80 + 80,
Math.random() * 50 + 110, Math.random() * 20 + 80, Math.random() * 80 + 80));
}
model.setTitle("Candlestick");
model.setCandleStick(true);
model.getAxis(AxisType.X).setLabel("Sector");
model.getAxis(AxisType.Y).setLabel("Index Value");
} public OhlcChartModel getModel() { return model; }
}
80
3.14.7 MeterGauge Chart
MeterGauge Chart is created using MeterGaugeChartModel.
Basic
<p:chart type="metergauge" model="#{bean.model}" /> public class Bean { private MeterGaugeChartModel model; public ChartBean() {
List<Number> intervals = new ArrayList<Number>(){{ add(20); add(50); add(120); add(220);
}}; model = new MeterGaugeChartModel(140, intervals); model.setTitle("MeterGauge Chart"); model.setGaugeLabel("km/h");
} public MeterGaugeChartModel getModel() { return model; }
}
PrimeFaces User Guide
Customized
<p:chart type="metergauge" model="#{bean.model}" />
81
public class Bean { private MeterGaugeChartModel model; public ChartBean() {
List<Number> intervals = new ArrayList<Number>(){{ add(20); add(50); add(120); add(220);
}};
} model = new MeterGaugeChartModel(140, intervals); model.setTitle("Custom Options"); model.setSeriesColors("66cc66,93b75f,E7E658,cc6666"); model.setGaugeLabel("km/h"); model.setGaugeLabelPosition("bottom"); model.setShowTickLabels(false); model.setLabelHeightAdjust(110); model.setIntervalOuterRadius(130); public MeterGaugeChartModel getModel() { return model; }
}
PrimeFaces User Guide
82
3.14.8 Combined Chart
On same graph, different series type can be displayed together.
Basic
<p:chart type="bar" model="#{bean.model}" /> public class Bean { private BarChartModel model; public ChartBean() { combinedModel = new BarChartModel();
BarChartSeries boys = new BarChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);
LineChartSeries girls = new LineChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 135); girls.set("2008", 120);
} model.addSeries(boys); model.addSeries(girls); model.setTitle("Bar and Line"); model.setLegendPosition("ne"); model.setMouseoverHighlight(false); model.setShowDatatip(false); model.setShowPointLabels(true);
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(200); public BarChartModel getModel() { return model; }
}
PrimeFaces User Guide
83
3.14.9 Multiple Axis
Up to 9 axes (xaxis-x9axis, yaxis-y9axis) can be displayed on the same chart.
Basic
<p:chart type="line" model="#{bean.model}" />
PrimeFaces User Guide public class Bean { private LineChartModel model; public ChartBean() { model = new LineChartModel();
BarChartSeries boys = new BarChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);
LineChartSeries girls = new LineChartSeries(); girls.setLabel("Girls"); girls.setXaxis(AxisType.X2); girls.setYaxis(AxisType.Y2); girls.set("A", 52); girls.set("B", 60); girls.set("C", 110); girls.set("D", 135); girls.set("E", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Multi Axis Chart"); model.setMouseoverHighlight(false); model.getAxes().put(AxisType.X, new CategoryAxis("Years")); model.getAxes().put(AxisType.X2, new CategoryAxis("Period"));
Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Birth"); yAxis.setMin(0); yAxis.setMax(200);
}
Axis y2Axis = new LinearAxis("Number"); y2Axis.setMin(0); y2Axis.setMax(200); model.getAxes().put(AxisType.Y2, y2Axis); public LineChartModel getModel() { return model; }
}
84
85
PrimeFaces User Guide
3.14.10 Date Axis
Use DateAxis if you are displaying dates in an axis.
Basic
<p:chart type="line" model="#{bean.model}" /> public class Bean { private LineChartModel model; public ChartBean() { dateModel = new LineChartModel();
LineChartSeries series1 = new LineChartSeries(); series1.setLabel("Series 1"); series1.set("2014-01-01", 51); series1.set("2014-01-06", 22); series1.set("2014-01-12", 65); series1.set("2014-01-18", 74); series1.set("2014-01-24", 24); series1.set("2014-01-30", 51);
LineChartSeries series2 = new LineChartSeries(); series2.setLabel("Series 2"); series2.set("2014-01-01", 32); series2.set("2014-01-06", 73); series2.set("2014-01-12", 24); series2.set("2014-01-18", 12); series2.set("2014-01-24", 74); series2.set("2014-01-30", 62);
} dateModel.addSeries(series1); dateModel.addSeries(series2); dateModel.setTitle("Zoom for Details"); dateModel.setZoom(true); dateModel.getAxis(AxisType.Y).setLabel("Values");
DateAxis axis = new DateAxis("Dates"); axis.setTickAngle(-50); axis.setMax("2014-02-01"); axis.setTickFormat("%b %#d, %y"); dateModel.getAxes().put(AxisType.X, axis); public LineChartModel getModel() { return model; }
}
PrimeFaces User Guide
86
PrimeFaces User Guide
3.14.11 Interactive Chart
Charts are interactive components, information about selected series and items can be passed via ajax to a JSF backing bean using ItemSelectEvent.
Basic
<p:chart type="pie" model="#{bean.model}">
<p:ajax event="itemSelect" listener="#{bean.itemSelect}" />
</p:chart> public class Bean { private PieChartModel model; public ChartBean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421);
} model.setTitle("Simple Pie"); model.setLegendPosition("w"); public PieChartModel getModel() { return model; } public void itemSelect(ItemSelectEvent event) {
FacesMessage msg = new FacesMessage(FacesMessage.SEVERITY_INFO,
"Item selected", "Item Index: " + event.getItemIndex() +
", Series Index:" + event.getSeriesIndex());
FacesContext.getCurrentInstance().addMessage(null, msg);
}
}
87
PrimeFaces User Guide
3.14.12 Export
Chart component provides a client side method to convert the graph to an image. Example below demonstrates how to use a button click to export the chart as an image and display it in a dialog so that users can download it as a regular image.
<p:chart type="line" model="#{bean.model}" style="width:500px;height:300px" widgetVar="chart"/>
<p:commandButton type="button" value="Export" icon="ui-icon-extlink" onclick="exportChart()"/>
<p:dialog widgetVar="dlg" showEffect="fade" modal="true" header="Chart as an Image">
<p:outputPanel id="output" layout="block" style="width:500px;height:300px"/>
</p:dialog> function exportChart() {
//export image
$('#output').empty().append(PF('chart').exportAsImage());
//show the dialog
PF('dlg').show();
}
88
PrimeFaces User Guide
3.14.13 Static Images
JFreeChart with GraphicImage component is an alternative to the chart component.
Basic
<p:graphicImage value="#{bean.chart}" /> public class Bean { private StreamedContent chart; public Bean() {
JFreeChart jfreechart = ChartFactory.createPieChart("Cities", createDataset(), true, true, false);
File chartFile = new File("dynamichart");
ChartUtilities.saveChartAsPNG(chartFile, jfreechart, 375, 300);
chart = new DefaultStreamedContent(new FileInputStream(chartFile),
"image/png");
} public StreamedContent getChart() { return model; } private PieDataset createDataset() {
DefaultPieDataset dataset = new DefaultPieDataset();
dataset.setValue("New York", new Double(45.0));
dataset.setValue("London", new Double(15.0));
dataset.setValue("Paris", new Double(25.2));
dataset.setValue("Berlin", new Double(14.8));
return dataset;
}
}
89
PrimeFaces User Guide
3.14.14 Skinning
Charts can be styled using regular css. Following is the list of style classes;
.jqplot-target
.jqplot-axis
Style Class
.jqplot-xaxis
.jqplot-yaxis
Plot target container.
Axes.
Primary x-axis.
Primary y-axis.
.jqplot-x2axis, .jqplot-x3axis ...
2nd, 3rd ... x-axis.
.jqplot-y2axis, .jqplot-y3axis ...
2nd, 3rd ... y-axis.
.jqplot-axis-tick Axis ticks.
.jqplot-xaxis-tick
.jqplot-x2axis-tick
Primary x-axis ticks.
Secondary x-axis ticks.
.jqplot-yaxis-tick
.jqplot-y2axis-tick table.jqplot-table-legend
.jqplot-title
.jqplot-cursor-tooltip
.jqplot-highlighter-tooltip div.jqplot-table-legend-swatch
Primary y-axis-ticks.
Seconday y-axis-ticks.
Legend table.
Title of the chart.
Cursor tooltip.
Highlighter tooltip.
Colors swatch of the legend.
Applies
Additionally style and styleClass options of chart component apply to the container element of charts, use these attribute to specify the dimensions of a chart.
<p:chart type="pie" model="#{bean.model}" style=”width:320px;height:200px” />
In case you’d like to change the colors of series, use the seriesColors option in ChartModel API.
90
PrimeFaces User Guide
3.14.15 Extender
Chart API provide high level access to commonly used jqplot options however there are many more customization options available in jqplot. Extender feature provide access to low level apis to do advanced customization by enhancing the configuration object, here is an example to increase shadow depth of the line series where model's extender property is set to "ext".
<p:chart type="line" model="#{bean.model}" /> function ext() {
//this = chart widget instance
//this.cfg = options this.cfg.seriesDefaults = { shadowDepth: 5
};
}
Refer to jqPlot docs for available options.
91
PrimeFaces User Guide
3.14.16 Chart API
Axis
org.primefaces.model.chart.Axis
Property
label min max tickAngle tickFormat tickInterval tickCount null null null null
Default Type
null null null
String
Object
Object
Integer
String
String
Description
Title of the axis.
Minimum boundary value.
Maximum boundary value.
Angle of text, measured clockwise.
Format string to use with the axis tick formatter
Number of units between ticks.
Integer Desired number of ticks.
AxisType
org.primefaces.model.chart.AxisType
AxisType is an enum to define the type of the axis from X-Y to X9-Y9.
BarChartModel
org.primefaces.model.chart.BarChartModel extends org.primefaces.model.chart.ChartModel
Property
barPadding barMargin stacked
Default Type
8 Integer
10 false
Integer
Boolean
Description
Padding between bars.
Margin between bars.
Displays series in stacked format.
BarChartSeries
org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries
Property
disableStack
Default Type
false Boolean
Description
When true, series data is not included in a stacked chart.
BubbleChartModel
org.primefaces.model.chart.BubbleChartModel extends org.primefaces.model.chart.ChartModel
Property
data
Default Type
null
Description
List<BubbleChartSeries> Data as a list of BubbleChartSeries.
bubbleGradients false bubbleAlpha 1.0
showLabels true
Boolean
Double
Boolean
Displays bubbles with gradients.
Opacity of bubbles.
Displays label of a series inside a bubble.
92
PrimeFaces User Guide
BubbleChartSeries
org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries
Property
x y radius label
Default Type
null Integer null null null
Integer
Integer
String
Description
X-Axis value of the bubble.
Y-Axis value of the bubble.
Radius of the bubble.
Label text of the bubble.
CartesianChartModel
org.primefaces.model.chart.CartesianChartModel
Property
series axes zoom animate showDatatip datatipFormat showPointLabels
Default Type
null List<ChartSeries>
Description
List of series.
HashMap Map<AxisType,Axis> Map of chart axis.
false false true
Boolean
Boolean
Boolean
Adds zoom feature when enabled.
When enabled, series are drawn with an effect.
Displays a tooltip on hover.
null false
String
Boolean
Format of the data tooltip.
Displays data inline in plot.
CategoryAxis
org.primefaces.model.chart.CategoryAxis extends org.primefaces.model.chart.Axis
CategoryAxis is used when data on the axis does not consists of numbers.
ChartModel
org.primefaces.model.chart.ChartModel
Property
title shadow seriesColors
Default Type
null true null
String
String
Description
Title text for the plot
Boolean To show shadow or not on series.
Comma separated list of series colors e.g. "#4BB2C5",
"CCCCC" negativeSeriesColors null legendPosition null legendCols 0
String
String
Similar to seriesColors but for negative values.
Position of the legend like "n" or "ne".
Integer Maximum number of columns in the legend.
legendRows legendPlacement
0 null mouseoverHighlight true extender null
Integer Maximum number of rows in the legend.
Enum Defines the location of the legend.
Boolean Highlights series on hover.
String Name of javascript function to extend chart with.
ChartSeries
org.primefaces.model.chart.ChartSeries
93
Property
label data xaxis yaxis
PrimeFaces User Guide
Default Type
null String null
Description
Title text of the series.
Map<Object,Number> Data of the series as a map.
null null
AxisType
AxisType
X-Axis of the series.
Y-Axis of the series.
DateAxis
org.primefaces.model.chart.DateAxis extends org.primefaces.model.chart.Axis
DateAxis is used when data on the axis consists of string representations of date values.
DonutChartModel
org.primefaces.model.chart.DonutChartModel extends org.primefaces.model.chart.ChartModel
Property
data sliceMargin fill
Default
null
0 true
Type
List>Map<String,Object>> Data as a list of map instances.
Integer
Boolean showDataLabels false dataFormat percent
Boolean
String
Description
Angular spacing between pie slices in degrees.
True or False to fill the slices.
True to False show data labels on slices.
Either ‘label’, ‘value’, ‘percent’ or an array of labels to place on the pie slices.
HorizontalBarChartModel
org.primefaces.model.chart.HorizontalBarChartModel extends
org.primefaces.model.chart.BarChartModel
HorizontalBarChartModel is an extension to BarChartModel with y-axis used for the categories and x-axis for the data values.
LineChartSeries
org.primefaces.model.chart.LineChartSeries extends org.primefaces.model.chart.ChartSeries
Property Default
markerStyle filledCircle showLine true showMarker true fill false fillAlpha 1 disableStack false
Type
String
Boolean
Boolean
Boolean
Double
Boolean
Description
Style of the markers, valid values are diamond, circle, square,
x, plus, dash, filledDiamond, filledCircle, filledSquare.
Whether to actually draw the line or not.
Displays markes at data points.
Fills the area between lines.
Opacity of the filled area.
When true, series data is not included in a stacked chart.
LinearAxis
org.primefaces.model.chart.LinearAxis extends org.primefaces.model.chart.Axis
LinearAxis is the Axis implementation used to display numbers.
94
PrimeFaces User Guide
LineChartModel
org.primefaces.model.chart.LineChartModel extends
org.primefaces.model.chart.CartesianChartModel
Property
stacked breakOnNull
Default Type
null List<ChartSeries>
Description
Displays series in stacked format.
HashMap Map<AxisType,Axis> Discontinues line plot for null values.
MeterGaugeChartModel
org.primefaces.model.chart.MeterGaugeChartModel extends
org.primefaces.model.chart.ChartModel
Property
value intervals ticks gaugeLabel gaugeLabelPosition false min null max null showTickLabels true intervalInnerRadius null intervalOuterRadius 85 labelHeightAdjust -25
Default Type
null Number null
0 true
Description
Value of the gauge.
List<Number> List of ranges to be drawn around the gauge.
List<Number> List of tick values.
String Label text of the gauge.
String
Double
Double
Boolean
Integer
Integer
Integer
Where to position the label, either ‘inside’ or ‘bottom’.
Minimum value on the gauge.
Minimum value on the gauge.
Displays tick labels next to ticks.
Radius of the inner circle of the interval ring.
Radius of the outer circle of the interval ring.
Number of Pixels to offset the label up (-) or down (+) from its default position.
OhlcChartModel
org.primefaces.model.chart.OhlcChartModel extends org.primefaces.model.chart.ChartModel
Property
data candleStick
Default Type
null
Description
List<OhlcChartSeries> Data as a list of OhlChartSeries.
false Boolean Displays series as candlestick.
OhlcChartSeries
org.primefaces.model.chart.OhlcChartSeries extends org.primefaces.model.chart.ChartSeries
Property
value open high low close
Default Type
null null
Description
List<OhlcChartSeries> Data as a list of OhlChartSeries.
Double Open value.
null null null
Double
Double
Double
High value.
Low value.
Close value.
PieChartModel
org.primefaces.model.chart.PieChartModel extends org.primefaces.model.chart.ChartModel
95
PrimeFaces User Guide
Property
data diameter
Default Type
null Map<String,Object>
Description
Data as a Map instance.
null Integer Outer diameter of the pie, auto computed by default sliceMargin fill
0 true
Integer
Boolean showDataLabels false dataFormat percent
Boolean
String
Angular spacing between pie slices in degrees.
True or False to fill the slices.
True to False show data labels on slices.
Either ‘label’, ‘value’, ‘percent’ or an array of labels to place on the pie slices.
96
PrimeFaces User Guide
3.15 Clock
Clock displays server or client datetime live.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
clock org.primefaces.component.clock.Clock
org.primefaces.component.Clock
org.primefaces.component
org.primefaces.component.ClockRenderer
org.primefaces.component.clock.ClockRenderer
Attributes
id rendered
Name
binding pattern mode autoSync syncInterval
Default
null true null null client false
60000
Type
String
Boolean
Object
String
String
Boolean
Integer
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Datetime format.
Mode value, valid values are client and server.
Syncs time periodically in server mode.
Defines the sync in ms interval in autoSync setting.
Getting Started with Clock
Clock has two modes, client (default) and server. In simples mode, datetime is displayed by just adding component on page. On page load, clock is initialized and start running based on client time.
<p:clock />
97
PrimeFaces User Guide
Server Mode
In server mode, clock initialized itself with the server’s datetime and starts running on client side.
To make sure client clock and server clock is synced, you can enable autoSync option that makes an ajax call to the server periodically to refresh the server time with client.
DateTime Format
Datetime format used can be changed using pattern attribute.
<p:clock pattern="HH:mm:ss dd.MM.yyyy" />
Skinning
Clock resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
.ui-clock
Style Class
Container element.
Applies
98
PrimeFaces User Guide
3.16 Collector
Collector is a simple utility to manage collections declaratively.
Info
Tag
ActionListener Class
collector org.primefaces.component.collector.Collector
Attributes
Name
value
Default
null addTo null removeFrom null unique true
Type
Object java.util.Collection
java.util.Collection
Boolean
Description
Value to be used in collection operation
Reference to the Collection instance
Reference to the Collection instance
When enabled, rejects duplicate items on addition.
Getting started with Collector
Collector requires a collection and a value to work with. It’s important to override equals and hashCode methods of the value object to make collector work.
public class BookBean { private Book book = new Book(); private List<Book> books; public CreateBookBean() { books = new ArrayList<Book>();
}
//getters and setters
}
<p:commandButton value="Add">
<p:collector value="#{bookBean.book}" addTo="#{bookBean.books}" />
</p:commandButton>
<p:commandLink value="Remove">
<p value="#{book}" removeFrom="#{createBookBean.books}" />
</p:commandLink>
99
PrimeFaces User Guide
3.17 Color Picker
ColorPicker is an input component with a color palette.
Info
Tag
colorPicker
Component Class
Component Type
org.primefaces.component.colorpicker.ColorPicker
org.primefaces.component.ColorPicker
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.ColorPickerRenderer
org.primefaces.component.colorpicker.ColorPickerRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null false false null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Object
Converter/Str ing
Boolean
Value of the component.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required.
MethodExpr A method expression that refers to a method for validation the input.
100
Name Default
valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar mode style styleClass null null null null popup null null
PrimeFaces User Guide
Type
ValueChange
Listener
String
String
String
String
String
String
String
Description
A method binding expression that refers to a method for handling a valuchangeevent.
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Display mode, valid values are “popup” and
“inline”.
Inline style of the component.
Style class of the component.
Getting started with ColorPicker
ColorPicker’s value should be a hex string.
public class Bean { private String color; public String getColor() { return this.color;
} public void setColor(String color) { this.color = color;
}
}
<p:colorPicker value="#{bean.color}" />
Display Mode
ColorPicker has two modes, default mode is popup and other available option is inline.
<p:colorPicker value="#{bean.color}" mode="inline"/>
101
PrimeFaces User Guide
Skinning
ColorPicker resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-colorpicker
.ui-colorpicker_color
.ui-colorpicker_hue
.ui-colorpicker_new_color
Container element.
Background of gradient.
Hue element.
New color display.
.ui-colorpicker_current_color Current color display.
.ui-colorpicker-rgb-r Red input.
.ui-colorpicker-rgb-g
.ui-colorpicker-rgb-b
Greed input.
Blue input.
.ui-colorpicker-rgb-h
.ui-colorpicker-rgb-s
.ui-colorpicker-rgb-b
.ui-colorpicker-rgb-hex
Hue input.
Saturation input.
Brightness input.
Hex input.
Applies
102
PrimeFaces User Guide
3.18 Column
Column is an extended version of the standard column used by various components like datatable, treetable and more.
Info
Tag
Component Class
Component Type
column org.primefaces.component.column.Column
org.primefaces.component.Column
Component Family
org.primefaces.component
Attributes
id
Name
rendered
Default
null true
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding null style styleClass sortBy sortFunction filterBy filterStyle filterStyleClass filterOptions null null null null null null null null filterMatchMode startsWith String rowspan 1 Integer colspan 1 Integer headerText footerText null null selectionMode null disabledSelection false
String
String
String
Boolean
Object
String
String
ValueExpr
An el expression that maps to a server side
UIComponent instance in a backing bean
Inline style of the column.
Style class of the column.
ValueExpression to be used for sorting.
MethodExpr Custom pluggable sortFunction.
ValueExpr ValueExpression to be used for filtering.
String Inline style of the filter element
String
Object
Style class of the filter element
A collection of selectitems for filter dropdown.
Match mode for filtering.
Defines the number of rows the column spans.
Defines the number of columns the column spans.
Shortcut for header facet.
Shortcut for footer facet.
Enables selection mode.
Disables row selection.
103
PrimeFaces User Guide
Name Default
filterMaxLength null resizable true width exportable filterValue toggleable filterFunction field null true null true null null
Type
Integer
Boolean
Description
Maximum number of characters for an input filter.
Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option.
Width in pixels or percentage.
String
Boolean
Object
Boolean
Defines if the column should be exported by dataexporter.
Value of the filter field.
Defines if panel is toggleable by columnToggler component. Default value is true and a false value marks the column as static.
MethodExpr Custom implementation to filter a value against a constraint.
String Name of the field to pass lazy load method for filtering and sorting. If not specified, filterBy-sortBy values are used to identify the field name.
Getting Started with Column
As column is a reused component, see documentation of components that use a column.
Note
Not all attributes of column are implemented by the components that utilize column.
104
PrimeFaces User Guide
3.19 Columns
Columns is used by datatable to create columns dynamically.
Info
Tag
Component Class
columns org.primefaces.component.column.Columns
Component Type
org.primefaces.component.Columns
Component Family
org.primefaces.component
Attributes
id
Name
rendered binding value var style styleClass sortBy sortFunction filterBy filterStyle
Default
null true null null null null null null null null null filterStyleClass null filterOptions null
String
Object filterMatchMode startsWith String rowspan 1 Integer colspan headerText footerText
1 null null
Integer
String
String
Type
String
Boolean
Description
Unique identifier of the component
Object
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Data to represent columns.
Object
String
String
String
ValueExpr
Name of iterator to access a column.
Inline style of the column.
Style class of the column.
ValueExpression to be used for sorting.
MethodExpr Custom pluggable sortFunction.
ValueExpr ValueExpression to be used for filtering.
String Inline style of the filter element
Style class of the filter element
A collection of selectitems for filter dropdown.
Match mode for filtering.
Defines the number of rows the column spans.
Defines the number of columns the column spans.
Shortcut for header facet.
Shortcut for footer facet.
105
Name Default
filterMaxLength null resizable true width exportable columnIndexVar filterValue toggleable filterFunction field null true null null true null null
PrimeFaces User Guide
Type
Integer
Boolean
Description
Maximum number of characters for an input filter.
Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option.
Width in pixels or percentage.
String
Boolean
String
Object
Defines if the column should be exported by dataexporter.
Name of iterator to refer each index.
Value of the filter field.
Boolean Defines if panel is toggleable by columnToggler component. Default value is true and a false value marks the column as static.
MethodExpr Custom implementation to filter a value against a constraint.
String Name of the field to pass lazy load method for filtering and sorting. If not specified, filterBy-sortBy values are used to identify the field name.
Getting Started with Columns
See dynamic columns section in datatable documentation for detailed information.
106
3.20 ColumnGroup
ColumnGroup is used by datatable for column grouping.
Info
Tag
Component Class
columnGroup org.primefaces.component.columngroup.ColumnGroup
Component Type
org.primefaces.component. ColumnGroup
Component Family
org.primefaces.component
PrimeFaces User Guide
Attributes
Name
id rendered binding type
Default
null true
String
Type
Boolean null null
Object
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Type of group, valid values are “header” and “footer”.
Getting Started with ColumnGroup
See grouping section in datatable documentation for detailed information.
107
PrimeFaces User Guide
3.21 CommandButton
CommandButton is an extended version of standard commandButton with ajax and theming.
Info
Tag
commandButton
Component Class
org.primefaces.component.commandbutton.CommandButton
Component Type
org.primefaces.component.CommandButton
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.CommandButtonRenderer
org.primefaces.component.commandbutton.CommandButtonRenderer
Attributes
Name
id rendered binding value action actionListener immediate type ajax async process update
Default
null true
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null null null false
Object
String
MethodExpr/
String
An el expression that maps to a server side UIComponent instance in a backing bean
Label for the button
A method expression or a String outcome that’d be processed when button is clicked.
MethodExpr An actionlistener that’d be processed when button is clicked.
Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
submit String true Boolean false null null
Boolean
String
String
Sets the behavior of the button.
Specifies the submit mode, when set to true(default), submit would be made with Ajax.
When set to true, ajax requests are not queued.
Component(s) to process partially instead of whole view.
Component(s) to be updated with ajax.
108
onstart
Name
oncomplete onsuccess onerror global delay partialSubmit resetValues false false ignoreAutoUpdate false timeout style styleClass onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup
Default
null
Type
String null null null true null
String
String
String
Boolean
String
0 null null null null null null null null null null
Boolean
Boolean
Boolean
Integer
String
String
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
Client side callback to execute before ajax request is begins.
Client side callback to execute when ajax request is completed.
Client side callback to execute when ajax request succeeds.
Client side callback to execute when ajax request fails.
Defines whether to trigger ajaxStatus or not.
If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Enables serialization of values belonging to the partially processed components only.
If true, local values of input components to be updated within the ajax request would be reset.
If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Timeout for the ajax request in milliseconds.
Inline style of the button element.
StyleClass of the button element.
Client side callback to execute when button loses focus.
Client side callback to execute when button loses focus and its value has been modified since gaining focus.
Client side callback to execute when button is clicked.
Client side callback to execute when button is double clicked.
Client side callback to execute when button receives focus.
Client side callback to execute when a key is pressed down over button.
Client side callback to execute when a key is pressed and released over button.
Client side callback to execute when a key is released over button.
109
null null null false null null null null null false null left false true null null null null
Default
null
Type
String null null
String
String
String
String
String
String
String
String
Boolean
String
String
String
Integer
String
Boolean
String
String
String
Boolean
String
Name
onmousedown onmousemove onmouseout onmouseover onmouseup onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos inline escape widgetVar
PrimeFaces User Guide
Description
Client side callback to execute when a pointer button is pressed down over button.
Client side callback to execute when a pointer button is moved within button.
Client side callback to execute when a pointer button is moved away from button.
Client side callback to execute when a pointer button is moved onto button.
Client side callback to execute when a pointer button is released over button.
Client side callback to execute when text within button is selected by user.
Access key that when pressed transfers focus to the button.
Alternate textual description of the button.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables the button.
Style class for the button icon. (deprecated: use icon)
A localized user presentable name.
Code describing the language used in the generated markup for this component.
Position of the button element in the tabbing order.
Advisory tooltip information.
Flag indicating that this component will prevent changes by the user.
Icon of the button as a css class.
Position of the icon.
Used by PrimeFaces mobile only.
Defines whether label would be escaped or not.
Name of the client side widget.
110
PrimeFaces User Guide
Getting started with CommandButton
CommandButton usage is similar to standard commandButton, by default commandButton submits its enclosing form with ajax.
<p:commandButton value="Save" actionListener="#{bookBean.saveBook}" /> public class BookBean {
public void saveBook() {
//Save book
}
}
Reset Buttons
Reset buttons do not submit the form, just resets the form contents.
<p:commandButton type="reset" value="Reset" />
Push Buttons
Push buttons are used to execute custom javascript without causing an ajax/non-ajax request. To create a push button set type as "button".
<p:commandButton type="button" value="Alert" onclick="alert(‘Prime’)" />
AJAX and Non-AJAX
CommandButton has built-in ajax capabilities, ajax submit is enabled by default and configured using ajax attribute. When ajax attribute is set to false, form is submitted with a regular full page refresh.
T h e update attribute is used to partially update other component(s) after the ajax response is received. Update attribute takes a comma or white-space separated list of JSF component ids to be updated. Basically any JSF component, not just PrimeFaces components should be updated with the
Ajax response. In the following example, form is submitted with ajax and display outputText is updated with the ajax response.
<h:form>
<h:inputText value="#{bean.text}" />
<p:commandButton value="Submit" update="display"/>
<h:outputText value="#{bean.text}" id="display" />
</h:form>
Tip: You can use the ajaxStatus component to notify users about the ajax request.
111
PrimeFaces User Guide
Icons
An icon on a button is provided using icon option. iconPos is used to define the position of the button which can be “left” or “right”.
<p:commandButton value="With Icon" icon="disk"/>
<p:commandButton icon="disk"/>
.disk is a simple css class with a background property;
.disk { background-image: url(‘disk.png’) !important;
}
You can also use the pre-defined icons from ThemeRoller like ui-icon-search.
Client Side API
Widget: PrimeFaces.widget.CommandButton
Method
disable() enable()
Params
-
-
Return Type
void void
Description
Disables button
Enables button
Skinning
CommandButton renders a button tag which style and styleClass applies. Following is the list of structural style classes;
Style Class
.ui-button
.ui-button-text-only
.ui-button-text
Applies
Button element
Button element when icon is not used
Label of button
As skinning style classes are global, see the main theming section for more information.
112
PrimeFaces User Guide
3.22 CommandLink
CommandLink extends standard JSF commandLink with Ajax capabilities.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
commandLink org.primefaces.component.commandlink.CommandLink
org.primefaces.component.CommandLink
org.primefaces.component
org.primefaces.component.CommandLinkRenderer
org.primefaces.component. commandlink.CommandLinkRenderer
Attributes
Name
id rendered async process ajax update onstart binding value action actionListener immediate
Default
null true null null null null false false null true null null
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side
UIComponent instance in a backing bean
Href value of the rendered anchor.
MethodExpr/
String
A method expression or a String outcome that’d be processed when link is clicked.
MethodExpr An actionlistener that’d be processed when link is clicked.
Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
Boolean
String
Boolean
String
String
When set to true, ajax requests are not queued.
Component(s) to process partially instead of whole view.
Specifies the submit mode, when set to true(default), submit would be made with Ajax.
Component(s) to be updated with ajax.
Client side callback to execute before ajax request is begins.
113
style styleClass onblur onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove oncomplete onsuccess onerror global delay
Name
partialSubmit resetValues false false ignoreAutoUpdate false timeout
Default
null
Type
String null null true null
String
String
Boolean
String
0
Boolean
Boolean
Boolean
Integer
PrimeFaces User Guide
Description
Client side callback to execute when ajax request is completed.
Client side callback to execute when ajax request succeeds.
Client side callback to execute when ajax request fails.
Defines whether to trigger ajaxStatus or not.
If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Enables serialization of values belonging to the partially processed components only.
If true, local values of input components to be updated within the ajax request would be reset.
If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Timeout for the ajax request in milliseconds.
null null null null null null null null null null null
String
String
String
String
String
String
String
String
String
String
String
Style to be applied on the anchor element
StyleClass to be applied on the anchor element
Client side callback to execute when link loses focus.
Client side callback to execute when link is clicked.
Client side callback to execute when link is double clicked.
Client side callback to execute when link receives focus.
Client side callback to execute when a key is pressed down over link.
Client side callback to execute when a key is pressed and released over link.
Client side callback to execute when a key is released over link.
Client side callback to execute when a pointer button is pressed down over link.
Client side callback to execute when a pointer button is moved within link.
114
coords dir disabled hreflang rel
Name
onmouseout onmouseover onmouseup accesskey charset rev shape tabindex target title type null null null null null null null null null null null
Default
null
Type
String null null null null
String
String
String
String
String
String
Boolean
String
String
String
String
Integer
String
String
String
PrimeFaces User Guide
Description
Client side callback to execute when a pointer button is moved away from link.
Client side callback to execute when a pointer button is moved onto link.
Client side callback to execute when a pointer button is released over link.
Access key that when pressed transfers focus to the link.
Character encoding of the resource designated by this hyperlink.
Position and shape of the hot spot on the screen for client use in image maps.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables the link
Languae code of the resource designated by the link.
Relationship from the current document to the anchor specified by the link, values are provided by a spaceseparated list of link types.
A reverse link from the anchor specified by this link to the current document, values are provided by a spaceseparated list of link types.
Shape of hot spot on the screen, valid values are default, rect, circle and poly.
Position of the button element in the tabbing order.
Name of a frame where the resource targeted by this link will be displayed.
Advisory tooltip information.
Type of resource referenced by the link.
Getting Started with CommandLink
CommandLink is used just like the standard h:commandLink, difference is form is submitted with ajax by default.
public class BookBean {
public void saveBook() {
//Save book
}
}
115
PrimeFaces User Guide
<p:commandLink actionListener="#{bookBean.saveBook}">
<h:outputText value="Save" />
</p:commandLink>
Skinning
CommandLink renders an html anchor element that style and styleClass attributes apply.
116
PrimeFaces User Guide
3.23 Confirm
Confirm is a behavior element used to integrate with global confirm dialog.
Info
Tag
Behavior Id
confirm org.primefaces.behavior.ConfirmBehavior
Attributes
Name
header message icon
Default
null null null
String
String
String
Type
Getting started with Confirm
See global confirm dialog topic in next section for details.
Description
Header of confirm dialog.
Message to display in confirm dialog.
Icon to display next to message.
117
PrimeFaces User Guide
3.24 ConfirmDialog
ConfirmDialog is a replacement to the legacy javascript confirmation box. Skinning, customization and avoiding popup blockers are notable advantages over classic javascript confirmation.
Info
Tag
Component Class
Component Type
confirmDialog org.primefaces.component.confirmdialog.ConfirmDialog
org.primefaces.component.ConfirmDialog
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ConfirmDialogRenderer
Renderer Class
org.primefaces.component.confirmdialog.ConfirmDialogRenderer
Attributes
Name
id rendered binding widgetVar message header severity width height style styleClass auto auto null null null null null null
Default
null true null
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
String
String
String
An el expression that maps to a server side UIComponent instance in a backing bean
Name of the client side widget.
Text to be displayed in body.
Text for the header.
Message severity for the displayed icon.
Integer Width of the dialog in pixels
Integer Width of the dialog in pixels
String
String
Inline style of the dialog container.
Style class of the dialog container
118
Name
closable appendTo visible showEffect hideEffect closeOnEscape dir global false null null false ltr false
Default
true false
PrimeFaces User Guide
Type Description
Boolean Defines if close icon should be displayed or not
Boolean Appends the dialog to the element defined by the given search expression.
Boolean Whether to display confirm dialog on load.
String
String
Effect to use on showing dialog.
Effect to use on hiding dialog.
Boolean Defines if dialog should hide on escape key.
String Defines text direction, valid values are ltr and rtl.
Boolean When enabled, confirmDialog becomes a shared for other components that require confirmation.
Getting started with ConfirmDialog
ConfirmDialog has two modes; global and non-global. Non-Global mode is almost same as the dialog component used with a simple client side api, show() and hide().
<h:form>
<p:commandButton type="button" onclick="PF('cd').show()" />
<p:confirmDialog message="Are you sure about destroying the world?" header="Initiating destroy process" severity="alert" widgetVar="cd">
<p:commandButton value="Yes Sure" actionListener="#{buttonBean.destroyWorld}" update="messages" oncomplete="PF('cd').hide()"/>
<p:commandButton value="Not Yet" onclick="PF('cd').hide();" type="button" />
</p:confirmDialog>
</h:form>
Message and Severity
Message can be defined in two ways, either via message option or message facet. Message facet is useful if you need to place custom content instead of simple text. Note that header can also be defined using the header attribute or the header facet. Severity defines the icon to display next to the message, default severity is alert and the other option is info.
<p:confirmDialog widgetVar="cd" header=”Confirm”>
<f:facet name="message">
<h:outputText value="Are you sure?" />
</f:facet>
//content
</p:confirmDialog>
Global
Creating a confirmDialog for a specific action is a repetitive task, to solve this global confirmDialog which is a singleton has been introduced. Trigger components need to have p:confirm behavior to
119
PrimeFaces User Guide use the confirm dialog. Component that trigger the actual command in dialog must have ui-confirm-
dialog-yes style class, similarly component to cancel the command must have ui-confirm-dialog-no.
At the moment p:confirm is supported by p:commandButton and p:commandLink.
<p:growl id="messages" />
<p:commandButton value="Save" actionListener="#{bean.save}" update="messages">
<p:confirm header="Confirmation" message="Sure?" icon="ui-icon-alert"/>
</p:commandButton>
<p:confirmDialog global="true">
<p:commandButton value="Yes" type="button" styleClass="ui-confirmdialog-yes" icon="ui-icon-check"/>
<p:commandButton value="No" type="button" styleClass="ui-confirmdialog-no" icon="ui-icon-close"/>
</p:confirmDialog>
Client Side API
Widget: PrimeFaces.widget.ConfirmDialog show() hide()
Method Params
-
-
Return Type
void void
Description
Displays dialog.
Closes dialog.
Skinning
ConfirmDialog resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-dialog
.ui-dialog-titlebar
.ui-dialog-title
.ui-dialog-titlebar-close
.ui-dialog-content
.ui-dialog-buttonpane
Container element of dialog
Applies
Title bar
Header text
Close icon
Dialog body
Footer button panel
120
3.25 ContentFlow
ContentFlow is a horizontal content gallery component with a slide animation.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
contentFlow org.primefaces.component.contentflow.ContentFlow
org.primefaces.component.ContentFlow
org.primefaces.component
org.primefaces.component.ContentFlowRenderer
org.primefaces.component.contentflow.ContentFlowRenderer
Attributes
id rendered
Name
binding widgetVar value var style styleClass null null null null null null
Default
null true
Type
String
Boolean
Object
String
String
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Name of the client side widget.
Collection of items to display.
Name of the iterator to display an item.
Inline style of the component.
Style class of the component.
121
PrimeFaces User Guide
Getting Started with ContentFlow
ContentFlow requires content as children that can either be defined dynamically using iteration or one by one. Each item must have the content style class applied as well.
Static Images
<p:contentFlow>
<p:graphicImage value="/images/photo1.jpg" styleClass="content" />
<p:graphicImage value="/images/photo2.jpg" styleClass="content" />
<p:graphicImage value="/images/photo2.jpg" styleClass="content" />
</p:contentFlow>
Dynamic Images
<p:contentFlow var="image" value="#{bean.images}">
<p:graphicImage value="/images/#{image}" styleClass="content" />
</p:contentFlow>
Caption
To present a caption along with an item, embed a div with "caption" style class inside.
<p:contentFlow var="image" value="#{bean.images}">
<p:graphicImage value="#{image.path}" styleClass="content" />
<div class="caption">#{image.title}</div>
</p:contentFlow>
Skinning
ContentFlow resides in a container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Applies Style Class
.ui-contentflow
.flow
.item
.caption
Container element.
Container of item list
Item container
Caption element
122
3.26 ContextMenu
ContextMenu provides an overlay menu displayed on mouse right-click event.
PrimeFaces User Guide
Info
Tag
Component Class
contextMenu org.primefaces.component.contextmenu.ContextMenu
Component Type
org.primefaces.component.ContextMenu
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.ContextMenuRenderer
org.primefaces.component.contextmenu.ContextMenuRenderer
Attributes
id
Name
rendered binding widgetVar for style styleClass model nodeType event beforeShow selectionMode
Default
null true null null null null null null null null null multiple
Type
String
Boolean
Description
Unique identifier of the component
Object
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Name of the client side widget.
String
String
String
Id of the component to attach to
Style of the main container element
String Style class of the main container element
MenuModel Menu model instance to create menu programmatically.
String
String
String
String
Specific type of tree nodes to attach to.
Event to bind contextMenu display, default is contextmenu aka right click.
Client side callback to execute before showing.
Defines the selection behavior, e.g "single" or "multiple".
123
PrimeFaces User Guide
Getting started with ContextMenu
ContextMenu is created with submenus and menuitems. Optional for attribute defines which component the contextMenu is attached to. When for is not defined, contextMenu is attached to the page meaning, right-click on anywhere on page will display the menu.
<p:contextMenu>
<p:menuitem value="Save" actionListener="#{bean.save}" update="msg"/>
<p:menuitem value="Delete" actionListener="#{bean.delete}" ajax="false"/>
<p:menuitem value="Go Home" url= " " target="_blank"/>
</p:contextMenu
ContextMenu example above is attached to the whole page and consists of three different menuitems with different use cases. First menuitem triggers an ajax action, second one triggers a non-ajax action and third one is used for navigation.
Attachment
ContextMenu can be attached to any JSF component, this means right clicking on the attached component will display the contextMenu. Following example demonstrates an integration between contextMenu and imageSwitcher, contextMenu here is used to navigate between images.
<p:imageSwitch id="images" widgetVar="gallery" slideshowAuto="false">
<p:graphicImage value="/images/nature1.jpg" />
<p:graphicImage value="/images/nature2.jpg" />
<p:graphicImage value="/images/nature3.jpg" />
<p:graphicImage value="/images/nature4.jpg" />
</p:imageSwitch>
<p:contextMenu for="images">
<p:menuitem value="Previous" url="#" onclick="PF('gallery').previous()" />
<p:menuitem value="Next" url="#" onclick="PF('gallery').next()" />
</p:contextMenu>
Now right-clicking anywhere on an image will display the contextMenu like;
Data Components
Data components like datatable, tree and treeTable has special integration with context menu, see the documentation of these component for more information.
124
PrimeFaces User Guide
Dynamic Menus
ContextMenus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
ContextMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-contextmenu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Applies
Container element of menu
List container
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
125
PrimeFaces User Guide
3.27 Dashboard
Dashboard provides a portal like layout with drag&drop based reorder capabilities.
Info
Tag
Component Class
dashboard org.primefaces.component.dashboard.Dashboard
Component Type
org.primefaces.component.Dashboard
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.DashboardRenderer
org.primefaces.component.dashboard.DashboardRenderer
Attributes
Name
id rendered binding widgetVar model disabled style styleClass
Default
null true null null null false null null
Type
String
Boolean
Object
String
Dashboard
Model
Boolean
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget
Dashboard model instance representing the layout of the UI.
Disables reordering feature.
Inline style of the dashboard container
Style class of the dashboard container
126
Getting started with Dashboard
Dashboard is backed by a DashboardModel and consists of panel components.
PrimeFaces User Guide
<p:dashboard model="#{bean.model}">
<p:panel id="sports">
//Sports Content
</p:panel>
<p:panel id="finance">
//Finance Content
</p:panel>
//more panels like lifestyle, weather, politics...
</p:dashboard>
Dashboard model simply defines the number of columns and the widgets to be placed in each column. See the end of this section for the detailed Dashboard API.
public class Bean { private DashboardModel model; public Bean() { model = new DefaultDashboardModel();
DashboardColumn column1 = new DefaultDashboardColumn();
DashboardColumn column2 = new DefaultDashboardColumn();
DashboardColumn column3 = new DefaultDashboardColumn(); column1.addWidget("sports"); column1.addWidget("finance"); column2.addWidget("lifestyle"); column2.addWidget("weather"); column3.addWidget("politics"); model.addColumn(column1); model.addColumn(column2); model.addColumn(column3);
}
}
State
Dashboard is a stateful component, whenever a widget is reordered dashboard model will be updated, by persisting the user changes so you can easily create a stateful dashboard.
Ajax Behavior Events
“reorder” is the one and only ajax behavior event provided by dashboard, this event is fired when dashboard panels are reordered. A defined listener will be invoked by passing an
org.primefaces.event.DashboardReorderEvent instance containing information about reorder.
Following dashboard displays a message about the reorder event
127
PrimeFaces User Guide
<p:dashboard model="#{bean.model}">
<p:ajax event=”reorder” update=”messages” listener=”#{bean.handleReorder}” />
//panels
</p:dashboard>
<p:growl id="messages" /> public class Bean {
...
public void handleReorder(DashboardReorderEvent event) {
String widgetId = event.getWidgetId(); int widgetIndex = event.getItemIndex(); int columnIndex = event.getColumnIndex(); int senderColumnIndex = event.getSenderColumnIndex();
//Add facesmessage
}
}
If a widget is reordered in the same column, senderColumnIndex will be null. This field is populated only when a widget is transferred to a column from another column. Also when the listener is invoked, dashboard has already updated it’s model.
Disabling Dashboard
If you’d like to disable reordering feature, set disabled option to true.
<p:dashboard disabled="true" ...>
//panels
</p:dashboard>
Toggle, Close and Options Menu
Widgets presented in dashboard can be closable, toggleable and have options menu as well, dashboard doesn’t implement these by itself as these features are already provided by the panel component. See panel component section for more information.
<p:dashboard model="#{dashboardBean.model}">
<p:panel id="sports" closable="true" toggleable="true">
//Sports Content
</p:panel>
</p:dashboard>
New Widgets
Draggable component is used to add new widgets to the dashboard. This way you can add new panels from outside of the dashboard.
128
PrimeFaces User Guide
<p:dashboard model="#{dashboardBean.model}" id="board">
//panels
</p:dashboard>
<p:panel id="newwidget" />
<p:draggable for="newwidget" helper="clone" dashboard="board" />
Skinning
Dashboard resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-dashboard
.ui-dashboard-column div.ui-state-hover
Applies
Container element of dashboard
Each column in dashboard
Placeholder
As skinning style classes are global, see the main theming section for more information. Here is an example based on a different theme;
Tips
• Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets.
Dashboard Model API
org.primefaces.model.DashboardModel (org.primefaces.model.map.DefaultDashboardModel is the default implementation)
Method
void addColumn(DashboardColumn column)
List<DashboardColumn> getColumns() int getColumnCount()
DashboardColumn getColumn(int index) void transferWidget(DashboardColumn from,
DashboardColumn to, String widgetId, int index)
Description
Adds a column to the dashboard
Returns all columns in dashboard
Returns the number of columns in dashboard
Returns the dashboard column at given index
Relocates the widget identifed with widget id to the given index of the new column from old column.
129
PrimeFaces User Guide
org.primefaces.model.DashboardColumn (org.primefaces.model.map.DefaultDashboardModel is the default implementation)
Method
void removeWidget(String widgetId)
List<String> getWidgets() int getWidgetCount()
String getWidget(int index) void addWidget(String widgetId) void addWidget(int index, String widgetId) void reorderWidget(int index, String widgetId)
Description
Removes the widget with the given id
Returns the ids of widgets in column
Returns the count of widgets in column
Returns the widget id with the given index
Adds a new widget with the given id
Adds a new widget at given index
Updates the index of widget in column
130
PrimeFaces User Guide
3.28 DataExporter
DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel, pdf, csv and xml.
Info
Tag
Tag Class
ActionListener Class
dataExporter org.primefaces.component.export.DataExporterTag
org.primefaces.component.export.DataExporter
Attributes
Name
type target fileName pageOnly preProcessor postProcessor encoding selectionOnly
Default
null null null
String
Type
String
String
0 null null
UTF-8
0
String
MethodExpr
MethodExpr
Boolean
Boolean
Description
Export type: "xls","pdf","csv", "xml"
Id of the datatable whose data to export.
Filename of the generated export file, defaults to datatable id.
Exports only current page instead of whole dataset
PreProcessor for the exported document.
PostProcessor for the exported document.
Character encoding to use
When enabled, only selection would be exported.
Getting Started with DataExporter
DataExporter is nested in a UICommand component such as commandButton or commandLink. For pdf exporting itext and for xls exporting poi libraries are required in the classpath. Target must point to a PrimeFaces Datatable. Assume the table to be exported is defined as;
<p:dataTable id="tableId" ...>
//columns
</p:dataTable>
Excel export
<p:commandButton value="Export as Excel" ajax="false">
<p:dataExporter type="xls" target="tableId" fileName="cars"/>
</p:commandButton>
131
PDF export
<p:commandButton value="Export as PDF" ajax="false" >
<p:dataExporter type="pdf" target="tableId" fileName="cars"/>
</p:commandButton>
PrimeFaces User Guide
CSV export
<p:commandButton value="Export as CSV" ajax="false" >
<p:dataExporter type="csv" target="tableId" fileName="cars"/>
</p:commandButton>
XML export
<p:commandButton value="Export as XML" ajax="false" >
<p:dataExporter type="xml" target="tableId" fileName="cars"/>
</p:commandLink>
PageOnly
By default dataExporter works on whole dataset, if you’d like export only the data displayed on current page, set pageOnly to true.
<p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/>
Excluding Columns
In case you need one or more columns to be ignored set exportable option of column to false.
<p:column exportable="false">
//...
</p:column>
Monitor Status
DataExport is a non-ajax process so ajaxStatus component cannot apply. See FileDownload
Monitor Status section to find out how monitor export process. Same solution applies to data export as well.
Pre and Post Processors
Processors are handy to customize the exported document (e.g. add logo, caption ...). PreProcessors are executed before the data is exported and PostProcessors are processed after data is included in the document. Processors are simple java methods taking the document as a parameter.
Change Excel Table Header
First example of processors changes the background color of the exported excel’s headers.
132
<h:commandButton value="Export as XLS">
<p:dataExporter type="xls" target="tableId" fileName="cars" postProcessor="#{bean.postProcessXLS}"/>
</h:commandButton>
PrimeFaces User Guide public void postProcessXLS(Object document) {
HSSFWorkbook wb = (HSSFWorkbook) document;
HSSFSheet sheet = wb.getSheetAt(0);
HSSFRow header = sheet.getRow(0);
HSSFCellStyle cellStyle = wb.createCellStyle(); cellStyle.setFillForegroundColor(HSSFColor.GREEN.index); cellStyle.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND); for(int i=0; i < header.getPhysicalNumberOfCells();i++) { header.getCell(i).setCellStyle(cellStyle);
}
}
Add Logo to PDF
This example adds a logo to the PDF before exporting begins.
<h:commandButton value="Export as PDF">
<p:dataExporter type="pdf" target="tableId" fileName="cars" preProcessor="#{bean.preProcessPDF}"/>
</h:commandButton> public void preProcessPDF(Object document) throws IOException,
BadElementException, DocumentException {
Document pdf = (Document) document;
ServletContext servletContext = (ServletContext)
FacesContext.getCurrentInstance().getExternalContext().getContext();
String logo = servletContext.getRealPath("") + File.separator + "images" +
File.separator + "prime_logo.png"; pdf.add(Image.getInstance(logo));
}
133
3.29 DataGrid
DataGrid displays a collection of data in a grid layout.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
dataGrid org.primefaces.component.datagrid.DataGrid
org.primefaces.component.DataGrid
org.primefaces.component
org.primefaces.component.DataGridRenderer
org.primefaces.component.datagrid.DataGridRenderer
Attributes
Name
id rendered binding
Default
null true null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
134
PrimeFaces User Guide value var style styleClass rowIndexVar lazy layout
Name
rows first widgetVar null
0 null columns paginator paginatorTemplate
3 false null rowsPerPageTemplate null currentPageReportTemplate null pageLinks paginatorPosition paginatorAlwaysVisible
10 both true emptyMessage null null null false
Default
null null
Type
Object Data to display.
Description
String Name of the request-scoped variable used to refer each data.
Integer Number of rows to display per page.
Integer Index of the first row to be displayed
String Name of the client side widget.
Integer Number of columns in grid.
boolean Enables pagination.
String Template of the paginator.
String
String
Template of the rowsPerPage dropdown.
Template of the currentPageReport UI.
Integer Maximum number of page links to display.
String Position of the paginator.
Boolean Defines if paginator should be hidden if total data count is less than number of rows per page.
String
String
Inline style of the datagrid.
Style class of the datagrid.
String Name of the iterator to refer each row index.
Boolean Defines if lazy loading is enabled for the data component.
String Text to display when there is no data to display.
No records found.
tabular String Layout approach to use, valid values are
"tabular" and "grid" for responsive grid.
Getting started with the DataGrid
A list of cars will be used throughout the datagrid, datalist and datatable examples.
public class Car { private String model; private int year; private String manufacturer; private String color;
...
}
135
PrimeFaces User Guide
The code for CarBean that would be used to bind the datagrid to the car list.
public class CarBean { private List<Car> cars; public CarBean() { cars = new ArrayList<Car>(); cars.add(new Car("myModel",2005,"ManufacturerX","blue"));
//add more cars
} public List<Car> getCars() { return cars;
}
}
<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12">
<p:column>
<p:panel header="#{car.model}">
<h:panelGrid columns="1">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
<h:outputText value="#{car.year}" />
</h:panelGrid>
</p:panel>
</p:column>
</p:dataGrid>
This datagrid has 3 columns and 12 rows. As datagrid extends from standard UIData, rows correspond to the number of data to display not the number of rows to render so the actual number of rows to render is rows/columns = 4. As a result datagrid is displayed as;
136
PrimeFaces User Guide
Ajax Pagination
DataGrid has a built-in paginator that is enabled by setting paginator option to true.
<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12" paginator="true">
...
</p:dataGrid>
Paginator Template
Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls.
Note that this section applies to dataGrid, dataList and dataTable.
• FirstPageLink
• LastPageLink
• PreviousPageLink
• NextPageLink
• PageLinks
• CurrentPageReport
• RowsPerPageDropdown
Note that {RowsPerPageDropdown} has it’s own template, options to display is provided via rowsPerPageTemplate attribute (e.g. rowsPerPageTemplate="9,12,15").
Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option.
You can use {currentPage},{totalPages},{totalRecords},{startRecord},{endRecord} keyword within currentPageReportTemplate. Default is {currentPage} of{totalPages}. Default UI is; w hich corresponds to the following template.
"{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}"
Here are more examples based on different templates;
" {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink}
{LastPageLink} {RowsPerPageDropdown}"
" {PreviousPageLink} {CurrentPageReport} {NextPageLink}"
Paginator Position
Paginator can be positoned using paginatorPosition attribute in three different locations, "top",
"bottom" or "both" (default).
137
PrimeFaces User Guide
Custom Content in Paginator
Custom content can be placed inside a paginator using a facet name matching a token in the template.
<p:dataTable paginatorTemplate="{CurrentPageReport} {MyContent} ...">
<f:facet name="{MyContent}">
//Any content here
</f:facet>
//...
</p:dataTable>
Selecting Data
Selection of data displayed in datagrid is very similar to row selection in datatable, you can access the current data using the var reference. Here is an example to demonstrate how to select data from datagrid and display within a dialog with ajax.
<h:form id="carForm">
<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12">
<p:panel header="#{car.model}">
<p:commandLink update=":carForm:display" oncomplete="PF('dlg').show()">
<f:setPropertyActionListener value="#{car}" target="#{carBean.selectedCar}"
<h:outputText value="#{car.model}" />
</p:commandLink>
</p:panel>
</p:dataGrid>
<p:dialog modal="true" widgetVar="dlg">
<h:panelGrid id="display" columns="2">
<f:facet name="header">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
</f:facet>
<h:outputText value="Model:" />
<h:outputText value="#{carBean.selectedCar.year}" />
//more selectedCar properties
</h:panelGrid>
</p:dialog>
</h:form> public class CarBean { private List<Car> cars; private Car selectedCar;
//getters and setters
}
138
PrimeFaces User Guide
Layout Modes
DataGrid has two layout modes, "tabular" mode uses a table element and "grid" mode uses
PrimeFaces Grid CSS create a responsive ui.
On a smaller screen, grid mode adjusts the content for the optimal view.
139
PrimeFaces User Guide
Ajax Behavior Events
Event
page
Listener Parameter
org.primefaces.event.data.PageEvent
<p:dataGrid var="car" value="#{carBean.model}">
<p:ajax event="page" update=”anothercomponent" />
//content
</p:dataGrid>
On pagination.
Fired
Client Side API
Widget: PrimeFaces.widget.DataGrid
Method
getPaginator()
Params
-
Return Type
Paginator
Description
Returns the paginator widget.
Skinning
DataGrid resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;
.ui-datagrid
.ui-datagrid-content
.ui-datagrid-data
Class
.ui-datagrid-row
.ui-datagrid-column
Applies
Main container element
Content container.
Table element containing data
A row in grid
A column in grid
As skinning style classes are global, see the main theming section for more information.
Tips
• DataGrid supports lazy loading data via LazyDataModel, see DataTable lazy loading section.
• DataGrid provides two facets named header and footer that you can use to provide custom content at these locations.
140
3.30 DataList
DataList presents a collection of data in list layout with several display types.
PrimeFaces User Guide binding value var rows first
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
dataList org.primefaces.component.datalist.DataList
org.primefaces.component.DataList
org.primefaces.component
org.primefaces.component.DataListRenderer
org.primefaces.component.datalist.DataListRenderer
Attributes
Name
id rendered
Default
null true null null null null
0
Type Description
String Unique identifier of the component boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
Object
String
An el expression that maps to a server side
UIComponent instance in a backing bean
Data to display.
Name of the request-scoped variable used to refer each data.
Integer
Integer
Number of rows to display per page.
Index of the first row to be displayed
141
Name
type itemType widgetVar paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible style styleClass rowIndexVar varStatus lazy emptyMessage itemStyleClass
PrimeFaces User Guide null null
10 both true null null false null
Default
unordered
Type
String
Description
Type of the list, valid values are "unordered",
"ordered", "definition" and "none".
String
String
Specifies the list item type.
Name of the client side widget.
boolean Enables pagination.
String Template of the paginator.
String
String
Integer
Template of the rowsPerPage dropdown.
Template of the currentPageReport UI.
Maximum number of page links to display.
String Position of the paginator.
Boolean Defines if paginator should be hidden if total data count is less than number of rows per page.
null
Null null
String
String
String
Inline style of the main container.
Style class of the main container.
Name of the iterator to refer each row index.
null false
No records found.
null
String Name of the exported request scoped variable to represent state of the iteration same as in ui:repeat varStatus.
Boolean Defines if lazy loading is enabled for the data component.
String
String
Text to display when there is no data to display.
Style class of an item in list.
Getting started with the DataList
Since DataList is a data iteration component, it renders it’s children for each data represented with
var option. See itemType section for more information about the possible values.
<p:dataList value="#{carBean.cars}" var="car" itemType="disc">
#{car.manufacturer}, #{car.year}
</p:dataList>
Ordered Lists
DataList displays the data in unordered format by default, if you’d like to use ordered display set
type option to "ordered".
142
PrimeFaces User Guide
<p:dataList value="#{carBean.cars}" var="car" type="ordered">
#{car.manufacturer}, #{car.year}
</p:dataList>
Item Type
itemType defines the bullet type of each item. For ordered lists, in addition to commonly used
decimal type, following item types are available;
- A
- a
- i
And for unordered lists, available values are;
- disc
- circle
- square
Definition Lists
Third type of dataList is definition lists that display inline description for each item, to use definition list set type option to "definition". Detail content is provided with the facet called
"description".
<p:dataList value="#{carBean.cars}" var="car" type="definition">
Model: #{car.model}, Year: #{car.year}
<f:facet name="description">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
</f:facet>
</p:dataList>
Ajax Pagination
DataList has a built-in paginator that is enabled by setting paginator option to true.
<p:dataList value="#{carBean.cars}" var="car" paginator="true" rows="10">
#{car.manufacturer}, #{car.year}
</p:dataList>
Pagination configuration and usage is same as dataGrid, see pagination section in dataGrid documentation for more information and examples.
143
PrimeFaces User Guide
Selecting Data
Data selection can be implemented same as in dataGrid, see selecting data section in dataGrid documentation for more information and an example.
Client Side API
Widget: PrimeFaces.widget.DataList
Method
getPaginator()
Params
-
Return Type
Paginator
Description
Returns the paginator widget.
Skinning
DataList resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;
.ui-datalist
.ui-datalist-content
.ui-datalist-data
.ui-datalist-item
Class
Main container element
Content container
Data container
Each item in list
Applies
As skinning style classes are global, see the main theming section for more information.
Tips
• DataList supports lazy loading data via LazyDataModel, see DataTable lazy loading section.
• If you need full control over list type markup, set type to “none”. With this setting, datalist does not render item tags like li and behaves like ui:repeat.
• DataList provides two facets named header and footer that you can use to provide custom content at these locations.
144
PrimeFaces User Guide
3.31 DataScroller
DataScroller displays a collection of data with on demand loading using scrolling.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
dataScroller org.primefaces.component.datascroller.DataScroller
org.primefaces.component.DataScroller
org.primefaces.component
org.primefaces.component.DataScrollerRenderer
org.primefaces.component.datascroller.DataScrollerRenderer
Attributes
Name
id rendered binding
Default
null true null
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
145
value var rows first widgetVar style styleClass chunkSize rowIndexVar mode
Name
scrollHeight lazy buffer
PrimeFaces User Guide
Default
null null null
0 null
Type
Object
String
Integer
Integer
String
Description
Data to display.
Name of the request-scoped variable used to refer each data.
Number of rows to display per page.
Index of the first row to be displayed
Name of the client side widget.
null
Null
0 null
String
String int
String
Inline style of the main container.
Style class of the main container.
Number of items to fetch in each load.
Name of iterator to refer each row index.
document null false
10
String Defines the target to listen for scroll event, valid values are "document" (default) and
"inline".
String
Boolean Defines if lazy loading is enabled for the data component.
Integer
Defines pixel height of the viewport in inline mode.
Percentage height of the buffer between the bottom of the page and the scroll position to initiate the load for the new chunk. Value is defined in integer and default is 10 meaning load would happen after 90% of the viewport is scrolled down.
Getting started with the DataScroller
DataScroller requires a collection of data to display, when the page is scrolled down, datascroller will do a request with ajax to fetch the new chunk of data and append them at the bottom.
<p:dataScroller value="#{carBean.cars}" var="car" chunkSize="10">
#{car.manufacturer}
//more content
</p:dataList>
Scroll Mode
Default element whose scrollbar is monitored is page itself, mode option is used to customize the scroll target. Two possible options for the mode attribute are “document” and “inline”. Document mode is default and inline mode listens to the scroll event of the datascroller container itself.
146
PrimeFaces User Guide
<p:dataScroller value="#{carBean.cars}" var="car" mode="inline" chunkSize="10">
#{car.manufacturer}
//more content
</p:dataList>
Loader
In case of scrolling, a UI element such as button can defined as the loader so that new data is loaded when the loader element is clicked. Loader component is defined using "loader" facet.
<p:dataScroller value="#{carBean.cars}" var="car" mode="inline" chunkSize="10">
#{car.manufacturer}
//more content
<f:facet name="loader">
<p:commandButton type="button" value="View More" />
</f:facet>
</p:dataList>
Lazy Loading
Lazy loading is enabled by enabling the lazy attribute and providing a LazyDataModel instance as the value. Refer to lazy load example in DataTable for an example about LazyDataModel.
<p:dataScroller value="#{carBean.lazyModel}" var="car" lazy="true">
#{car.manufacturer}
//more content
</p:dataList>
Header
Header of the component is defined using header facet.
<p:dataScroller value="#{carBean.lazyModel}" var="car">
<f:facet name="header">Cars</f:facet>
#{car.manufacturer}
//more content
</p:dataList>
Client Side API
Widget: PrimeFaces.widget.DataScroller load()
Method Params
-
Return Type
void
Description
Loads the next chunk.
147
PrimeFaces User Guide
Skinning
DataScroller resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;
Class
.ui-datascroller
.ui-datascroller-inline
.ui-datalist-header
.ui-datalist-content
.ui-datascroller-list
.ui-datascroller-item
.ui-datascroller-loader
.ui-datascroller-loading
Applies
Main container element
Main container element in inline mode
Header element
Content element
List element container
Container of each item in the list
Container of custom loader element.
Built-in load status indicator
As skinning style classes are global, see the main theming section for more information.
148
3.32 DataTable
DataTable displays data in tabular format.
PrimeFaces User Guide binding value var rows first
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
dataTable org.primefaces.component.datatable.DataTable
org.primefaces.component.DataTable
org.primefaces.component
org.primefaces.component.DataTableRenderer
org.primefaces.component.datatable.DataTableRenderer
Attributes
Name
id rendered
Default
null false null null null null
0
Type
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
Object
String
Integer
Integer
Data to display.
Description
Name of the request-scoped variable used to refer each data.
Number of rows to display per page.
Index of the first row to be displayed
149
PrimeFaces User Guide
Name
widgetVar paginator paginatorTemplate rowsPerPageTemplate rowsPerPageLabel null null currentPageReportTemplate null pageLinks 10 paginatorPosition both paginatorAlwaysVisible true
Default
null false null scrollable scrollHeight scrollWidth selectionMode selection rowIndexVar emptyMessage style styleClass dblClickSelect liveScroll rowStyleClass onExpandStart resizableColumns sortBy sortOrder scrollRows rowKey tableStyle false null null null null false false null null false null null null
No records found.
null ascending String
0 Integer null String null String
Type
String
Description
Name of the client side widget.
Boolean Enables pagination.
String Template of the paginator.
String
String
String
Integer
String
Template of the rowsPerPage dropdown.
Label for the rowsPerPage dropdown.
Template of the currentPageReport UI.
Maximum number of page links to display.
Position of the paginator.
Boolean Defines if paginator should be hidden if total data count is less than number of rows per page.
Boolean Makes data scrollable with fixed header.
Integer
Integer
String
Object
String
String
Scroll viewport height.
Scroll viewport width.
Enables row selection, valid values are “single” and “multiple”.
Reference to the selection data.
Name of iterator to refer each row index.
Text to display when there is no data to display.
Alternative is emptyMessage facet.
String Inline style of the component.
String Style class of the component.
Boolean Enables row selection on double click.
Boolean Enables live scrolling.
String
String
Style class for each row.
Client side callback to execute before expansion.
Boolean Enables column resizing.
Object Property to be used for default sorting.
“ascending” or “descending”.
Number of rows to load on live scroll.
Unique identifier of a row.
Inline style of the table element.
150
Name
tableStyleClass filterEvent filterDelay draggableColumns editable lazy filteredValue sortMode editMode editingRow cellSeparator summary frozenRows dir liveResize stickyHeader expandedRow disabledSelection rowSelectMode rowExpandMode dataLocale nativeElements frozenColumns null null ltr false
Default
null keyup
300 false false false null single row false null false false false new new null false null
PrimeFaces User Guide
Type
String
String
Integer
Description
Style class of the table element.
Event to invoke filtering for input filters.
Delay in milliseconds before sending an ajax filter query.
Boolean Columns can be reordered with dragdrop when enabled.
Boolean Controls incell editing.
Boolean Controls lazy loading.
List
String
String Defines edit mode, valid values are row and cell.
Boolean Defines if cell editors of row should be displayed as editable or not.
String
List to keep filtered data.
Defines sorting mode, valid values are single and
multiple.
String
Object
Separator text to use in output mode of editable cells with multiple components.
Summary attribute for WCAG.
Collection to display as fixed in scrollable mode.
String Defines text direction, valid values are ltr and rtl.
Boolean Columns are resized live in this mode without using a resize helper.
Boolean Sticky header stays in window viewport during scrolling.
Boolean Defines if row should be rendered as expanded by default.
Boolean Disables row selection when true.
String
String
Defines row selection mode for multiple selection. Valid values are "new", "add" and
"checkbox".
Defines row expand mode, valid values are
"single" and "multiple" (default).
Object Locale to be used in features such as filtering and sorting, defaults to view locale.
Boolean Uses native radio-checkbox elements for row selection.
Integer Number of columns to freeze from start index 0.
151
Name
draggableRows caseSensitiveSort skipChildren disabledTextSelection sortField
Default
false false false true null
PrimeFaces User Guide
Type Description
Boolean When enabled, rows can be reordered using dragdrop.
Boolean Case sensitivity for sorting, insensitive by default.
Boolean Ignores processing of children during lifecycle, improves performance if table only has output components.
Boolean Disables text selection on row click.
String Name of the field to pass lazy load method for sorting. If not specified, sortBy expression is used to extract the name.
Getting started with the DataTable
We will be using the same Car and CarBean classes described in DataGrid section.
<p:dataTable var="car" value="#{carBean.cars}">
<p:column>
<f:facet name="header">
<h:outputText value="Model" />
</f:facet>
<h:outputText value="#{car.model}" />
</p:column>
//more columns
</p:dataTable>
Header and Footer
Both datatable itself and columns can have custom content in their headers and footers using header and footer facets respectively. Alternatively for columns there are headerText and footerText shortcuts to display simple texts.
152
PrimeFaces User Guide
<p:dataTable var="car" value="#{carBean.cars}">
<f:facet name="header">
List of Cars
</f:facet>
<p:column>
<f:facet name="header">
Model
</f:facet>
#{car.model}
<f:facet name="footer">
8 digit code
</f:facet>
</p:column>
<p:column headerText="Year" footerText="1960-2010">
#{car.year}
</p:column>
//more columns
<f:facet name="footer">
In total there are #{fn:length(carBean.cars)} cars.
</f:facet>
</p:dataTable>
Pagination
DataTable has a built-in ajax based paginator that is enabled by setting paginator option to true, see pagination section in dataGrid documentation for more information about customization options.
<p:dataTable var="car" value="#{carBean.cars}" paginator="true" rows="10">
//columns
</p:dataTable>
Sorting
Defining sortBy attribute enables ajax based sorting on that particular column.
<p:dataTable var="car" value="#{carBean.cars}">
<p:column sortBy="#{car.model}" headerText="Model">
<h:outputText value="#{car.model}" />
</p:column>
...more columns
</p:dataTable>
Instead of using the default sorting algorithm which uses a java comparator, you can plug-in your own sort method as well.
public int sortByModel(Object car1, Object car2) {
//return -1, 0 , 1 if car1 is less than, equal to or greater than car2
}
153
PrimeFaces User Guide
<p:dataTable var="car" value="#{carBean.cars}">
<p:column sortBy="#{car.model}" sortFunction="#{carBean.sortByModel}" headerText="Model">
<h:outputText value="#{car.model}" />
</p:column>
...more columns
</p:dataTable>
Multiple sorting is enabled by setting sortMode to multiple. In this mode, clicking a sort column while metakey is on adds sort column to the order group.
<p:dataTable var="car" value="#{carBean.cars}" sortMode="multiple">
//columns
</p:dataTable>
DataTable can display data sorted by default, to implement this use the sortBy option of datatable and the optional sortOrder. Table below would be initially displayed as sorted by model.
<p:dataTable var="car" value="#{carBean.cars}" sortBy="#{car.model}">
<p:column sortBy="#{car.model}" headerText=”Model”>
<h:outputText value="#{car.model}" />
</p:column>
<p:column sortBy="#{car.year}" headerText="Year">
<h:outputText value="#{car.year}" />
</p:column>
...more columns
</p:dataTable>
Filtering
Ajax based filtering is enabled by setting filterBy at column level and providing a list to keep the filtered sublist. It is suggested to use a scope longer than request like viewscope to keep the filteredValue so that filtered list is still accessible after filtering.
<p:dataTable var="car" value="#{carBean.cars}" filteredValue="#{carBean.filteredCars}">
<p:column filterBy="#{car.model}" headerText="Model">
<h:outputText value="#{car.model}" />
</p:column>
...more columns
</p:dataTable>
Filtering is triggered with keyup event and filter inputs can be styled using filterStyle,
filterStyleClass attributes. If you’d like to use a dropdown instead of an input field to only allow predefined filter values use filterOptions attribute and a collection/array of selectitems as value. In addition, filterMatchMode defines the built-in matcher which is startsWith by default.
Following is a basic filtering datatable with these options demonstrated;
154
PrimeFaces User Guide
<p:dataTable var="car" value="#{carBean.cars}" filteredValue="#{carBean.filteredCars}" widgetVar="carsTable">
<f:facet name="header">
<p:outputPanel>
<h:outputText value="Search all fields:" />
<h:inputText id="globalFilter" onkeyup="PF('carsTable').filter()" />
</p:outputPanel>
</f:facet>
<p:column filterBy="#{car.model}" headerText="Model" filterMatchMode="contains">
<h:outputText value="#{car.model}" />
</p:column>
<p:column filterBy="#{car.year}" headerText="Year" footerText="startsWith">
<h:outputText value="#{car.year}" />
</p:column>
<p:column filterBy="#{car.manufacturer}" headerText="Manufacturer" filterOptions="#{carBean.manufacturerOptions}" filterMatchMode="exact">
<h:outputText value="#{car.manufacturer}" />
</p:column>
<p:column filterBy="#{car.color}" headerText="Color" filterMatchMode="endsWith">
<h:outputText value="#{car.color}" />
</p:column>
<p:column filterBy="#{car.price}" headerText="Price" filterMatchMode="exact">
<h:outputText value="#{car.price}" />
</p:column>
</p:dataTable>
Filter located at header is a global one applying on all fields, this is implemented by calling client side API method called filter(), important part is to specify the id of the input text as globalFilter which is a reserved identifier for datatable.
In addition to default filtering with generated elements, custom elements can also be used as a filter facet. Example below uses custom filter components in combination with generated elements.
When a custom component is used as a filter facet, filtering needs to be called manually from a preferred event such as onchange="PF('carsTable').filter()". Also defining a converter might be necessary if the value of the filter facet is not defined.
155
PrimeFaces User Guide
<p:dataTable id="dataTable" var="car" value="#{tableBean.carsSmall}" widgetVar="carsTable" filteredValue="#{tableBean.filteredCars}">
<p:column id="modelColumn" filterBy="#{car.model}" headerText="Model" footerText="contains" filterMatchMode="contains">
<h:outputText value="#{car.model}" />
</p:column>
<p:column id="yearColumn" filterBy="#{car.year}" headerText="Year" footerText="lte" filterMatchMode="lte">
<f:facet name="filter">
<p:spinner onchange="PF('carsTable').filter()" min="1960" max="2010">
<f:converter converterId="javax.faces.Integer" />
</p:spinner>
</f:facet>
<h:outputText value="#{car.year}" />
</p:column>
<p:column id="manufacturerColumn" filterBy="#{car.manufacturer}" headerText="Manufacturer" footerText="exact" filterMatchMode="exact">
<f:facet name="filter">
<p:selectOneMenu onchange="PF('carsTable').filter()" >
<f:selectItems value="#{tableBean.manufacturerOptions}" />
</p:selectOneMenu>
</f:facet>
<h:outputText value="#{car.manufacturer}" />
</p:column>
<p:column id="colorColumn" filterBy="#{car.color}" headerText="Color" footerText="in" filterMatchMode="in">
<f:facet name="filter">
<p:selectCheckboxMenu label="Colors" onchange="PF('carsTable').filter()">
<f:selectItems value="#{tableBean.colors}" />
</p:selectCheckboxMenu>
</f:facet>
<h:outputText value="#{car.color}" />
</p:column>
<p:column id="soldColumn" filterBy="#{car.sold}" headerText="Status" footerText="equals" filterMatchMode="equals">
<f:facet name="filter">
<p:selectOneButton onchange="PF('carsTable').filter()">
<f:converter converterId="javax.faces.Boolean" />
<f:selectItem itemLabel="All" itemValue="" />
<f:selectItem itemLabel="Sold" itemValue="true" />
<f:selectItem itemLabel="Sale" itemValue="false" />
</p:selectOneButton>
</f:facet>
<h:outputText value="#{car.sold ? 'Sold': 'Sale'}" />
</p:column>
</p:dataTable>
156
PrimeFaces User Guide filterMatchMode defines which built-in filtering algorithm would be used per column, valid values for this attribute are;
- startsWith: Checks if column value starts with the filter value.
- endsWith: Checks if column value ends with the filter value.
- contains: Checks if column value contains the filter value.
- exact: Checks if string representations of column value and filter value are same.
- lt: Checks if column value is less than the filter value.
- lte: Checks if column value is less than or equals the filter value.
- gt: Checks if column value is greater than the filter value.
- gte: Checks if column value is greater than or equals the filter value.
- equals: Checks if column value equals the filter value.
- in: Checks if column value is in the collection of the filter value.
In case the built-in methods do not suffice, custom filtering can be implemented using filterFunction approach.
<p:column filterBy="#{car.price}" filterFunction="#{tableBean.filterByPrice}">
<h:outputText value="#{car.price}">
<f:convertNumber currencySymbol="$" type="currency"/>
</h:outputText>
</p:column>
filterFunction should be a method with three parameters; column value, filter value and locale.
Return value is a boolean, true accepts the value and false rejects it.
public boolean filterByPrice(Object value, Object filter, Locale locale) {
//return true or false
}
Locale is provided as optional in case you need to use a locale aware method like
toLowerCase(Locale locale). Note that String based filters like startsWith, endsWith uses toLowerCase already and dataLocale attribute is used to provide the locale to use when filtering.
Row Selection
There are several ways to select row(s) from datatable. Let’s begin by adding a Car reference for single selection and a Car array for multiple selection to the CarBean to hold the selected data.
public class CarBean { private List<Car> cars; private Car selectedCar; private Car[] selectedCars; public CarBean() { cars = new ArrayList<Car>();
//populate cars
}
//getters and setters
}
Single Selection with a Command Component
This method is implemented with a command component such as commandLink or commandButton. Selected row can be set to a server side instance by passing as a parameter if you are using EL 2.2 or using f:setPropertyActionListener.
157
PrimeFaces User Guide
<p:dataTable var="car" value="#{carBean.cars}">
<p:column>
<p:commandButton value="Select">
<f:setPropertyActionListener value="#{car}" target="#{carBean.selectedCar}" />
</p:commandButton>
</p:column>
...columns
</p:dataTable>
Single Selection with Row Click
Previous method works when the button is clicked, if you’d like to enable selection wherever the row is clicked, use selectionMode option.
<p:dataTable var="car" value="#{carBean.cars}" selectionMode="single" selection="#{carBean.selectedCar}" rowKey="#{car.id}">
...columns
</p:dataTable>
Multiple Selection with Row Click
Multiple row selection is similar to single selection but selection should reference an array or a list of the domain object displayed and user needs to use press modifier key(e.g. ctrl) during selection *.
<p:dataTable var="car" value="#{carBean.cars}" selectionMode="multiple" selection="#{carBean.selectedCars}" rowKey="#{car.id}" >
...columns
</p:dataTable>
Single Selection with RadioButton
Selection a row with a radio button placed on each row is a common case, datatable has built-in support for this method so that you don’t need to deal with h:selectOneRadios and low level bits. In order to enable this feature, define a column with selectionMode set as single.
<p:dataTable var="car" value="#{carBean.cars}" selection="#{carBean.selectedCar}" rowKey="#{car.id}">
<p:column selectionMode="single"/>
...columns
</p:dataTable>
Multiple Selection with Checkboxes
Similar to how radio buttons are enabled, define a selection column with a multiple selectionMode.
DataTable will also provide a selectAll checkbox at column header.
<p:dataTable var="car" value="#{carBean.cars}" selection="#{carBean.selectedCars}" rowKey="#{car.id}" >
<p:column selectionMode="multiple"/>
...columns
</p:dataTable>
158
PrimeFaces User Guide
* Use rowSelectMode option to customize the default behavior on row click of a multiple selection enabled datatable. Default value is "new" that clears previous selections, "add" mode keeps previous selections same as selecting a row with mouse click when metakey is on and
"checkbox" mode allows row selection with checkboxes only.
RowKey
RowKey should a unique identifier from your data model and used by datatable to find the selected rows. You can either define this key by using the rowKey attribute or by binding a data model which implements org.primefaces.model.SelectableDataModel.
Dynamic Columns
Dynamic columns is handy in case you can’t know how many columns to render. Columns component is used to define the columns programmatically. It requires a collection as the value, two iterator variables called var and columnIndexVar.
<p:dataTable var="cars" value="#{tableBean.cars}">
<p:columns value="#{tableBean.columns}" var="column" sortBy="#{column.property}" filterBy="#{column.property}">
<f:facet name="header">
#{column.header}
</f:facet>
<h:outputText value="#{cars[column.property]}" />
</p:columns>
</p:dataTable>
159
PrimeFaces User Guide public class CarBean { private List<ColumnModel> columns = new ArrayList<ColumnModel>(); private List<Car> cars; public CarBean() { populateColumns(); cars = //populate cars;
} public void populateColumns() {
String[] columnKeys = new String[]{"model","year","color"};
for(String columnKey : columnKeys) {
columns.add(new ColumnModel(columnKey.toUpperCase(), columnKey));
}
}
//getters and setters
static public class ColumnModel implements Serializable {
private String header;
private String property;
public ColumnModel(String header, String property) {
this.header = header;
this.property = property;
}
public String getHeader() {
return header;
}
public String getProperty() {
return property;
}
}
}
Grouping
Grouping is defined by ColumnGroup component used to combine datatable header and footers.
160
PrimeFaces User Guide
<p:dataTable var="sale" value="#{carBean.sales}">
<p:columnGroup type="header">
<p:row>
<p:column rowspan="3" headerText="Manufacturer" />
<p:column colspan="4" headerText="Sales" />
</p:row>
<p:row>
<p:column colspan="2" headerText="Sales Count" />
<p:column colspan="2" headerText="Profit" />
</p:row>
<p:row>
<p:column headerText="Last Year" />
<p:column headerText="This Year" />
<p:column headerText="Last Year" />
<p:column headerText="This Year" />
</p:row>
</p:columnGroup>
<p:column>
#{sale.manufacturer}
</p:column>
<p:column>
#{sale.lastYearProfit}%
</p:column>
<p:column>
#{sale.thisYearProfit}%
</p:column>
<p:column>
#{sale.lastYearSale}$
</p:column>
<p:column>
#{sale.thisYearSale}$
</p:column>
<p:columnGroup type="footer">
<p:row>
<p:column colspan="3" style="text-align:right" footerText="Totals:"/>
<p:column footerText="#{tableBean.lastYearTotal}$" />
<p:column footerText="#{tableBean.thisYearTotal}$" />
</p:row>
</p:columnGroup>
</p:dataTable> public class CarBean { private List<Sale> sales; public CarBean() { sales = //create a list of BrandSale objects
} public List<Sale> getSales() { return this.sales;
}
}
161
PrimeFaces User Guide
Scrolling
Scrolling makes the header-footer of the table fixed and the body part scrollable. scrollable attribute must be enabled and depending on the scrolling orientation, scrollHeight and/or scrollWidth options must be specified.
<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150">
<p:column />
//columns
</p:dataTable>
Simple scrolling renders all data to client whereas live scrolling is useful to deal with huge data, in this case data is fetched whenever the scrollbar reaches bottom. Set liveScroll to enable this option;
<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150" liveScroll="true">
<p:column />
//columns
</p:dataTable>
Scrolling has 3 modes; x, y and x-y scrolling that are defined by scrollHeight and scrollWidth.
These two scroll attributes can be defined using integer values indicating fixed pixels or percentages relative to the container dimensions.
Frozen Rows
Certain rows can be fixed in a scrollable table by using the frozenRows attribute that defines the number of rows to freeze from the start.
<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150" frozenRows="2">
<p:column />
//columns
</p:dataTable>
Frozen Columns
Specific columns can be fixed while the rest of them remain as scrollable. frozenColumns defines the number of columns to freeze from the start.
162
PrimeFaces User Guide
<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollWidth="200" frozenColumns="2">
<p:column />
//columns
</p:dataTable>
Expandable Rows
RowToggler and RowExpansion facets are used to implement expandable rows.
<p:dataTable var="car" value="#{carBean.cars}">
<f:facet name="header">
Expand rows to see detailed information
</f:facet>
<p:column>
<p:rowToggler />
</p:column>
//columns
<p:rowExpansion>
//Detailed content of a car
</p:rowExpansion>
</p:dataTable> p:rowToggler component places an expand/collapse icon, clicking on a collapsed row loads expanded content with ajax. If you need to display a row as expanded by default, use expandedRow attribute which is evaluated before rendering of each row so value expressions are supported.
Additionally, rowExpandMode attribute defines if multiple rows can be expanded at the same time or not, valid values are "single" and "multiple" (default).
Editing
Incell editing provides an easy way to display editable data. p:cellEditor is used to define the cell editor of a particular column. There are two types of editing, row and cell. Row editing is the default mode and used by adding a p:rowEditor component as row controls.
163
<p:dataTable var="car" value="#{carBean.cars}" editable="true">
<f:facet name="header">
In-Cell Editing
</f:facet>
<p:column headerText="Model">
<p:cellEditor>
<f:facet name="output">
<h:outputText value="#{car.model}" />
</f:facet>
<f:facet name="input">
<h:inputText value="#{car.model}"/>
</f:facet>
</p:cellEditor>
</p:column>
//more columns with cell editors
<p:column>
<p:rowEditor />
</p:column>
</p:dataTable>
PrimeFaces User Guide
When pencil icon is clicked, row is displayed in editable mode meaning input facets are displayed and output facets are hidden. Clicking tick icon only saves that particular row and cancel icon reverts the changes, both options are implemented with ajax interaction.
Another option for incell editing is cell editing, in this mode a cell switches to edit mode when it is clicked, losing focus triggers an ajax event to save the change value.
Lazy Loading
Lazy Loading is an approach to deal with huge datasets efficiently, regular ajax based pagination works by rendering only a particular page but still requires all data to be loaded into memory. Lazy loading datatable renders a particular page similarly but also only loads the page data into memory not the whole dataset. In order to implement this, you’d n e e d t o b i n d a
org.primefaces.model.LazyDataModel as the value and implement load method and enable lazy option. Also it is required to implement getRowData and getRowKey if you have selection enabled.
164
PrimeFaces User Guide
<p:dataTable var="car" value="#{carBean.model}" paginator="true" rows="10" lazy="true">
//columns
</p:dataTable> public class CarBean { private LazyDataModel model; public CarBean() { model = new LazyDataModel() {
@Override public void load(int first, int pageSize, String sortField,
SortOrder sortOrder, Map<String,Object> filters) {
//load physical data
}
}; int totalRowCount = //logical row count based on a count query model.setRowCount(totalRowCount);
} public LazyDataModel getModel() { return model;
}
}
DataTable calls your load implementation whenever a paging, sorting or filtering occurs with following parameters;
• first: Offset of first data to start from
• pageSize: Number of data to load
• sortField: Name of sort field
• sortOrder: SortOrder enum.
• filter: Filter map with field name as key (e.g. "model" for filterBy="#{car.model}") and value.
In addition to load method, totalRowCount needs to be provided so that paginator can display itself according to the logical number of rows to display.
It is suggested to use field attribute of column component to define the field names passed as sortField and filterFields, otherwise these fields would be tried to get extracted from the value expression which is not possible in cases like composite components.
Sticky Header
Sticky Header feature makes the datatable header visible on page scrolling.
<p:dataTable var="car" value="#{carBean.model}" stickyHeader="true">
//columns
</p:dataTable>
165
PrimeFaces User Guide
SummaryRow
Summary is a helper component to display a summary for the grouping which is defined by the sortBy option.
166
<p:dataTable var="car" value="#{tableBean.cars}">
<p:column headerText="Model">
#{car.model}
</p:column>
<p:column headerText="Year" sortBy="year">
#{car.year}
</p:column>
<p:column headerText="Manufacturer" sortBy="manufacturer">
#{car.manufacturer}
</p:column>
<p:column headerText="Color" sortBy="color">
#{car.color}
</p:column>
<p:summaryRow>
<p:column colspan="3" style="text-align:right">
Total:
</p:column>
<p:column>
#{tableBean.randomPrice}$
</p:column>
</p:summaryRow>
</p:dataTable>
PrimeFaces User Guide
SubTable
SubTable is a helper component to display nested collections. Example below displays a collection of players and a subtable for the stats collection of each player.
167
PrimeFaces User Guide
<p:dataTable var="player" value="#{tableBean.players}">
<f:facet name="header">
FCB Statistics
</f:facet>
<p:columnGroup type="header">
<p:row>
<p:column rowspan="2" headerText="Player" />
<p:column colspan="2" headerText="Stats" />
</p:row>
<p:row>
<p:column headerText="Goals" />
<p:column headerText="Assists" />
</p:row>
</p:columnGroup>
<p:subTable var="stats" value="#{player.stats}">
<f:facet name="header">
#{player.name}
</f:facet>
<p:column>
#{stats.season}
</p:column>
<p:column>
#{stats.goals}
</p:column>
<p:column>
#{stats.assists}
</p:column>
<p:columnGroup type="footer">
<p:row>
<p:column footerText="Totals: " style="text-align:right"/>
</p:row>
</p:columnGroup>
</p:subTable>
<p:column footerText="#{player.allGoals}" />
<p:column footerText="#{player.allAssists}" />
</p:dataTable>
Column Toggler
Visible columns of a table can be toggled using the column toggler helper component.
168
PrimeFaces User Guide
<p:dataTable var="car" value="#{tableBean.cars}">
<f:facet name="header">
List of Cars
<p:commandButton id="toggler" type="button" value="Columns" style="float:right" icon="ui-icon-calculator" />
<p:columnToggler datasource="cars" trigger="toggler" />
</f:facet>
<p:column headerText="Model">
#{car.model}
</p:column>
<p:column headerText="Year" sortBy="year">
#{car.year}
</p:column>
<p:column headerText="Manufacturer" sortBy="manufacturer">
#{car.manufacturer}
</p:column>
<p:column headerText="Color" sortBy="color">
#{car.color}
</p:column>
</p:dataTable>
On page load, column chooser finds all columns of datatable and generates the ui. If you'd like some of the columns to be ignored, set toggleable option of a column as false. Optional toggle ajax behavior is provided by columnChooser component to listen to toggle events at server side. Listener of this behavior gets an org.primefaces.event.ToggleEvent as a parameter that gives the visibility and index of the column being toggled.
Reordering Rows
Rows of the table can be reordered using drag&drop. Set draggableRows attribute to true to enable this feature.
Optional rowReorder ajax behavior is provided to listen to reorder events at server side. Listener of this behavior gets an org.primefaces.event.ReorderEvent as a parameter that gives the past and current index of the row being moved.
169
PrimeFaces User Guide
<p:dataTable var="car" value="#{tableBean.cars}" draggableRows="true">
<p:ajax event="rowReorder" listener="#{tableBean.onRowReorder}" />
<p:column headerText="Model">
#{car.model}
</p:column>
//columns
</p:dataTable> public class TableBean {
//...
public void onRowReorder(ReorderEvent event) {
//int from = event.getFromIndex();
//int end = event.getEndIndex();
}
}
Reordering Columns
Columns of the table can be reordered using drag&drop as well. Set draggableColumns attribute to true to enable this feature. Optional colReorder ajax behavior is provided to listen to reorder events at server side.
<p:dataTable var="car" value="#{tableBean.cars}" draggableColumns="true">
<p:column headerText="Model">
#{car.model}
</p:column>
//columns
</p:dataTable>
Ajax Behavior Events
Event
page sort filter rowSelect rowUnselect rowEdit
Listener Parameter
org.primefaces.event.data.PageEvent
org.primefaces.event.data.SortEvent
org.primefaces.event.data.FilterEvent
org.primefaces.event.SelectEvent
org.primefaces.event.UnselectEvent
org.primefaces.event.RowEditEvent
170
Fired
On pagination.
When a column is sorted.
On filtering.
When a row is being selected.
When a row is being unselected.
When a row is edited.
PrimeFaces User Guide
Event
rowEditInit rowEditCancel colResize toggleSelect colReorder rowSelectRadio rowSelectCheckbox rowUnselectCheckbox rowDblselect rowToggle contextMenu cellEdit rowReorder
Listener Parameter
org.primefaces.event.RowEditEvent
Fired
When a row switches to edit mode org.primefaces.event.RowEditEvent
When row edit is cancelled.
org.primefaces.event.ColumnResizeEvent When a column is being selected.
org.primefaces.event.ToggleSelectEvent
When header checkbox is toggled.
When columns are reordered.
org.primefaces.event.SelectEvent
org.primefaces.event.SelectEvent
org.primefaces.event.UnselectEvent
Row selection with radio.
Row selection with checkbox.
Row unselection with checkbox.
org.primefaces.event.SelectEvent
org.primefaces.event.ToggleEvent
org.primefaces.event.SelectEvent
org.primefaces.event.CellEditEvent
org.primefaces.event.ReorderEvent
Row selection with double click.
Row expand or collapse.
ContextMenu display.
When a cell is edited.
On row reorder.
For example, datatable below makes an ajax request when a row is selected with a click on row.
<p:dataTable var="car" value="#{carBean.model}">
<p:ajax event=”rowSelect” update=”another_component” />
//columns
</p:dataTable>
Client Side API
Widget: PrimeFaces.widget.DataTable
Method
getPaginator() clearFilters() getSelectedRowsCount() selectRow(r, silent) unselectRow(r, silent)
Params
-
-
r: number or tr element as jQuery object,
silent: flag to fire row select ajax behavior
r: number or tr element as jQuery object,
silent: flag to fire row select ajax behavior
Return Type Description
Paginator Returns the paginator insance.
void
Number
Clears all column filters
Returns number of selected rows.
void Selects the given row.
void Unselects the given row.
171
Method
unselectAllRows() toggleCheckAll() filter() selectAllRows() selectAllRowsOnPage() unselectAllRowsOnPage()
Params
-
-
-
-
-
-
PrimeFaces User Guide
Return Type
void void
Void void void void
Description
Unselects all rows.
Toggles header checkbox state.
Filters the data.
Select all rows.
Select all rows on current page.
Unselect all rows on current page.
Skinning
DataTable resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Class
.ui-datatable
.ui-datatable-data
.ui-datatable-empty-message
.ui-datatable-header
.ui-datatable-footer
.ui-sortable-column
.ui-sortable-column-icon
.ui-expanded-row-content
.ui-row-toggler
.ui-editable-column
.ui-cell-editor
.ui-cell-editor-input
.ui-cell-editor-output
.ui-datatable-even
.ui-datatable-odd
.ui-datatable-scrollable
.ui-datatable-scrollable-header
.ui-datatable-scrollable-header-box
.ui-datatable-scrollable-body
Applies
Main container element
Table body
Empty message row
Table header
Table footer
Sortable columns
Icon of a sortable icon
Content of an expanded row
Row toggler for row expansion
Columns with a cell editor
Container of input and output controls of an editable cell
Container of input control of an editable cell
Container of output control of an editable cell
Even numbered rows
Odd numbered rows
Main container element of a scrollable table.
Header wrapper of a scrollable table.
Header container of a scrollable table.
Body container of a scrollable table.
172
Class
.ui-datatable-scrollable-footer
.ui-datatable-scrollable-footer-box
.ui-datatable-resizable
PrimeFaces User Guide
Applies
Footer wrapper of a scrollable table.
Footer container of a scrollable table.
Main container element of a resizable table.
173
PrimeFaces User Guide
3.33 DefaultCommand
Which command to submit the form with when enter key is pressed a common problem in web apps not just specific to JSF. Browsers tend to behave differently as there doesn’t seem to be a standard and even if a standard exists, IE probably will not care about it. There are some ugly workarounds like placing a hidden button and writing javascript for every form in your app. DefaultCommand solves this problem by normalizing the command(e.g. button or link) to submit the form with on enter key press.
Info
Tag
Component Class
Component Type
defaultCommand org.primefaces.component.defaultcommand.DefaultCommand
org.primefaces.component.DefaultCommand
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DefaultCommandRenderer
Renderer Class
org.primefaces.component.defaultcommand.DefaultCommandRenderer
Attributes
id rendered
Name
binding widgetVar target scope null null null null
Default
null true
Type
String
Boolean
Object
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget
Identifier of the default command component.
Identifier of the ancestor component to enable multiple default commands in a form.
Getting Started with the DefaultCommand
DefaultCommand must be nested inside a form requires target option to reference a clickable command. Example below triggers btn2 when enter key is pressed. Note that an input must have focused due to browser nature.
174
PrimeFaces User Guide
<h:form id="form">
<h:panelGrid columns="3" cellpadding="5">
<h:outputLabel for="name" value="Name:" style="font-weight:bold"/>
<p:inputText id="name" value="#{defaultCommandBean.text}" />
<h:outputText value="#{defaultCommandBean.text}" id="display" />
</h:panelGrid>
<p:commandButton value="Button1" id="btn1" actionListener="#{bean.submit1}" ajax="false"/>
<p:commandButton value="Button2" id="btn2" actionListener="#{bean.submit2}" />
<h:commandButton value="Button3" id="btn3" actionListener="#{bean.submit3}" />
<p:defaultCommand target="bt2" />
</h:form>
Scope
If you need multiple default commands on same page use scope attribute that refers to the ancestor component of the target input.
175
3.34 Dialog
Dialog is a panel component that can overlay other elements on page.
PrimeFaces User Guide binding widgetVar header draggable resizable modal visible width height minWidth
Info
Tag
Component Class
dialog org.primefaces.component.dialog.Dialog
Component Type
org.primefaces.component.Dialog
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DialogRenderer
Renderer Class
org.primefaces.component.dialog.DialogRenderer
Attributes
id rendered
Name
null null true true false false auto auto
150
Default
null true null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget
String Text of the header
Boolean Specifies draggability
Boolean Specifies resizability
Boolean Enables modality.
Boolean When enabled, dialog is visible by default.
Integer
Integer
Integer
Width of the dialog
Height of the dialog
Minimum width of a resizable dialog.
176
Name
minHeight style styleClass showEffect hideEffect position closable onShow onHide appendTo showHeader footer dynamic minimizable maximizable closeOnEscape dir focus fitViewport
PrimeFaces User Guide true null false false false false ltr null false
0
Default
null null null null null true null null null
Type
Integer
String
String
Description
Minimum height of a resizable dialog.
Inline style of the dialog.
Style class of the dialog
String
String
Effect to use when showing the dialog
Effect to use when hiding the dialog
String Defines where the dialog should be displayed
Boolean Defines if close icon should be displayed or not
String Client side callback to execute when dialog is displayed.
String
String
Client side callback to execute when dialog is hidden.
Appends the dialog to the element defined by the given search expression.
Boolean Defines visibility of the header content.
String Text of the footer.
Boolean Enables lazy loading of the content with ajax.
Boolean Whether a dialog is minimizable or not.
Boolean Whether a dialog is maximizable or not.
Boolean Defines if dialog should close on escape key.
String Defines text direction, valid values are ltr and rtl.
String Defines which component to apply focus.
Boolean Dialog size might exceeed viewport if content is bigger than viewport in terms of height. fitViewport option automatically adjusts height to fit dialog within the viewport.
Getting started with the Dialog
Dialog is a panel component containing other components, note that by default dialog is not visible.
<p:dialog>
<h:outputText value="Resistance to PrimeFaces is Futile!" />
//Other content
</p:dialog>
Show and Hide
Showing and hiding the dialog is easy using the client side api.
177
PrimeFaces User Guide
<p:dialog header="Header Text" widgetVar="dlg">//Content</p:dialog>
<p:commandButton value="Show" type="button" onclick="PF('dlg').show()" />
<p:commandButton value="Hide" type="button" onclick="PF('dlg').hide()" />
Effects
There are various effect options to be used when displaying and closing the dialog. Use showEffect and hideEffect options to apply these effects; blind, bounce, clip, drop, explode, fade, fold, highlight, puff, pulsate, scale, shake, size, slide and transfer.
<p:dialog showEffect="fade" hideEffect="explode" ...>
//...
</p:dialog>
Position
By default dialog is positioned at center of the viewport and position option is used to change the location of the dialog. Possible values are;
• Single string value like ‘center’, ‘left’, ‘right’, ‘top’, ‘bottom’ representing the position within viewport.
•
Comma separated x and y coordinate values like 200, 500
• Comma separated position values like ‘top’,‘right’. (Use single quotes when using a combination)
Some examples are described below;
<p:dialog position="top" ...>
<p:dialog position="left,top" ...>
<p:dialog position="200,50" ...>
Focus
Dialog applies focus on first visible input on show by default which is useful for user friendliness however in some cases this is not desirable. Assume the first input is a popup calendar and opening the dialog shows a popup calendar. To customize default focus behavior, use focus attribute.
Ajax Behavior Events
close event is one of the ajax behavior events provided by dialog that is fired when the dialog is hidden. If there is a listener defined it’ll be executed by passing an instance of
org.primefaces.event.CloseEvent.
Example below adds a FacesMessage when dialog is closed and updates the messages component to display the added message.
178
PrimeFaces User Guide
<p:dialog>
<p:ajax event="close" listener="#{dialogBean.handleClose}" update="msg" />
//Content
</p:dialog>
<p:messages id="msg" /> public class DialogBean { public void handleClose(CloseEvent event) {
//Add facesmessage
}
}
3 other ajax behavior events are maximize, minimize, move that are invoked when dialog is maximized, minimized and moved respectively.
Client Side Callbacks
Similar to close listener, onShow and onHide are handy callbacks for client side in case you need to execute custom javascript.
<p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)">
//Content
</p:dialog>
Client Side API
Widget: PrimeFaces.widget.Dialog show()
Method
hide()
Params
-
-
Return Type
void void
Description
Displays dialog.
Closes dialog.
Skinning
Dialog resides in a main container element which styleClass option apply. Following is the list of structural style classes;
Style Class
.ui-dialog
.ui-dialog-titlebar
.ui-dialog-title-dialog
.ui-dialog-titlebar-close
.ui-dialog-content
Container element of dialog
Title bar
Applies
Header text
Close icon
Dialog body
179
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
Tips
• Use appendTo with care as the page definition and html dom would be different, for example if dialog is inside an h:form component and appendToBody is enabled, on the browser dialog would be outside of form and may cause unexpected results. In this case, nest a form inside a dialog.
• Do not place dialog inside tables, containers likes divs with relative positioning or with nonvisible overflow defined, in cases like these functionality might be broken. This is not a limitation but a result of DOM model. For example dialog inside a layout unit, tabview, accordion are a couple of examples. Same applies to confirmDialog as well.
180
PrimeFaces User Guide
3.35 Drag&Drop
Drag&Drop utilities of PrimeFaces consists of two components; Draggable and Droppable.
3.35.1 Draggable
Info
Tag
Component Class
Component Type
draggable org.primefaces.component.dnd.Draggable
org.primefaces.component.Draggable
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DraggableRenderer
Renderer Class
org.primefaces.component.dnd.DraggableRenderer
Attributes
Name
id rendered
Default
null true
Type
String boolean binding widgetVar proxy dragOnly for disabled axis containment helper revert snap snapMode null null false false null false null null null false false null
Object
String
Boolean
Boolean
String
Boolean
String
String
String
Boolean
Boolean
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget
Displays a proxy element instead of actual element.
Specifies a draggable that can’t be dropped.
Id of the component to add draggable behavior
Disables draggable behavior when true.
Specifies drag axis, valid values are ‘x’ and ‘y’.
Constraints dragging within the boundaries of containment element
Helper element to display when dragging
Reverts draggable to it’s original position when not dropped onto a valid droppable
Draggable will snap to edge of near elements
Specifies the snap mode. Valid values are ‘both’,
‘inner’ and ‘outer’.
181
Name
snapTolerance zindex handle opacity stack
20
Default Type
Integer null null
1 null
Integer
String
Double
String grid scope cursor dashboard appendTo null null crosshair null null
String
String
String
String
String
PrimeFaces User Guide
Description
Distance from the snap element in pixels to trigger snap.
ZIndex to apply during dragging.
Specifies a handle for dragging.
Defines the opacity of the helper during dragging.
In stack mode, draggable overlap is controlled automatically using the provided selector, dragged item always overlays other draggables.
Dragging happens in every x and y pixels.
Scope key to match draggables and droppables.
CSS cursor to display in dragging.
Id of the dashboard to connect with.
A search expression to define which element to append the draggable helper to.
Getting started with Draggable
Any component can be enhanced with draggable behavior, basically this is achieved by defining the id of component using the for attribute of draggable.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="This is actually a regular panel" />
</p:panel>
<p:draggable for="pnl"/>
If you omit the for attribute, parent component will be selected as the draggable target.
<h:graphicImage id="campnou" value="/images/campnou.jpg">
<p:draggable />
</h:graphicImage>
Handle
By default any point in dragged component can be used as handle, if you need a specific handle, you can define it with handle option. Following panel is dragged using it’s header only.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="I can only be dragged using my header" />
</p:panel>
<p:draggable for="pnl" handle="div.ui-panel-titlebar"/>
182
PrimeFaces User Guide
Drag Axis
Dragging can be limited to either horizontally or vertically.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="I am dragged on an axis only" />
</p:panel>
<p:draggable for="pnl" axis="x or y"/>
Clone
By default, actual component is used as the drag indicator, if you need to keep the component at it’s original location, use a clone helper.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="I am cloned" />
</p:panel>
<p:draggable for="pnl" helper="clone"/>
Revert
When a draggable is not dropped onto a matching droppable, revert option enables the component to move back to it’s original position with an animation.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="I will be reverted back to my original position" />
</p:panel>
<p:draggable for="pnl" revert="true"/>
Opacity
During dragging, opacity option can be used to give visual feedback, helper of following panel’s opacity is reduced in dragging.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="My opacity is lower during dragging" />
</p:panel>
<p:draggable for="pnl" opacity="0.5"/>
Grid
Defining a grid enables dragging in specific pixels. This value takes a comma separated dimensions in x,y format.
<p:panel id="pnl" header="Draggable Panel">
<h:outputText value="I am dragged in grid mode" />
</p:panel>
<p:draggable for="pnl" grid="20,40"/>
183
PrimeFaces User Guide
Containment
A draggable can be restricted to a certain section on page, following draggable cannot go outside of it’s parent.
<p:outputPanel layout="block" style="width:400px;height:200px;">
<p:panel id="conpnl" header="Restricted">
<h:outputText value="I am restricted to my parent's boundaries" />
</p:panel>
</p:outputPanel>
<p:draggable for="conpnl" containment="parent" />
184
PrimeFaces User Guide
3.35.2 Droppable
Info
Tag
Component Class
Component Type
droppable org.primefaces.component.dnd.Droppable
org.primefaces.component.Droppable
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DroppableRenderer
Renderer Class
org.primefaces.component.dnd.DroppableRenderer
Attributes
Name
id rendered binding widgetVar for disabled hoverStyleClass activeStyleClass null onDrop accept scope tolerance datasource null null null null null null null null false null
Default
null true
Type
String
Boolean
Object
String
String
Boolean
String
String
String
String
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Variable name of the client side widget
Id of the component to add droppable behavior
Disables of enables droppable behavior
Style class to apply when an acceptable draggable is dragged over.
Style class to apply when an acceptable draggable is being dragged.
Client side callback to execute when a draggable is dropped.
Selector to define the accepted draggables.
Scope key to match draggables and droppables.
Specifies the intersection mode to accept a draggable.
Id of a UIData component to connect with.
185
PrimeFaces User Guide
Getting Started with Droppable
Usage of droppable is very similar to draggable, droppable behavior can be added to any component specified with the for attribute.
<p:outputPanel id="slot" styleClass="slot" />
<p:droppable for="slot" /> slot styleClass represents a small rectangle.
<style type="text/css">
.slot { background:#FF9900; width:64px; height:96px; display:block;
}
</style>
If for attribute is omitted, parent component becomes droppable.
<p:outputPanel id="slot" styleClass="slot">
<p:droppable />
</p:outputPanel>
Ajax Behavior Events
drop is the only and default ajax behavior event provided by droppable that is processed when a valid draggable is dropped. In case you define a listener it’ll be executed by passing an
org.primefaces.event.DragDrop event instance parameter holding information about the dragged and dropped components.
Following example shows how to enable draggable images to be dropped on droppables.
<p:graphicImage id="messi" value="barca/messi_thumb.jpg" />
<p:draggable for="messi"/>
<p:outputPanel id="zone" styleClass="slot" />
<p:droppable for="zone">
<p:ajax listener="#{ddController.onDrop}" />
</p:droppable> public void onDrop(DragDropEvent ddEvent) {
String draggedId = ddEvent.getDragId();
String droppedId = ddEvent.getDropId();
Object data = ddEvent.getData();
}
//Client id of dragged component
//Client id of dropped component
//Model object of a datasource
186
PrimeFaces User Guide
onDrop
onDrop is a client side callback that is invoked when a draggable is dropped, it gets two parameters event and ui object holding information about the drag drop event.
<p:outputPanel id="zone" styleClass="slot" />
<p:droppable for="zone" onDrop="handleDrop"/> function handleDrop(event, ui) { var draggable = ui.draggable, helper = ui.helper, position = ui.position, offset = ui.offset;
}
//draggable element, a jQuery object
//helper element of draggable, a jQuery object
//position of draggable helper
//absolute position of draggable helper
DataSource
Droppable has special care for data elements that extend from UIData(e.g. datatable, datagrid), in order to connect a droppable to accept data from a data component define datasource option as the id of the data component. Example below show how to drag data from datagrid and drop onto a droppable to implement a dragdrop based selection. Dropped cars are displayed with a datatable.
public class TableBean { private List<Car> availableCars; private List<Car> droppedCars; public TableBean() { availableCars = //populate data
}
//getters and setters public void onCarDrop(DragDropEvent event) {
Car car = ((Car) ddEvent.getData()); droppedCars.add(car); availableCars.remove(car);
}
}
187
PrimeFaces User Guide
<h:form id="carForm">
<p:fieldset legend="AvailableCars">
<p:dataGrid id="availableCars" var="car" value="#{tableBean.availableCars}" columns="3">
<p:column>
<p:panel id="pnl" header="#{car.model}" style="text-align:center">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg" />
</p:panel>
<p:draggable for="pnl" revert="true" handle=".ui-panel-titlebar" stack=".ui-panel"/>
</p:column>
</p:dataGrid>
</p:fieldset>
<p:fieldset id="selectedCars" legend="Selected Cars" style="margin-top:20px">
<p:outputPanel id="dropArea">
<h:outputText value="!!!Drop here!!!" rendered="#{empty tableBean.droppedCars}" style="font-size:24px;" />
<p:dataTable var="car" value="#{tableBean.droppedCars}" rendered="#{not empty tableBean.droppedCars}">
<p:column headerText="Model">
<h:outputText value="#{car.model}" />
</p:column>
<p:column headerText="Year">
<h:outputText value="#{car.year}" />
</p:column>
<p:column headerText="Manufacturer">
<h:outputText value="#{car.manufacturer}" />
</p:column>
<p:column headerText="Color">
<h:outputText value="#{car.color}" />
</p:column>
</p:dataTable>
</p:outputPanel>
</p:fieldset>
<p:droppable for="selectedCars" tolerance="touch" activeStyleClass="ui-state-highlight" datasource="availableCars" onDrop="handleDrop"/>
<p:ajax listener="#{tableBean.onCarDrop}" update="dropArea availableCars" />
</p:droppable>
</h:form>
<script type="text/javascript"> function handleDrop(event, ui) { ui.draggable.fadeOut(‘fast’);
}
</script>
//fade out the dropped item
188
PrimeFaces User Guide
Tolerance
There are four different tolerance modes that define the way of accepting a draggable.
fit intersect pointer touch
Mode Description
draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount
Acceptance
You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has. Following example has two images, only first image can be accepted by droppable.
<p:graphicImage id="messi" value="barca/messi_thumb.jpg" />
<p:draggable for="messi" scope="forward"/>
<p:graphicImage id="xavi" value="barca/xavi_thumb.jpg" />
<p:draggable for="xavi" scope="midfield"/>
<p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" />
<p:droppable for="forwardsonly" />
Skinning
hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable.
189
3.36 Dock
Dock component mimics the well known dock interface of Mac OS X.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
dock org.primefaces.component.dock.Dock
org.primefaces.component.Dock
org.primefaces.component
org.primefaces.component.DockRenderer
org.primefaces.component.dock.DockRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding model null null position itemWidth maxWidth proximity halign widgetVar bottom
40
50
90 center null
Object
MenuModel
String
Integer
Integer
Integer
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
MenuModel instance to create menus programmatically
Position of the dock, bottom or top.
Initial width of items.
Maximum width of items.
Distance to enlarge.
Horizontal alignment,
Name of the client side widget.
190
PrimeFaces User Guide
Getting started with the Dock
A dock is composed of menuitems.
<p:dock>
<p:menuitem value="Home" icon="/images/dock/home.png" url="#" />
<p:menuitem value="Music" icon="/images/dock/music.png" url="#" />
<p:menuitem value="Video" icon="/images/dock/video.png" url="#"/>
<p:menuitem value="Email" icon="/images/dock/email.png" url="#"/>
<p:menuitem value="Link" icon="/images/dock/link.png" url="#"/>
<p:menuitem value="RSS" icon="/images/dock/rss.png" url="#"/>
<p:menuitem value="History" icon="/images/dock/history.png" url="#"/>
</p:dock>
Position
Dock can be located in two locations, top or bottom (default). For a dock positioned at top set position to top.
Dock Effect
When mouse is over the dock items, icons are zoomed in. The configuration of this effect is done via the maxWidth and proximity attributes.
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
Following is the list of structural style classes, {positon} can be top or bottom.
Style Class
.ui-dock-{position}
.ui-dock-container-{position}
.ui-dock-item-{position}
Main container.
Menu item container.
Each menu item.
Applies
As skinning style classes are global, see the main theming section for more information.
191
3.37 Editor
Editor is an input component with rich text editing capabilities.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding value converter immediate required
editor org.primefaces.component.editor.Editor
org.primefaces.component.Editor
org.primefaces.component
org.primefaces.component.EditorRenderer
org.primefaces.component.editor.EditorRenderer
Default
null true null null null false false
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Value of the component than can be either an EL expression of a literal text.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id.
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required.
192
validator
Name
valueChangeListener requiredMessage
Default
null null null
Type
Method
Expr
Method
Expr
String converterMessage validatorMessage widgetVar controls height width disabled style styleClass onchange maxlength null null null null null null null null null false null
String
String
String
String
Integer
Integer
Boolean
String
String
String
Integer
PrimeFaces User Guide
Description
A method expression that refers to a method validationg the input.
A method expression that refers to a method for handling a valuchangeevent.
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fails.
Name of the client side widget.
List of controls to customize toolbar.
Height of the editor.
Width of the editor.
Disables editor.
Inline style of the editor container.
Style class of the editor container.
Client side callback to execute when editor data changes.
Maximum length of the raw input.
Getting started with the Editor
Rich Text entered using the Editor is passed to the server using value expression.
public class Bean { private String text;
//getter and setter
}
<p:editor value="#{bean.text}" />
Custom Toolbar
Toolbar of editor is easy to customize using controls option;
<p:editor value="#{bean.text}" controls="bold italic underline strikethrough" />
193
PrimeFaces User Guide
Here is the full list of all available controls;
• bold
• italic
• underline
• strikethrough
• subscript
• superscript
• font
• size
• style
• color
• highlight
• bullets
• numbering
• alignleft
• center
• alignright
• justify
• undo
• redo
• rule
• image
• link
• unlink
• cut
• copy
• paste
• pastetext
• source
• outdent
• indent
• removeFormat
Client Side API
Widget: PrimeFaces.widget.Editor init()
Method Params
saveHTML() clear() enable() disable() focus() selectAll() getSelectedHTML() getSelectedText()
-
-
-
-
-
-
-
void void
String
String void void void void
Return Type
void
Description
Initializes a lazy editor, subsequent calls do not reinit the editor.
Saves html text in iframe back to the textarea.
Clears the text in editor.
Enables editing.
Disables editing.
Adds cursor focus to edit area.
Selects all text in editor.
Returns selected text as HTML.
Returns selected text in plain format.
194
PrimeFaces User Guide
Skinning
Following is the list of structural style classes.
Style Class
.ui-editor
.ui-editor-toolbar
.ui-editor-group
.ui-editor-button
.ui-editor-divider
.ui-editor-disabled
.ui-editor-list
.ui-editor-color
.ui-editor-popup
.ui-editor-prompt
.ui-editor-message
Main container.
Toolbar of editor.
Button groups.
Each button.
Divider to separate buttons.
Applies
Disabled editor controls.
Dropdown lists.
Color picker.
Popup overlays.
Overlays to provide input.
Overlays displaying a message.
Editor is not integrated with ThemeRoller as there is only one icon set for the controls.
195
PrimeFaces User Guide
3.38 Effect
Effect component is based on the jQuery UI effects library.
Info
Tag
Tag Class
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
effect org.primefaces.component.effect.EffectTag
org.primefaces.component.effect.Effect
org.primefaces.component.Effect
org.primefaces.component
org.primefaces.component.EffectRenderer
org.primefaces.component.effect.EffectRenderer
Attributes
Name
id rendered binding effect event type for speed delay
Default
null
1 null null null null null
1000 null
String
Boolean
Type
Object
String
String
String
String
Integer
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Dom event to attach the event that executes the animation
Specifies the name of the animation
Component that is animated
Speed of the animation in ms
Time to wait until running the effect.
Getting started with Effect
Effect component needs a trigger and target which is effect’s parent by default. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.
196
PrimeFaces User Guide
<h:outputText value="#{bean.value}">
<p:effect type="pulsate" event="click" />
</h:outputText>
Effect Target
There may be cases where you want to display an effect on another target on the same page while keeping the parent as the trigger. Use for option to specify a target.
<h:outputLink id="lnk" value="#">
<h:outputText value="Show the Barca Temple" />
<p:effect type="appear" event="click" for="img" />
</h:outputLink>
<p:graphicImage id="img" value="/ui/barca/campnou.jpg" style="display:none"/>
With this setting, outputLink becomes the trigger for the effect on graphicImage. When the link is clicked, initially hidden graphicImage comes up with a fade effect.
Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly.
List of Effects
Following is the list of effects;
• blind
• clip
• drop
• explode
• fold
• puff
• slide
• scale
• bounce
• highlight
• pulsate
• shake
• size
• transfer
197
PrimeFaces User Guide
Effect Configuration
Each effect has different parameters for animation like colors, duration and more. In order to change the configuration of the animation, provide these parameters with the f:param tag.
<h:outputText value="#{bean.value}">
<p:effect type="scale" event="mouseover">
<f:param name="percent" value="90"/>
</p:effect>
</h:outputText>
It’s important to provide string options with single quotes.
<h:outputText value="#{bean.value}">
<p:effect type="blind" event="click">
<f:param name="direction" value="'horizontal'" />
</p:effect>
</h:outputText>
For the full list of configuration parameters for each effect, please see the jquery documentation; http://docs.jquery.com/UI/Effects
Effect on Load
Effects can also be applied to any JSF component when page is loaded for the first time or after an ajax request is completed by using load as the event name. Following example animates messages with pulsate effect after ajax request completes.
<p:messages id="messages">
<p:effect type="pulsate" event="load" delay=”500”>
<f:param name="mode" value="'show'" />
</p:effect>
</p:messages>
<p:commandButton value="Save" actionListener="#{bean.action}" update="messages"/>
198
PrimeFaces User Guide
3.39 FeedReader
FeedReader is used to display content from a feed.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
feedReader org.primefaces.component.feedreader.FeedReader
org.primefaces.component.FeedReader
org.primefaces.component
org.primefaces.component.FeedReaderRenderer
org.primefaces.component.feedreader.FeedReaderRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding value var size null null null
Unlimited
Object
String
String
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
URL of the feed.
Iterator to refer each item in feed.
Number of items to display.
Getting started with FeedReader
FeedReader requires a feed url to display and renders its content for each feed item.
<p:feedReader value=" http://rss.news.yahoo.com/rss/sports " var="feed">
<h:outputText value="#{feed.title}" style="font-weight: bold"/>
<h:outputText value="#{feed.description.value}" escape="false"/>
<p:separator />
<f:facet name="error">
Something went wrong.
</f:facet>
</p:feedReader>
Note that you need the ROME library in your classpath to make feedreader work.
199
3.40 Fieldset
Fieldset is a grouping component as an extension to html fieldset.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
fieldset org.primefaces.component.fieldset.Fieldset
org.primefaces.component.Fieldset
org.primefaces.component
org.primefaces.component.FieldsetRenderer
org.primefaces.component.fieldset.FieldsetRenderer
Attributes
Name
id rendered binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null
Default
true
Type
String
Boolean null null null null null false
500 false
Object
String
String
String
String
Boolean
Integer
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Title text.
Inline style of the fieldset.
Style class of the fieldset.
Makes content toggleable with animation.
Toggle duration in milliseconds.
Defines initial visibility state of content.
200
PrimeFaces User Guide
Getting started with Fieldset
Fieldset is used as a container component for its children.
<p:fieldset legend="Simple Fieldset">
<h:panelGrid column="2">
<p:graphicImage value="/images/godfather/1.jpg" />
<h:outputText value="The story begins as Don Vito Corleone ..." />
</h:panelGrid>
</p:fieldset>
Legend
Legend can be defined in two ways, with legend attribute as in example above or using legend facet. Use facet way if you need to place custom html other than simple text.
<p:fieldset>
<f:facet name="legend">
</f:facet>
//content
</p:fieldset>
When both legend attribute and legend facet are present, facet is chosen.
Toggleable Content
Clicking on fieldset legend can toggle contents, this is handy to use space efficiently in a layout. Set toggleable to true to enable this feature.
<p:fieldset legend="Toggleable Fieldset" toggleable="true">
<h:panelGrid column="2">
<p:graphicImage value="/images/godfather/2.jpg" />
<h:outputText value="Francis Ford Coppolas’ legendary ..." />
</h:panelGrid>
</p:fieldset>
Ajax Behavior Events
toggle is the default and only ajax behavior event provided by fieldset that is processed when the content is toggled. In case you have a listener defined, it will be invoked by passing an instance of
org.primefaces.event.ToggleEvent.
201
PrimeFaces User Guide
Here is an example that adds a facesmessage and updates growl component when fieldset is toggled.
<p:growld id="messages" />
<p:fieldset legend="Toggleable Fieldset" toggleable="true"
<p:ajax listener="#{bean.onToggle}" update="messages">
//content
</p:fieldset> public void onToggle(ToggleEvent event) {
Visibility visibility = event.getVisibility();
FacesMessage msg = new FacesMessage(); msg.setSummary("Fieldset " + event.getId() + " toggled"); msg.setDetail("Visibility: " + visibility);
FacesContext.getCurrentInstance().addMessage(null, msg);
}
Client Side API
Widget: PrimeFaces.widget.Fieldset toggle()
Method Params
-
Return Type
void
Description
Toggles fieldset content.
Skinning
style and styleClass options apply to the fieldset. Following is the list of structural style classes;
Style Class
.ui-fieldset
.ui-fieldset-toggleable
Applies
Main container
Main container when fieldset is toggleable
.ui-fieldset .ui-fieldset-legend Legend of fieldset
.ui-fieldset-toggleable .ui-fieldset-legend Legend of fieldset when fieldset is toggleable
.ui-fieldset .ui-fieldset-toggler Toggle icon on fieldset
As skinning style classes are global, see the main theming section for more information.
Tips
• A collapsed fieldset will remain collapsed after a postback since fieldset keeps its toggle state internally, you don’t need to manage this using toggleListener and collapsed option.
202
PrimeFaces User Guide
3.41 FileDownload
The legacy way to present dynamic binary data to the client is to write a servlet or a filter and stream the binary data. FileDownload presents an easier way to do the same.
Info
Tag
fileDownload
ActionListener Class
org.primefaces.component.filedownload.FileDownloadActionListener
Attributes
value
Name Default
null contextDisposition attachment String
Type
StreamedContent
Description
A streamed content instance
Specifies display mode.
Getting started with FileDownload
A user command action is required to trigger the filedownload process. FileDownload can be attached to any command component like a commandButton or commandLink. The value of the
FileDownload must be an org.primefaces.model.StreamedContent instance. We suggest using the built-in DefaultStreamedContent implementation. First parameter of the constructor is the binary stream, second is the mimeType and the third parameter is the name of the file.
public class FileBean {
private StreamedContent file;
public FileDownloadController() {
InputStream stream = this.getClass().getResourceAsStream("yourfile.pdf");
file = new DefaultStreamedContent(stream, "application/pdf",
"downloaded_file.pdf");
} public StreamedContent getFile() { return this.file;
}
}
This streamed content should be bound to the value of the fileDownload.
<h:commandButton value="Download">
<p:fileDownload value="#{fileBean.file}" />
</h:commandButton>
Similarly a more graphical presentation would be to use a commandlink with an image.
203
PrimeFaces User Guide
<h:commandLink value="Download">
<p:fileDownload value="#{fileBean.file}"/>
<h:graphicImage value="pdficon.gif" />
</h:commandLink>
If you’d like to use PrimeFaces commandButton and commandLink, disable ajax option as fileDownload requires a full page refresh to present the file.
<p:commandButton value="Download" ajax="false">
<p:fileDownload value="#{fileBean.file}" />
</p:commandButton>
<p:commandLink value="Download" ajax="false">
<p:fileDownload value="#{fileBean.file}"/>
<h:graphicImage value="pdficon.gif" />
</p:commandLink>
ContentDisposition
By default, content is displayed as an attachment with a download dialog box, another alternative is the inline mode, in this case browser will try to open the file internally without a prompt. Note that content disposition is not part of the http standard although it is widely implemented.
Monitor Status
As fileDownload process is non-ajax, ajaxStatus cannot apply. Still PrimeFaces provides a feature to monitor file downloads via client side monitorDownload(startFunction, endFunction) method.
Example below displays a modal dialog when dowload begins and hides it on complete.
<script type="text/javascript"> function showStatus() {
PF('statusDialog').show();
} function hideStatus() {
PF('statusDialog').hide();
}
</script>
<h:form>
<p:dialog modal="true" widgetVar="statusDialog" header="Status" draggable="false" closable="false">
<p:graphicImage value="/design/ajaxloadingbar.gif" />
</p:dialog>
<p:commandButton value="Download" ajax="false" onclick="PrimeFaces.monitorDownload(showStatus, hideStatus)">
<p:fileDownload value="#{fileDownloadController.file}"/>
</p:commandButton>
</h:form>
Cookies must be enabled for monitoring.
204
PrimeFaces User Guide
3.42 FileUpload
FileUpload goes beyond the browser input type="file" functionality and features an HTML5 powered rich solution with graceful degradation for legacy browsers.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
fileUpload org.primefaces.component.fileupload.FileUpload
org.primefaces.component.FileUpload
org.primefaces.component
org.primefaces.component.FileUploadRenderer
org.primefaces.component.fileupload.FileUploadRenderer
Attributes
Name
id rendered binding
Default
null true
String boolean null Object
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
205
PrimeFaces User Guide
Name Default Description
value converter immediate required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar update process fileUploadListener multiple auto label allowTypes sizeLimit fileLimit style null null false false null null
Object Value of the component than can be either an EL expression of a literal text.
Converter
/String
Boolean
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id.
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required.
Boolean
MethodExpr A method expression that refers to a method validationg the input.
MethodExpr A method expression that refers to a method for handling a valuchangeevent.
null null null null null null null false false
Choose null null
String
String
String
String
String
String Component(s) to process in fileupload request.
MethodExpr Method to invoke when a file is uploaded.
Boolean
Boolean
String
String
Integer
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fails.
Name of the client side widget.
Component(s) to update after fileupload completes.
Allows choosing of multi file uploads from native file browse dialog
When set to true, selecting a file starts the upload process implicitly.
Label of the browse button.
Regular expression for accepted file types, e.g. /(\.|\/)(gif|jpe?g|png)$/
Individual file size limit in bytes.
styleClass mode uploadLabel cancelLabel null null
Integer
String null String advanced String
Upload String
Cancel String
Maximum number of files allowed to upload.
Inline style of the component.
Style class of the component.
Mode of the fileupload, can be simple or advanced.
Label of the upload button.
Label of the cancel button.
206
Name Default
invalidSizeMessage null invalidFileMessage null fileLimitMessage null dragDropSupport true
String
String
String
Boolean onstart onerror oncomplete disabled messageTemplate previewWidth null null null false
{name}
{size}
80
String
String
String
Boolean
String
Integer
PrimeFaces User Guide
Description
Message to display when size limit exceeds.
Message to display when file is not accepted.
Message to display when file limit exceeds.
Specifies dragdrop based file selection from filesystem, default is true and works only on supported browsers.
Client side callback to execute when upload begins.
Callback to execute if fileupload request fails.
Client side callback to execute when upload ends.
Disables component when set true.
Message template to use when displaying file validation errors.
Width for image previews in pixels.
Getting started with FileUpload
FileUpload engine on the server side can either be servlet 3.0 or commons fileupload. PrimeFaces selects the most appropriate uploader engine by detection and it is possible to force one or the other usign an optional configuration param.
<context-param>
<param-name>primefaces.UPLOADER</param-name>
<param-value>auto|native|commons</param-value>
</context-param>
auto: This is the default mode and PrimeFaces tries to detect the best method by checking the runtime environment, if JSF runtime is at least 2.2 native uploader is selected, otherwise commons.
native: Native mode uses servlet 3.x Part API to upload the files and if JSF runtime is less than 2.2
and exception is being thrown.
commons: This option chooses commons fileupload regardless of the environment, advantage of this option is that it works even on a Servlet 2.5 environment.
If you have decided to choose commons fileupload, it requires the following filter configration in your web deployment descriptior.
207
PrimeFaces User Guide
<filter>
<filter-name>PrimeFaces FileUpload Filter</filter-name>
<filter-class> org.primefaces.webapp.filter.FileUploadFilter
</filter-class>
</filter>
<filter-mapping>
<filter-name>PrimeFaces FileUpload Filter</filter-name>
<servlet-name>Faces Servlet</servlet-name>
</filter-mapping>
Note that the servlet-name should match the configured name of the JSF servlet which is Faces
Servlet in this case. Alternatively you can do a configuration based on url-pattern as well.
Simple File Upload
Simple file upload mode works in legacy mode with a file input whose value should be an
UploadedFile instance. Ajax uploads are not supported in simple upload.
<h:form enctype="multipart/form-data">
<p:fileUpload value="#{fileBean.file}" mode="simple" />
<p:commandButton value="Submit" ajax="false"/>
</h:form> import org.primefaces.model.UploadedFile;
public class FileBean { private UploadedFile file;
//getter-setter
}
Advanced File Upload
FileUploadListener is the way to access the uploaded files in this mode, when a file is uploaded defined fileUploadListener is processed with a FileUploadEvent as the parameter.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" /> public class FileBean { public void handleFileUpload(FileUploadEvent event) {
UploadedFile file = event.getFile();
//application code
}
}
208
PrimeFaces User Guide
Multiple Uploads
Multiple uploads can be enabled using the multiple attribute so that multiple files can be selected from browser dialog. Multiple uploads are not supported in legacy browsers. Note that multiple mode is for selection only, it does not send all files in one request. FileUpload component always uses a new request for each file.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" multiple="true" />
Auto Upload
Default behavior requires users to trigger the upload process, you can change this way by setting auto to true. Auto uploads are triggered as soon as files are selected from the dialog.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" auto="true" />
Partial Page Update
After the fileUpload process completes you can use the PrimeFaces PPR to update any component on the page. FileUpload is equipped with the update attribute for this purpose. Following example displays a "File Uploaded" message using the growl component after file upload.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" update="msg" />
<p:growl id="msg" /> public class FileBean { public void handleFileUpload(FileUploadEvent event) {
//add facesmessage to display with growl
//application code
}
}
File Filters
Users can be restricted to only select the file types you’ve configured, example below demonstrates how to accept images only.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" allowTypes="/(\.|\/)(gif|jpe?g|png)$/"/>
Size Limit
Most of the time you might need to restrict the file upload size for a file, this is as simple as setting the sizeLimit configuration. Following fileUpload limits the size to 1000 bytes for each file.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" sizeLimit="1000" />
209
PrimeFaces User Guide
File Limit
FileLimit restricts the number of maximum files that can be uploaded.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" fileLimit="3" />
Validation Messages
invalidFileMessage, invalidSizeMessage and fileLimitMessage options are provided to display validation messages to the users. Similar to the FacesMessage message API, these message define the summary part, the detail part is retrieved from the messageTemplate option where default value is “{name} {size}”.
Skinning
FileUpload resides in a container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes
Class
.ui-fileupload
.fileupload-buttonbar
.fileinput-button
.ui-fileupload start
.ui-fileupload cancel fileupload-content
Main container element
Button bar.
Browse button.
Upload button.
Cancel button.
Content container.
Applies
Browser Compatibility
Advanced uploader is implemented with HTML5 and provides far more features compared to single version. For legacy browsers that do not support HMTL5 features like canvas or file api, fileupload uses graceful degradation so that iframe is used for transport, detailed file information is not shown and a gif animation is displayed instead of progress bar. It is suggested to offer simple uploader as a fallback.
Filter Configuration
Filter configuration is required if you are using commons uploader only. Two configuration options exist, threshold size and temporary file upload location.
Parameter Name
thresholdSize uploadDirectory
Description
Maximum file size in bytes to keep uploaded files in memory. If a file exceeds this limit, it’ll be temporarily written to disk.
Disk repository path to keep temporary files that exceeds the threshold size.
By default it is System.getProperty("java.io.tmpdir")
210
PrimeFaces User Guide
An example configuration below defined thresholdSize to be 50kb and uploads to users temporary folder.
<filter>
<filter-name>PrimeFaces FileUpload Filter</filter-name>
<filter-class> org.primefaces.webapp.filter.FileUploadFilter
</filter-class>
<init-param>
<param-name>thresholdSize</param-name>
<param-value>51200</param-value>
</init-param>
<init-param>
<param-name>uploadDirectory</param-name>
<param-value>/Users/primefaces/temp</param-value>
</init-param>
</filter>
Note that uploadDirectory is used internally, you always need to implement the logic to save the file contents yourself in your backing bean.
211
PrimeFaces User Guide
3.43 Focus
Focus is a utility component that makes it easy to manage the element focus on a JSF page.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
focus org.primefaces.component.focus.Focus
org.primefaces.component.Focus.FocusTag
org.primefaces.component
org.primefaces.component.FocusRenderer
org.primefaces.component.focus.FocusRenderer
Attributes
Name
id rendered binding for context minSeverity
Default
null true
String
Type
boolean null null null error
Object
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Specifies the exact component to set focus
The root component to start first input search.
Minimum severity level to be used when finding the first invalid component
Getting started with Focus
By default focus will find the first enabled and visible input component on page and apply focus.
Input component can be any element such as input, textarea and select.
<p:focus />
<p:inputText ... />
<h:inputText ... />
<h:selectOneMenu ... />
Following is a simple example;
212
PrimeFaces User Guide
<h:form>
<p:panel id="panel" header="Register">
<p:focus />
<p:messages />
<h:panelGrid columns="3">
<h:outputLabel for="firstname" value="Firstname: *" />
<h:inputText id="firstname" value="#{pprBean.firstname}" required="true" label="Firstname" />
<p:message for="firstname" />
<h:outputLabel for="surname" value="Surname: *" />
<h:inputText id="surname" value="#{pprBean.surname}" required="true" label="Surname"/>
<p:message for="surname" />
</h:panelGrid>
<p:commandButton value="Submit" update="panel" actionListener="#{pprBean.savePerson}" />
</p:panel>
</h:form>
When this page initially opens up, input text with id "firstname" will receive focus as it is the first input component.
Validation Aware
Another useful feature of focus is that when validations fail, first invalid component will receive a focus. So in previous example if firstname field is valid but surname field has no input, a validation error will be raised for surname, in this case focus will be set on surname field implicitly. Note that for this feature to work on ajax requests, you need to update p:focus component as well.
Explicit Focus
Additionally, using for attribute focus can be set explicitly on an input component which is useful when using a dialog.
<p:focus for="text"/>
<h:inputText id="text" value="{bean.value}" />
213
PrimeFaces User Guide
3.44 Fragment
Fragment component is used to define automatically partially process and update sections whenever ajax request is triggered by a descendant component.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
fragment org.primefaces.component.fragment.Fragment
org.primefaces.component.Fragment
org.primefaces.component
org.primefaces.component.FragmentRenderer
org.primefaces.component.fragment.FragmentRenderer
Attributes
id
Name
rendered binding autoUpdate
Default
null true null false
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side UIComponent instance in a backing bean
Boolean Updates the fragment automatically.
Getting started with Fragment
In the following case, required input field outside the fragment is ignored and only the contents of the fragment are processed-updated automatically on button click since button is inside the fragment. Fragment makes it easy to define partial ajax process and update without explicitly defining component identifiers.
214
PrimeFaces User Guide
<h:form>
<h:panelGrid columns="2">
<p:outputLabel for="ign" value="Required:" />
<p:inputText id="ign" required="true" />
</h:panelGrid>
<p:fragment autoUpdate="true">
<h:panelGrid columns="4" cellpadding="5">
<h:outputLabel for="name" value="Name:" />
<h:outputText value="#{pprBean.firstname}" />
</h:panelGrid>
</p:fragment>
<p:inputText id="name" value="#{pprBean.firstname}" />
<p:commandButton value="Submit"/>
</h:form>
AutoUpdate has different notion compared to autoUpdate of message, growl and outputPanel. The fragment is updated automatically after an ajax request if the source is a descendant. In other mentioned components, there is no such restriction as they are updated for every ajax request regardless of the source.
215
PrimeFaces User Guide
3.45 Galleria
Galleria is used to display a set of images.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
galleria org.primefaces.component.galleria.Galleria
org.primefaces.component.Galleria
org.primefaces.component
org.primefaces.component.GalleriaRenderer
org.primefaces.component.galleria.GalleriaRenderer
Attributes
Name
id rendered binding widgetVar value var style styleClass effect
Default
null true
String
Type
boolean null null null null null null fade
Object
String
Collection
String
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Collection of data to display.
Name of variable to access an item in collection.
Inline style of the container element.
Style class of the container element.
Name of animation to use.
216
Name
effectSpeed panelWidth panelHeight frameWidth frameHeight
60
40 showFilmstrip showCaption true false transitionInterval 4000 autoPlay true
Default
700
600
400
Type
Integer
Integer
Integer
Integer
Integer
Boolean
Boolean
Integer
Boolean
PrimeFaces User Guide
Description
Duration of animation in milliseconds.
Width of the viewport.
Height of the viewport.
Width of the frames.
Height of the frames.
Defines visibility of filmstrip.
Defines visibility of captions.
Defines interval of slideshow.
Images are displayed in a slideshow in autoPlay.
Getting Started with Galleria
Images to displayed are defined as children of galleria;
<p:galleria effect="slide" effectDuration="1000">
<p:graphicImage value="/images/image1.jpg" title="image1" alt="image1 desc" />
<p:graphicImage value="/images/image2.jpg" title="image1" alt=" image2 desc" />
<p:graphicImage value="/images/image3.jpg" title="image1" alt=" image3 desc" />
<p:graphicImage value="/images/image4.jpg" title="image1" alt=" image4 desc" />
</p:galleria>
Galleria displays the details of an image using an overlay which is displayed by clicking the information icon. Title of this popup is retrieved from the image title attribute and description from
alt attribute so it is suggested to provide these attributes as well.
Dynamic Collection
Most of the time, you would need to display a dynamic set of images rather than defining each image declaratively. For this you can use built-in data iteration feature.
<p:galleria value="#{galleriaBean.images}" var="image" >
<p:graphicImage value="#{image.path}" title="#{image.title}" alt="#{image.description}" />
</p:galleria>
Effects
There are various effect options to be used in transitions; blind, bounce, clip, drop, explode, fade, fold, highlight, puff, pulsate, scale, shake, size, slide and transfer.
By default animation takes 500 milliseconds, use effectSpeed option to tune this.
217
PrimeFaces User Guide
<p:galleria effect="slide" effectSpeed="1000">
//images
</p:galleria>
Skinning
Galleria resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes
Style Class
.ui-galleria
.ui-galleria-panel-wrapper
Applies
Container element for galleria.
Container of panels.
.ui-galleria-panel
.ui-galleria-caption
Container of each image.
Caption element.
.ui-galleria-nav-prev, .ui-galleria-nav-next Navigators of filmstrip.
.ui-galleria-filmstrip-wrapper Container of filmstrip.
.ui-galleria-filmstrip
.ui-galleria-frame
.ui-galleria-frame-content
.ui-galleria-frame-image
Filmstrip element.
Frame element in a filmstrip.
Content of a frame.
Thumbnail image.
218
3.46 GMap
GMap is a map component integrated with Google Maps API V3.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
gmap org.primefaces.component.gmap.GMap
org.primefaces.component.Gmap
org.primefaces.component
org.primefaces.component.GmapRenderer
org.primefaces.component.gmap.GmapRenderer
Attributes
Name
id rendered binding widgetVar model
Default
null true null null null
Type
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side
UIComponent instance in a backing bean.
Name of the client side widget.
MapModel An org.primefaces.model.MapModel instance.
219
Name
style styleClass type center zoom streetView disableDefaultUI navigationControl mapTypeControl draggable disabledDoubleClickZoom onPointClick fitBounds
Default
false false true true true false null null null null null
8
Type
String
String
String
String
Integer
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
String true Boolean
PrimeFaces User Guide
Description
Inline style of the map container.
Style class of the map container.
Type of the map.
Center point of the map.
Defines the initial zoom level.
Controls street view support.
Disables default UI controls
Defines visibility of navigation control.
Defines visibility of map type control.
Defines draggability of map.
Disables zooming on mouse double click.
Javascript callback to execute when a point on map is clicked.
Defines if center and zoom should be calculated automatically to contain all markers on the map.
Getting started with GMap
First thing to do is placing V3 of the Google Maps API that the GMap is based on. Ideal location is the head section of your page.
<script src="http://maps.google.com/maps/api/js?sensor=true|false" type="text/javascript"></script>
As Google Maps api states, mandatory sensor parameter is used to specify if your application requires a sensor like GPS locator. Four options are required to place a gmap on a page, these are center, zoom, type and style.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" />
center: Center of the map in lat, lng format
zoom: Zoom level of the map
type: Type of map, valid values are, "hybrid", "satellite", "hybrid" and "terrain".
style: Dimensions of the map.
220
PrimeFaces User Guide
MapModel
GMap is backed by an org.primefaces.model.map.MapModel instance, PrimeFaces provides
org.primefaces.model.map.DefaultMapModel as the default implementation. API Docs of all GMap related model classes are available at the end of GMap section and also at javadocs of PrimeFaces.
Markers
A marker is represented by org.primefaces.model.map.Marker.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {
private MapModel model = new DefaultMapModel();
public MapBean() { model.addOverlay(new Marker(new LatLng(36.879466, 30.667648), "M1"));
//more overlays
}
public MapModel getModel() { return this.model; }
}
Polylines
A polyline is represented by org.primefaces.model.map.Polyline.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/>
221
PrimeFaces User Guide public class MapBean {
private MapModel model;
public MapBean() { model = new DefaultMapModel();
Polyline polyline = new Polyline(); polyline.getPaths().add(new LatLng(36.879466, 30.667648)); polyline.getPaths().add(new LatLng(36.883707, 30.689216)); polyline.getPaths().add(new LatLng(36.879703, 30.706707)); polyline.getPaths().add(new LatLng(36.885233, 37.702323)); model.addOverlay(polyline);
}
public MapModel getModel() { return this.model; }
}
Polygons
A polygon is represented by org.primefaces.model.map.Polygon.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {
private MapModel model;
public MapBean() { model = new DefaultMapModel();
Polygon polygon = new Polygon(); polyline.getPaths().add(new LatLng(36.879466, 30.667648)); polyline.getPaths().add(new LatLng(36.883707, 30.689216)); polyline.getPaths().add(new LatLng(36.879703, 30.706707)); model.addOverlay(polygon);
}
public MapModel getModel() { return this.model; }
}
Circles
A circle is represented by org.primefaces.model.map.Circle.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/>
222
PrimeFaces User Guide public class MapBean {
private MapModel model;
public MapBean() { model = new DefaultMapModel();
Circle circle = new Circle(new LatLng(36.879466, 30.667648), 500); model.addOverlay(circle);
}
public MapModel getModel() { return this.model; }
}
Rectangles
A circle is represented by org.primefaces.model.map.Rectangle.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {
private MapModel model;
public MapBean() { model = new DefaultMapModel();
LatLng coord1 = new LatLng(36.879466, 30.667648);
LatLng coord2 = new LatLng(36.883707, 30.689216);
Rectangle rectangle = new Rectangle(coord1, coord2); model.addOverlay(circle);
}
public MapModel getModel() { return this.model; }
}
Ajax Behavior Events
GMap provides many custom ajax behavior events for you to hook-in to various features.
Event
overlaySelect stateChange pointSelect markerDrag
Listener Parameter
org.primefaces.event.map.OverlaySelectEvent
org.primefaces.event.map.StateChangeEvent
org.primefaces.event.map.PointSelectEvent
org.primefaces.event.map.MarkerDragEvent
Fired
When an overlay is selected.
When map state changes.
When an empty point is selected.
When a marker is dragged.
Following example displays a FacesMessage about the selected marker with growl component.
223
PrimeFaces User Guide
<h:form>
<p:growl id="growl" />
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}">
<p:ajax event="overlaySelect" listener="#{mapBean.onMarkerSelect}" update="growl" />
</p:gmap>
</h:form> public class MapBean {
private MapModel model;
public MapBean() { model = new DefaultMapModel();
//add markers
}
public MapModel getModel() { return model
}
public void onMarkerSelect(OverlaySelectEvent event) {
Marker selectedMarker = (Marker) event.getOverlay();
//add facesmessage
}
}
InfoWindow
A common use case is displaying an info window when a marker is selected. gmapInfoWindow is used to implement this special use case. Following example, displays an info window that contains an image of the selected marker data.
<h:form>
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}">
<p:ajax event="overlaySelect" listener="#{mapBean.onMarkerSelect}" />
<p:gmapInfoWindow>
<p:graphicImage value="/images/#{mapBean.marker.data.image}" />
<h:outputText value="#{mapBean.marker.data.title}" />
</p:gmapInfoWindow>
</p:gmap>
</h:form>
224
public class MapBean {
private MapModel model;
private Marker marker;
public MapBean() { model = new DefaultMapModel();
//add markers
}
public MapModel getModel() { return model; }
public Marker getMarker() { return marker; }
public void onMarkerSelect(OverlaySelectEvent event) { this.marker = (Marker) event.getOverlay();
}
}
PrimeFaces User Guide
Street View
StreeView is enabled simply by setting streetView option to true.
<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" streetView="true" />
225
PrimeFaces User Guide
Map Controls
Controls on map can be customized via attributes like navigationControl and mapTypeControl.
Alternatively setting disableDefaultUI to true will remove all controls at once.
<p:gmap center="41.381542, 2.122893" zoom="15" type="terrain" style="width:600px;height:400px" mapTypeControl="false" navigationControl="false" />
Native Google Maps API
In case you need to access native google maps api with javascript, use provided getMap() method.
var gmap = PF('yourWidgetVar').getMap();
//gmap is a google.maps.Map instance
Full map api is provided at; http://code.google.com/apis/maps/documentation/javascript/reference.html
GMap API
org.primefaces.model.map.MapModel (org.primefaces.model.map.DefaultMapModel is the default implementation)
Method
addOverlay(Overlay overlay)
List<Marker> getMarkers()
List<Polyline> getPolylines()
List<Polygon> getPolygons()
List<Circle> getCircles()
List<Rectangle> getRectangles()
Overlay findOverlay(String id)
Adds an overlay to map
Returns the list of markers
Returns the list of polylines
Returns the list of polygons
Description
Returns the list of circles
Returns the list of rectangles.
Finds an overlay by it’s unique id
226
PrimeFaces User Guide
org.primefaces.model.map.Overlay
Property
id data zindex
Default
null null null
Type
String
Object
Integer
Description
Id of the overlay, generated and used internally
Data represented in marker
Z-Index of the overlay
org.primefaces.model.map.Marker extends org.primefaces.model.map.Overlay
Property
title latlng icon shadow cursor draggable clickable flat visible
Default
null null
0
1 null null pointer
0
1
Type
String
LatLng
String
String
String
Boolean
Boolean
Boolean
Boolean
Description
Text to display on rollover
Location of the marker
Icon of the foreground
Shadow image of the marker
Cursor to display on rollover
Defines if marker can be dragged
Defines if marker can be dragged
If enabled, shadow image is not displayed
Defines visibility of the marker
org.primefaces.model.map.Polyline extends org.primefaces.model.map.Overlay
Description Property
paths strokeColor strokeOpacity strokeWeight
Default
null null
1
1
List
Type
String
Double
Integer
List of coordinates
Color of a line
Opacity of a line
Width of a line
org.primefaces.model.map.Polygon extends org.primefaces.model.map.Overlay
Description Property
paths strokeColor strokeOpacity
Default
null null
1
Type
List
String
Double
List of coordinates
Color of a line
Opacity of a line
227
Property
strokeWeight fillColor fillOpacity
Default
1 null
1
Type
Integer
String
Double
PrimeFaces User Guide
Description
Weight of a line
Background color of the polygon
Opacity of the polygon
org.primefaces.model.map.Circle extends org.primefaces.model.map.Overlay
Property
center radius strokeColor strokeOpacity strokeWeight fillColor fillOpacity
1
1 null
1
Default
null null null
Type
LatLng
Double
String
Double
Integer
String
Double
Description
Center of the circle
Radius of the circle.
Stroke color of the circle.
Stroke opacity of circle.
Stroke weight of the circle.
Background color of the circle.
Opacity of the circle.
org.primefaces.model.map.Rectangle extends org.primefaces.model.map.Overlay
Property
bounds strokeColor strokeOpacity strokeWeight fillColor fillOpacity
Default
null null
1
1 null
1
Type Description
LatLngBounds Boundaries of the rectangle.
String Stroke color of the rectangle.
Double
Integer
String
Double
Stroke opacity of rectangle.
Stroke weight of the rectangle.
Background color of the rectangle.
Opacity of the rectangle.
org.primefaces.model.map.LatLng
lat lng
Property Default
null null
Type
double double
org.primefaces.model.map.LatLngBounds
Description
Latitude of the coordinate
Longitude of the coordinate
228
Property
center northEast southWest
Default
null null null
Type
LatLng
LatLng
LatLng
PrimeFaces User Guide
Description
Center coordinate of the boundary
NorthEast coordinate of the boundary
SouthWest coordinate of the boundary
GMap Event API
All classes in event api extends from javax.faces.event.FacesEvent.
org.primefaces.event.map.MarkerDragEvent
Property
marker
Default
null
Type
Marker
Description
Dragged marker instance
org.primefaces.event.map.OverlaySelectEvent
Property
overlay
Default
null
Type
Overlay
Description
Selected overlay instance
org.primefaces.event.map.PointSelectEvent
Property
latLng
Default
null
Type
LatLng
Description
Coordinates of the selected point
org.primefaces.event.map.StateChangeEvent
Property
bounds zoomLevel
Default
null
0
Type
LatLngBounds
Integer
Description
Boundaries of the map
Zoom level of the map
229
PrimeFaces User Guide
3.47 GMapInfoWindow
GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.
Info
Tag
Tag Class
Component Class
Component Type
Component Family
gmapInfoWindow org.primefaces.component.gmap.GMapInfoWindowTag
org.primefaces.component.gmap.GMapInfoWindow
org.primefaces.component.GMapInfoWindow
org.primefaces.component
Attributes
Name
id rendered binding maxWidth
Default
null true
Type
String
Boolean null null
Object
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Maximum width of the info window
Getting started with GMapInfoWindow
See GMap section for more information about how gmapInfoWindow is used.
230
PrimeFaces User Guide
3.48 GraphicImage
GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier. Legacy way to do this is to come up with a Servlet that does the streaming, GraphicImage does all the hard work without the need of a Servlet.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
graphicImage org.primefaces.component.graphicimage.GraphicImage
org.primefaces.component.GraphicImage
org.primefaces.component
org.primefaces.component.GraphicImageRenderer
org.primefaces.component.graphicimage.GraphicImageRenderer
Attributes
Name
id rendered binding value alt url width height title dir lang ismap usemap style styleClass
Default
null true
String
Type
boolean null null null false null null null null null null null null null
Object
String
String
Boolean
String
String
String
Object
String
String
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Binary data to stream or context relative path.
Alternate text for the image
Alias to value attribute
Width of the image
Height of the image
Title of the image
Direction of the text displayed
Language code
Specifies to use a server-side image map
Name of the client side map
Style of the image
Style class of the image
231
Name
onclick ondblclick onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup cache name library null null null null null null null true null null
Default
null null null
String
Type
String
String
String
String
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
onclick dom event handler ondblclick dom event handler onkeydown dom event handler onkeypress dom event handler onkeyup dom event handler onmousedown dom event handler onmousemove dom event handler onmouseout dom event handler onmouseover dom event handler onmouseup dom event handler
Enables/Disables browser from caching the image
Name of the image.
Library name of the image.
Getting started with GraphicImage
GraphicImage requires an org.primefaces.model.StreamedContent content as it’s value for dynamic images. StreamedContent is an interface and PrimeFaces provides a built-in implementation called
DefaultStreamedContent. Following examples loads an image from the classpath.
<p:graphicImage value="#{imageBean.image}" /> public class ImageBean { private StreamedContent image; public DynamicImageController() {
InputStream stream = this.getClass().getResourceAsStream("barcalogo.jpg");
image = new DefaultStreamedContent(stream, "image/jpeg");
} public StreamedContent getImage() { return this.image;
}
}
DefaultStreamedContent gets an inputstream as the first parameter and mime type as the second.
In a real life application, you can create the inputstream after reading the image from the database.
For example java.sql.ResultsSet API has the getBinaryStream() method to read blob files stored in database.
232
PrimeFaces User Guide
Displaying Charts with JFreeChart
See static images section at chart component for a sample usage of graphicImage with jFreeChart.
Displaying a Barcode
Similar to the chart example, a barcode can be generated as well. This sample uses barbecue project for the barcode API.
<p:graphicImage value="#{backingBean.barcode}" /> public class BarcodeBean { private StreamedContent barcode; public BackingBean() { try {
File barcodeFile = new File("dynamicbarcode");
BarcodeImageHandler.saveJPEG(
BarcodeFactory.createCode128("PRIMEFACES"), barcodeFile); barcode = new DefaultStreamedContent( new FileInputStream(barcodeFile), "image/jpeg");
} catch (Exception e) { e.printStackTrace();
}
} public BarcodeBean getBarcode() { return this.barcode;
}
}
Displaying Regular Images
As GraphicImage extends standard graphicImage component, it can also display regular non dynamic images just like standard graphicImage component using name and optional library.
<p:graphicImage name="barcalogo.jpg" library="yourapp" />
How It Works
Dynamic image display works as follows;
• Dynamic image encryps its value expression string to generate a key.
• This key is appended to the image url that points to JSF resource handler.
• Custom PrimeFaces ResourceHandler gets the key from the url, decrypts the expression string to something like #{bean.streamedContentValue}, evaluates it to get the instance of
StreamedContent from bean and streams contents to client.
233
PrimeFaces User Guide
As a result there will be 2 requests to display an image, first browser will make a request to load the page and then another one to the dynamic image url that points to JSF resource handler. Please note that you cannot use viewscope beans as they are not available in resource loading request.
Passing Parameters and Data Iteration
You can pass request parameters to the graphicImage via f:param tags, as a result the actual request rendering the image can have access to these values. This is extremely handy to display dynamic images if your image is in a data iteration component like datatable or ui:repeat.
StreamedContent
There are two StreamedContent implementations out of the box; DefaultStreamedContent is not uses an InputStream and not serializable whereas the serializable ByteArrayContent uses a byte array.
234
PrimeFaces User Guide
3.49 Grid CSS
Grid CSS is a lightweight responsive layout utility optimized for mobile devices, tablets and desktops. Up to 12 columns are supported based on fluid and fixed modes.
Getting Started with Grid
There are special components as usage is simple using divs. A 3 column layout can be defined as;
<div class="ui-grid">
<div class="ui-grid-row">
<div class="ui-grid-col-4">Col1</div>
<div class="ui-grid-col-4">Col2</div>
<div class="ui-grid-col-4">Col2</div>
</div>
</div>
235
Custom Layout
As long as the sum of columns are 12, various combinations are supported.
<div class="ui-grid">
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-8">8</div>
</div>
</div>
PrimeFaces User Guide
Multi Line
Multiple rows are enabled using more than one .ui-grid-row elements.
<div class="ui-grid">
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
</div>
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
</div>
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-4">4</div>
</div>
</div>
Responsive
Adding .ui-grid-responsive to the container makes the content responsive to screen sizes.
<div class="ui-grid ui-grid-responsive">
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-8">8</div>
</div>
</div>
Fixed
.ui-grid-fixed enables fixed width for the content.
<div class="ui-grid ui-grid-fixed">
<div class="ui-grid-row">
<div class="ui-grid-col-4">4</div>
<div class="ui-grid-col-8">8</div>
</div>
</div>
236
PrimeFaces User Guide
3.50 Growl
Growl is based on the Mac’s growl notification widget and used to display FacesMessages in an overlay.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
growl org.primefaces.component.growl.Growl
org.primefaces.component.Growl
org.primefaces.component
org.primefaces.component.GrowlRenderer
org.primefaces.component.growl.GrowlRenderer
Attributes
Name
id rendered binding sticky null false showSummary true showDetail globalOnly false false life 6000 null true
Default Type
String
Boolean
Object
Boolean
Boolean
Boolean
Boolean
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Specifies if the message should stay instead of hidden automatically.
Specifies if the summary of message should be displayed.
Specifies if the detail of message should be displayed.
When true, only facesmessages without clientids are displayed.
Duration in milliseconds to display non-sticky messages.
237
Name
autoUpdate redisplay for escape severity false
Default
true null true null
Type
Boolean
Boolean
String
Boolean
String
PrimeFaces User Guide
Description
Specifies auto update mode.
Defines if already rendered messaged should be displayed.
Name of associated key, takes precedence when used with globalOnly.
Defines whether html would be escaped or not.
Comma separated list of severities to display only.
Getting Started with Growl
Growl usage is similar to standard h:messages component. Simply place growl anywhere on your page, since messages are displayed as an overlay, the location of growl in JSF page does not matter.
<p:growl />
Lifetime of messages
By default each message will be displayed for 6000 ms and then hidden. A message can be made sticky meaning it’ll never be hidden automatically.
<p:growl sticky="true" />
If growl is not working in sticky mode, it’s also possible to tune the duration of displaying messages. Following growl will display the messages for 5 seconds and then fade-out.
<p:growl life="5000" />
Growl with Ajax Updates
If you need to display messages with growl after an ajax request you just need to update it. Note that if you enable autoUpdate, growl will be updated automatically with each ajax request anyway.
<p:growl id="messages"/>
<p:commandButton value="Submit" update="messages" />
Positioning
Growl is positioned at top right corner by default, position can be controlled with a CSS selector called ui-growl. With the below setting growl will be located at top left corner.
.ui-growl { left:20px;
}
238
PrimeFaces User Guide
Targetable Messages
There may be times where you need to target one or more messages to a specific message component, for example suppose you have growl and messages on same page and you need to display some messages on growl and some on messages. Use for attribute to associate messages with specific components.
<p:messages for="somekey" />
<p:growl for="anotherkey" />
FacesContext context = FacesContext.getCurrentInstance();
context.addMessage("somekey", facesMessage1);
context.addMessage("somekey", facesMessage2);
context.addMessage("anotherkey", facesMessage3);
In sample above, messages will display first and second message and growl will only display the
3rd message.
Severity Levels
Using severity attribute, you can define which severities can be displayed by the component. For instance, you can configure growl to only display infos and warnings.
<p:growl severity="info,warn" />
Escaping
Growl escapes html content in messages, in case you need to display html via growl set escape option to false.
<p:growl escape="false" />
Skinning
Following is the list of structural style classes;
Style Class
.ui-growl
.ui-growl-item-container
.ui-growl-item
.ui-growl-message
.ui-growl-title
.ui-growl-message p
.ui-growl-image
Applies
Main container element of growl
Container of messages
Container of a message
Text message container
Summary of the message
Detail of the message
Severity icon
239
PrimeFaces User Guide
Style Class
.ui-growl-image-info
.ui-growl-image-warn
.ui-growl-image-error
.ui-growl-image-fatal
Info severity icon
Warning severity icon
Error severity icon
Fatal severity icon
Applies
As skinning style classes are global, see the main theming section for more information.
240
PrimeFaces User Guide
3.51 HotKey
HotKey is a generic key binding component that can bind any formation of keys to javascript event handlers or ajax calls.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
hotkey org.primefaces.component.hotkey.HotKey
org.primefaces.component.HotKey
org.primefaces.component
org.primefaces.component.HotKeyRenderer
org.primefaces.component.hotkey.HotKeyRenderer
Attributes
Name
id rendered binding bind handler action actionListener immediate null null false null null null
Object
String
String
MethodExpr
MethodExpr
Boolean async process update onstart
Default
null true
Type
String
Boolean false null null null
Boolean
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
The Key binding.
Javascript event handler to be executed when the key binding is pressed.
A method expression that’d be processed in the partial request caused by uiajax.
An actionlistener that’d be processed in the partial request caused by uiajax.
Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
When set to true, ajax requests are not queued.
Component id(s) to process partially instead of whole view.
Client side id of the component(s) to be updated after async partial submit request.
Javascript handler to execute before ajax request is
241
Name
oncomplete onsuccess onerror global delay
Default
null null null true
Type
String
String
String
Boolean null String partialSubmit resetValues timeout false false ignoreAutoUpdate false
0
Boolean
Boolean
Boolean
Integer
PrimeFaces User Guide
Description
begins.
Javascript handler to execute when ajax request is completed.
Javascript handler to execute when ajax request succeeds.
Javascript handler to execute when ajax request fails.
Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Enables serialization of values belonging to the partially processed components only.
If true, local values of input components to be updated within the ajax request would be reset.
If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Timeout for the ajax request in milliseconds.
Getting Started with HotKey
HotKey is used in two ways, either on client side with the event handler or with ajax support.
Simplest example would be;
<p:hotkey bind="a" handler="alert(‘Pressed a’);" />
When this hotkey is on page, pressing the a key will alert the ‘Pressed key a’ text.
Key combinations
Most of the time you’d need key combinations rather than a single key.
<p:hotkey bind="ctrl+s" handler="alert(‘Pressed ctrl+s’);" />
<p:hotkey bind="ctrl+shift+s" handler="alert(‘Pressed ctrl+shift+s’)" />
Integration
Here’s an example demonstrating how to integrate hotkeys with a client side api. Using left and right keys will switch the images displayed via the p:imageSwitch component.
242
PrimeFaces User Guide
<p:hotkey bind="left" handler="PF('switcher').previous();" />
<p:hotkey bind="right" handler="PF('switcher').next();" />
<p:imageSwitch widgetVar="switcher">
//content
</p:imageSwitch>
Ajax Support
Ajax is a built-in feature of hotKeys meaning you can do ajax calls with key combinations.
Following form can be submitted with the ctrl+shift+s combination.
<h:form>
<p:hotkey bind="ctrl+shift+s" update="display" />
<h:panelGrid columns="2">
<h:outputLabel for="name" value="Name:" />
<h:inputText id="name" value="#{bean.name}" />
</h:panelGrid>
<h:outputText id="display" value="Hello: #{bean.firstname}" />
</h:form>
Note that hotkey will not be triggered if there is a focused input on page.
243
PrimeFaces User Guide
3.52 IdleMonitor
IdleMonitor watches user actions on a page and notify callbacks in case they go idle or active again.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
idleMonitor org.primefaces.component.idlemonitor.IdleMonitor
org.primefaces.component.IdleMonitor
org.primefaces.component
org.primefaces.component.IdleMonitorRenderer
org.primefaces.component.idlemonitor.IdleMonitor
Attributes
Name
id rendered binding timeout onidle onactive widgetVar
Default
null true
Type
String
Boolean null
300000 null null null
Object
Integer
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Time to wait in milliseconds until deciding if the user is idle. Default is 5 minutes.
Client side callback to execute when user goes idle.
Client side callback to execute when user goes idle.
Name of the client side widget.
Getting Started with IdleMonitor
To begin with, you can hook-in to client side events that are called when a user goes idle or becomes active again. Example below toggles visibility of a dialog to respond these events.
<p:idleMonitor onidle="PF('idleDialog').show();" onactive="PF('idleDialog').hide();"/>
<p:dialog header="What's happening?" widgetVar="idleDialog" modal="true">
<h:outputText value="Dude, are you there?" />
</p:dialog>
244
PrimeFaces User Guide
Controlling Timeout
By default, idleMonitor waits for 5 minutes (300000 ms) until triggering the onidle event. You can customize this duration with the timeout attribute.
Ajax Behavior Events
IdleMonitor provides two ajax behavior events which are idle and active that are fired according to user status changes. Example below displays messages for each event;
<p:idleMonitor timeout="5000" update="messages">
<p:ajax event="idle" listener="#{bean.idleListener}" update="msg" />
<p:ajax event="active" listener="#{bean.activeListener}" update="msg" />
</p:idleMonitor>
<p:growl id=”msg” /> public class Bean { public void idleListener() {
//Add facesmessage
} public void idle() {
//Add facesmessage
}
}
245
3.53 ImageCompare
ImageCompare provides a user interface to compare two images.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
imageCompare org.primefaces.component.imagecompare.ImageCompare
org.primefaces.component.ImageCompare
org.primefaces.component
org.primefaces.component.ImageCompareRenderer
org.primefaces.component.imagecompare.ImageCompareRenderer
Attributes
id rendered
Name
binding widgetVar
Default
null true
Type
String
Boolean null null
Object
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
246
leftImage
Name
rightImage width height style styleClass null null null
Default
null null null
Type
String
String
String
String
String
String
PrimeFaces User Guide
Description
Source of the image placed on the left side
Source of the image placed on the right side
Width of the images
Height of the images
Inline style of the container element
Style class of the container element
Getting started with ImageCompare
ImageCompare is created with two images with same height and width. It is required to set width and height of the images as well.
<p:imageCompare leftImage="xbox.png" rightImage="ps3.png" width="438" height="246"/>
Skinning
Both images are placed inside a div container element, style and styleClass attributes apply to this element.
247
PrimeFaces User Guide
3.54 ImageCropper
ImageCropper allows cropping a certain region of an image. A new image is created containing the cropped area and assigned to a CroppedImage instanced on the server side.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
imageCropper org.primefaces.component. imagecropper.ImageCropper
org.primefaces.component.ImageCropper
org.primefaces.component
org.primefaces.component.ImageCropperRenderer
org.primefaces.component.imagecropper.ImageCropperRenderer
Attributes
id rendered
Name
binding value converter immediate required
Default
null true null null null false false
Type
String
Boolean
Object
Object
Converter
/String
Boolean
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
248
validator
Name
valueChangeListener requiredMessage converterMessage validatorMessage widgetVar image alt aspectRatio minSize maxSize backgroundColor backgroundOpacity initialCoords null null
0,6 null null null null null null null null
Default
null null null
Type
Method
Expr
Method
Expr
String
String
String
String
String
String
Double
String
String
String
Double
String
PrimeFaces User Guide
Description
A method binding expression that refers to a method validationg the input
A method binding expression that refers to a method for handling a valuchangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Context relative path to the image.
Alternate text of the image.
Aspect ratio of the cropper area.
Minimum size of the cropper area.
Maximum size of the cropper area.
Background color of the container.
Background opacity of the container
Initial coordinates of the cropper area.
Getting started with the ImageCropper
ImageCropper is an input component and image to be cropped is provided via the image attribute.
The cropped area of the original image is used to create a new image, this new image can be accessed on the backing bean by setting the value attribute of the image cropper. Assuming the image is at %WEBAPP_ROOT%/campnou.jpg
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" /> public class Cropper { private CroppedImage croppedImage;
//getter and setter
}
org.primefaces.model.CroppedImage belongs a PrimeFaces API and contains handy information about the crop process. Following table describes CroppedImage properties.
Property
originalFileName bytes
String byte[]
Type Description
Name of the original file that’s cropped
Contents of the cropped area as a byte array
249
left right width height
Property
int int int int
Type Description
Left coordinate
Right coordinate
Width of the cropped image
Height of the cropped image
PrimeFaces User Guide
External Images
ImageCropper has the ability to crop external images as well.
<p:imageCropper value="#{cropper.croppedImage}" image= " ">
</p:imageCropper>
Context Relative Path
For local images, ImageCropper always requires the image path to be context relative. So to accomplish this simply just add slash ("/path/to/image.png") and imagecropper will recognize it at
%WEBAPP_ROOT%/path/to/image.png. Action url relative local images are not supported.
Initial Coordinates
By default, user action is necessary to initiate the cropper area on an image, you can specify an initial area to display on page load using initialCoords option in x,y,w,h format.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" initialCoords="225,75,300,125"/>
Boundaries
minSize and maxSize attributes are control to limit the size of the area to crop.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" minSize="50,100" maxSize="150,200"/>
Saving Images
Below is an example to save the cropped image to file system.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" />
<p:commandButton value="Crop" actionListener="#{myBean.crop}" />
250
PrimeFaces User Guide public class Cropper { private CroppedImage croppedImage;
//getter and setter public String crop() {
ServletContext servletContext = (ServletContext)
FacesContext.getCurrentInstance().getExternalContext().getContext();
String newFileName = servletContext.getRealPath("") + File.separator +
"ui" + File.separator + "barca" + File.separator+ croppedImage.getOriginalFileName()
+ "cropped.jpg";
FileImageOutputStream imageOutput; try { imageOutput = new FileImageOutputStream(new File(newFileName)); imageOutput.write(croppedImage.getBytes(), 0, croppedImage.getBytes().length); imageOutput.close();
} catch (Exception e) { e.printStackTrace();
} return null;
}
}
251
3.55 ImageSwitch
Imageswitch component is a simple image gallery component.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
imageSwitch org.primefaces.component.imageswitch.ImageSwitch
org.primefaces.component.ImageSwitch
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ImageSwitchRenderer
Renderer Class
org.primefaces.component.imageswitch.ImageSwitchRenderer
Attributes
Name
id rendered binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass null null null
500
3000 true null null
Default
null true
Type
String
Boolean
Object
String
String
Integer
Integer
Boolean
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Name of the effect for transition.
Speed of the effect in milliseconds.
Slideshow speed in milliseconds.
Starts slideshow automatically on page load.
Style of the main container.
Style class of the main container.
252
PrimeFaces User Guide
Getting Started with ImageSwitch
ImageSwitch component needs a set of images to display. Provide the image collection as a set of children components.
<p:imageSwitch effect="FlyIn">
<p:graphicImage value="/images/nature1.jpg" />
<p:graphicImage value="/images/nature2.jpg" />
<p:graphicImage value="/images/nature3.jpg" />
<p:graphicImage value="/images/nature4.jpg" />
</p:imageSwitch>
Most of the time, images could be dynamic, ui:repeat is supported to implement this case.
<p:imageSwitch>
<ui:repeat value="#{bean.images}" var="image">
<p:graphicImage value="#{image}" />
</ui:repeat>
</p:imageSwitch>
Slideshow or Manual
ImageSwitch is in slideShow mode by default, if you’d like manual transitions disable slideshow and use client side api to create controls.
<p:imageSwitch effect="FlyIn" widgetVar="imageswitch">
//images
</p:imageSwitch>
<span onclick="PF('imageswitch').previous();">Previous</span>
<span onclick="PF('imageswitch').next();">Next</span>
Client Side API
Widget: PrimeFaces.widget.ImageSwitch
Method
startSlideshow() stopSlideshow() toggleSlideshow() pauseSlideshow() next() previous() switchTo(index)
Params
-
-
-
-
-
index
Return Type
void void void void void void void
Description
Starts slideshow mode.
Stops slideshow mode.
Toggles slideshow mode.
Pauses slideshow mode.
Switches to next image.
Switches to previous image.
Displays image with given index.
253
PrimeFaces User Guide
Effect Speed
The speed is considered in terms of milliseconds and specified via the speed attribute.
<p:imageSwitch effect="FlipOut" speed="150">
//set of images
</p:imageSwitch>
List of Effects
ImageSwitch supports a wide range of transition effects. Following is the full list, note that values are case sensitive.
• blindX
• blindY
• blindZ
• cover
• curtainX
• curtainY
• fade
• fadeZoom
• growX
• growY
• none
• scrollUp
• scrollDown
• scrollLeft
• scrollRight
• scrollVert
• shuffle
• slideX
• slideY
• toss
• turnUp
• turnDown
• turnLeft
• turnRight
• uncover
• wipe
• zoom
254
PrimeFaces User Guide
3.56 Inplace
Inplace provides easy inplace editing and inline content display. Inplace consists of two members, display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.
binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor saveLabel
Info
Tag
Component Class
Component Type
inplace org.primefaces.component.inplace.Inplace
org.primefaces.component.Inplace
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.InplaceRenderer
Renderer Class
org.primefaces.component.inplace.InplaceRenderer
Attributes
Name
id rendered
Default
null true
String
Type
Boolean null null null null fade normal false null null false
Save
Object
String
String
String
String
String
Boolean
String
String
Boolean
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Label to be shown in display mode.
Label to be shown in display mode when value is empty.
Effect to be used when toggling.
Speed of the effect.
Prevents hidden content to be shown.
Inline style of the main container element.
Style class of the main container element.
Specifies the editor mode.
Tooltip text of save buttin in editor mode.
255
Name
cancelLabel event toggleable
Default
Cancel click
String
Type
String true Boolean
PrimeFaces User Guide
Description
Tooltip text of cancel buttin in editor mode.
Name of the client side event to display inline content.
Defines if inplace is toggleable or not.
Getting Started with Inplace
The inline component needs to be a child of inplace.
<p:inplace>
<h:inputText value="Edit me" />
</p:inplace>
Custom Labels
By default inplace displays its first childs value as the label, you can customize it via the label attribute.
<h:outputText value="Select One:" />
<p:inplace label="Cities">
<h:selectOneMenu>
<f:selectItem itemLabel="Istanbul" itemValue="Istanbul" />
<f:selectItem itemLabel="Ankara" itemValue="Ankara" />
</h:selectOneMenu>
</p:inplace>
Facets
For advanced customization, output and input facets are provided.
<p:inplace id="checkboxInplace">
<f:facet name="output">
Yes or No
</f:facet>
<f:facet name="input">
<h:selectBooleanCheckbox />
</f:facet>
</p:inplace>
256
PrimeFaces User Guide
Effects
Default effect is fade and other possible effect is slide, also effect speed can be tuned with values
slow, normal and fast.
<p:inplace label="Show Image" effect="slide" effectSpeed="fast">
<p:graphicImage value="/images/nature1.jpg" />
</p:inplace>
Editor
Inplace editing is enabled via the editor option.
public class InplaceBean { private String text;
//getter-setter
}
<p:inplace editor="true">
<h:inputText value="#{inplaceBean.text}" />
</p:inplace>
save and cancel are two provided ajax behaviors events you can use to hook-in the editing process.
public class InplaceBean { private String text; public void handleSave() {
//add faces message with update text value
}
//getter-setter
}
<p:inplace editor="true">
<p:ajax event="save" listener="#{inplaceBean.handleSave}" update="msgs" />
<h:inputText value="#{inplaceBean.text}" />
</p:inplace>
<p:growl id="msgs" />
257
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.Inplace
Method
show() hide() toggle() save() cancel()
Params
-
-
-
-
-
Return Type
void void void void void
Description
Shows content and hides display element.
Shows display element and hides content.
Toggles visibility of between content and display element.
Triggers an ajax request to process inplace input.
Triggers an ajax request to revert inplace input.
Skinning
Inplace resides in a main container element which style and styleClass options apply. Following is the list of structural style classes;
.ui-inplace
.ui-inplace-disabled
.ui-inplace-display
.ui-inplace-content
.ui-inplace-editor
.ui-inplace-save
.ui-inplace-cancel
Style Class Applies
Main container element.
Main container element when disabled.
Display element.
Inline content.
Editor controls container.
Save button.
Cancel button.
As skinning style classes are global, see the main theming section for more information.
258
3.57 InputMask
InputMask forces an input to fit in a defined mask template.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
inputMask org.primefaces.component.inputmask.InputMask
org.primefaces.component.InputMask
org.primefaces.component
org.primefaces.component.InputMaskRenderer
org.primefaces.component.inputmask.InputMaskRenderer
Attributes
Name
id rendered binding mask placeHolder slotChar value null null null null null
Default
null true
Type
String
Boolean
Object
String
String
String
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Mask template
PlaceHolder in mask template. (deprecated)
PlaceHolder in mask template.
Value of the component than can be either an EL expression of a literal text
259
PrimeFaces User Guide converter immediate required validator false null valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang onblur onclick
Name
maxlength onchange ondblclick
Default
null false null null null null null null null null false null null null null null null null ing
Type
Converter/Str
String
String
String
Boolean
String
String
Description
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean
Boolean
MethodExpr A method binding expression that refers to a method validationg the input
MethodExpr A method binding expression that refers to a method for handling a valuchangeevent
String Message to be displayed when required field validation fails.
String
String
String
String
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables input field
A localized user presentable name.
Integer
String
Code describing the language used in the generated markup for this component.
Maximum number of characters that may be entered in this field.
Client side callback to execute when input element loses focus.
String
String
String
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
Client side callback to execute when input element is clicked.
Client side callback to execute when input element is double clicked.
260
onfocus
Name
onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title null null null false null null null null null null null null null null
Default
null
Type
String null null
String
String
String
String
String
String
String
String
String
String
Boolean
Integer
String
String
Integer
String
PrimeFaces User Guide
Description
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
Specifies a short hint.
Flag indicating that this component will prevent changes by the user.
Number of characters used to determine the width of the input element.
Inline style of the input element.
Style class of the input element.
Position of the input element in the tabbing order.
Advisory tooltip informaton.
Getting Started with InputMask
InputMask below enforces input to be in 99/99/9999 date format.
<p:inputMask value="#{bean.field}" mask="99/99/9999" />
261
PrimeFaces User Guide
Mask Samples
Here are more samples based on different masks;
<h:outputText value="Phone: " />
<p:inputMask value="#{bean.phone}" mask="(999) 999-9999"/>
<h:outputText value="Phone with Ext: " />
<p:inputMask value="#{bean.phoneExt}" mask="(999) 999-9999? x99999"/>
<h:outputText value="SSN: " />
<p:inputMask value="#{bean.ssn}" mask="999-99-9999"/>
<h:outputText value="Product Key: " />
<p:inputMask value="#{bean.productKey}" mask="a*-999-a999"/>
Skinning
style and styleClass options apply to the displayed input element. As skinning style classes are global, see the main theming section for more information.
262
PrimeFaces User Guide
3.58 InputSwitch
InputSwitch is used to select a boolean value.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
inputSwitch org.primefaces.component.inputswitch.InputSwitch
org.primefaces.component.InputSwitch
org.primefaces.component
org.primefaces.component.InputSwitchRenderer
org.primefaces.component.inputswitch.InputSwitchRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null false false null
Type
String
Boolean
Object
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
Converter
/String
Boolean
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method binding expression that refers to a method validating the input
263
PrimeFaces User Guide offLabel label disabled onchange style styleClass tabindex
Name Default
valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar onLabel null null null null on
Type Description
MethodExpr A method binding expression that refers to a method for handling a valuchangeevent
String
String
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
String
String
String
Message to be displayed when validation fields.
Name of the client side widget.
Label for on state.
showLabels off null null false null null null null
String
String
String
Boolean
String
String
Integer
String
Label for off state.
User presentable name.
Disables or enables the switch.
Client side callback to execute on value change event.
Inline style of the main container.
Style class of the main container.
The tabindex attribute specifies the tab order of an element when the "tab" button is used for navigating.
Controls the visibility of the labels, defaults to true.
Getting started with InputSwitch
InputSwitch requires a boolean reference as the value.
<p:inputSwitch value="#{bean.propertyName}" /> public class Bean { private boolean propertyName;
//getter and setter
}
Labels
Labels are customized using onLabel and offLabel options. Setting showLabels as false, turns off labels altogether.
<p:inputSwitch value="#{bean.propertyName}" onLabel="yes" offLabel="no"/>
264
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.InputSwitch
Method
toggle() check() uncheck()
Params
-
-
-
Return Type
void void void
Toggles the state.
Switches to on state.
Switches to off state.
Description
Skinning
InputSwitch resides in a main container element which style and styleClass options apply.
Following is the list of structural style classes;
Style Class
.ui-inputswitch
.ui-inputswitch-off
.ui-inputswitch-on
.ui-inputswitch-handle
Applies
Main container element.
Off state element.
On state element.
Switch handle.
As skinning style classes are global, see the main theming section for more information.
265
3.59 InputText
InputText is an extension to standard inputText with skinning capabilities.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
inputText org.primefaces.component.inputtext.InputText
org.primefaces.component.InputText
org.primefaces.component
org.primefaces.component.InputTextRenderer
org.primefaces.component.inputtext.InputTextRender
Attributes
id
Name
rendered binding value converter immediate required validator false null valueChangeListener null requiredMessage
Default
null true
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null null
Object
Object
An el expression that maps to a server side UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
Converter
/String
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id false null
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
Method
Expr
Method
Expr
String
A method binding expression that refers to a method validationg the input
A method binding expression that refers to a method for handling a valuchangeevent
Message to be displayed after failed validation.
266
onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout
Name
converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange
PrimeFaces User Guide null null null null null null
0 null null
Default
null
Type
String
String
String
String
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
String
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
String
String
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Boolean Disables input field
String
String
A localized user presentable name.
Code describing the language used in the generated markup for this component.
null null null
Integer
String
String
Maximum number of characters that may be entered in this field.
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
null null null
String
String
String
Client side callback to execute when input element is clicked.
Client side callback to execute when input element is double clicked.
Client side callback to execute on input element focus.
null null null null null null
String
String
String
String
String
String
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
267
Name
onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title type
PrimeFaces User Guide null null null null text
Default
null null null null
0 null
Type
String
String
String
Description
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
String
Integer
Specifies a short hint.
Boolean Flag indicating that this component will prevent changes by the user.
Number of characters used to determine the width of the input element.
String
String
Integer
String
String
Inline style of the input element.
Style class of the input element.
Position of the input element in the tabbing order.
Advisory tooltip informaton.
Input field type.
Getting Started with InputText
InputText usage is same as standard inputText;
<p:inputText value="#{bean.propertyName}" /> public class Bean { private String propertyName;
//getter and setter
}
Client Side API
Widget: PrimeFaces.widget.InputText
Method
enable() disable()
Params
-
-
Return Type
void void
Description
Enables the input field.
Disables the input field.
268
PrimeFaces User Guide
3.60 InputTextarea
InputTextarea is an extension to standard inputTextarea with autoComplete, autoResize, remaining characters counter and theming features.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
inputTextarea org.primefaces.component.inputtextarea.InputTextarea
org.primefaces.component.InputTextarea
org.primefaces.component
org.primefaces.component.InputTextareaRenderer
org.primefaces.component.inputtextarea.InputTextareaRender
Attributes
Name
id rendered binding value converter immediate required
Default
null true null null null false false
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side UIComponent instance in a backing bean
Object
Converter/
String
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
269
PrimeFaces User Guide validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar accesskey alt disabled label lang onblur onclick onfocus onkeyup
Name
autocomplete dir onchange ondblclick onkeydown onkeypress onmousedown
Default
null null null null null null null null null null false null null null null null null null null null null null
Type
Method
Expr
Method
Expr
String
String
String
String
String
String
String
String
Description
A method binding expression that refers to a method validationg the input
A method binding expression that refers to a method for handling a valuchangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Boolean Disables input field
String A localized user presentable name.
String Code describing the language used in the generated markup for this component.
String
String
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
String
String
String
String
String
String
String
Client side callback to execute when input element is clicked.
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is
270
Name
onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title autoResize maxlength counter counterTemplate completeMethod miQueryLength queryDelay scrollHeight
PrimeFaces User Guide null
{0} null
3
700 null null null null null true null
Default
null null null null null false null
Type Description
pressed down over input element
String
String
String
String
String
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
Boolean Flag indicating that this component will prevent changes by the user.
Integer Number of characters used to determine the width of the input element.
String
String
Inline style of the input element.
Style class of the input element.
String
String
Method
Expr
Integer
Integer
Integer
Integer
String
Position of the input element in the tabbing order.
Advisory tooltip informaton.
Boolean Specifies auto growing when being typed.
Integer Maximum number of characters that may be entered in this field.
Id of the output component to display remaining chars.
Template text to display in counter.
Method to provide suggestions.
Number of characters to be typed to run a query.
Delay in ms before sending each query.
Height of the viewport for autocomplete suggestions.
271
PrimeFaces User Guide
Getting Started with InputTextarea
InputTextarea usage is same as standard inputTextarea;
<p:inputTextarea value="#{bean.propertyName}" />
AutoResize
While textarea is being typed, if content height exceeds the allocated space, textarea can grow automatically. Use autoResize option to turn on/off this feature.
<p:inputTextarea value="#{bean.propertyName}" autoResize="true|false"/>
Remaining Characters
InputTextarea can limit the maximum allowed characters with maxLength option and display the remaining characters count as well.
<p:inputTextarea value="#{bean.propertyName}" counter="display" maxlength="20" counterTemplate="{0} characters remaining" />
<h:outputText id="display" />
AutoComplete
InputTextarea supports ajax autocomplete functionality as well. You need to provide a completeMethod to provide the suggestions to use this feature. In sample below, completeArea method will be invoked with the query being the four characters before the caret.
public class AutoCompleteBean { public List<String> completeArea(String query) {
List<String> results = new ArrayList<String>();
} return results;
} if(query.equals("PrimeFaces")) { results.add("PrimeFaces Rocks!!!"); results.add("PrimeFaces has 100+ components."); results.add("PrimeFaces is lightweight."); results.add("PrimeFaces is easy to use."); results.add("PrimeFaces is developed with passion!");
} else { for(int i = 0; i < 10; i++) { results.add(query + i);
}
}
272
<p:inputTextarea rows="10" cols="50" minQueryLength="4" completeMethod="#{autoCompleteBean.completeArea}" />
PrimeFaces User Guide
Skinning
InputTextarea renders a textarea element which style and styleClass options apply. Following is the list of structural style classes;
Applies Style Class
ui-inputtextarea ui-inputfield
.ui-autocomplete-panel
.ui-autocomplete-items
.ui-autocomplete-item
Textarea element.
Textarea element.
Overlay for suggestions.
Suggestions container.
Each suggestion.
As skinning style classes are global, see the main theming section for more information.
273
PrimeFaces User Guide
3.61 Keyboard
Keyboard is an input component that uses a virtual keyboard to provide the input. Notable features are the customizable layouts and skinning capabilities.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
keyboard org.primefaces.component.keyboard.Keyboard
org.primefaces.component.Keyboard
org.primefaces.component
org.primefaces.component.KeyboardRenderer
org.primefaces.component.keyboard.KeyboardRenderer
Attributes
Name
id rendered binding value converter immediate required
Default
null true null null null false false
Type
String
Description
Unique identifier of the component
Boolean
Object
Object
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
Converter/Str ing
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean
Boolean
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
274
validator valueChangeListener requiredMessage converterMessage validatorMessage password showMode buttonImage buttonImageOnly effect dir
Name
effectDuration layout layoutTemplate keypadOnly promptLabel closeLabel clearLabel backspaceLabel accesskey alt autocomplete disabled label lang maxlength
Default
null null null null null false focus null false fadeIn null qwerty null focus null null null null null null null null false null null null
PrimeFaces User Guide
Boolean
String
String
String
String
String
Type Description
MethodExpr A method binding expression that refers to a method validationg the input
MethodExpr A method binding expression that refers to a method for handling a valuchangeevent
String Message to be displayed when required field validation fails.
String
String
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Boolean
String
String boolean
Makes the input a password field.
Specifies the showMode, ‘focus’, ‘button’, ‘both’
Image for the button.
When set to true only image of the button would be displayed.
Effect of the display animation.
String
String
String
String
Length of the display animation.
Built-in layout of the keyboard.
Template of the custom layout.
Specifies displaying a keypad instead of a keyboard.
Label of the prompt text.
Label of the close key.
Label of the clear key.
String
String
String
Boolean
String
String
Integer
Label of the backspace key.
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables input field
A localized user presentable name.
Code describing the language used in the generated markup for this component.
Maximum number of characters that may be entered in this field.
275
onblur
Name
onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title null null null null false null null null null null null null null null null null null null null
String
String
String
Integer
String
String
Integer
String
String
String
String
String
Boolean
String
String
String
String
String
String
Default
null
Type
String null String
PrimeFaces User Guide
Description
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
Client side callback to execute when input element is clicked.
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
Specifies a short hint.
Flag indicating that this component will prevent changes by the user.
Number of characters used to determine the width of the input element.
Inline style of the input element.
Style class of the input element.
Position of the input element in the tabbing order.
Advisory tooltip informaton.
276
Name
widgetVar
Default
null
Type
String
PrimeFaces User Guide
Description
Name of the client side widget.
Getting Started with Keyboard
Keyboard is used just like a simple inputText, by default when the input gets the focus a keyboard is displayed.
<p:keyboard value="#{bean.value}" />
Built-in Layouts
There’re a couple of built-in keyboard layouts these are ‘qwerty’, ‘qwertyBasic’ and ‘alphabetic’. For example keyboard below has the alphabetic layout.
<p:keyboard value="#{bean.value}" layout="alphabetic"/>
Custom Layouts
Keyboard has a very flexible layout mechanism allowing you to come up with your own layout.
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="prime-back,faces-clear,rocks-close"/>
Another example;
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="create-space-your-close,owntemplate-shift,easily-spacespacebar"/>
277
PrimeFaces User Guide
A layout template basically consists of built-in keys and your own keys. Following is the list of all built-in keys.
• back
• clear
• close
• shift
• spacebar
• space
• halfspace
All other text in a layout is realized as seperate keys so "prime" would create 5 keys as "p" "r" "i"
"m" "e". Use dash to seperate each member in layout and use commas to create a new row.
Keypad
By default keyboard displays whole keys, if you only need the numbers use the keypad mode.
<p:keyboard value="#{bean.value}" keypadOnly="true"/>
ShowMode
There’re a couple of different ways to display the keyboard, by default keyboard is shown once input field receives the focus. This is customized using the showMode feature which accept values
‘focus’, ‘button’, ‘both’. Keyboard below displays a button next to the input field, when the button is clicked the keyboard is shown.
<p:keyboard value="#{bean.value}" showMode="button"/>
Button can also be customized using the buttonImage and buttonImageOnly attributes.
278
PrimeFaces User Guide
3.62 Layout
Layout component features a highly customizable borderLayout model making it very easy to create complex layouts even if you’re not familiar with web design.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
layout org.primefaces.component.layout.Layout
org.primefaces.component.Layout
org.primefaces.component
org.primefaces.component.LayoutRenderer
org.primefaces.component.layout.LayoutRenderer
Attributes
Name
id rendered binding widgetVar fullPage
Default
null true null null false
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Name of the client side widget.
Boolean Specifies whether layout should span all page or not.
279
style
Name
styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle
Default
null
Type
String null null null null null null null null
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
Style to apply to container element, this is only applicable to element based layouts.
Style class to apply to container element, this is only applicable to element based layouts.
Client side callback to execute when a layout unit is resized.
Client side callback to execute when a layout unit is closed.
Client side callback to execute when a layout unit is toggled.
Title label of the resize button.
Title label of the collapse button.
Title label of the expand button.
Title label of the close button.
Getting started with Layout
Layout is based on a borderLayout model that consists of 5 different layout units which are top, left, center, right and bottom. This model is visualized in the schema below;
Full Page Layout
Layout has two modes, you can either use it for a full page layout or for a specific region in your page. This setting is controlled with the fullPage attribute which is false by default.
The regions in a layout are defined by layoutUnits, following is a simple full page layout with all possible units. Note that you can place any content in each layout unit.
280
PrimeFaces User Guide
<p:layout fullPage="true">
<p:layoutUnit position="north" size="50">
<h:outputText value="Top content." />
</p:layoutUnit>
<p:layoutUnit position="south" size="100">
<h:outputText value="Bottom content." />
</p:layoutUnit>
<p:layoutUnit position="west" size="300">
<h:outputText value="Left content" />
</p:layoutUnit>
<p:layoutUnit position="east" size="200">
<h:outputText value="Right Content" />
</p:layoutUnit>
<p:layoutUnit position="center">
<h:outputText value="Center Content" />
</p:layoutUnit>
</p:layout>
Forms in Full Page Layout
When working with forms and full page layout, avoid using a form that contains layoutunits as generated dom may not be the same. So following is invalid.
<p:layout fullPage="true">
<h:form>
<p:layoutUnit position="west" size="100"> h:outputText value="Left Pane" />
</p:layoutUnit>
<p:layoutUnit position="center">
<h:outputText value="Right Pane" />
</p:layoutUnit>
</h:form>
</p:layout>
A layout unit must have it’s own form instead, also avoid trying to update layout units because of same reason, update it’s content instead.
Dimensions
Except center layoutUnit, other layout units must have dimensions defined via size option.
Element based layout
Another use case of layout is the element based layout. This is the default case actually so just ignore fullPage attribute or set it to false. Layout example below demonstrates creating a split panel implementation.
281
PrimeFaces User Guide
<p:layout style="width:400px;height:200px">
<p:layoutUnit position="west" size="100">
<h:outputText value="Left Pane" />
</p:layoutUnit>
<p:layoutUnit position="center">
<h:outputText value="Right Pane" />
</p:layoutUnit>
//more layout units
</p:layout>
Ajax Behavior Events
Layout provides custom ajax behavior events for each layout state change.
Event
toggle close resize
Listener Parameter
org.primefaces.event.ToggleEvent
org.primefaces.event.CloseEvent
org.primefaces.event.ResizeEvent
Fired
When a unit is expanded or collapsed.
When a unit is closed.
When a unit is resized.
Stateful Layout
Making layout stateful would be easy, once you create your data to store the user preference, you can update this data using ajax event listeners provided by layout. For example if a layout unit is collapsed, you can save and persist this information. By binding this persisted information to the collapsed attribute of the layout unit layout will be rendered as the user left it last time.
Client Side API
Widget: PrimeFaces.widget.Layout
Method
toggle(position) show(position) hide(unit)
Params
position position position
Return Type
void void void
Toggles layout unit.
Shows layout unit.
Hides layout unit.
Description
282
PrimeFaces User Guide
Skinning
Following is the list of structural style classes;
Style Class
.ui-layout
.ui-layout-doc
.ui-layout-unit
.ui-layout-{position}
.ui-layout-unit-header
.ui-layout-unit-content
Applies
Main wrapper container element
Layout container
Each layout unit container
Position based layout unit
Layout unit header
Layout unit body
As skinning style classes are global, see the main theming section for more information.
283
binding position size resizable closable collapsible header footer minSize maxSize gutter visible collapsed collapseSize
PrimeFaces User Guide
3.63 LayoutUnit
LayoutUnit represents a region in the border layout model of the Layout component.
Info
Tag
Component Class
layoutUnit org.primefaces.component.layout.LayoutUnit
Component Type
org.primefaces.component.LayoutUnit
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.LayoutUnitRenderer
org.primefaces.component.layout.LayoutUnitRenderer
Attributes
id rendered
Name
null null null null
4px true false null null null false false fale null
Object
String
Integer
Integer
String
Boolean
Boolean
Integer
String
String
Boolean
Boolean
Boolean
String
Default
null true
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Position of the unit.
Size of the unit.
Makes the unit resizable.
Makes the unit closable.
Makes the unit collapsible.
Text of header.
Text of footer.
Minimum dimension for resize.
Maximum dimension for resize.
Gutter size of layout unit.
Specifies default visibility
Specifies toggle status of unit
Size of the unit when collapsed
284
Name
style styleClass effect effectSpeed
Default
null null null null
Type
String
String
String
String
PrimeFaces User Guide
Description
Inline style of the component.
Style class of the component.
Effect name of the layout transition.
Effect speed of the layout transition.
Getting started with LayoutUnit
See layout component documentation for more information regarding the usage of layoutUnits.
Facets
In addition to header and footer attributes to display text at these locations, facets are also provided with the same name to display custom content.
285
PrimeFaces User Guide
3.64 LightBox
Lightbox is a powerful overlay that can display images, multimedia content, custom content and external urls.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
lightBox org.primefaces.component lightbox.LightBox
org.primefaces.component.LightBox
org.primefaces.component
org.primefaces.component.LightBoxRenderer
org.primefaces.component.lightbox.LightBoxRenderer
Attributes
Name
id rendered binding widgetVar style styleClass width null null null null
Default Type
null true null
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side UIComponent instance in a backing bean
String
String
String
String
Name of the client side widget.
Style of the container element not the overlay element.
Style class of the container element not the overlay element.
Width of the overlay in iframe mode.
286
Name
height iframe iframeTitle visible onHide onShow
PrimeFaces User Guide
Default Type
null String false null
Boolean
String
Description
Height of the overlay in iframe mode.
Specifies an iframe to display an external url in overlay.
Title of the iframe element.
false null null
Boolean
String
String
Displays lightbox without requiring any user interaction by default.
Client side callback to execute when lightbox is displayed.
Client side callback to execute when lightbox is hidden.
Images
The images displayed in the lightBox need to be nested as child outputLink components. Following lightBox is displayed when any of the links are clicked.
<p:lightBox>
<h:outputLink value="sopranos/sopranos1.jpg" title="Sopranos 1">
<h:graphicImage value="sopranos/sopranos1_small.jpg/>
</h:outputLink>
<h:outputLink value="sopranos/sopranos2.jpg" title="Sopranos 2">
<h:graphicImage value="sopranos/sopranos2_small.jpg/>
</h:outputLink>
<h:outputLink value="sopranos/sopranos3.jpg" title="Sopranos 3">
<h:graphicImage value="sopranos/sopranos3_small.jpg/>
</h:outputLink>
//more
</p:lightBox>
IFrame Mode
LightBox also has the ability to display iframes inside the page overlay, following lightbox displays the PrimeFaces homepage when the link inside is clicked.
<p:lightBox iframe="true">
<h:outputLink value=" http://www.primefaces.org
" title="PrimeFaces HomePage">
<h:outputText value="PrimeFaces HomePage"/>
</h:outputLink>
</p:lightBox>
Clicking the outputLink will display PrimeFaces homepage within an iframe.
Inline Mode
Inline mode acts like a modal dialog, you can display other JSF content on the page using the lightbox overlay. Simply place your overlay content in the "inline" facet. Clicking the link in the example below will display the panelGrid contents in overlay.
287
PrimeFaces User Guide
<p:lightBox>
<h:outputLink value="#" title="Leo Messi" >
<h:outputText value="The Messiah"/>
</h:outputLink>
<f:facet name="inline">
//content here
</f:facet>
</p:lightBox>
Lightbox inline mode doesn’t support advanced content like complex widgets. Use a dialog instead for advanced cases involving custom content.
Client Side API
Widget: PrimeFaces.widget.LightBox
Method
show() hide() showURL(opt)
Params
-
opt
Return Type
void void void
Description
Displays lightbox.
Hides lightbox.
Displays a URL in a iframe. opt parameter has three variables. width and height for iframe dimensions and src for the page url.
Skinning
Lightbox resides in a main container element which style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-lightbox
.ui-lightbox-content-wrapper
.ui-lightbox-content
.ui-lightbox-nav-right
.ui-lightbox-nav-left
.ui-lightbox-loading
.ui-lightbox-caption
Applies
Main container element.
Content wrapper element.
Content container.
Next image navigator.
Previous image navigator.
Loading image.
Caption element.
288
PrimeFaces User Guide
3.65 Link
Link is an extension to standard h:link component.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
link org.primefaces.component.link.Link
org.primefaces.component.Link
org.primefaces.component
org.primefaces.component.LinkRenderer
org.primefaces.component.link.LinkRenderer
Attributes
id
Name
rendered binding value outcome includeViewParams
Default Type
null String true
Description
Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component.
null null null false
Object An el expression that maps to a server side UIComponent instance in a backing bean.
Object Value of the component than can be either an EL expression of a literal text.
String Used to resolve a navigation case.
Boolean Whether to include page parameters in target URI fragment disabled null false disableClientWindow false accesskey charset coords dir hreflang null null null null null
String Identifier of the target page which should be scrolled to.
Boolean Disables button.
Boolean Disable appending the ClientWindow on the rendering of this element.
String
String
String
String
String
Access key that when pressed transfers focus to button.
Character encoding of the resource designated by this hyperlink.
Position and shape of the hot spot on the screen for client use in image maps.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Language code of the resource designated by the link.
289
rel
Name
rev onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup href shape tabindex target title type style styleClass onblur onclick ondblclick onfocus onkeydown
Default Type
null String null null null null null null null null null null null null null null null null null null null null null
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
Relationship from the current document to the anchor specified by the link, values are provided by a spaceseparated list of link types.
A reverse link from the anchor specified by this link to the current document, values are provided by a space-separated list of link types.
Shape of hot spot on the screen, valid values are default, rect, circle and poly.
Position of the element in the tabbing order.
Name of a frame where the resource targeted by this link will be displayed.
Advisory tooltip informaton.
Type of resource referenced by the link.
Inline style of the component.
Style class of the component.
Client side callback to execute when button loses focus.
Client side callback to execute when button is clicked.
Client side callback to execute when button is double clicked.
Client side callback to execute when button receives focus.
Client side callback to execute when a key is pressed down over button.
Client side callback to execute when a key is pressed and released over button.
Client side callback to execute when a key is released over button.
Client side callback to execute when a pointer button is pressed down over button.
Client side callback to execute when a pointer button is moved within button
Client side callback to execute when a pointer button is moved away from button.
Client side callback to execute when a pointer button is moved onto button.
Client side callback to execute when a pointer button is released over button.
Inline style of the button.
290
escape
Name
PrimeFaces User Guide
Default Type
true
Description
Boolean Defines if label of the component is escaped or not.
Getting Started with Link
p:link usage is same as standard h:link, an outcome is necessary to navigate using GET requests.
Assume you are at source.xhtml and need to navigate target.xhtml.
<p:link outcome="target" value="Navigate"/>
To navigate without outcome based approach, use href attribute.
<p:link href="http://www.primefaces.org" value="Navigate"/>
291
3.66 Log
Log component is a visual console to display logs on JSF pages.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
log org.primefaces.component.log.Log
org.primefaces.component.Log
org.primefaces.component
org.primefaces.component.LogRenderer
org.primefaces.component.log.LogRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding null Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Getting started with Log
Log component is used simply as adding the component to the page.
<p:log />
292
PrimeFaces User Guide
Log API
PrimeFaces uses client side log apis internally, for example you can use log component to see details of an ajax request. Log API is also available via global PrimeFaces object in case you’d like to use the log component to display your logs.
<script type=”text/javascript”>
PrimeFaces.info(‘Info message’);
PrimeFaces.debug(‘Debug message’);
PrimeFaces.warn(‘Warning message’);
PrimeFaces.error(‘Error message’);
</script>
Client Side API
Widget: PrimeFaces.widget.Log show() hide()
Method Params
-
-
Return Type
void void
Description
Show the container element.
Hides the container element.
293
PrimeFaces User Guide
3.67 Media
Media component is used for embedding multimedia content.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
media org.primefaces.component.media.Media
org.primefaces.component.Media
org.primefaces.component
org.primefaces.component.MediaRenderer
org.primefaces.component.media.MediaRenderer
Attributes
Name
id rendered binding value player width height style styleClass cache
Default
null true
Type
String
Boolean null null null null null null null true
Object
String
String
String
String
String
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Media source to play.
Type of the player, possible values are
"quicktime","windows","flash","real" and "pdf".
Width of the player.
Height of the player.
Style of the player.
StyleClass of the player.
Controls browser caching mode of the resource.
Getting started with Media
In its simplest form media component requires a source to play;
<p:media value="/media/ria_with_primefaces.mov" />
294
PrimeFaces User Guide
Player Types
By default, players are identified using the value extension so for instance mov files will be played by quicktime player. You can customize which player to use with the player attribute.
<p:media value=" http://www.youtube.com/v/ABCDEFGH " player="flash"/>
Following is the supported players and file types.
Player
windows quicktime flash real pdf
Types
asx, asf, avi, wma, wmv aif, aiff, aac, au, bmp, gsm, mov, mid, midi, mpg, mpeg, mp4, m4a, psd, qt, qtif, qif, qti, snd, tif, tiff, wav, 3g2, 3pg flv, mp3, swf ra, ram, rm, rpm, rv, smi, smil pdf
Parameters
Different proprietary players might have different configuration parameters, these can be specified using f:param tags.
<p:media value="/media/ria_with_primefaces.mov">
<f:param name="param1" value="value1" />
</p:media>
StreamedContent Support
Media component can also play binary media content, example for this use case is storing media files in database using binary format. In order to implement this, bind a StreamedContent.
<p:media value="#{mediaBean.media}" width="250" height="225" player="quicktime"/> public class MediaBean { private StreamedContent media; public MediaController() {
InputStream stream = //Create binary stream from database media = new DefaultStreamedContent(stream, "video/quicktime");
} public StreamedContent getMedia() { return media; }
}
295
PrimeFaces User Guide
3.68 MegaMenu
MegaMenu is a horizontal navigation component that displays submenus together.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding widgetVar model style styleClass
megaMenu org.primefaces.component.megamenu.MegaMenu
org.primefaces.component.MegaMenu
org.primefaces.component
org.primefaces.component.MegaMenuRenderer
org.primefaces.component.megamenu.MegaMenuRenderer
Default
null true null null null null null
Type
String
Boolean
Object
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
String Name of the client side widget
MenuModel MenuModel instance to create menus programmatically
String
String
Inline style of the component.
Style class of the component.
296
Name
autoDisplay activeIndex orientation
Default
true
Type
Boolean null horizontal
Integer
String
PrimeFaces User Guide
Description
Defines whether submenus will be displayed on mouseover or not. When set to false, click event is required to display.
Index of the active root menu to display as highlighted. By default no root is highlighted.
Defines the orientation of the root menuitems, valid values are "horizontal" and "vertical".
Getting Started with MegaMenu
Layout of MegaMenu is grid based and root items require columns as children.
<p:megaMenu>
<p:submenu label="TV" icon="ui-icon-check">
<p:column>
<p:submenu label="TV.1">
<p:menuitem value="TV.1.1" url="#" />
<p:menuitem value="TV.1.2" url="#" />
</p:submenu>
<p:submenu label="TV.2">
<p:menuitem value="TV.2.1" url="#" />
<p:menuitem value="TV.2.2" url="#" />
<p:menuitem value="TV.2.3" url="#" />
</p:submenu>
<p:submenu label="TV.3">
<p:menuitem value="TV.3.1" url="#" />
<p:menuitem value="TV.3.2" url="#" />
</p:submenu>
</p:column>
<p:column>
<p:submenu label="TV.4">
<p:menuitem value="TV.4.1" url="#" />
<p:menuitem value="TV.4.2" url="#" />
</p:submenu>
<p:submenu label="TV.5">
<p:menuitem value="TV.5.1" url="#" />
<p:menuitem value="TV.5.2" url="#" />
<p:menuitem value="TV.5.3" url="#" />
</p:submenu>
<p:submenu label="TV.6">
<p:menuitem value="TV.6.1" url="#" />
<p:menuitem value="TV.6.2" url="#" />
<p:menuitem value="TV.6.3" url="#" />
</p:submenu>
</p:column>
</p:submenu>
//more root items
</p:megaMenu>
297
PrimeFaces User Guide
Custom Content
Any content can be placed inside columns.
<p:column>
<strong>Sopranos</strong>
<p:graphicImage value="/images/sopranos/sopranos1.jpg" width="200"/>
</p:column>
Root Menuitem
MegaMenu supports menuitem as root menu options as well. Following example allows a root menubar item to execute an action to logout the user.
<p:megaMenu>
//submenus
<p:menuitem label="Logout" action="#{bean.logout}"/>
</p:megaMenu>
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
MegaMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-megamenu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Applies
Container element of menubar.
List container
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
298
3.69 Menu
Menu is a navigation component with submenus and menuitems.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
menu org.primefaces.component.menu.Menu
org.primefaces.component.Menu
org.primefaces.component
org.primefaces.component.MenuRenderer
org.primefaces.component.menu.MenuRenderer
Attributes
Name
id rendered binding widgetVar model trigger null null null
Default
null true null
Type
String
Boolean
Object
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean.
String Name of the client side widget.
MenuModel A menu model instance to create menu programmatically.
String Target component to attach the overlay menu.
299
Name
my at overlay style styleClass null null triggerEvent click tabindex 0 toggleable false
Default
null null false
Type
String
String
Boolean
String
String
String
String
Boolean
PrimeFaces User Guide
Description
Corner of menu to align with trigger element.
Corner of trigger to align with menu element.
Defines positioning type of menu, either static or overlay.
Inline style of the main container element.
Style class of the main container element.
Event to show the dynamic positioned menu.
Position of the element in the tabbing order. Default is 0.
Defines whether clicking the header of a submenu toggles the visibility of children menuitems.
Getting started with the Menu
A menu is composed of submenus and menuitems.
<p:menu>
<p:menuitem value="Gmail" url=" http://www.google.com
" />
<p:menuitem value="Hotmail" url=" http://www.hotmail.com
" />
<p:menuitem value="Yahoo Mail" url=" http://mail.yahoo.com
" />
<p:menuitem value="Youtube" url=" http://www.youtube.com
" />
<p:menuitem value="Break" url=" http://www.break.com
" />
<p:menuitem value="Metacafe" url=" http://www.metacafe.com
" />
<p:menuitem value="Facebook" url=" http://www.facebook.com
" />
<p:menuitem value="MySpace" url=" http://www.myspace.com
" />
</p:menu>
300
PrimeFaces User Guide
Submenus are used to group menuitems;
<p:menu>
<p:submenu label="Mail">
<p:menuitem value="Gmail" url=" http://www.google.com
" />
<p:menuitem value="Hotmail" url=" http://www.hotmail.com
" />
<p:menuitem value="Yahoo Mail" url=" http://mail.yahoo.com
" />
</p:submenu>
<p:submenu label="Videos">
<p:menuitem value="Youtube" url=" http://www.youtube.com
" />
<p:menuitem value="Break" url=" http://www.break.com
" />
<p:menuitem value="Metacafe" url=" http://www.metacafe.com
" />
</p:submenu>
<p:submenu label="Social Networks">
<p:menuitem value="Facebook" url=" http://www.facebook.com
" />
<p:menuitem value="MySpace" url=" http://www.myspace.com
" />
</p:submenu>
</p:menu>
Overlay Menu
Menu can be positioned on a page in two ways; "static" and "dynamic". By default it’s static meaning the menu is in normal page flow. In contrast dynamic menus is not on the normal flow of the page allowing them to overlay other elements.
A dynamic menu is created by setting overlay option to true and defining a trigger to show the menu. Location of menu on page will be relative to the trigger and defined by my and at options that take combination of four values;
• left
• right
• bottom
• top
301
PrimeFaces User Guide
For example, clicking the button below will display the menu whose top left corner is aligned with bottom left corner of button.
<p:menu overlay="true" trigger="btn" my="left top" at="bottom left">
...submenus and menuitems
</p:menu>
<p:commandButton id="btn" value="Show Menu" type="button"/>
Ajax and Non-Ajax Actions
As menu uses menuitems, it is easy to invoke actions with or without ajax as well as navigation.
See menuitem documentation for more information about the capabilities.
<p:menu>
<p:submenu label="Options">
<p:menuitem value="Save" actionListener="#{bean.save}" update="comp"/>
<p:menuitem value="Update" actionListener="#{bean.update}" ajax="false"/>
<p:menuitem value="Navigate" url=" http://www.primefaces.org
"/>
</p:submenu>
</p:menu>
Dynamic Menus
Menus can be created programmatically as well, this is more flexible compared to the declarative approach. Menu metadata is defined using an org.primefaces.model.MenuModel instance,
PrimeFaces provides the built-in org.primefaces.model.DefaultMenuModel implementation.
For further customization you can also create and bind your own MenuModel implementation. (e.g.
One with JPA @Entity annotation to able able to persist to a database).
<p:menu model="#{menuBean.model}" />
302
PrimeFaces User Guide public class MenuBean { private MenuModel model; public MenuBean() { model = new DefaultMenuModel();
//First submenu
DefaultSubMenu firstSubmenu = new DefaultSubMenu("Dynamic Submenu");
DefaultMenuItem item = new DefaultMenuItem("External"); item.setUrl(" http://www.primefaces.org
"); item.setIcon("ui-icon-home"); firstSubmenu.addElement(item); model.addElement(firstSubmenu);
//Second submenu
DefaultSubMenu secondSubmenu = new DefaultSubMenu("Dynamic Actions"); item = new DefaultMenuItem("Save"); item.setIcon("ui-icon-disk"); item.setCommand("#{menuBean.save}"); item.setUpdate("messages"); secondSubmenu.addElement(item); item = new DefaultMenuItem("Delete"); item.setIcon("ui-icon-close"); item.setCommand("#{menuBean.delete}"); item.setAjax(false); secondSubmenu.addElement(item); item = new DefaultMenuItem("Redirect"); item.setIcon("ui-icon-search"); item.setCommand("#{menuBean.redirect}"); secondSubmenu.addElement(item); model.addElement(secondSubmenu);
} public MenuModel getModel() { return model; }
}
For all UI component counterpart such as p:menuitem, p:submenu, p:separator a corresponding interface with a default implementation exists in MenuModel API. Regarding actions, if you need to pass parameters in ajax or non-ajax commands, use setParam(key, value) method.
MenuModel API is supported by all menu components that have model attribute.
303
PrimeFaces User Guide
Toggleable
Enabling toggleable option makes the header of submenus clickable to expand and collapse their content.
<p:menu toggleable="true">
Skinning
Menu resides in a main container element which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-menu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
.ui-menu-sliding
Applies
Container element of menu
List container
Each menu item
Anchor element in a link item
Text element in an item
Container of ipod like sliding menu
As skinning style classes are global, see the main theming section for more information.
304
PrimeFaces User Guide
3.70 Menubar
Menubar is a horizontal navigation component.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding widgetVar model style styleClass autoDisplay tabindex
menubar org.primefaces.component.menubar.Menubar
org.primefaces.component.Menubar
org.primefaces.component
org.primefaces.component.MenubarRenderer
org.primefaces.component.menubar.MenubarRenderer
Default
null true null null null null null false
0
Type
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean.
Name of the client side widget String
MenuModel MenuModel instance to create menus programmatically
String
String
Boolean
Inline style of menubar
Style class of menubar
String
Defines whether the first level of submenus will be displayed on mouseover or not. When set to false, click event is required to display.
Position of the element in the tabbing order.
305
Name
toggleEvent
Default
hover
Type
String
PrimeFaces User Guide
Description
Event to toggle the submenus, valid values are
"hover" and "click".
Getting started with Menubar
Submenus and menuitems as child components are required to compose the menubar.
<p:menubar>
<p:submenu label="Mail">
<p:menuitem value="Gmail" url=" http://www.google.com
" />
<p:menuitem value="Hotmail" url=" http://www.hotmail.com
" />
<p:menuitem value="Yahoo Mail" url=" http://mail.yahoo.com
" />
</p:submenu>
<p:submenu label="Videos">
<p:menuitem value="Youtube" url=" http://www.youtube.com
" />
<p:menuitem value="Break" url=" http://www.break.com
" />
</p:submenu>
</p:menubar>
Nested Menus
To create a menubar with a higher depth, nest submenus in parent submenus.
<p:menubar>
<p:submenu label="File">
<p:submenu label="New">
<p:menuitem value="Project" url="#"/>
<p:menuitem value="Other" url="#"/>
</p:submenu>
<p:menuitem value="Open" url="#"></p:menuitem>
<p:menuitem value="Quit" url="#"></p:menuitem>
</p:submenu>
<p:submenu label="Edit">
<p:menuitem value="Undo" url="#"></p:menuitem>
<p:menuitem value="Redo" url="#"></p:menuitem>
</p:submenu>
<p:submenu label="Help">
<p:menuitem label="Contents" url="#" />
<p:submenu label="Search">
<p:submenu label="Text">
<p:menuitem value="Workspace" url="#" />
</p:submenu>
<p:menuitem value="File" url="#" />
</p:submenu>
</p:submenu>
</p:menubar>
306
PrimeFaces User Guide
Root Menuitem
Menubar supports menuitem as root menu options as well;
<p:menubar>
<p:menuitem label="Logout" action="#{bean.logout}"/>
</p:menubar>
Ajax and Non-Ajax Actions
As menu uses menuitems, it is easy to invoke actions with or without ajax as well as navigation.
See menuitem documentation for more information about the capabilities.
<p:menubar>
<p:submenu label="Options">
<p:menuitem value="Save" actionListener="#{bean.save}" update="comp"/>
<p:menuitem value="Update" actionListener="#{bean.update}" ajax="false"/>
<p:menuitem value="Navigate" url=" http://www.primefaces.org
"/>
</p:submenu>
</p:menubar>
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
Menubar resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-menubar
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Applies
Container element of menubar.
List container
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
307
3.71 MenuButton
MenuButton displays different commands in a popup menu.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding value style styleClass widgetVar model disabled iconPos appendTo
menuButton org.primefaces.component.menubutton.MenuButton
org.primefaces.component.MenuButton
org.primefaces.component
org.primefaces.component.MenuButtonRenderer
org.primefaces.component.menubutton.MenuButtonRenderer
null false left null null null null null
Default
null true null
Type
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
String
String
String
An el expression that maps to a server side
UIComponent instance in a backing bean.
Label of the button
Style of the main container element
Style class of the main container element
Name of the client side widget
MenuModel MenuModel instance to create menus programmatically
Boolean Disables or enables the button.
String Position of the icon, valid values are left and right.
String Appends the overlay to the element defined by search expression. Defaults to document body.
308
PrimeFaces User Guide
Getting started with the MenuButton
MenuButton consists of one ore more menuitems. Following menubutton example has three menuitems, first one is used triggers an action with ajax, second one does the similar but without ajax and third one is used for redirect purposes.
<p:menuButton value="Options">
<p:menuitem value="Save" actionListener="#{bean.save}" update="comp" />
<p:menuitem value="Update" actionListener="#{bean.update}" ajax="false" />
<p:menuitem value="Go Home" url="/home.jsf" />
</p:menuButton>
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
MenuButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-menu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
.ui-button
.ui-button-text
Container element of menu.
List container
Applies
Each menu item
Anchor element in a link item
Text element in an item
Button element
Label of button
309
PrimeFaces User Guide binding value actionListener action immediate url target style styleClass onclick async process update
3.72 MenuItem
MenuItem is used by various menu components.
Info
Tag
Tag Class
Component Class
Component Type
menuItem org.primefaces.component.menuitem.MenuItemTag
org.primefaces.component.menuitem.MenuItem
org.primefaces.component.MenuItem
Component Family
org.primefaces.component
Attributes
id rendered
Name
null null null null null false null null
Default
null true null null null null false
Type Description
String Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean.
String
Method
Expr
Label of the menuitem
Action listener to be invoked when menuitem is clicked.
Method
Expr
Action to be invoked when menuitem is clicked.
Boolean When true, action of this menuitem is processed after apply request phase.
String
String
String
Url to be navigated when menuitem is clicked
Target type of url navigation
Style of the menuitem label
String
String
StyleClass of the menuitem label
Javascript event handler for click event
Boolean When set to true, ajax requests are not queued.
String Components to process partially instead of whole view.
String Components to update after ajax request.
310
disabled onstart onsuccess onerror global
Name
oncomplete delay partialSubmit resetValues ignoreAutoUpdate timeout ajax icon title outcome true null null null includeViewParams false fragment null disableClientWindow false containerStyle null containerStyleClass null
PrimeFaces User Guide
Default
false null null null null true null false false false
0
Type Description
Boolean Disables the menuitem.
String
String
Javascript handler to execute before ajax request is begins.
Javascript handler to execute when ajax request is completed.
String
String
Javascript handler to execute when ajax request succeeds.
Javascript handler to execute when ajax request fails.
Boolean Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
String If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Boolean Enables serialization of values belonging to the partially processed components only.
Boolean If true, local values of input components to be updated within the ajax request would be reset.
Boolean If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Integer Timeout for the ajax request in milliseconds.
Boolean Specifies submit mode.
String Path of the menuitem image.
String
String
Advisory tooltip information.
Navigation case outcome.
Boolean Defines if page parameters should be in target URI.
String Identifier of the target page element to scroll to.
Boolean Disable appending the ClientWindow on the rendering of this element.
String
String
Inline style of the menuitem container.
Style class of the menuitem container.
311
PrimeFaces User Guide
Getting started with MenuItem
MenuItem is a generic component used by the following components.
• Menu
• MenuBar
• MegaMenu
• Breadcrumb
• Dock
• Stack
• MenuButton
• SplitButton
• PanelMenu
• TabMenu
• SlideMenu
• TieredMenu
Note that some attributes of menuitem might not be supported by these menu components. Refer to the specific component documentation for more information.
Navigation vs Action
Menuitem has two use cases, directly navigating to a url with GET or doing a POST to execute an action. This is decided by url or outcome attributes, if either one is present menuitem does a GET request, if not parent form is posted with or without ajax decided by ajax attribute.
Icons
There are two ways to specify an icon of a menuitem, you can either use bundled icons within
PrimeFaces or provide your own via css.
ThemeRoller Icons
<p:menuitem icon="ui-icon-disk" ... />
Custom Icons
<p:menuitem icon="barca" ... />
.barca { background: url(barca_logo.png) no-repeat; height:16px; width:16px;
}
312
PrimeFaces User Guide
3.73 Message
Message is a pre-skinned extended version of the standard JSF message component.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
message org.primefaces.component.message.Message
org.primefaces.component.Message
org.primefaces.component
org.primefaces.component.MessageRenderer
org.primefaces.component.message.MessageRenderer
Attributes
Name
id rendered binding showSummary false showDetail true for redisplay display escape severity style styleClass true null null null null true both
Default
null true
Type
String
Boolean null Object
Boolean
Boolean
String
Boolean
String
Boolean
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean.
Specifies if the summary of the FacesMessage should be displayed.
Specifies if the detail of the FacesMessage should be displayed.
Id of the component whose messages to display.
Defines if already rendered messages should be displayed
Defines the display mode.
Defines whether html would be escaped or not.
Comma separated list of severities to display only.
Inline style of the component.
Style class of the component.
313
PrimeFaces User Guide
Getting started with Message
Message usage is exactly same as standard message.
<h:inputText id="txt" value="#{bean.text}" />
<p:message for="txt" />
Display Mode
Message component has three different display modes;
• text : Only message text is displayed.
• icon : Only message severity is displayed and message text is visible as a tooltip.
• both (default) : Both icon and text are displayed.
Severity Levels
Using severity attribute, you can define which severities can be displayed by the component. For instance, you can configure messages to only display infos and warnings.
<p:message severity="info,warn" for="txt"/>
Escaping
Component escapes html content in messages by default, in case you need to display html, disable escape option.
<p:message escape="false" for="txt" />
Skinning
Full list of CSS selectors of message is as follows;
Style Class
ui-message-{severity} ui-message-{severity}-summary ui-message-{severity}-detail
Applies
Container element of the message
Summary text
Detail text
{severity} can be ‘info’, ‘error’, ‘warn’ and error.
314
PrimeFaces User Guide
3.74 Messages
Messages is a pre-skinned extended version of the standard JSF messages component.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
messages org.primefaces.component.messages.Messages
org.primefaces.component.Messages
org.primefaces.component
org.primefaces.component.MessagesRenderer
org.primefaces.component.messages.MessagesRenderer
Attributes
Name
id rendered
Default
null true
Type
String
Boolean binding null showSummary true showDetail globalOnly false false redisplay autoUpdate for escape true false null true
Object
Boolean
Boolean
String
Boolean
Boolean
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Specifies if the summary of the FacesMessages should be displayed.
Specifies if the detail of the FacesMessages should be displayed.
When true, only facesmessages with no clientIds are displayed.
Defines if already rendered messages should be displayed
Enables auto update mode if set true.
Name of associated key, takes precedence when used with globalOnly.
Defines whether html would be escaped or not.
315
Name
severity closable style styleClass showIcon
Default
null false null null true
Type
String
Boolean
String
String
Boolean
PrimeFaces User Guide
Description
Comma separated list of severities to display only.
Adds a close icon to hide the messages.
Inline style of the component.
Style class of the component.
Defines if severity icons would be displayed.
Getting started with Messages
Message usage is exactly same as standard messages.
<p:messages />
AutoUpdate
When auto update is enabled, messages component is updated with each ajax request automatically.
Targetable Messages
There may be times where you need to target one or more messages to a specific message component, for example suppose you have growl and messages on same page and you need to display some messages on growl and some on messages. Use for attribute to associate messages with specific components.
<p:messages for="somekey" />
<p:growl for="anotherkey" />
FacesContext context = FacesContext.getCurrentInstance(); context.addMessage("somekey", facesMessage1); context.addMessage("somekey", facesMessage2); context.addMessage("anotherkey", facesMessage3);
In sample above, messages will display first and second message and growl will only display the
3rd message.
Severity Levels
Using severity attribute, you can define which severities can be displayed by the component. For instance, you can configure messages to only display infos and warnings.
<p:messages severity="info,warn" />
Escaping
Messages escapes html content in messages, disable escape option to display content as html.
316
<p:messages escape="false" />
Skinning
Full list of CSS selectors of message is as follows;
Style Class
ui-messages-{severity} ui-messages-{severity}-summary ui-messages-{severity}-detail ui-messages-{severity}-icon
Applies
Container element of the message
Summary text
Detail text
Icon of the message.
{severity} can be ‘info’, ‘error’, ‘warn’ and error.
PrimeFaces User Guide
317
PrimeFaces User Guide
3.75 Mindmap
Mindmap is an interactive tool to visualize mindmap data featuring lazy loading, callbacks, animations and more.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered
mindmap org.primefaces.component.mindmap.Mindmap
org.primefaces.component.Mindmap
org.primefaces.component
org.primefaces.component.MindmapRenderer
org.primefaces.component.mindmap.MindmapRenderer
Default
null true
String
Type
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
318
binding
Name
value style styleClass effectSpeed widgetVar null null null
300 null
Default
null
PrimeFaces User Guide
Type
Object
Description
An el expression that maps to a server side
UIComponent instance in a backing bean
MindmapNode MenuModel instance to build menu dynamically.
String Inline style of the component.
String
Integer
String
Style class of the component.
Speed of the animations in milliseconds.
Name of the client side widget.
Getting started with Mindmap
Mindmap requires an instance of org.primefaces.model.mindmap.MindmapNode as the root. Due to it’s lazy nature, a select ajax behavior must be provided to load children of selected node on the fly with ajax.
public class MindmapBean {
private MindmapNode root;
public MindmapBean() {
root = new DefaultMindmapNode("google.com", "Google", "FFCC00", false);
MindmapNode ips = new DefaultMindmapNode("IPs", "IP Nos", "6e9ebf", true);
MindmapNode ns = new DefaultMindmapNode("NS(s)", "Names", "6e9ebf", true);
MindmapNode mw = new DefaultMindmapNode("Mw", "Malicious ", "6e9ebf", true);
root.addNode(ips);
root.addNode(ns);
root.addNode(malware);
}
public MindmapNode getRoot() {
return root;
}
public void onNodeSelect(SelectEvent event) {
MindmapNode node = (MindmapNode) event.getObject();
//load children of select node and add via node.addNode(childNode);
}
}
<p:mindmap value="#{mindmapBean.root}" style="width:100%;height:600px">
<p:ajax event="select" listener="#{mindmapBean.onNodeSelect}" />
</p:mindmap>
319
PrimeFaces User Guide
DoubleClick Behavior
Selecting a node with single click is used to load subnodes, double click behavior is also provided for further customization. Following sample, displays the details of the subnode in a dialog.
<p:mindmap value="#{mindmapBean.root}" style="width:100%;height:600px;">
<p:ajax event="select" listener="#{mindmapBean.onNodeSelect}" />
<p:ajax event="dblselect" listener="#{mindmapBean.onNodeDblselect}" update="output" oncomplete="PF('details').show()"/>
</p:mindmap>
<p:dialog widgetVar="details" header="Node Details" resizable="false" modal="true" showEffect="fade" hideEffect="fade">
<h:outputText id="output" value="#{mindmapBean.selectedNode.data}" />
</p:dialog> public void onNodeDblselect(SelectEvent event) {
this.selectedNode = (MindmapNode) event.getObject();
}
MindmapNode API
org.primefaces.model.mindmap.MindmapNode
label data
Property
fill selectable parent null
1 null
Default
null null
String
Object
Type
String
Boolean
MindmapNode
Description
Label of the node.
Optional data associated with the node.
Color code of the node.
Flag to define if node is clickable.
Parent node instance.
Tips
• IE 7 and IE 8 are not supported due to technical limitations, IE 9 is supported.
320
PrimeFaces User Guide
3.76 MultiSelectListbox
MultiSelectListbox is used to select an item from a collection of listboxes that are in parent-child relationship.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
multiSelectListbox org.primefaces.component.multiselectlistbox.MultiSelectListbox
org.primefaces.component.MultiSelectListbox
org.primefaces.component
org.primefaces.component.MultiSelectListboxRenderer
org.primefaces.component.multiselectlistbox.MultiSelectListboxRenderer
Attributes
Name
id rendered
Default
null true
Type
String
Boolean binding widgetVar style styleClass disabled effect showHeaders header null null null null false null false null
Object
String
String
String
Boolean
String
Boolean
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Name of the client side widget.
Inline style of the component.
Style class of the component.
If true, disables the component.
Effect to use when showing a group of items.
Displays label of a group at header section of the children items.
Label of the root group items.
321
PrimeFaces User Guide
Getting started with MultiSelectListbox
MultiSelectListbox needs a collection of SelectItemGroups.
public class MultiSelectListboxBean {
private List<SelectItem> categories;
private String selection;
@PostConstruct
public void init() {
categories = new ArrayList<SelectItem>();
SelectItemGroup group1 = new SelectItemGroup("Group 1");
SelectItemGroup group2 = new SelectItemGroup("Group 2");
SelectItemGroup group3 = new SelectItemGroup("Group 3");
SelectItemGroup group4 = new SelectItemGroup("Group 4");
SelectItemGroup group11 = new SelectItemGroup("Group 1.1");
SelectItemGroup group12 = new SelectItemGroup("Group 1.2");
SelectItemGroup group21 = new SelectItemGroup("Group 2.1");
SelectItem option31 = new SelectItem("Option 3.1", "Option 3.1");
SelectItem option32 = new SelectItem("Option 3.2", "Option 3.2");
SelectItem option33 = new SelectItem("Option 3.3", "Option 3.3");
SelectItem option34 = new SelectItem("Option 3.4", "Option 3.4");
SelectItem option41 = new SelectItem("Option 4.1", "Option 4.1");
SelectItem option111 = new SelectItem("Option 1.1.1");
SelectItem option112 = new SelectItem("Option 1.1.2");
group11.setSelectItems(new SelectItem[]{option111, option112});
SelectItem option121 = new SelectItem("Option 1.2.1", "Option 1.2.1");
SelectItem option122 = new SelectItem("Option 1.2.2", "Option 1.2.2");
SelectItem option123 = new SelectItem("Option 1.2.3", "Option 1.2.3");
group12.setSelectItems(new SelectItem[]{option121, option122, option123});
SelectItem option211 = new SelectItem("Option 2.1.1", "Option 2.1.1");
group21.setSelectItems(new SelectItem[]{option211});
group1.setSelectItems(new SelectItem[]{group11, group12});
group2.setSelectItems(new SelectItem[]{group21});
group3.setSelectItems(new SelectItem[]{option31, option32, option33, option34});
group4.setSelectItems(new SelectItem[]{option41});
categories.add(group1);
categories.add(group2);
categories.add(group3);
categories.add(group4);
}
//getters-setters of categories and selection
}
322
PrimeFaces User Guide
<p:multiSelectListbox value="#{multiSelectListboxBean.selection}">
<f:selectItems value="#{multiSelectListboxBean.categories}" />
</p:multiSelectListbox>
Note that SelectItemGroups are not selectable, only values of SelectItems can be passed to the bean.
Effects
An animation is executed during toggling of a group, following options are available for effect attribute; blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size, slide
(suggested).
Client Side API
Widget: PrimeFaces.widget.MultiSelectListbox
Method
enable() disable() showItemGroup(item)
Params
-
li element as jQuery object
Return Type
void void void
Description
Enables the component.
Disables the component.
Shows subcategories of a given item.
Skinning
MultiSelectListbox resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-multiselectlistbox
.ui-multiselectlistbox-list
.ui-multiselectlistbox-item
Main container element.
List container.
Each item in a list.
Applies
323
PrimeFaces User Guide
3.77 NotificationBar
NotificationBar displays a multipurpose fixed positioned panel for notification.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
notificationBar org.primefaces.component.notificationbar.NotificationBar
org.primefaces.component.NotificatonBar
org.primefaces.component
org.primefaces.component.NotificationBarRenderer
org.primefaces.component.notificationbar.NotificationBarRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding style styleClass position effect effectSpeed autoDisplay widgetVar null null null top fade normal false null
Object
String
String
String
String
String
Boolean
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Style of the container element
StyleClass of the container element
Position of the bar, "top" or "bottom".
Name of the effect, "fade", "slide" or "none".
Speed of the effect, "slow", "normal" or "fast".
When true, panel is displayed on page load.
Name of the client side widget.
Getting started with NotificationBar
As notificationBar is a panel component, any content can be placed inside.
<p:notificationBar>
//Content
</p:notificationBar>
324
PrimeFaces User Guide
Showing and Hiding
To show and hide the content, notificationBar provides an easy to use client side api that can be accessed through the widgetVar. show() displays the bar and hide() hides it. isVisible() and toggle() are additional client side api methods.
<p:notificationBar widgetVar="nv">
//Content
</p:notificationBar>
<h:outputLink value="#" onclick="PF('nv').show()">Show</h:outputLink>
<h:outputLink value="#" onclick="PF('nv').hide()">Hide</h:outputLink>
Note that notificationBar has a default built-in close icon to hide the content.
Effects
Default effect to be used when displaying and hiding the bar is "fade", another possible effect is
"slide".
<p:notificationBar effect="slide">
//Content
</p:notificationBar>
If you’d like to turn off animation, set effect name to "none". In addition duration of the animation is controlled via effectSpeed attribute that can take "normal", "slow" or "fast" as it’s value.
Position
Default position of bar is "top", other possibility is placing the bar at the bottom of the page. Note that bar positioning is fixed so even page is scrolled, bar will not scroll.
<p:notificationBar position="bottom">
//Content
</p:notificationBar>
Skinning
style and styleClass attributes apply to the main container element. Additionally there are two predefined css selectors used to customize the look and feel.
Selector
.ui-notificationbar Main container element
Applies
325
PrimeFaces User Guide
3.78 OrderList
OrderList is used to sort a collection featuring drag&drop based reordering, transition effects and pojo support.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
orderList org.primefaces.component.orderlist.OrderList
org.primefaces.component.OrderList
org.primefaces.component
org.primefaces.component.OrderListRenderer
org.primefaces.component.orderlist.OrderListRenderer
Attributes
Name
id rendered binding value converter
Default
null
True null null null
Type
String
Boolean
Object
Object
Converter
/String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
326
Name
immediate required validator
0
Default Type
Boolean
0 null valueChangeListener null requiredMessage null
Boolean
Method
Expr
Method
Expr
String converterMessage validatorMessage widgetVar var itemLabel itemValue style styleClass disabled effect moveUpLabel moveTopLabel moveDownLabel moveBottomLabel controlsLocation
Move
Top
Move
Down
Move
Bottom left null null null null null null null null
0 fade
String
Boolean
String
Move Up String
String
String
String
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
A method expression that refers to a method validationg the input
A method expression that refers to a method for handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Name of the iterator.
Label of an item.
Value of an item.
Inline style of container element.
Style class of container element.
Disables the component.
Name of animation to display.
Label of move up button.
Label of move top button.
Label of move down button.
Label of move bottom button.
Location of the reorder buttons, valid values are “left”,
“right” and “none”.
327
PrimeFaces User Guide
Getting started with OrderList
A list is required to use OrderList component.
public class OrderListBean { private List<String> cities; public OrderListBean() { cities = new ArrayList<String>(); cities.add("Istanbul"); cities.add("Ankara"); cities.add("Izmir"); cities.add("Antalya"); cities.add("Bursa");
}
//getter&setter for cities
}
<p:orderList value="#{orderListBean.cities}" var="city"
itemLabel="#{city}" itemValue="#{city}""/>
Advanced OrderList
OrderList supports displaying custom content instead of simple labels by using columns. In addition, pojos are supported if a converter is defined.
public class OrderListBean { private List<Player> players; public OrderListBean() { players = new ArrayList<Player>(); players.add(new Player("Messi", 10, "messi.jpg")); players.add(new Player("Iniesta", 8, "iniesta.jpg")); players.add(new Player("Villa", 7, "villa.jpg")); players.add(new Player("Xavi", 6, "xavi.jpg"));
}
//getter&setter for players
}
<p:orderList value="#{orderListBean.players}" var="player" itemValue="#{player}" converter="player">
<p:column style="width:25%">
<p:graphicImage value="/images/barca/#{player.photo}" />
</p:column>
<p:column style="width:75%;">
#{player.name} - #{player.number}
</p:column>
</p:orderList>
328
PrimeFaces User Guide
Header
A facet called “caption” is provided to display a header content for the orderlist.
Effects
An animation is executed during reordering, default effect is fade and following options are available for effect attribute; blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size and slide.
Skinning
OrderList resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-orderlist
.ui-orderlist-list
.ui-orderlist-item
.ui-orderlist-caption
Main container element.
Container of items.
Each item in the list.
Caption of the list.
Applies
329
3.79 OutputLabel
OutputLabel is a an extension to the standard outputLabel component.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding value accesskey dir escape for
outputLabel org.primefaces.component.outputlabel.OutputLabel
org.primefaces.component.OutputLabel
org.primefaces.component
org.primefaces.component.OutputLabelRenderer
org.primefaces.component.outputlabel.OutputLabelRenderer
null true null
Default
null true
Type
String
Boolean null null null
Object
String
String
String
Boolean
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Label to display.
The accesskey attribute is a standard HTML attribute that sets the access key that transfers focus to this element when pressed.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Defines if value should be escaped or not.
Component to attach the label to.
330
Name
tabindex title style styleClass onblur onclick ondblclick onfocus onkeydown onkeypress onkeyup null onmousedown null onmouseout null onmouseover onmouseup null null indicateRequired true null null null
Default
null null null null null
Type
String
String
String
String
String null null
String
String
String
String
String
String
String
String
String
String
Boolean
PrimeFaces User Guide
Description
Position in tabbing order.
Advisory tooltip information.
Inline style of the component.
Style class of the component.
Client side callback to execute when component loses focus.
Client side callback to execute when component is clicked.
Client side callback to execute when component is double clicked.
Client side callback to execute when component receives focus.
Client side callback to execute when a key is pressed down over component.
Client side callback to execute when a key is pressed and released over component.
Client side callback to execute when a key is released over component.
Client side callback to execute when a pointer is pressed down over component.
Client side callback to execute when a pointer is moved away from component.
Client side callback to execute when a pointer is moved onto component.
Client side callback to execute when a pointer is released over component.
Displays * symbol if the input is required.
Getting Started with OutputLabel
Usage is same as standard outputLabel, an input component is associated with for attribute.
<p:outputLabel for="input" value="Label" />
<p:inputText id="input" value="#{bean.text}" />
331
PrimeFaces User Guide
Auto Label
OutputLabel sets its value as the label of the target component to be displayed in validation errors so the target component does not need to define the label attribute again.
<h:outputLabel for="input" value="Field" />
<p:inputText id="input" value="#{bean.text}" label="Field"/> can be rewritten as;
<p:outputLabel for="input" value="Field" />
<p:inputText id="input" value="#{bean.text}" />
Support for Advanced Components
Some PrimeFaces input components like spinner, autocomplete does not render just basic inputs so standard outputLabel component cannot apply focus to these, however PrimeFaces outputLabel can.
<h:outputLabel for="input" value="Can’t apply focus" />
<p:outputLabel for="input" value="Can apply focus" />
<p:spinner id="input" value="#{bean.text}" />
Validations
When the target input is required, outputLabel displays * symbol next to the value. In case any validation fails on target input, label will also be displayed with theme aware error styles.
Skinning
Label renders a label element that style and styleClass attributes apply. Following is the list of structural style classes;
.ui-outputlabel
.ui-state-error
Style Class
.ui-outputlabel-rfi
Applies
Label element
Label element when input is invalid
Required field indicator.
332
PrimeFaces User Guide
3.80 OutputPanel
OutputPanel is a panel component with the ability to auto update.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
outputPanel org.primefaces.component.outputpanel.OutputPanel
org.primefaces.component.OutputPanel
org.primefaces.component
org.primefaces.component.OutputPanelRenderer
org.primefaces.component.output.OutputPanelRenderer
Attributes
Name
id rendered
Default
null true
Type
String
Boolean binding style styleClass layout autoUpdate deferred false false deferredMode load null null null block
Object
String
String
String
Boolean
Boolean
String global delay false none
Boolean
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Style of the html container element
StyleClass of the html container element
Shortcut for the css display property, valid values are block
(default) and inline.
Enables auto update mode if set true.
Deferred mode loads the contents after page load to speed up page load.
Defines deferred loading mode, valid values are "load"
(after page load) and "visible" (once the panel is visible on scroll).
Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus on deferred loading.
Delay in milliseconds to wait before initiating a deferred loading, default value is "none".
333
PrimeFaces User Guide
PlaceHolder
When a JSF component is not rendered, no markup is rendered so for components with conditional rendering, regular update mechanism may not work since the markup to update on page does not exist. OutputPanel is useful in this case to be used as a placeholder.
Suppose the rendered condition on bean is false when page if loaded initially and search method on bean sets the condition to be true meaning datatable will be rendered after a page submit. The problem is although partial output is generated, the markup on page cannot be updated since it doesn’t exist.
<p:dataTable id="tbl" rendered="#{bean.condition}" ...>
//columns
</p:dataTable>
<p:commandButton update="tbl" actionListener="#{bean.search}" />
Solution is to use the outputPanel as a placeHolder.
<p:outputPanel id="out">
<p:dataTable id="tbl" rendered="#{bean.condition}" ...>
//columns
</p:dataTable>
</p:outputPanel>
<p:commandButton update="out" actionListener="#{bean.list}" />
Note that you won’t need an outputPanel if commandButton has no update attribute specified, in this case parent form will be updated partially implicitly making an outputPanel use obselete.
Deferred Loading
When this feature option is enabled, content of panel is not loaded along with the page but loaded after the page on demand. Initially panel displays a loading animation after page load to indicate more content is coming up and displays content with ajax update. Using deferredMode option, it is possible to load contents not just after page load (default mode) but when it becomes visible on page scroll as well. This feature is very useful to increase page load performance, assume you have one part of the page that has components dealing with backend and taking time, with deferred mode on, rest of the page is loaded instantly and time taking process is loaded afterwards with ajax.
Layout
OutputPanel has two layout modes;
• block (default): Renders a div
• inline: Renders a span
AutoUpdate
When auto update is enabled, outputPanel component is updated with each ajax request automatically.
Skinning
style and styleClass attributes are used to style the outputPanel, by default .ui-outputpanel css class is added to element and .ui-outputpanel-loading when content is loading in deferred loading case.
334
PrimeFaces User Guide
3.81 OverlayPanel
OverlayPanel is a generic panel component that can be displayed on top of other content.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
overlayPanel org.primefaces.component.overlaypanel.OverlayPanelRenderer
org.primefaces.component.OverlayPanel
org.primefaces.component
org.primefaces.component.OverlayPanelRenderer
org.primefaces.component.overlaypanel.OverlayPanelRenderer
Attributes
Name
id rendered binding widgetVar style styleClass for showEvent null null null null click
Default
null true null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
String Name of the client side widget.
String
String
String
String
Inline style of the panel.
Style class of the panel.
Target component to display panel next to.
Event on target to show the panel.
335
Name
hideEvent showEffect hideEffect appendToBody onShow onHide my at dynamic dismissable showCloseIcon
PrimeFaces User Guide
Default
click null null
Type
String
String
String
Description
Event on target to hide the panel.
Animation to display when showing the panel.
Animation to display when hiding the panel.
0 null null left top
String
String left bottom String false true false
Boolean When true, panel is appended to document body.
String Client side callback to execute when panel is shown.
Boolean
Client side callback to execute when panel is hidden.
Position of the panel relative to the target.
Position of the target relative to the panel.
Defines content loading mode.
Boolean When set true, clicking outside of the panel hides the overlay.
Boolean Displays a close icon to hide the overlay, default is false.
Getting started with OverlayPanel
OverlayPanel needs a component as a target in addition to the content to display. Example below demonstrates an overlayPanel attached to a button to show a chart in a popup.
<p:commandButton id="chartBtn" value="Basic" type="button" />
<p:overlayPanel for="chartBtn">
<p:pieChart value="#{chartBean.pieModel}" legendPosition="w" title="Sample Pie Chart" style="width:400px;height:300px" />
</p:overlayPanel>
Events
Default event on target to show and hide the panel is mousedown. These are customized using
showEvent and hideEvent options.
<p:commandButton id="chartBtn" value="Basic" type="button" />
<p:overlayPanel showEvent="mouseover" hideEvent="mousedown">
//content
</p:overlayPanel>
Effects
blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size, slide are available values for showEffect and hideEffect options if you’d like display animations.
336
PrimeFaces User Guide
Positioning
By default, left top corner of panel is aligned to left bottom corner of the target if there is enough space in window viewport, if not the position is flipped on the fly to find the best location to display. In order to customize the position use my and at options that takes combinations of left, right, bottom and top e.g. “right bottom”.
Dynamic Mode
Dynamic mode enables lazy loading of the content, in this mode content of the panel is not rendered on page load and loaded just before panel is shown. Also content is cached so consecutive displays do not load the content again. This feature is useful to reduce the page size and reduce page load time.
Skinning
Panel resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-overlaypanel
Applies
Main container element of panel
As skinning style classes are global, see the main theming section for more information.
Tips
• Enable appendToBody when overlayPanel is in other panel components like layout, dialog ...
• If there is a component with a popup like calendar, autocomplete placed inside the overlay panel, popup part might exceed the boundaries of panel and clicking the outside hides the panel. This is undesirable so in cases like this use overlayPanel with dismissable false and optional
showCloseIcon settings.
337
PrimeFaces User Guide
3.82 Panel
Panel is a grouping component with content toggle, close and menu integration.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding header footer toggleable toggleSpeed collapsed style styleClass
panel org.primefaces.component.panel.Panel
org.primefaces.component.Panel
org.primefaces.component
org.primefaces.component.PanelRenderer
org.primefaces.component.panel.PanelRenderer
Default
null true
Type
String
Boolean null null null false
1000 false null null
Object
String
String
Boolean
Integer
Boolean
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Header text
Footer text
Makes panel toggleable.
Speed of toggling in milliseconds
Renders a toggleable panel as collapsed.
Style of the panel
Style class of the panel
338
Name
closable closeSpeed visible closeTitle toggleTitle menuTitle toggleOrientation widgetVar
Default
false
1000 true null null null vertical null
Type
Boolean
Integer
Boolean
String
String
String
String
String
PrimeFaces User Guide
Description
Make panel closable.
Speed of closing effect in milliseconds
Renders panel as visible.
Tooltip for the close button.
Tooltip for the toggle button.
Tooltip for the menu button.
Defines the orientation of the toggling, valid values are vertical and horizontal.
Name of the client side widget
Getting started with Panel
Panel encapsulates other components.
<p:panel>
//Child components here...
</p:panel>
Header and Footer
Header and Footer texts can be provided by header and footer attributes or the corresponding facets.
When same attribute and facet name are used, facet will be used.
<p:panel header="Header Text">
<f:facet name="footer">
<h:outputText value="Footer Text" />
</f:facet>
//Child components here...
</p:panel>
Ajax Behavior Events
Panel provides custom ajax behavior events for toggling and closing features.
Event
toggle close
Listener Parameter
org.primefaces.event.ToggleEvent
org.primefaces.event.CloseEvent
Fired
When panel is expanded or collapsed.
When panel is closed.
339
PrimeFaces User Guide
Popup Menu
Panel has built-in support to display a fully customizable popup menu, an icon to display the menu is placed at top-right corner. This feature is enabled by defining a menu component and defining it as the options facet.
<p:panel closable="true">
//Child components here...
<f:facet name="options">
<p:menu>
//Menuitems
</p:menu>
</f:facet>
</p:panel>
Custom Action
If you’d like to add custom actions to panel titlebar, use actions facet with icon markup;
<p:panel>
<f:facet name="actions">
<h:commandLink styleClass="ui-panel-titlebar-icon ui-corner-all ui-state-default">
</f:facet>
//content
</p:panel>
<h:outputText styleClass="ui-icon ui-icon-help" />
</h:commandLink>
Skinning Panel
Panel resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-panel
.ui-panel-titlebar
.ui-panel-title
.ui-panel-titlebar-icon
.ui-panel-content
.ui-panel-footer
Applies
Main container element of panel
Header container
Header text
Option icon in header
Panel content
Panel footer
As skinning style classes are global, see the main theming section for more information.
340
PrimeFaces User Guide
3.83 PanelGrid
PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
panelGrid org.primefaces.component.panelgrid.PanelGridRenderer
org.primefaces.component.PanelGrid
org.primefaces.component
org.primefaces.component.PanelGridRenderer
org.primefaces.component.panelgrid.PanelGridRenderer
Attributes
Name
id rendered binding columns
Default
null true null false
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
Integer
An el expression that maps to a server side
UIComponent instance in a backing bean
Number of columns in grid.
341
Name
style styleClass columnClasses layout
Default
null null null tabular
Type
String
String
String
String
PrimeFaces User Guide
Description
Inline style of the panel.
Style class of the panel.
Comma separated list of column style classes.
Displays data in a 'table' layout or 'grid' layout. The grid layout is a responsive layout.
Getting started with PanelGrid
Basic usage of panelGrid is same as the standard one.
<p:panelGrid columns="2">
<h:outputLabel for="firstname" value="Firstname:" />
<p:inputText id="firstname" value="#{bean.firstname}" label="Firstname" />
<h:outputLabel for="surname" value="Surname:" />
<p:inputText id="surname" value="#{bean.surname}" label="Surname"/>
</p:panelGrid>
Header and Footer
PanelGrid provides facets for header and footer content.
<p:panelGrid columns="2">
<f:facet name="header">
Basic PanelGrid
</f:facet>
<h:outputLabel for="firstname" value="Firstname: *" />
<p:inputText id="firstname" value="#{bean.firstname}" label="Firstname" />
<h:outputLabel for="surname" value="Surname: *" />
<p:inputText id="surname" value="#{bean.surname}" label="Surname"/>
<f:facet name="footer">
<p:commandButton type="button" value="Save" icon="ui-icon-check" />
</f:facet>
</p:panelGrid>
342
PrimeFaces User Guide
Rowspan and Colspan
PanelGrid supports rowspan and colspan options as well, in this case row and column markup should be defined manually.
<p:panelGrid>
<p:row>
<p:column rowspan="3">AAA</p:column>
<p:column colspan="4">BBB</p:column>
</p:row>
<p:row>
<p:column colspan="2">CCC</p:column>
<p:column colspan="2">DDD</p:column>
</p:row>
<p:row>
<p:column>EEE</p:column>
<p:column>FFF</p:column>
<p:column>GGG</p:column>
<p:column>HHH</p:column>
</p:row>
</p:panelGrid>
* Note that this approach does not support grid layout.
Skinning
PanelGrid resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-panelgrid
.ui-panelgrid-header
.ui-panelgrid-footer
.ui-panelgrid-even
.ui-panelgrid-odd
Applies
Main container element of panelGrid.
Header.
Footer.
Even numbered rows.
Odd numbered rows.
As skinning style classes are global, see the main theming section for more information.
343
3.84 PanelMenu
PanelMenu is a hybrid component of accordionPanel and tree components.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding model style styleClass widgetVar
panelMenu org.primefaces.component.panelmenu.PanelMenu
org.primefaces.component.PanelMenu
org.primefaces.component
org.primefaces.component.PanelMenuRenderer
org.primefaces.component.panelmenu.PanelMenuRenderer
null null null null
Default
null true null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
MenuModel MenuModel instance to build menu dynamically.
String Inline style of the component.
String Style class of the component.
String Name of the client side widget.
344
PrimeFaces User Guide
Getting started with PanelMenu
PanelMenu consists of submenus and menuitems. First level of submenus are rendered as accordion panels and descendant submenus are rendered as tree nodes. Just like in any other menu component, menuitems can be utilized to do ajax requests, non-ajax requests and simple GET navigations.
<p:panelMenu style="width:200px">
<p:submenu label="Ajax Menuitems">
<p:menuitem value="Save" actionListener="#{buttonBean.save}" />
<p:menuitem value="Update" actionListener="#{buttonBean.update}" />
</p:submenu>
<p:submenu label="Non-Ajax Menuitem">
<p:menuitem value="Delete" actionListener="#{buttonBean.delete}" ajax="false"/>
</p:submenu>
<p:submenu label="Navigations" >
<p:submenu label="Links" icon="ui-icon-extlink">
<p:submenu label="PrimeFaces" icon="ui-icon-heart">
<p:menuitem value="Home" url="http://www.primefaces.org" />
<p:menuitem value="Docs" url="http://www.primefaces.org/..." />
<p:menuitem value="Support" url="http://www.primefaces.org/..." />
</p:submenu>
</p:submenu>
<p:menuitem value="Mobile" outcome="/mobile/index" />
</p:submenu>
</p:panelMenu>
Skinning
PanelMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Applies Style Class
.ui-panelmenu
.ui-panelmenu-header
.ui-panelmenu-content
.ui-panelmenu .ui-menu-list
.ui-panelmenu .ui-menuitem
Main container element.
Header of a panel.
Footer of a panel.
Tree container.
A menuitem in tree.
As skinning style classes are global, see the main theming section for more information.
345
PrimeFaces User Guide
3.85 Password
Password component is an extended version of standard inputSecret component with theme integration and strength indicator.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
password org.primefaces.component.password.Password
org.primefaces.component.Password
org.primefaces.component
org.primefaces.component.PasswordRenderer
org.primefaces.component.password.PasswordRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null false false null
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
Object
An el expression that maps to a server side UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
Converter
/String
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean When set true, process validations logic is executed at apply request values phase for this component.
boolean Marks component as required
Method
Expr
A method expression that refers to a method validationg the input.
346
PrimeFaces User Guide weakLabel goodLabel strongLabel redisplay match
Name
requiredMessage converterMessage validatorMessage feedback inline promptLabel
Default
valueChangeListener null null null null false false
Please enter a password
Weak
Good
Strong false null
Type
Method
Expr
String
Description
A method binding expression that refers to a method for handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
String
String Message to be displayed when validation fields.
Boolean Enables strength indicator.
boolean Displays feedback inline rather than using a popup.
String Label of prompt.
String
String
String
Label of weak password.
Label of good password.
Label of strong password.
Boolean Whether or not to display previous value.
String Id of another password component to match value against.
widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick null null null null null false null null null null null null
String
String
String
String
Name of the client side widget.
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
String
String
String
Boolean Disables input field
String A localized user presentable name.
String Code describing the language used in the generated markup for this component.
Integer
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Maximum number of characters that may be entered in this field.
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
String Client side callback to execute when input element is clicked.
347
Name
ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title
PrimeFaces User Guide null null null null
Default
null null null null null null null null null null null null false null
Type
String
String
String
String
String
String
String
String
Description
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
String
String
String
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
String Specifies a short hint.
Boolean Flag indicating that this component will prevent changes by the user.
Integer
String
Number of characters used to determine the width of the input element.
Inline style of the input element.
String
Integer
String
Style class of the input element.
Position of the input element in the tabbing order.
Advisory tooltip informaton.
Getting Started with Password
Password is an input component and used just like a standard input text. When feedback option is enabled a password strength indicator is displayed.
<p:password value="#{bean.password}" feedback="true|false" />
348
PrimeFaces User Guide public class Bean { private String password; public String getPassword() { return password; } public void setPassword(String password) { this.password = password;}
}
I18N
Although all labels are in English by default, you can provide custom labels as well. Following password gives feedback in Turkish.
<p:password value="#{bean.password}" promptLabel="Lütfen şifre giriniz" weakLabel="Zayıf" goodLabel="Orta seviye" strongLabel="Güçlü" feedback= "true"/>
Inline Strength Indicator
By default strength indicator is shown in an overlay, if you prefer an inline indicator just enable inline mode.
<p:password value="#{mybean.password}" inline="true" feedback= "true"/>
Confirmation
Password confirmation is a common case and password provides an easy way to implement. The other password component’s id should be used to define the match option.
<p:password id="pwd1" value="#{passwordBean.password6}" feedback="false" match="pwd2" label="Password 1" required="true"/>
<p:password id="pwd2" value="#{passwordBean.password6}" feedback="false" label="Password 2" required="true"/>
Skinning
Structural selectors for password are;
Name
.ui-password
.ui-password-panel
.ui-password-meter
.ui-password-info
Applies
Input element.
Overlay panel of strength indicator.
Strength meter.
Strength label.
As skinning style classes are global, see the main theming section for more information.
349
PrimeFaces User Guide
3.86 PhotoCam
PhotoCam is used to take photos with webcam and send them to the JSF backend model.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
photoCam org.primefaces.component.photocam.PhotoCam
org.primefaces.component.PhotoCam
org.primefaces.component
org.primefaces.component.PhotoCamRenderer
org.primefaces.component.photocam.PhotoCamRenderer
Attributes
id rendered binding value converter immediate required
Name
validator
Default
null false null null null
0 valueChangeListener null requiredMessage converterMessage validatorMessage
0 null null null null
Type
String
Boolean
Object
Object
Converter/
String
Boolean boolean
Method
Expr
Method
Expr
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
A method binding expression that refers to a method validationg the input
A method binding expression that refers to a method for handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
350
Name
widgetVar style styleClass process update listener null null null
Default
null null null
Type
String
String
String
String
String
Method
Expr
PrimeFaces User Guide
Description
Name of the client side widget.
Inline style of the component.
Style class of the component.
Identifiers of components to process during capture.
Identifiers of components to update during capture.
Method expression to listen to capture events.
Getting started with PhotoCam
Capture is triggered via client side api’s capture method. Also a method expression is necessary to invoke when an image is captured. Sample below captures an image and saves it to a directory.
<h:form>
<p:photoCam widgetVar="pc" listener="#{photoCamBean.oncapture}"update="photos"/>
<p:commandButton type="button" value="Capture" onclick="PF('pc').capture()"/>
</h:form> public class PhotoCamBean {
public void oncapture(CaptureEvent captureEvent) {
byte[] data = captureEvent.getData();
ServletContext servletContext = (ServletContext)
FacesContext.getCurrentInstance().getExternalContext().getContext();
String newFileName = servletContext.getRealPath("") + File.separator +
"photocam" + File.separator + "captured.png";
FileImageOutputStream imageOutput; try { imageOutput = new FileImageOutputStream(new File(newFileName)); imageOutput.write(data, 0, data.length); imageOutput.close();
}
catch(Exception e) { throw new FacesException("Error in writing captured image.");
}
}
}
Notes
• PhotoCam is a flash, canvas and javascript solution.
• It is not supported in IE at the moment and this will be worked on in future versions.
351
3.87 PickList
PickList is used for transferring data between two different collections.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding value converter immediate required validator
pickList org.primefaces.component.picklist.Panel
org.primefaces.component.PickList
org.primefaces.component
org.primefaces.component.PickListRenderer
org.primefaces.component.picklist.PickListRenderer
Default
null true null null null false false null
Type
String
Boolean
Object
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
Converter/
String
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean
Boolean
Method
Expr
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
A method binding expression that refers to a method validationg the input
352
converterMessage validatorMessage var itemLabel itemValue style styleClass widgetVar disabled effect effectSpeed addLabel addAllLabel removeLabel removeAllLabel moveUpLabel moveTopLabel moveDownLabel moveButtomLabel
Name
valueChangeListener requiredMessage showSourceControls showTargetControls onTransfer label itemDisabled showSourceFilter showTargetFilter
Default
null null null false false false
Type
Method
Expr
String
Message to be displayed when validation fields.
Name of the iterator.
Label of an item.
Value of an item.
Style of the main container.
Style class of the main container.
Name of the client side widget.
Disables the component.
Name of the animation to display.
Speed of the animation.
Title of add button.
Title of add all button.
Title of remove button.
Title of remove all button.
Title of move up button.
Title of move top button.
Title of move down button.
Title of move bottom button.
PrimeFaces User Guide
Description
A method binding expression that refers to a method for handling a valuchangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
null null null null null null null null false null null
Add
Add All
Boolean
String
String
String
String
Remove String
Remove All String
Move Up String
Move Top String
Move Down String
String Move
Buttom false false null
String
String
String
String
String
String
String
Object
String
String
String
String
Boolean
Boolean
Boolean
Specifies visibility of reorder buttons of source list.
Specifies visibility of reorder buttons of target list.
Client side callback to execute when an item is transferred from one list to another.
A localized user presentable name.
Specified if an item can be picked or not.
Displays and input filter for source list.
Displays and input filter for target list.
353
Name
filterMatchMode filterFunction showCheckbox labelDisplay
Default
startsWith null false tooltip
Type
String
String
Boolean
String
PrimeFaces User Guide
Description
Match mode for filtering, valid values are startsWith, contains, endsWith and custom.
Name of the javascript function for custom filtering.
When true, a checkbox is displayed next to each item.
Defines how the button labels displayed, valid values are "tooltip" (default) and "inline".
Getting started with PickList
You need to create custom model called org.primefaces.model.DualListModel to use PickList. As the name suggests it consists of two lists, one is the source list and the other is the target. As the first example we’ll create a DualListModel that contains basic Strings.
public class PickListBean { private DualListModel<String> cities; public PickListBean() {
List<String> source = new ArrayList<String>();
List<String> target = new ArrayList<String>(); citiesSource.add("Istanbul"); citiesSource.add("Ankara"); citiesSource.add("Izmir"); citiesSource.add("Antalya"); citiesSource.add("Bursa");
//more cities cities = new DualListModel<String>(citiesSource, citiesTarget);
} public DualListModel<String> getCities() { return cities;
} public void setCities(DualListModel<String> cities) { this.cities = cities;
}
}
And bind the cities dual list to the picklist;
<p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}">
When the enclosed form is submitted, the dual list reference is populated with the new values and you can access these values with DualListModel.getSource() and DualListModel.getTarget() api.
354
PrimeFaces User Guide
POJOs
Most of the time you would deal with complex pojos rather than simple types like String.
This use case is no different except the addition of a converter. Following pickList displays a list of players(name, age ...).
<p:pickList value="#{pickListBean.players}" var="player" itemLabel="#{player.name}" itemValue="#{player}" converter="player">
PlayerConverter in this case should implement javax.faces.convert.Converter contract and implement getAsString, getAsObject methods. Note that a converter is always necessary for primitive types like long, integer, boolean as well.
In addition custom content instead of simple strings can be displayed by using columns.
<p:pickList value="#{pickListBean.players}"
var="player" iconOnly="true" effect="bounce"
itemValue="#{player}" converter="player"
showSourceControls="true" showTargetControls="true">
<p:column style="width:25%">
<p:graphicImage value="/images/barca/#{player.photo}"/>
</p:column>
<p:column style="width:75%";>
#{player.name} - #{player.number}
</p:column>
</p:pickList>
Reordering
PickList support reordering of source and target lists, these are enabled by showSourceControls and
showTargetControls options.
Effects
An animation is displayed when transferring when item to another or reordering a list, default effect is fade and following options are available to be applied using effect attribute; blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size and slide. effectSpeed attribute is used to customize the animation speed, valid values are slow, normal and fast.
Captions
Caption texts for lists are defined with facets named sourceCaption and targetCaption;
<p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" onTransfer="handleTransfer(e)">
<f:facet name="sourceCaption">Available</f:facet>
<f:facet name="targetCaption">Selected</f:facet>
</p:pickList>
Filtering
PickList provides built-in client side filtering. Filtering is enabled by setting the corresponding filtering attribute of a list. For source list this is showSourceFilter and for target list it is
showTargetFilter. Default match mode is startsWith and contains, endsWith are also available options.
355
PrimeFaces User Guide
When you need to a custom match mode set filterMatchMode to custom and write a javascript function that takes itemLabel and filterValue as parameters. Return false to hide an item and true to display.
<p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" showSourceFilter="true" showTargetFilter="true" filterMatchMode="custom" filterFunction="myfilter">
</p:pickList> function myfilter(itemLabel, filterValue) {
//return true or false
}
onTransfer
If you’d like to execute custom javascript when an item is transferred, bind your javascript function to onTransfer attribute.
<p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" onTransfer="handleTransfer(e)">
<script type="text/javascript"> function handleTransfer(e) {
//item = e.item
//fromList = e.from
//toList = e.toList
//type = e.type (type of transfer; command, dblclick or dragdrop)
}
</script>
Ajax Behavior Events
PickList provides transfer as the default and only ajax behavior event that is fired when an item is moved from one list to the other. Example below demonstrates how to use this event.
<p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}">
<p:ajax event="transfer" listener="#{pickListBean.handleTransfer}" />
</p:pickList>
356
public class PickListBean {
//DualListModel code public void handleTransfer(TransferEvent event) {
//event.getItems() : List of items transferred
//event.isAdd() : Is transfer from source to target
//event.isRemove() : Is transfer from target to source
}
}
PrimeFaces User Guide
Skinning
PickList resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-picklist
.ui-picklist-list
.ui-picklist-list-source
.ui-picklist-list-target
.ui-picklist-source-controls
.ui-picklist-target-controls
.ui-picklist-button
.ui-picklist-button-move-up
.ui-picklist-button-move-top
.ui-picklist-button-move-down
.ui-picklist-button-move-bottom
.ui-picklist-button-add
.ui-picklist-button-add-all
.ui-picklist-button-remove-all
.ui-picklist-button-add
Applies
Main container element(table) of picklist
Lists of a picklist
Source list
Target list
Container element of source list reordering controls
Container element of target list reordering controls
Buttons of a picklist
Move up button
Move top button
Move down button
Move bottom button
Add button
Add all button
Remove all button
Add button
As skinning style classes are global, see the main theming section for more information.
357
Attributes
Name
id rendered binding widgetVar interval update listener immediate
3.88 Poll
Poll is an ajax component that has the ability to send periodical ajax requests.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
poll org.primefaces.component.poll.Poll
org.primefaces.component.Poll
org.primefaces.component
org.primefaces.component.PollRenderer
org.primefaces.component.poll.PollRenderer
PrimeFaces User Guide async process onstart oncomplete onsuccess onerror null
2 null null false
Default
null true null false null null
Type
String
Boolean
Object
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean.
Name of the client side widget.
String
Integer
String
MethodExpr A method expression to invoke by polling.
Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
Boolean When set to true, ajax requests are not queued.
String
String
Interval in seconds to do periodic ajax requests.
Component(s) to be updated with ajax.
Component id(s) to process partially instead of whole view.
Javascript handler to execute before ajax request is begins.
null null null
String
String
String
Javascript handler to execute when ajax request is completed.
Javascript handler to execute when ajax request succeeds.
Javascript handler to execute when ajax request fails.
358
global delay
Name
timeout
Default
true
Type
Boolean null partialSubmit autoStart stop resetValues false ignoreAutoUpdate false true false false
0
String
Boolean
Boolean
Boolean
Boolean
Boolean
Integer
PrimeFaces User Guide
Description
Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Enables serialization of values belonging to the partially processed components only.
In autoStart mode, polling starts automatically on page load, to start polling on demand set to false.
Stops polling when true.
If true, local values of input components to be updated within the ajax request would be reset.
If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Timeout for the ajax request in milliseconds.
Getting started with Poll
Poll below invokes increment method on CounterBean every 2 seconds and txt_count is updated with the new value of the count variable. Note that poll must be nested inside a form.
<h:outputText id="txt_count" value="#{counterBean.count}" />
<p:poll listener="#{counterBean.increment}" update="txt_count" /> public class CounterBean { private int count; public void increment() { count++;
} public int getCount() { return this.count;
} public void setCount(int count) { this.count = count;
}
}
359
PrimeFaces User Guide
Tuning timing
By default the periodic interval is 2 seconds, this is changed with the interval attribute. Following poll works every 5 seconds.
<h:outputText id="txt_count" value="#{counterBean.count}" />
<p:poll listener="#{counterBean.increment}" update="txt_count" interval="5" />
Start and Stop
Poll can be started and stopped using client side api;
<h:form>
<h:outputText id="txt_count" value="#{counterBean.count}" />
<p:poll interval="5" actionListener="#{counterBean.increment}" update="txt_count" widgetVar="myPoll" autoStart="false" />
<a href="#" onclick="PF('myPoll').start();">Start</a>
<a href="#" onclick="PF('myPoll').stop();">Stop</a>
</h:form>
Or bind a boolean variable to the stop attribute and set it to false at any arbitrary time.
360
PrimeFaces User Guide
3.89 Printer
Printer allows sending a specific JSF component to the printer, not the whole page.
Info
Tag
Behavior Class
printer org.primefaces.component.behavior.Printer
Attributes
Name
id rendered binding target
Default
null true
Type
String
Boolean null null
Object
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Target component to print.
Getting started with the Printer
Printer is attached to any command component like a button or a link. Examples below demonstrates how to print a simple output text or a particular image on page;
<h:commandButton id="btn" value="Print">
<p:printer target="output" />
</h:commandButton>
<h:outputText id="output" value="PrimeFaces Rocks!" />
<h:outputLink id="lnk" value="#">
<p:printer target="image" />
<h:outputText value="Print Image" />
</h:outputLink>
<p:graphicImage id="image" value="/images/nature1.jpg" />
361
PrimeFaces User Guide
3.90 ProgressBar
ProgressBar is a process status indicator that can either work purely on client side or interact with server side using ajax.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding widgetVar value disabled ajax interval
propressBar org.primefaces.component.progressbar.ProgressBar
org.primefaces.component.Progressbar
org.primefaces.component
org.primefaces.component.ProgressBarRenderer
org.primefaces.component.progressbar.ProgressBarRenderer
Default
null true
Type
String
Boolean null null
0 false false
3000
Object
String
Integer
Boolean
Boolean
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget
Value of the progress bar
Disables or enables the progressbar
Specifies the mode of progressBar, in ajax mode progress value is retrieved from a backing bean.
Interval in seconds to do periodic requests in ajax mode.
362
Name
style styleClass labelTemplate displayOnly global
Default
null null
{value} false true
Type
String
String
String
Boolean
Boolean
PrimeFaces User Guide
Description
Inline style of the main container element.
Style class of the main container element.
Template of the progress label.
Enables static display mode.
Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
Getting started with the ProgressBar
ProgressBar has two modes, "client"(default) or "ajax". Following is a pure client side progressBar.
<p:progressBar widgetVar="pb" />
<p:commandButton value="Start" type="button" onclick="start()" />
<p:commandButton value="Cancel" type="button" onclick="cancel()" />
<script type="text/javascript"> function start() { this.progressInterval = setInterval(function(){
PF('pb').setValue(PF('pb').getValue() + 10);
}, 2000);
} function cancel() { clearInterval(this.progressInterval);
PF('pb').setValue(0);
}
</script>
Ajax Progress
Ajax mode is enabled by setting ajax attribute to true, in this case the value defined on a managed bean is retrieved periodically and used to update the progress.
<p:progressBar ajax="true" value="#{progressBean.progress}" /> public class ProgressBean { private int progress;
//getter-setter
}
363
PrimeFaces User Guide
Interval
ProgressBar is based on polling and 3000 milliseconds is the default interval for ajax progress bar meaning every 3 seconds progress value will be recalculated. In order to set a different value, use the interval attribute.
<p:progressBar interval="5000" />
Ajax Behavior Events
ProgressBar provides complete as the default and only ajax behavior event that is fired when the progress is completed. Example below demonstrates how to use this event.
public class ProgressBean { private int progress; public void handleComplete() {
//Add a faces message
} public int getProgress() { return progress;
} public void setProgress(int progress) { this.progress = progress;
}
}
<p:progressBar value="#{progressBean.progress}" ajax="true">
<p:ajax event="complete" listener="#{progressBean.handleComplete}" update="messages" />
</p:progressBar>
<p:growl id="messages" />
Display Only
Assume you have a process like a ticket purchase that spans various pages where each page has different use cases such as customer info, seat selection, billing, payment and more. In order to display static value of the process on each page, you can use a static progressBar.
<p:progressBar value="50" displayOnly="true" />
Client Side API
Widget: PrimeFaces.widget.ProgressBar
Method
getValue()
Params
-
Return Type
Number
Description
Returns current value
364
Method
setValue(value) start() cancel()
Params
value: Value to display
-
-
PrimeFaces User Guide
Return Type
void void void
Description
Sets current value
Starts ajax progress bar
Stops ajax progress bar
Skinning
ProgressBar resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
.ui-progressbar
Style Class
.ui-progressbar-value
.ui-progressbar-label
Main container.
Value of the progressbar
Progress label.
Applies
As skinning style classes are global, see the main theming section for more information.
365
PrimeFaces User Guide
3.91 RadioButton
RadioButton is a helper component of SelectOneRadio to implement custom layouts.
Info
Tag
radioButton
Component Class
org.primefaces.component.radiobutton.RadioButton
Component Type
org.primefaces.component.RadioButton
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.RadioButtonRenderer
org.primefaces.component.radiobutton.RadioButtonRenderer
Attributes
Name
id rendered binding disabled itemIndex onchange for style styleClass tabindex null null null null null false null null
Default
null true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
Boolean Disabled the component.
Integer
String
Index of the selectItem of selectOneRadio.
Client side callback to execute on state change.
String
String
String
String
Id of the selectOneRadio to attach to.
Inline style of the component.
Style class of the container.
Specifies the tab order of element in tab navigation.
Getting started with RadioButton
See custom layout part in SelectOneRadio section for more information.
366
PrimeFaces User Guide
3.92 Rating
Rating component features a star based rating system.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
rating org.primefaces.component.rating.Rating
org.primefaces.component.Rating
org.primefaces.component
org.primefaces.component.RatingRenderer
org.primefaces.component.rating.RatingRenderer
Attributes
id rendered
Name
binding value converter immediate null null null
Default
null true
0
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed, when true the events will be fired at "apply request values", if immediate is set to false, valueChange
Events are fired in "process validations" phase
367
required validator
Name
valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stars disabled readonly onRate style styleClass cancel
PrimeFaces User Guide null null null true null null null
5 false false
Default
false null null null
Type
Boolean
MethodExpr A method binding expression that refers to a method validationg the input
MethodExpr A method binding expression that refers to a method for handling a valuchangeevent
String
Description
Marks component as required
String
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
String
String
Integer
Boolean
Boolean
Message to be displayed when validation fields.
Name of the client side widget.
Number of stars to display
Disables user interaction
Disables user interaction without disabled visuals.
String
String
String
Boolean
Client side callback to execute when rate happens.
Inline style of the component.
Style class of the component.
When enabled, displays a cancel icon to reset.
Getting Started with Rating
Rating is an input component that takes a double variable as it’s value.
public class RatingBean { private Integer rating;
//getter-setter
}
<p:rating value="#{ratingBean.rating}" />
Number of Stars
Default number of stars is 5, if you need less or more stars use the stars attribute. Following rating consists of 10 stars.
<p:rating value="#{ratingBean.rating}" stars="10"/>
368
PrimeFaces User Guide
Display Value Only
In cases where you only want to use the rating component to display the rating value and disallow user interaction, set readonly to true. Using disabled attribute does the same but adds disabled visual styles.
Ajax Behavior Events
Rating provides rate and cancel as ajax behavior events. A defined listener for rate event will be executed by passing an org.primefaces.event.RateEvent as a parameter and cancel event will be invoked with no parameter.
<p:rating value="#{ratingBean.rating}">
<p:ajax event="rate" listener="#{ratingBean.handleRate}" update="msgs" />
<p:ajax event="cancel" listener="#{ratingBean.handleCancel}" update="msgs" />
</p:rating>
<p:messages id="msgs" /> public class RatingBean { private Integer rating; public void handleRate(RateEvent rateEvent) {
Integer rate = (Integer) rateEvent.getRating();
//Add facesmessage
} public void handleCancel() {
//Add facesmessage
}
//getter-setter
}
Client Side Callbacks
onRate is called when a star is selected with value as the only parameter.
<p:rating value="#{ratingBean.rating}" onRate="alert('You rated: ' + value)" />
Client Side API
Widget: PrimeFaces.widget.Rating
Method
getValue()
Params
setValue(value) value: Value to set disable() enable() reset() -
-
Return Type
Number void void void void
369
Description
Returns the current value
Updates rating value with provided one.
Disables component.
Enables component.
Clears the rating.
PrimeFaces User Guide
Skinning
Rating resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-rating
.ui-rating-cancel
.ui-rating
.ui-rating-on
Main container element.
Cancel icon
Default star
Active star
Applies
370
Attributes
Name
id rendered binding action actionListener immediate
PrimeFaces User Guide
3.93 RemoteCommand
RemoteCommand provides a way to execute backing bean methods directly from javascript.
Info
Tag
Component Class
remoteCommand org.primefaces.component.remotecommand.RemoteCommand
Component Type
org.primefaces.component.RemoteCommand
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.RemoteCommandRenderer
org.primefaces.component.remotecommand.RemoteCommandRenderer
name async process update onstart oncomplete onsuccess onerror null false null null null null
Default
null true null null null false null null
Type
String
Description
Unique identifier of the component.
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side UIComponent instance in a backing bean
Method
Expr
A method expression that’d be processed in the partial request caused by uiajax.
Method
Expr
An actionlistener that’d be processed in the partial request caused by uiajax.
Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
String Name of the command
Boolean When set to true, ajax requests are not queued.
String Component(s) to process partially instead of whole view.
String
String
String
Component(s) to update with ajax.
Javascript handler to execute before ajax request is begins.
String
String
Javascript handler to execute when ajax request is completed.
Javascript handler to execute when ajax request succeeds.
Javascript handler to execute when ajax request fails.
371
PrimeFaces User Guide global delay
Name
partialSubmit autoRun resetValues ignoreAutoUpdate timeout
Default
true null false false false false
0
Type Description
Boolean Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.
String If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Boolean Enables serialization of values belonging to the partially processed components only.
Boolean When enabled command is executed on page load.
Boolean If true, local values of input components to be updated within the ajax request would be reset.
Boolean If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Integer Timeout for the ajax request in milliseconds.
Getting started with RemoteCommand
RemoteCommand is used by invoking the command from your javascript code.
<p:remoteCommand name="increment" actionListener="#{counter.increment}" out="count" />
<h:outputText id="count" value="#{counter.count}" />
<script type="text/javascript"> function customfunction() {
//your custom code increment(); //makes a remote call
}
</script>
That’s it whenever you execute your custom javascript function(eg customfunction()), a remote call will be made, actionListener is processed and output text is updated. Note that remoteCommand must be nested inside a form.
Passing Parameters
Remote command can send dynamic parameters in the following way; increment([{name:'x', value:10}, {name:'y', value:20}]);
372
PrimeFaces User Guide
3.94 ResetInput
Input components keep their local values at state when validation fails. ResetInput is used to clear the cached values from state so that components retrieve their values from the backing bean model instead.
Info
Tag
resetInput
ActionListener Class
org.primefaces.component.resetinput.ResetInputActionListener
Attributes
target
Name Default
null String
Type Description
Comma or white space separated list of component identifiers.
Getting started with ResetInput
ResetInput is attached to action source components like commandButton and commandLink.
<h:form id="form">
<p:panel id="panel" header="New User" style="margin-bottom:10px;">
<p:messages id="messages" />
<h:panelGrid columns="2">
<h:outputLabel for="firstname" value="Firstname: *" />
<p:inputText id="firstname" value="#{pprBean.firstname}" required="true" label="Firstname">
<f:validateLength minimum="2" />
</p:inputText>
<h:outputLabel for="surname" value="Surname: *" />
<p:inputText id="surname" value="#{pprBean.surname}" required="true" label="Surname"/>
</h:panelGrid>
</p:panel>
<p:commandButton value="Submit" update="panel" actionListener="#{pprBean.savePerson}" />
<p:commandButton value="Reset Tag" update="panel" process="@this">
<p:resetInput target="panel" />
</p:commandButton>
<p:commandButton value="Reset Non-Ajax" actionListener="#{pprBean.reset}" immediate="true" ajax="false">
<p:resetInput target="panel" />
</p:commandButton>
</h:form>
ResetInput supports both ajax and non-ajax actions, for non-ajax actions set immediate true on the source component so lifecycle jumps to render response after resetting. To reset multiple
373
PrimeFaces User Guide components at once, provide a list of ids or just provide an ancestor component like the panel in sample above.
Reset Programmatically
ResetInput tag is the declarative way to reset input components, another way is resetting programmatically. This is also handy if inputs should get reset based on a condition. Following sample demonstrates how to use RequestContext to do the reset within an ajaxbehavior listener.
Parameter of the reset method can be a single clientId or a collection of clientIds.
<p:inputText value="#{bean.value}">
<p:ajax event="blur" listener="#{bean.listener}" />
</p:inputText> public void listener() {
RequestContext context = RequestContext.getCurrentInstance(); context.reset("form:panel");
}
Tip
p:ajax has built-in resetValues attribute to reset values of processed components during a request.
374
PrimeFaces User Guide
3.95 Resizable
Resizable component is used to make another JSF component resizable.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
resizable org.primefaces.component.resizable.Resizable
org.primefaces.component.Resizable
org.primefaces.component
org.primefaces.component.ResizableRenderer
org.primefaces.component.resizable.ResizableRenderer
Attributes
Name
id rendered binding widgetVar for aspectRatio proxy handles ghost null null null false false null false animate effect false swing
Boolean
String effectDuration normal String maxWidth null Integer maxHeight minWidth minHeight null
10
10
Integer
Integer
Integer
Object
String
String
Boolean
Boolean
String
Boolean
Default
null true
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Name of the client side widget.
Identifier of the target component to make resizable.
Defines if aspectRatio should be kept or not.
Displays proxy element instead of actual element.
Specifies the resize handles.
In ghost mode, resize helper is displayed as the original element with less opacity.
Enables animation.
Effect to use in animation.
Effect duration of animation.
Maximum width boundary in pixels.
Maximum height boundary in pixels.
Minimum width boundary in pixels.
Maximum height boundary in pixels.
375
Name
containment grid onStart onResize onStop
Default
false
1 null null null
Type
Boolean
Integer
String
String
String
PrimeFaces User Guide
Description
Sets resizable boundaries as the parents size.
Snaps resizing to grid structure.
Client side callback to execute when resizing begins.
Client side callback to execute during resizing.
Client side callback to execute after resizing end.
Getting started with Resizable
Resizable is used by setting for option as the identifier of the target.
<p:graphicImage id="img" value="campnou.jpg" />
<p:resizable for="img" />
Another example is the input fields, if users need more space for a textarea, make it resizable by;
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" />
Boundaries
To prevent overlapping with other elements on page, boundaries need to be specified. There’re 4 attributes for this minWidth, maxWidth, minHeight and maxHeight. The valid values for these attributes are numbers in terms of pixels.
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" minWidth="20" minHeight="40" maxWidth="50" maxHeight="100"/>
Handles
Resize handles to display are customize using handles attribute with a combination of n, e, s, w, ne,
se, sw and nw as the value. Default value is "e, s, se".
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" handles="e,w,n,se,sw,ne,nw"/>
Visual Feedback
Resize helper is the element used to provide visual feedback during resizing. By default actual element itself is the helper and two options are available to customize the way feedback is provided.
Enabling ghost option displays the element itself with a lower opacity, in addition enabling proxy option adds a css class called .ui-resizable-proxy which you can override to customize.
376
PrimeFaces User Guide
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" proxy="true" />
.ui-resizable-proxy { border: 2px dotted #00F;
}
Effects
Resizing can be animated using animate option and setting an effect name. Animation speed is customized using effectDuration option "slow", "normal" and "fast" as valid values.
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" animate="true" effect="swing" effectDuration="normal" />
Following is the list of available effect names;
• swing
• easeInQuad
• easeOutQuad
• easeInOutQuad
• easeInCubic
• easeOutCubic
• easeInOutCubic
• easeInQuart
• easeOutQuart
• easeInOutQuart
• easeInQuint
• easeOutQuint
• easeInOutQuint
• easeInSine
• easeOutSine
• easeInExpo
• easeOutExpo
• easeInOutExpo
• easeInCirc
• easeOutCirc
• easeInOutCirc
• easeInElastic
• easeOutElastic
• easeInOutElastic
• easeInBack
• easeOutBack
• easeInOutBack
• easeInBounce
• easeOutBounce
• easeInOutBounce
Ajax Behavior Events
Resizable provides default and only resize event that is called on resize end. In case you have a listener defined, it will be called by passing an org.primefaces.event.ResizeEvent instance as a parameter.
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area">
<p:ajax listener="#{resizeBean.handleResize}">
</p:resizable> public class ResizeBean { public void handleResize(ResizeEvent event) { int width = event.getWidth(); int height = event.getHeight();
}
}
377
PrimeFaces User Guide
Client Side Callbacks
Resizable has three client side callbacks you can use to hook-in your javascript; onStart, onResize and onStop. All of these callbacks receive two parameters that provide various information about resize event.
<h:inputTextarea id="area" value="Resize me if you need more space" />
<p:resizable for="area" onStop="handleStop(event, ui)" /> function handleStop(event, ui) {
//ui.helper = helper element as a jQuery object
//ui.originalPosition = top, left position before resizing
//ui.originalSize = width, height before resizing
//ui.positon = top, left after resizing
//ui.size = width height of current size
}
Skinning
Style Class
.ui-resizable
.ui-resizable-handle
.ui-resizable-handle-{handlekey}
.ui-resizable-proxy
Applies
Element that is resizable
Handle element
Particular handle element identified by handlekey like e, s, ne
Proxy helper element for visual feedback
378
PrimeFaces User Guide
3.96 Ribbon
Ribbon is container component to group different sets of controls in a tabbed layout. Special styling is applied to inner components for a unified look.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
ribbon org.primefaces.component.ribbon.Ribbon
org.primefaces.component.Ribbon
org.primefaces.component
org.primefaces.component.RibbonRenderer
org.primefaces.component.ribbon.RibbonRenderer
Attributes
Name
id rendered binding null widgetVar style styleClass activeIndex 0 null null null
Default
null true
String
Boolean
Type
Object
String
String
String
Integer
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Inline style of the container element.
Style class of the container element.
Index of the active tab.
Getting started with Ribbon
Tab and RibbonGroup components are used when building the Ribbon.
379
PrimeFaces User Guide
<p:ribbon>
<p:tab title="File">
<p:ribbonGroup label="Options">
<p:commandButton value="New" icon="ui-ribbonicon-new" styleClass="ui-ribbon-bigbutton" type="button"/>
<p:commandButton value="Save" icon="ui-ribbonicon-save" styleClass="ui-ribbon-bigbutton" type="button"/>
</p:ribbonGroup>
<p:ribbonGroup label="Clipboard" style="width:120px">
<p:selectManyButton>
<p:commandButton value="Paste" icon="ui-ribbonicon-paste" styleClass="ui-ribbon-bigbutton" type="button"/>
<p:commandButton value="Cut" icon="ui-ribbonicon-cut" style="width:64px" type="button"/>
<p:commandButton value="Print" icon="ui-ribbonicon-print" style="width:64px" type="button"/>
</p:selectManyButton>
</p:ribbonGroup>
<p:ribbonGroup label="Fonts" style="width:220px">
<p:selectOneMenu appendTo="@this">
<f:selectItem itemLabel="Arial" itemValue="0" />
<f:selectItem itemLabel="Comis Sans" itemValue="1" />
<f:selectItem itemLabel="Helvetica" itemValue="2" />
<f:selectItem itemLabel="Times New Roman" itemValue="3" />
<f:selectItem itemLabel="Verdana" itemValue="4" />
</p:selectOneMenu>
<p:colorPicker />
</p:ribbonGroup>
</p:tab>
<p:tab title="View">
<p:ribbonGroup label="Zoom">
<p:commandButton value="In" icon="ui-ribbonicon-zoomin" styleClass="ui-ribbon-bigbutton" type="button" />
<p:commandButton value="Out" icon="ui-ribbonicon-zoomout" styleClass="ui-ribbon-bigbutton" type="button"/>
</p:ribbonGroup>
</p:tab>
</p:ribbon>
Styling
Following components have special styling applied inside ribbon;
• Button
• CommandButton
• SelectOneButton
• SelectManyButton
• SelectOneMenu
• InputText
Default PrimeFaces icons are 16px, in case you need bigger icons add ui-ribbon-bigbutton style class to the button.
380
PrimeFaces User Guide
Skinning
Ribbon resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes.
Style Class
.ui-ribbon
.ui-ribbon-groups
.ui-ribbon-group
.ui-ribbon-group-content
.ui-ribbon-group-label
Applies
Main container element.
Container of ribbon groups in a tab.
Ribbon group element.
Content of a group.
Label of a group.
Ribbon shares the same structure with TabView for the tabbing functionality, refer to TabView for the styles of the Tabs.
381
PrimeFaces User Guide
3.97 RibbonGroup
RibbonGroup is a helper component for Ribbon to define groups in a tab.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
ribbonGroup org.primefaces.component.ribbon.RibbonGroup
org.primefaces.component.RibbonGroup
org.primefaces.component
org.primefaces.component.RibbonGroupRenderer
org.primefaces.component.ribbon.RibbonGroupRenderer
Attributes
Name
id rendered
Default
null true binding style styleClass label null null null null
String
Boolean
Type
Object
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Inline style of the container element.
Style class of the container element.
Label of the group.
Getting started with RibbonGroup
Refer to Ribbon component documentation for more information.
382
PrimeFaces User Guide
3.98 Ring
Ring is a data display component with a circular animation.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
ring org.primefaces.component.ring.Ring
org.primefaces.component.Ring
org.primefaces.component
org.primefaces.component.RingRenderer
org.primefaces.component.ring.RingRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding widgetVar value var style styleClass easing null null null null null null swing
Object
String
Object
String
String
String
String
Getting started with Ring
A collection is required to use the Ring component.
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
Collection to display.
Name of the data iterator.
Inline style of the container element.
Style class of the container element.
Type of easing to use in animation.
383
PrimeFaces User Guide
<p:ring value="#{ringBean.players}" var="player”>
<p:graphicImage value="/images/barca/#{player.photo}"/>
</p:ring> public class RingBean { private List<Player> players; public RingBean() { players = new ArrayList<Player>();
}
//getter&setter for players
} players.add(new Player("Messi", 10, "messi.jpg", "CF")); players.add(new Player("Iniesta", 8, "iniesta.jpg", "CM"));
//more players
Item Selection
A column is required to process item selection from ring properly.
<p:ring value="#{ringBean.players}" var="player">
<p:column>
//UI to select an item e.g. commandLink
</p:column>
</p:ring>
Easing
Following is the list of available options for easing animation.
• swing
• easeInQuad
• easeOutQuad
• easeInOutQuad
• easeInCubic
• easeOutCubic
• easeInOutCubic
• easeInQuart
• easeOutQuart
• easeInOutQuart
• easeInQuint
• easeOutQuint
• easeInOutQuint
• easeInSine
• easeOutSine
• easeInExpo
• easeOutExpo
• easeInOutExpo
• easeInCirc
• easeOutCirc
• easeInOutCirc
• easeInElastic
• easeOutElastic
• easeInOutElastic
• easeInBack
• easeOutBack
• easeInOutBack
• easeInBounce
• easeOutBounce
• easeInOutBounce
Skinning
Ring resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes.
Style Class Applies
.ui-ring
.ui-ring-item
Main container element.
Each item in the list.
384
PrimeFaces User Guide
3.98 Row
Row is a helper component for datatable.
Info
Tag
Component Class
Component Type
Component Family
row org.primefaces.component.row.Row
org.primefaces.component.Row
org.primefaces.component
Attributes
Name
id rendered binding
Default
null true
Type
String
Boolean null Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Getting Started with Row
See datatable grouping section for more information about how row is used.
385
PrimeFaces User Guide
3.99 RowEditor
RowEditor is a helper component for datatable.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
rowEditor org.primefaces.component.roweditor.RowEditor
org.primefaces.component.RowEditor
org.primefaces.component
org.primefaces.component.RowEditorRenderer
org.primefaces.component.roweditor.RowEditorRenderer
Attributes
Name
id rendered binding
Default
null true
Type
String
Boolean null Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Getting Started with RowEditor
See inline editing section in datatable documentation for more information about usage.
386
PrimeFaces User Guide
3.100 RowExpansion
RowExpansion is a helper component of datatable used to implement expandable rows.
Info
Tag
Component Class
Component Type
Component Family
rowExpansion org.primefaces.component.rowexpansion.RowExpansion
org.primefaces.component.RowExpansion
org.primefaces.component
Attributes
Name
id rendered binding styleClass
Default
null true
Type
String
Boolean null null
Object
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Style class of the component.
Getting Started with RowExpansion
See datatable expandable rows section for more information about how rowExpansion is used.
387
PrimeFaces User Guide
3.101 RowToggler
RowToggler is a helper component for datatable.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
rowToggler org.primefaces.component.rowtoggler.RowToggler
org.primefaces.component.RowToggler
org.primefaces.component
org.primefaces.component.RowTogglerRenderer
org.primefaces.component.rowtoggler.RowTogglerRenderer
Attributes
Name
id rendered binding
Default
null true
Type
String
Boolean null Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Getting Started with Row
See expandable rows section in datatable documentation for more information about usage.
388
PrimeFaces User Guide
3.102 Schedule
Schedule provides an Outlook Calendar, iCal like JSF component to manage events.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding
schedule org.primefaces.component.schedule.Schedule
org.primefaces.component.Schedule
org.primefaces.component
org.primefaces.component.ScheduleRenderer
org.primefaces.component.schedule.ScheduleRenderer
null
Default
true
Type
String
Boolean null Object
389
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
widgetVar value locale aspectRatio view initialDate
Name
showWeekends style styleClass draggable resizable showHeader leftHeaderTemplate centerHeaderTemplate rightHeaderTemplate allDaySlot slotMinutes firstHour minTime maxTime axisFormat true null
Boolean
String null
30
6 null null null
String true true true prev, next today title month, agendaWeek, agendaDay true
Boolean
Boolean
Boolean
String
String
String
Boolean
Integer
Integer
String
String
String null
Default
null null null month
Type
String
Object
Object
Float
String null Object
PrimeFaces User Guide
Description
Name of the client side widget.
An org.primefaces.model.ScheduleModel instance representing the backed model
Locale for localization, can be String or a java.util.Locale instance
Ratio of calendar width to height, higher the value shorter the height is
The view type to use, possible values are
'month', 'agendaDay', 'agendaWeek',
'basicWeek', 'basicDay'
The initial date that is used when schedule loads. If ommitted, the schedule starts on the current date
Specifies inclusion Saturday/Sunday columns in any of the views
Style of the main container element of schedule
Style class of the main container element of schedule
When true, events are draggable.
When true, events are resizable.
Specifies visibility of header content.
Content of left side of header.
Content of center of header.
Content of right side of header.
Determines if all-day slot will be displayed in agendaWeek or agendaDay views
Interval in minutes in an hour to create a slot.
First hour to display in day view.
Minimum time to display in a day view.
Maximum time to display in a day view.
Determines the time-text that will be displayed on the vertical axis of the agenda views.
390
Name
timeFormat columnFormat timeZone ignoreTimezone tooltip null
Default
null null
Type
String
String
Object true false
Boolean
Boolean
PrimeFaces User Guide
Description
Determines the time-text that will be displayed on each event.
Format for column headers.
String or a java.util.TimeZone instance to specify the timezone used for date conversion.
When parsing dates, whether UTC offsets should be ignored while processing event data.
Displays description of events on a tooltip.
Getting started with Schedule
Schedule needs to be backed by an org.primefaces.model.ScheduleModel instance, a schedule model consists of org.primefaces.model.ScheduleEvent instances.
<p:schedule value="#{scheduleBean.model}" /> public class ScheduleBean { private ScheduleModel model; public ScheduleBean() { eventModel = new ScheduleModel<ScheduleEvent>(); eventModel.addEvent(new DefaultScheduleEvent("title", new Date(), new Date()));
} public ScheduleModel getModel() { return model;
}
}
DefaultScheduleEvent is the default implementation of ScheduleEvent interface. Mandatory properties required to create a new event are the title, start date and end date. Other properties such as allDay get sensible default values.
Table below describes each property in detail.
Property
id title startDate
Description
Used internally by PrimeFaces, auto generated.
Title of the event.
Start date of type java.util.Date.
391
PrimeFaces User Guide
Property
endDate allDay styleClass data editable description
Description
End date of type java.util.Date.
Flag indicating event is all day.
Visual style class to enable multi resource display.
Optional data you can set to be represented by Event.
Whether the event is editable or not.
Tooltip text to display on mouseover of an event.
Ajax Behavior Events
Schedule provides various ajax behavior events to respond user actions.
Event
dateSelect eventSelect eventMove eventResize viewChange
Listener Parameter
org.primefaces.event.SelectEvent
org.primefaces.event.SelectEvent
Fired
When a date is selected.
When an event is selected.
org.primefaces.event.ScheduleEntryMoveEvent
When an event is moved.
org.primefaces.event.ScheduleEntryResizeEvent
When an event is resized.
org.primefaces.event.SelectEvent
When a view is changed.
Ajax Updates
Schedule has a quite complex UI which is generated on-the-fly by the client side
PrimeFaces.widget.Schedule widget to save bandwidth and increase page load performance. As a result when you try to update schedule like with a regular PrimeFacess PPR, you may notice a UI lag as the DOM will be regenerated and replaced. Instead, Schedule provides a simple client side api and the update method.
Whenever you call update, schedule will query its server side ScheduleModel instance to check for updates, transport method used to load events dynamically is JSON, as a result this approach is much more effective then updating with regular PPR. An example of this is demonstrated at editable schedule example, save button is calling PF('widgetvar').update() at oncomplete event handler.
TimeZone
By default, timezone offsets are ignored. Set ignoreTimezone to false so that schedule takes care of timezone differences by calculating the client browser timezone and the event date so that events are displayed at the clients local time.
Editable Schedule
Let’s put it altogether to come up a fully editable and complex schedule.
392
PrimeFaces User Guide
<h:form>
<p:schedule value="#{bean.eventModel}" editable="true" widgetVar="myschedule">
<p:ajax event="dateSelect" listener="#{bean.onDateSelect}" update="eventDetails" oncomplete="eventDialog.show()" />
<p:ajax event="eventSelect" listener="#{bean.onEventSelect}"
</p:schedule>
<p:dialog widgetVar="eventDialog" header="Event Details">
<h:panelGrid id="eventDetails" columns="2">
<h:outputLabel for="title" value="Title:" />
<h:inputText id="title" value="#{bean.event.title}" required="true"/>
<h:outputLabel for="from" value="From:" />
<p:inputMask id="from" value="#{bean.event.startDate}" mask="99/99/9999">
<f:convertDateTime pattern="dd/MM/yyyy" />
</p:inputMask>
<h:outputLabel for="to" value="To:" />
<p:inputMask id="to" value="#{bean.event.endDate}" mask="99/99/9999">
<f:convertDateTime pattern="dd/MM/yyyy" />
</p:inputMask>
<h:outputLabel for="allDay" value="All Day:" />
<h:selectBooleanCheckbox id="allDay" value="#{bean.event.allDay}" />
<p:commandButton type="reset" value="Reset" />
<p:commandButton value="Save" actionListener="#{bean.addEvent}" oncomplete="PF('myschedule').update();PF('eventDialog').hide();"/>
</h:panelGrid>
</p:dialog>
</h:form>
393
PrimeFaces User Guide public class ScheduleBean { private ScheduleModel<ScheduleEvent> model; private ScheduleEventImpl event = new DefaultScheduleEvent(); public ScheduleBean() { eventModel = new ScheduleModel<ScheduleEvent>();
} public ScheduleModel<ScheduleEvent> getModel() { return model; } public ScheduleEventImpl getEvent() { return event; } public void setEvent(ScheduleEventImpl event) { this.event = event; } public void addEvent() { if(event.getId() == null) eventModel.addEvent(event); else eventModel.updateEvent(event); event = new DefaultScheduleEvent();
} public void onEventSelect(SelectEvent e) { event = (ScheduleEvent) e.getObject();
}
//reset dialog form public void onDateSelect(SelectEvent e) {
Date date = (Date) e.getObject(); event = new DefaultScheduleEvent("", date, date);
}
}
Lazy Loading
Schedule assumes whole set of events are eagerly provided in ScheduleModel, if you have a huge data set of events, lazy loading features would help to improve performance. In lazy loading mode, only the events that belong to the displayed time frame are fetched whereas in default eager more all events need to be loaded.
<p:schedule value="#{scheduleBean.lazyModel}" />
To enable lazy loading of Schedule events, you just need to provide an instance of
org.primefaces.model.LazyScheduleModel and implement the loadEvents methods. loadEvents method is called with new boundaries every time displayed timeframe is changed.
394
public class ScheduleBean { private ScheduleModel lazyModel; public ScheduleBean() { lazyModel = new LazyScheduleModel() {
@Override public void loadEvents(Date start, Date end) {
//addEvent(...);
//addEvent(...);
}
}
}; public ScheduleModel getLazyModel() { return lazyModel;
}
}
PrimeFaces User Guide
Customizing Header
Header controls of Schedule can be customized based on templates, valid values of template options are;
• title: Text of current month/week/day information
• prev: Button to move calendar back one month/week/day.
• next: Button to move calendar forward one month/week/day.
• prevYear: Button to move calendar back one year
• nextYear: Button to move calendar forward one year
• today: Button to move calendar to current month/week/day.
• viewName: Button to change the view type based on the view type.
These controls can be placed at three locations on header which are defined with
leftHeaderTemplate, rightHeaderTemplate and centerTemplate attributes.
<p:schedule value="#{scheduleBean.model}" leftHeaderTemplate"today" rightHeaderTemplate="prev,next" centerTemplate="month, agendaWeek, agendaDay"
</p:schedule>
395
PrimeFaces User Guide
Views
5 different views are supported, these are "month", "agendaWeek", "agendaDay", "basicWeek" and
"basicDay".
agendaWeek
<p:schedule value="#{scheduleBean.model}" view="agendaWeek"/> agendaDay
<p:schedule value="#{scheduleBean.model}" view="agendaDay"/> basicWeek
<p:schedule value="#{scheduleBean.model}" view="basicWeek"/>
396
basicDay
<p:schedule value="#{scheduleBean.model}" view="basicDay"/>
PrimeFaces User Guide
Locale Support
By default locale information is retrieved from the view’s locale and can be overridden by the locale attribute. Locale attribute can take a locale key as a String or a java.util.Locale instance. Default language of labels are English and you need to add the necessary translations to your page manually as PrimeFaces does not include language translations. PrimeFaces Wiki Page for
PrimeFacesLocales is a community driven page where you may find the translations you need.
Please contribute to this wiki with your own translations.
http://wiki.primefaces.org/display/Components/PrimeFaces+Locales
Translation is a simple javascript object, we suggest adding the code to a javascript file and include in your application. Following is a Turkish calendar.
<p:schedule value="#{scheduleBean.model}" locale="tr"/>
Skinning
Schedule resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information.
397
PrimeFaces User Guide
3.103 ScrollPanel
ScrollPanel is used to display scrollable content with theme aware scrollbars instead of native browser scrollbars.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
scrollPanel org.primefaces.component.scrollpanel.ScrollPanel
org.primefaces.component.ScrollPanel
org.primefaces.component
org.primefaces.component.ScrollPanelRenderer
org.primefaces.component.scrollpanel.ScrollPanelRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding style styleClass mode null null null default
Object
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Inline style of the container element.
Style class of the container element.
Scrollbar display mode, valid values are default and native.
398
PrimeFaces User Guide
Getting started with ScrollPanel
In order to get scrollable content, width and/or height should be defined.
<p:scrollPanel style="width:250px;height:200px">
//any content
</p:scrollPanel>
Native ScrollBars
By default, scrollPanel displays theme aware scrollbars, setting mode option to native displays browser scrollbars.
<p:scrollPanel style="width:250px;height:200px" mode="native">
//any content
</p:scrollPanel>
Skinning
ScrollPanel resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-scrollpanel
.ui-scrollpanel-container
.ui-scrollpanel-content
.ui-scrollpanel-hbar
.ui-scrollpanel-vbar
.ui-scrollpanel-track
.ui-scrollbar-drag
Applies
Main container element.
Overflow container.
Content element.
Horizontal scrollbar container.
Vertical scrollbar container.
Track element.
Drag element.
399
3.104 SelectBooleanButton
SelectBooleanButton is used to select a binary decision with a toggle button.
PrimeFaces User Guide
Info
Tag
selectBooleanButton
Component Class
org.primefaces.component.selectbooleanbutton.SelectBooleanButton
Component Type
org.primefaces.component.SelectBooleanButton
Component Family
org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectBooleanButtonRenderer
org.primefaces.component.selectbooleanbutton.SelectBooleanButtonRenderer
Attributes
id
Name
rendered binding value converter immediate required validator null null false null valueChangeListener null requiredMessage
Default
null true null false null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Boolean
Method
Expr
Method
Expr
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
A method expression that refers to a method validationg the input
A method expression that refers to a method for handling a valuechangeevent
Message to be displayed when required field validation fails.
400
Name
converterMessage validatorMessage widgetVar disabled label onchange style styleClass onLabel offLabel onIcon offIcon false null null null null null null null null
Default
null null null
Type
String
String
String
Boolean
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Label to display when button is selected.
Label to display when button is unselected.
Icon to display when button is selected.
Icon to display when button is unselected.
Getting started with SelectBooleanButton
SelectBooleanButton usage is similar to selectBooleanCheckbox.
<p:selectBooleanButton id="value2" value="#{bean.value}" onLabel="Yes" offLabel="No" onIcon="ui-icon-check" offIcon="ui-icon-close" /> public class Bean { private boolean value;
//getter and setter
}
Skinning
SelectBooleanButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectbooleanbutton Main container element.
Applies
401
PrimeFaces User Guide
3.105 SelectBooleanCheckbox
SelectBooleanCheckbox is an extended version of the standard checkbox with theme integration.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
selectBooleanCheckbox org.primefaces.component.selectbooleancheckbox.SelectBooleanCheckbox
org.primefaces.component.SelectBooleanCheckbox
org.primefaces.component
org.primefaces.component.SelectBooleanCheckboxRenderer
org.primefaces.component.selectbooleancheckbox.SelectBooleanCheckbox
Renderer
Attributes
id
Name
rendered binding value converter immediate required validator null null false null valueChangeListener null requiredMessage
Default
null true null false null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Object
Converter/
String
Boolean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String Message to be displayed when required field validation fails.
402
Name
converterMessage validatorMessage widgetVar disabled label onchange style styleClass itemLabel tabindex false null null null null null null
Default
null null null
Type
String
String
String
Boolean
String
String
String
String
String
String
PrimeFaces User Guide
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Label displayed next to checkbox.
Specifies tab order for tab key navigation.
Getting started with SelectBooleanCheckbox
SelectBooleanCheckbox usage is same as the standard one.
Client Side API
Widget: PrimeFaces.widget.SelectBooleanCheckbox
Method
check() uncheck() toggle()
-
Params
-
Return Type
void void void
Description
Checks the checkbox.
Unchecks the checkbox.
Toggles check state.
-
Skinning
SelectBooleanCheckbox resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-chkbox
.ui-chkbox-box
.ui-chkbox-icon
.ui-chkbox-icon
Main container element.
Container of checkbox icon.
Checkbox icon.
Checkbox label.
Applies
403
PrimeFaces User Guide
3.106 SelectCheckboxMenu
SelectCheckboxMenu is a multi select component that displays options in an overlay.
Info
Tag
selectCheckboxMenu
Component Class
org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenu
Component Type
org.primefaces.component.SelectCheckboxMenu
Component Family org.primefaces.component
Renderer Type
org.primefaces.component.SelectCheckboxMenuRenderer
Renderer Class
org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenuRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null false false null valueChangeListener null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for
404
Name Default
null false null null null null null false startsWith null null null null false null null null null null null requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass scrollHeight onShow onHide filter filterMatchMode filterFunction caseSensitive panelStyle panelStyleClass appendTo tabindex
String
Boolean
String
String
Boolean
String
String
String
String
String
String
String
String
Boolean
String
String
String
String
Integer
String
Type
PrimeFaces User Guide
Description
handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Height of the overlay.
Client side callback to execute when overlay is displayed.
Client side callback to execute when overlay is hidden.
Renders an input field as a filter.
Match mode for filtering, valid values are startsWith, contains, endsWith and custom.
Client side function to use in custom filtering.
Defines if filtering would be case sensitive.
Inline style of the overlay.
Style class of the overlay.
Appends the overlay to the element defined by search expression. Defaults to document body.
Position of the element in the tabbing order.
405
PrimeFaces User Guide
Getting started with SelectCheckboxMenu
SelectCheckboxMenu usage is same as the standard selectManyCheckbox or PrimeFaces selectManyCheckbox components.
<p:selectCheckboxMenu value="#{bean.selectedOptions}" label="Movies">
<f:selectItems value="#{bean.options}" />
</p:selectCheckboxMenu>
Filtering
When filtering is enabled with setting filter on, an input field is rendered at overlay header and on keyup event filtering is executed on client side using filterMatchMode. Default modes of filterMatchMode are startsWith, contains, endsWith and custom. Custom mode requires a javascript function to do the filtering.
<p:selectCheckboxMenu value="#{bean.selectedOptions}" label="Movies" filterMatchMode="custom" filterFunction="customFilter">
<f:selectItems value="#{bean.options}" />
</p:selectCheckboxMenu> function customFilter(itemLabel, filterValue) {
//return true to accept and false to reject
}
Ajax Behavior Events
In addition to common dom events like change, selectCheckboxMenu provides toggleSelect event.
Event
toggleSelect
Listener Parameter Fired
org.primefaces.event.ToggleSelectEvent
When toggle all checkbox changes.
Skinning
SelectCheckboxMenu resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectcheckboxmenu Main container element.
.ui-selectcheckboxmenu-label-container Label container.
.ui-selectcheckboxmenu-label Label.
.ui-selectcheckboxmenu-trigger Dropdown icon.
.ui-selectcheckboxmenu-panel
.ui-selectcheckboxmenu-items
Overlay panel.
Option list container.
Applies
406
Style Class
.ui-selectcheckboxmenu-item
.ui-chkbox
.ui-chkbox-box
.ui-chkbox-icon
Applies
Each options in the collection.
Container of a checkbox.
Container of checkbox icon.
Checkbox icon.
PrimeFaces User Guide
407
PrimeFaces User Guide
3.107 SelectManyButton
SelectManyButton is a multi select component using button UI.
Info
Tag
selectManyButton
Component Class
org.primefaces.component.selectmanybutton.SelectManyButton
Component Type
org.primefaces.component.SelectManyButton
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectManyButton
org.primefaces.component.selectmanybutton.SelectManyButton
Attributes
id
Name
rendered binding value converter immediate required validator null null false null valueChangeListener null requiredMessage
Default
null true null false null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String Message to be displayed when required field validation fails.
408
Name
converterMessage validatorMessage widgetVar disabled label onchange style styleClass false null null null null
Default
null null null
Type
String
String
String
Boolean
String
String
String
String
PrimeFaces User Guide
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Getting started with SelectManyButton
SelectManyButton usage is same as selectManyCheckbox, buttons just replace checkboxes.
Skinning
SelectManyButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectmanybutton Main container element.
Applies
409
PrimeFaces User Guide
3.108 SelectManyCheckbox
SelectManyCheckbox is an extended version of the standard SelectManyCheckbox with theme integration.
Info
Tag
selectManyCheckbox
Component Class
org.primefaces.component.selectmanycheckbox.SelectManyCheckbox
Component Type
org.primefaces.component.SelectManyCheckbox
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectManyCheckboxRenderer
org.primefaces.component.selectmanycheckbox.SelectManyCheckboxRenderer
Attributes
Name
id rendered binding value converter immediate required validator false null valueChangeListener null requiredMessage
Default
null true null null null false null
Type
String
Boolean
Object
Object
Converter/St ring
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String Message to be displayed when required field
410
Name Default
converterMessage validatorMessage widgetVar disabled label layout columns onchange style styleClass
0 null null null null null null false
String
String
String
Boolean null String lineDirection String
Integer
String
String
String
Type
PrimeFaces User Guide
Description
validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Layout of the checkboxes, valid values are
lineDirection, pageDirection and grid.
Number of columns in grid layout.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Getting started with SelectManyCheckbox
SelectManyCheckbox usage is same as the standard one.
Skinning
SelectManyCheckbox resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectmanycheckbox
.ui-chkbox
.ui-chkbox-box
.ui-chkbox-icon
Main container element.
Container of a checkbox.
Container of checkbox icon.
Checkbox icon.
Applies
411
3.109 SelectManyMenu
SelectManyMenu is an extended version of the standard SelectManyMenu.
PrimeFaces User Guide
Info
Tag
selectManyMenu
Component Class
org.primefaces.component.selectmanymenu.SelectManyMenu
Component Type
org.primefaces.component.SelectManyMenu
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectManyMenuRenderer
org.primefaces.component.selectmanymenu.SelectManyMenuRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null false false null valueChangeListener null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for
412
Name
requiredMessage converterMessage validatorMessage widgetVar disabled label onchange onclick ondblclick style styleClass tabindex var showCheckbox filter filterMatchMode null null null null null null null null null null false null null false false null filterFunction caseSensitive scrollHeight null false null
Default
String
String
String
String
String
String
String
String
String
String
Boolean
String
String
Boolean
Boolean
String
String
Boolean
Integer
Type
PrimeFaces User Guide
Description
handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Callback for click event.
Callback for dblclick event.
Inline style of the component.
Style class of the container.
Position of the input element in the tabbing order.
Name of iterator to be used in custom content display.
When true, a checkbox is displayed next to each item.
Displays an input filter for the list.
Match mode for filtering, valid values are startsWith (default), contains, endsWith and custom.
Client side function to use in custom filterMatchMode.
Defines if filtering would be case sensitive.
Defines the height of the scrollable area
Getting started with SelectManyMenu
SelectManyMenu usage is same as the standard one.
Custom Content
Custom content can be displayed for each item using column components.
413
PrimeFaces User Guide
<p:selectManyMenu value="#{bean.selectedPlayers}" converter="player" var="p">
<f:selectItems value="#{bean.players}" var="player" itemLabel="#{player.name}" itemValue="#{player}" />
<p:column>
<p:graphicImage value="/images/barca/#{p.photo}" width="40"/>
</p:column>
<p:column>
#{p.name} - #{p.number}
</p:column>
</p:selectManyMenu>
Filtering
Filtering is enabled by setting filter attribute to true. There are four filter modes; startsWith,
contains, endsWith and custom. In custom mode, filterFunction must be defined as the name of the javascript function that takes the item value and filter as parameters to return a boolean to accept or reject a value. To add a filter to previous example;
<p:selectOneMenu value="#{menuBean.selectedPlayer}" converter="player" var="p" filter="true" filterMatchMode="contains">
...
</p:selectOneMenu>
Checkbox
SelectManyMenu has built-in support for checkbox based multiple selection, when enabled by
showCheckbox option, checkboxes are displayed next to each column.
414
PrimeFaces User Guide
Skinning
SelectManyMenu resides in a container that style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectmanymenu
.ui-selectlistbox-item
Main container element.
Each item in list.
Applies
415
PrimeFaces User Guide
3.110 SelectOneButton
SelectOneButton is an input component to do a single select.
Info
Tag
selectOneButton
Component Class
org.primefaces.component.selectonebutton.SelectOneButton
Component Type
org.primefaces.component.SelectOneButton
Component Family org.primefaces.component
Renderer Type
org.primefaces.component.SelectOneButtonRenderer
Renderer Class
org.primefaces.component.selectonebutton.SelectOneButtonRenderer
Attributes
Name
id rendered binding value converter immediate required validator false null valueChangeListener null requiredMessage null null null
Default
null true false null
Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
Object
Converter/St ring
Boolean
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required Boolean
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String Message to be displayed when required field
416
Name
converterMessage validatorMessage widgetVar disabled label onchange style styleClass null null null null null null null false
Default
String
String
String
Boolean
String
String
String
String
Type
PrimeFaces User Guide
Description
validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Inline style of the component.
Style class of the container.
Getting started with SelectOneButton
SelectOneButton usage is same as selectOneRadio component, buttons just replace the radios.
Skinning
SelectOneButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectonebutton Main container element.
Applies
417
PrimeFaces User Guide
3.111 SelectOneListbox
SelectOneListbox is an extended version of the standard selectOneListbox component.
Info
Tag
selectOneListbox
Component Class
org.primefaces.component.selectonelistbox.SelectOneListbox
Component Type
org.primefaces.component.SelectOneListbox
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectOneListboxRenderer
org.primefaces.component.selectonelistbox.SelectOneListBoxRenderer
Attributes
Name
id rendered binding value converter immediate required validator false null valueChangeListener null null null null
Default
null true false
Type
String
Boolean
Description
Unique identifier of the component
Object
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
Object
Converter/
String
Boolean
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for
418
Name
requiredMessage converterMessage validatorMessage widgetVar disabled label onchange onclick ondblclick style styleClass tabindex value var filter filterMatchMode null null null null null null null null null null false null null null false null filterFunction caseSensitive scrollHeight null false null
Default
String
String
String
String
String
String
String
String
String
String
Boolean
String
String
String
Boolean
String
String
Boolean
Integer
Type
PrimeFaces User Guide
Description
handling a valuechangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Callback to execute on value change.
Callback for click event.
Callback for dblclick event.
Inline style of the component.
Style class of the container.
Position of the input element in the tabbing order.
Name of iterator to be used in custom content display.
Name of iterator to be used in custom content display.
Displays an input filter for the list.
Match mode for filtering, valid values are startsWith (default), contains, endsWith and custom.
Client side function to use in custom filterMatchMode.
Defines if filtering would be case sensitive.
Defines the height of the scrollable area.
Getting started with SelectOneListbox
SelectOneListbox usage is same as the standard one.
Custom Content
Custom content can be displayed for each item using column components.
419
PrimeFaces User Guide
<p:selectOneListbox value="#{bean.player}" converter="player" var="p">
<f:selectItems value="#{bean.players}" var="player" itemLabel="#{player.name}" itemValue="#{player}" />
<p:column>
<p:graphicImage value="/images/barca/#{p.photo}" width="40"/>
</p:column>
<p:column>
#{p.name} - #{p.number}
</p:column>
</p:selectOneListbox>
Filtering
Filtering is enabled by setting filter attribute to true. There are four filter modes; startsWith,
contains, endsWith and custom. In custom mode, filterFunction must be defined as the name of the javascript function that takes the item value and filter as parameters to return a boolean to accept or reject a value. To add a filter to previous example;
<p:selectOneMenu value="#{menuBean.selectedPlayer}" converter="player" var="p" filter="true" filterMatchMode="contains">
...
</p:selectOneMenu>
Skinning
SelectOneListbox resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Applies Style Class
.ui-selectonelistbox
.ui-selectlistbox-item
Main container element.
Each item in list.
420
3.112 SelectOneMenu
SelectOneMenu is an extended version of the standard SelectOneMenu.
PrimeFaces User Guide
Info
Tag
selectOneMenu
Component Class
org.primefaces.component.selectonemenu.SelectOneMenu
Component Type
org.primefaces.component.SelectOneMenu
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectOneMenuRenderer
org.primefaces.component.selectonemenu.SelectOneMenuRenderer
Attributes
Name
id rendered binding value converter immediate required validator
Default
null true null null null
0
0 null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
421
PrimeFaces User Guide
Name Default
valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar effect effectSpeed disabled label onchange null null null null blind
String
String
String normal String false null null
Type Description
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String
String
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Boolean
String
String
Message to be displayed when validation fields.
Name of the client side widget.
Name of the toggle animation.
Duration of toggle animation, valid values are "slow",
"normal" and "fast".
Disables the component.
User presentable name.
Client side callback to execute on value change.
onkeyup onkeydown style styleClass var height tabindex editable filter filterMatchMode null null null null null auto null false false starts
With
String
String
String
String
String
Integer
String
Boolean
Boolean
String
Client side callback to execute on keyup.
Client side callback to execute on keydown.
Inline style of the component.
Style class of the container.
Name of the item iterator.
Height of the overlay.
Tabindex of the input.
When true, input becomes editable.
Renders an input field as a filter.
Match mode for filtering, valid values are startsWith, contains, endsWith and custom.
filterFunction caseSensitive maxlength appendTo null false null null
String
Boolean
Integer
String
Client side function to use in custom filtering.
Defines if filtering would be case sensitive.
Number of maximum characters allowed in editable selectOneMenu.
Appends the overlay to the element defined by search expression. Defaults to document body.
Getting started with SelectOneMenu
Basic SelectOneMenu usage is same as the standard one.
422
PrimeFaces User Guide
Custom Content
SelectOneMenu can display custom content in overlay panel by using column component and the var option to refer to each item.
public class MenuBean { private List<Player> players; private Player selectedPlayer; public OrderListBean() { players = new ArrayList<Player>(); players.add(new Player("Messi", 10, "messi.jpg"));
//more players
}
//getters and setters
}
<p:selectOneMenu value="#{menuBean.selectedPlayer}" converter="player" var="p">
<f:selectItem itemLabel="Select One" itemValue="" />
<f:selectItems value="#{menuBean.players}" var="player" itemLabel="#{player.name}" itemValue="#{player}"/>
<p:column>
<p:graphicImage value="/images/barca/#{p.photo}" width="40" height="50"/>
</p:column>
<p:column>
#{p.name} - #{p.number}
</p:column>
</p:selectOneMenu>
Effects
An animation is executed to show and hide the overlay menu, default effect is fade and following options are available for effect attribute; blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size, slide and none.
423
PrimeFaces User Guide
Editable
Editable SelectOneMenu provides a UI to either choose from the predefined options or enter a manual input. Set editable option to true to use this feature.
Filtering
When filtering is enabled with setting filter on, an input field is rendered at overlay header and on keyup event filtering is executed on client side using filterMatchMode. Default modes of filterMatchMode are startsWith, contains, endsWith and custom. Custom mode requires a javascript function to do the filtering.
<p:selectOneMenu value="#{bean.selectedOptions}" filterMatchMode="custom" filterFunction="customFilter">
<f:selectItems value="#{bean.options}" />
</p:selectOneMenu> function customFilter(itemLabel, filterValue) {
//return true to accept and false to reject
}
Client Side API
Widget: PrimeFaces.widget.SelectOneMenu
424
Method
show() hide() blur() focus() enable() disable() selectValue() getSelectedValue() getSelectedLabel()
Params
-
-
void
Return Type
void void
-
void void
void value: itemValue void
Object
String
PrimeFaces User Guide
Description
Shows overlay menu.
Hides overlay menu.
Invokes blur event.
Invokes focus event.
Enables component.
Disabled component.
Selects given value.
Returns value of selected item.
Returns label of selected item.
Skinning
SelectOneMenu resides in a container element that style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectonemenu
.ui-selectonemenu-label
.ui-selectonemenu-trigger
.ui-selectonemenu-items
.ui-selectonemenu-items
Applies
Main container.
Label of the component.
Container of dropdown icon.
Items list.
Each item in the list.
425
PrimeFaces User Guide
3.113 SelectOneRadio
SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.
Info
Tag
selectOneRadio
Component Class
org.primefaces.component.selectoneradio.SelectOneRadio
Component Type
org.primefaces.component.SelectOneRadio
Component Family org.primefaces.component
Renderer Type
Renderer Class
org.primefaces.component.SelectOneRadioRenderer
org.primefaces.component.selectoneradio.SelectOneRadioRenderer
Attributes
id required
Name
rendered binding value converter immediate validator null null
0 null valueChangeListener null requiredMessage
Default
null true null
0 null
Type
String
Boolean
Object
Object
Converter/
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component referring to a List.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
MethodExpr A method expression that refers to a method validationg the input
MethodExpr A method expression that refers to a method for handling a valuechangeevent
String Message to be displayed when required field validation fails.
426
columns onchange onclick style styleClass tabindex plain
Name
converterMessage validatorMessage widgetVar disabled label layout null null null null
Default
null null null false null line
Direction
0 null false
Type
String
String
String
Boolean
String
String
Integer
String
String
String
String
String
Boolean
PrimeFaces User Guide
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Disables the component.
User presentable name.
Layout of the radiobuttons, valid values are
lineDirection, pageDirection, custom and grid.
Number of columns in grid layout.
Callback to execute on value change.
Callback to execute on click of a radio.
Inline style of the component.
Style class of the container.
Specifies the tab order of element in tab navigation.
Plain mode displays radiobuttons using native browser rendering instead of themes.
Getting started with SelectOneRadio
SelectOneRadio usage is same as the standard one.
Custom Layout
Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. PrimeFaces SelectOneRadio on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. This is implemented by setting layout option to custom and with standalone radioButton components. Note that in custom mode, selectOneRadio itself does not render any output.
<p:selectOneRadio id="customRadio" value="#{formBean.option}" layout="custom">
<f:selectItem itemLabel="Option 1" itemValue="1" />
<f:selectItem itemLabel="Option 2" itemValue="2" />
<f:selectItem itemLabel="Option 3" itemValue="3" />
</p:selectOneRadio>
427
PrimeFaces User Guide
<h:panelGrid columns="3">
<p:radioButton id="opt1" for="customRadio" itemIndex="0"/>
<h:outputLabel for="opt1" value="Option 1" />
<p:spinner />
<p:radioButton id="opt2" for="customRadio" itemIndex="1"/>
<h:outputLabel for="opt2" value="Option 2" />
<p:inputText />
<p:radioButton id="opt3" for="customRadio" itemIndex="2"/>
<h:outputLabel for="opt3" value="Option 3" />
<p:calendar />
</h:panelGrid>
RadioButton’s for attribute should refer to a selectOneRadio component and itemIndex points to the index of the selectItem. When using custom layout option, selectOneRadio component should be placed above any radioButton that points to the selectOneRadio.
Skinning
SelectOneRadio resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Style Class
.ui-selectoneradio
.ui-radiobutton
.ui-radiobutton-box
.ui-radiobutton-icon
Main container element.
Container of a radio button.
Applies
Container of radio button icon.
Radio button icon.
428
PrimeFaces User Guide
3.114 Separator
Seperator displays a horizontal line to separate content.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
separator org.primefaces.component.separator.Separator
org.primefaces.component.Separator
org.primefaces.component
org.primefaces.component.Separator
org.primefaces.component.separator.Separator
Attributes
Name
id rendered binding title style styleClass null null null null null true
Default Type
String
Boolean
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Advisory tooltip informaton.
Inline style of the separator.
Style class of the separator.
Getting started with Separator
In its simplest form, separator is used as;
//content
<p:separator />
//content
Object
String
String
String
Dimensions
Separator renders a <hr /> tag which style and styleClass options apply.
429
PrimeFaces User Guide
<p:separator style="width:500px;height:20px" />
Special Separators
Separator can be used inside other components such as menu when supported.
<p:menu>
//submenu or menuitem
<p:separator />
//submenu or menuitem
</p:menu>
Skinning
As mentioned in dimensions section, style and styleClass options can be used to style the separator.
Following is the list of structural style classes;
Class Applies
.ui-separator Separator element
As skinning style classes are global, see the main theming section for more information.
430
3.115 SlideMenu
SlideMenu is used to display nested submenus with sliding animation.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
slideMenu org.primefaces.component.slidemenu.SlideMenu
org.primefaces.component.SlideMenu
org.primefaces.component
org.primefaces.component.SlideMenuRenderer
org.primefaces.component.slidemenu.SlideMenuRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding widgetVar model style styleClass backLabel trigger my null null null null null
Back null null
Object
String
MenuModel
String
String
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
MenuModel instance for programmatic menu.
Inline style of the component.
Style class of the component.
Text for back link.
Id of the component whose triggerEvent will show the dynamic positioned menu.
Corner of menu to align with trigger element.
431
Name
at overlay
Default
null false
String
Boolean
Type
triggerEvent click String
PrimeFaces User Guide
Description
Corner of trigger to align with menu element.
Defines positioning, when enabled menu is displayed with absolute position relative to the trigger. Default is false, meaning static positioning.
Event name of trigger that will show the dynamic positioned menu.
Getting started with the SlideMenu
SlideMenu consists of submenus and menuitems, submenus can be nested and each nested submenu will be displayed with a slide animation.
<p:slideMenu>
<p:submenu label="Ajax Menuitems" icon="ui-icon-refresh">
<p:menuitem value="Save" actionListener="#{buttonBean.save}" update="messages" icon="ui-icon-disk" />
<p:menuitem value="Update" actionListener="#{buttonBean.update}" update="messages" icon="ui-icon-arrowrefresh-1-w" />
</p:submenu>
<p:submenu label="Non-Ajax Menuitem" icon="ui-icon-newwin">
<p:menuitem value="Delete" actionListener="#{buttonBean.delete}" update="messages" ajax="false" icon="ui-icon-close"/>
</p:submenu>
<p:separator />
<p:submenu label="Navigations" icon="ui-icon-extlink">
<p:submenu label="Prime Links">
<p:menuitem value="Prime" url="http://www.prime.com.tr" />
<p:menuitem value="PrimeFaces" url="http://www.primefaces.org" />
</p:submenu>
<p:menuitem value="Mobile" url="/mobile" />
</p:submenu>
</p:slideMenu>
Overlay
SlideMenu can be positioned relative to a trigger component, following sample attaches a slideMenu to the button so that whenever the button is clicked menu will be displayed in an overlay itself.
<p:commandButton type="button" value="Show" id="btn" />
<p:slideMenu trigger="btn" my="left top" at="left bottom">
//content
</p:slideMenu>
432
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.SlideMenu
Method
show() hide() align()
Params
-
-
void
Return Type
void void
Description
Shows overlay menu.
Hides overlay menu.
Aligns overlay menu with trigger.
Skinning
SlideMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-menu .ui-slidemenu
.ui-slidemenu-wrapper
.ui-slidemenu-content
.ui-slidemenu-backward
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Container element of menu.
Applies
Wrapper element for content.
Content container.
Back navigator.
List container
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
433
PrimeFaces User Guide
3.116 Slider
Slider is used to provide input with various customization options like orientation, display modes and skinning.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding for display minValue maxValue style styleClass animate type step disabled onSlideStart
slider org.primefaces.component.slider.Slider
org.primefaces.component.Slider
org.primefaces.component
org.primefaces.component.SliderRenderer
org.primefaces.component.slider.SliderRenderer
Default
null true null null null
0
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
String
Integer
An el expression that maps to a server side UIComponent instance in a backing bean
Id of the input text that the slider will be used for
Id of the component to display the slider value.
Minimum value of the slider
100 null null
Integer
String
String
Maximum value of the slider
Inline style of the container element
Style class of the container element true Boolean Boolean value to enable/disable the animated move when background of slider is clicked horizontal String Sets the type of the slider, "horizontal" or "vertical".
1
0 null
Integer Fixed pixel increments that the slider move in
Boolean Disables or enables the slider.
String Client side callback to execute when slide begins.
434
onSlide onSlideEnd range
Name
displayTemplate
Default
null null false null
PrimeFaces User Guide
Type
String
Description
Client side callback to execute during sliding.
String Client side callback to execute when slide ends.
Boolean When enabled, two handles are provided for selection a range.
String String template to use when updating the display. Valid placeholders are {value}, {min} and {max}.
Getting started with Slider
Slider requires an input component to work with, for attribute is used to set the id of the input component whose input will be provided by the slider.
public class SliderBean { private int number; public int getNumber() { return number;
} public void setNumber(int number) { this.number = number;
}
}
<h:inputText id="number" value="#{sliderBean.number}" />
<p:slider for="number" />
Display Value
Using display feature, you can present a readonly display value and still use slider to provide input, in this case for should refer to a hidden input to bind the value.
<h:inputHidden id="number" value="#{sliderBean.number}" />
<h:outputText value="Set ratio to %" />
<h:outputText id="output" value="#{sliderBean.number}" />
<p:slider for="number" display="output" />
435
PrimeFaces User Guide
Vertical Slider
By default slider’s orientation is horizontal, vertical sliding is also supported and can be set using the type attribute.
<h:inputText id="number" value="#{sliderController.number}" />
<p:slider for="number" type="vertical" minValue="0" maxValue="200"/>
Step
Step factor defines the interval between each point during sliding. Default value is one and it is customized using step option.
<h:inputText id="number" value="#{sliderBean.number}" />
<p:slider for="number" step="10" />
Animation
Sliding is animated by default, if you want to turn it of animate attribute set the animate option to false.
Boundaries
Maximum and minimum boundaries for the sliding is defined using minValue and maxValue attributes. Following slider can slide between -100 and +100.
<h:inputText id="number" value="#{sliderBean.number}" />
<p:slider for="number" minValue="-100" maxValue="100"/>
Range Slider
Selecting a range with min-max values are supported by slider. To enable this feature, set range attribute to true and provide a comma separate pair of input fields to attach min-max values.
Following sample demonstrates a range slider along with the display template feature for feedback;
436
PrimeFaces User Guide
<h:outputText id="displayRange" value="Between #{sliderBean.number6} and #{sliderBean.number7}"/>
<p:slider for="txt6,txt7" display="displayRange" style="width:400px" range="true"
displayTemplate="Between {min} and {max}"/>
<h:inputHidden id="min" value="#{sliderBean.min}" />
<h:inputHidden id="max" value="#{sliderBean.max}" />
Client Side Callbacks
Slider provides three callbacks to hook-in your custom javascript, onSlideStart, onSlide and onSlideEnd. All of these callbacks receive two parameters; slide event and the ui object containing information about the event.
<h:inputText id="number" value="#{sliderBean.number}" />
<p:slider for="number" onSlideEnd="handleSlideEnd(event, ui)"/> function handleSlideEnd(event, ui) {
//ui.helper = Handle element of slider
//ui.value = Current value of slider
}
Ajax Behavior Events
Slider provides one ajax behavior event called slideEnd that is fired when the slide completes. If you have a listener defined, it will be called by passing org.primefaces.event.SlideEndEvent instance. Example below adds a message and displays it using growl component when slide ends.
<h:inputText id="number" value="#{sliderBean.number}" />
<p:slider for="number">
<p:ajax event="slideEnd" listener="#{sliderBean.onSlideEnd}" update="msgs" />
</p:slider>
<p:messages id="msgs" />
437
PrimeFaces User Guide public class SliderBean { private int number; public int getNumber() { return number;
} public void setNumber(int number) { this.number = number;
} public void onSlideEnd(SlideEndEvent event) { int value = event.getValue();
//add faces message
}
}
Client Side API
Widget: PrimeFaces.widget.Slider
Method
getValue() setValue(value) disable() enable()
Params
value: Value to set index: Index of tab to disable index: Index of tab to enable
Return Type
Number void void void
Description
Returns the current value
Updates slider value with provided one.
Disables slider.
Enables slider.
Skinning
Slider resides in a main container which style and styleClass attributes apply. These attributes are handy to specify the dimensions of the slider. Following is the list of structural style classes;
.ui-slider
.ui-slider-horizontal
Class
.ui-slider-vertical
.ui-slider-handle
Applies
Main container element
Main container element of horizontal slider
Main container element of vertical slider
Slider handle
As skinning style classes are global, see the main theming section for more information.
438
3.117 Spotlight
Spotlight highlights a certain component on page.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding widgetVar target animate
spotlight org.primefaces.component.spotlight.Spotlight
org.primefaces.component.Spotlight
org.primefaces.component
org.primefaces.component.SpotlightRenderer
org.primefaces.component.spotlight.SpotlightRenderer
null null true
Default
null false null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Name of the client side widget.
String Component to highlight.
Boolean Controls animation used during highlight.
439
PrimeFaces User Guide
Getting started with Spotlight
Spotlight is accessed using client side api. Clicking the button highlights the panel below;
<p:panel id="pnl" header="Panel">
//content
</p:panel>
<p:commandButton value="Highlight" onclick="PF('spot').show()" />
<p:spotlight target="pnl" widgetVar="spot" />
Client Side API
Widget: PrimeFaces.widget.Spotlight
Method
show() hide()
Params
-
-
Return Type
void void
Description
Highlights target.
Removes highlight.
Skinning
Slider resides in a main container which style and styleClass attributes apply. These attributes are handy to specify the dimensions of the slider. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;
Class
.ui-spotlight
.ui-spotlight-top
.ui-spotlight-bottom
.ui-spotlight-left
.ui-spotlight-right
Applies
Mask element, common to all regions.
Top mask element.
Bottom mask element.
Left mask element.
Right mask element.
440
PrimeFaces User Guide
3.118 Socket
Socket component is an agent that creates a push channel between the server and the client.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
socket org.primefaces.component.socket.Socket
org.primefaces.component.Socket
org.primefaces.component
org.primefaces.component.SocketRenderer
org.primefaces.component.socket.SocketRenderer
Attributes
id rendered
Name
binding channel transport fallbackTransport onMessage onError onClose onOpen onReconnect null true null null null
Default
websocket long-polling
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
Object
String
String
String
An el expression that maps to a server side
UIComponent instance in a backing bean
Channel name of the connection.
Desired protocol to be used valid values are websocket (default), sse, streaming, long-polling, jsonp.
Fallback protocol to be used when desired transport is not supported in environment, valid values are websocket, sse, streaming, long-polling (default), jsonp.
Javascript event handler that is processed when server publishes data.
null null null null
String
String
String
String
Javascript event handler that is processed when there is an error.
Javascript event handler for onClose callback of atmosphere.
Javascript event handler for onOpen callback of atmosphere.
Javascript event handler for onReconnect callback of atmosphere.
441
Name
onMessagePublished null
Default
onTransportFailure onLocalMessage autoConnect null null true
PrimeFaces User Guide
Type
String
String
String
Description
Javascript event handler for onMessagePublished callback of atmosphere.
Javascript event handler for onTransportFailure callback of atmosphere.
Javascript event handler for onLocalMessage callback of atmosphere.
Boolean Connects to channel on page load when enabled.
Getting Started with the Socket
See chapter 5, "PrimeFaces Push" for detailed information.
442
PrimeFaces User Guide
3.119 Spacer
Spacer is used to put spaces between elements.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
spacer org.primefaces.component.spacer.Spacer
org.primefaces.component.Spacer
org.primefaces.component
org.primefaces.component.SpacerRenderer
org.primefaces.component.spacer.SpacerRenderer
Attributes
Name
id rendered binding title style styleClass width height null
Default
true
Type
String
Boolean null null null null null null
Object
String
String
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Advisory tooltip informaton.
Inline style of the spacer.
Style class of the spacer.
Width of the space.
Height of the space.
Getting started with Spacer
Spacer is used by either specifying width or height of the space.
Spacer in this example separates this text <p:spacer width="100" height="10"> and
<p:spacer width="100" height="10"> this text.
443
PrimeFaces User Guide
3.120 Spinner
Spinner is an input component to provide a numerical input via increment and decrement buttons.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
spinner org.primefaces.component.spinner.Spinner
org.primefaces.component.Spinner
org.primefaces.component
org.primefaces.component.SpinnerRenderer
org.primefaces.component.spinner.SpinnerRenderer
Attributes
id rendered
Name Default
null true
Type
String
Boolean binding value converter immediate null null null
Object
Object
Converter/
String false Boolean required validator
False null valueChangeListener null
Boolean
Method
Expr
Method
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed, when true the events will be fired at "apply request values", if immediate is set to false, valueChange Events are fired in "process validations" phase
Marks component as required
A method binding expression that refers to a method validationg the input
A method binding expression that refers to a
444
Name
requiredMessage converterMessage validatorMessage widgetVar stepFactor min max prefix suffix accesskey alt autocomplete dir disabled label lang maxlength onblur onchange null null null null null null false null null null null null
1 null null null null null
Default
null
Expr
String
Type
String
String
String
Double
Double
Double
String
String
String
String
String
String
Boolean
String
String
Integer
String
String onclick ondblclick onfocus onkeydown null null null null
String
String
String
String
PrimeFaces User Guide
Description
method for handling a valuchangeevent
Message to be displayed when required field validation fails.
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Name of the client side widget.
Stepping factor for each increment and decrement
Minimum boundary value
Maximum boundary value
Prefix of the input
Suffix of the input
Access key that when pressed transfers focus to the input element.
Alternate textual description of the input field.
Controls browser autocomplete behavior.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables input field
A localized user presentable name.
Code describing the language used in the generated markup for this component.
Maximum number of characters that may be entered in this field.
Client side callback to execute when input element loses focus.
Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
Client side callback to execute when input element is clicked.
Client side callback to execute when input element is double clicked.
Client side callback to execute when input element receives focus.
Client side callback to execute when a key is pressed down over input element.
445
onmouseup onselect placeholder readonly size style styleClass tabindex title
Name
onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover null null null false null null null null null null null null
Default
null String
Type
null null
String
String
String
String
String
String
String
String
Boolean
Integer
String
String
Integer
String
PrimeFaces User Guide
Description
Client side callback to execute when a key is pressed and released over input element.
Client side callback to execute when a key is released over input element.
Client side callback to execute when a pointer button is pressed down over input element
Client side callback to execute when a pointer button is moved within input element.
Client side callback to execute when a pointer button is moved away from input element.
Client side callback to execute when a pointer button is moved onto input element.
Client side callback to execute when a pointer button is released over input element.
Client side callback to execute when text within input element is selected by user.
Specifies a short hint.
Flag indicating that this component will prevent changes by the user.
Number of characters used to determine the width of the input element.
Inline style of the input element.
Style class of the input element.
Position of the input element in the tabbing order.
Advisory tooltip informaton.
Getting Started with Spinner
Spinner is an input component and used just like a standard input text.
public class SpinnerBean { private int number;
//getter and setter
}
<p:spinner value="#{spinnerBean.number}" />
446
PrimeFaces User Guide
Step Factor
Other than integers, spinner also support decimals so the fractional part can be controller with spinner as well. For decimals use the stepFactor attribute to specify stepping amount. Following example uses a stepFactor 0.25.
<p:spinner value="#{spinnerBean.number}" stepFactor="0.25"/> public class SpinnerBean { private double number;
//getter and setter
}
Output of this spinner would be;
After an increment happens a couple of times.
Prefix and Suffix
Prefix and Suffix options enable placing fixed strings on input field. Note that you would need to use a converter to avoid conversion errors since prefix/suffix will also be posted.
<p:spinner value="#{spinnerBean.number}" prefix="$" />
Boundaries
In order to restrict the boundary values, use min and max options.
<p:spinner value="#{spinnerBean.number}" min="0" max="100"/>
Ajax Spinner
Spinner can be ajaxified using client behaviors like f:ajax or p:ajax. In example below, an ajax request is done to update the outputtext with new value whenever a spinner button is clicked.
<p:spinner value="#{spinnerBean.number}">
<p:ajax update="display" />
</p:spinner>
<h:outputText id="display" value="#{spinnerBean.number}" />
447
PrimeFaces User Guide
Skinning
Spinner resides in a container element that using style and styleClass applies. Following is the list of structural style classes;
Class
.ui-spinner
.ui-spinner-input
.ui-spinner-button
.ui-spinner-button-up
.ui-spinner-button-down
Applies
Main container element of spinner
Input field
Spinner buttons
Increment button
Decrement button
As skinning style classes are global, see the main theming section for more information.
448
3.121 SplitButton
SplitButton displays a command by default and additional ones in an overlay.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
splitButton org.primefaces.component.splitbutton.SplitButton
org.primefaces.component.SplitButton
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.SplitButtonRenderer
Renderer Class
org.primefaces.component.splitbutton.SplitButtonRenderer
Attributes
Name
id rendered binding value action actionListener immediate type ajax
Default
null true null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Label for the button
A method expression or a String outcome that’d be processed when button is clicked.
null null
String
MethodExpr/
String null false
MethodExpr An actionlistener that’d be processed when button is clicked.
Boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
submit String true Boolean
Sets the behavior of the button.
Specifies the submit mode, when set to true(default), submit would be made with Ajax.
449
async process update onstart
Name
oncomplete onsuccess onerror global delay partialSubmit false resetValues false ignoreAutoUpdate false timeout style styleClass onblur onchange onclick ondblclick onfocus onkeydown null true null
Default
false
Type
Boolean null null null
String
String
String null null
String
String
String
Boolean
String
0 null null null null null null null null
Boolean
Boolean
Boolean
Integer
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
When set to true, ajax requests are not queued.
Component(s) to process partially instead of whole view.
Component(s) to be updated with ajax.
Client side callback to execute before ajax request is begins.
Client side callback to execute when ajax request is completed.
Client side callback to execute when ajax request succeeds.
Client side callback to execute when ajax request fails.
Defines whether to trigger ajaxStatus or not.
If less than delay milliseconds elapses between calls to
request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.
Enables serialization of values belonging to the partially processed components only.
If true, local values of input components to be updated within the ajax request would be reset.
If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
Timeout for the ajax request in milliseconds.
Inline style of the button element.
StyleClass of the button element.
Client side callback to execute when button loses focus.
Client side callback to execute when button loses focus and its value has been modified since gaining focus.
Client side callback to execute when button is clicked.
Client side callback to execute when button is double clicked.
Client side callback to execute when button receives focus.
Client side callback to execute when a key is pressed down over button.
450
onmouseup onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos widgetVar appendTo
Name
onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover false null null null null null false null left null null null null null null null null null null
Default
null
Type
String null null
String
String
String
String
String
Boolean
String
String
String
Integer
String
Boolean
String
String
String
String
String
String
String
String
String
PrimeFaces User Guide
Description
Client side callback to execute when a key is pressed and released over button.
Client side callback to execute when a key is released over button.
Client side callback to execute when a pointer button is pressed down over button.
Client side callback to execute when a pointer button is moved within button.
Client side callback to execute when a pointer button is moved away from button.
Client side callback to execute when a pointer button is moved onto button.
Client side callback to execute when a pointer button is released over button.
Client side callback to execute when text within button is selected by user.
Access key that when pressed transfers focus to the button.
Alternate textual description of the button.
Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.
Disables the button.
Style class for the button icon. (deprecated: use icon)
A localized user presentable name.
Code describing the language used in the generated markup for this component.
Position of the button element in the tabbing order.
Advisory tooltip information.
Flag indicating that this component will prevent changes by the user.
Icon of the button as a css class.
Position of the icon.
Name of the client side widget.
Appends the overlay to the element defined by search expression. Defaults to document body.
451
PrimeFaces User Guide
Getting started with SplitButton
SplitButton usage is similar to a regular commandButton. Additional commands are placed inside the component and displayed in an overlay. In example below, clicking the save button invokes save method of the bean and updates messages. Nested options defined as menuitems do ajax, non-ajax requests as well as regular navigation to an external url.
<p:splitButton value="Save" actionListener="#{buttonBean.save}" update="messages" icon="ui-icon-disk">
<p:menuitem value="Update" actionListener="#{buttonBean.update}" update="messages" icon="ui-icon-arrowrefresh-1-w"/>
<p:menuitem value="Delete" actionListener="#{buttonBean.delete}" ajax="false" icon="ui-icon-close"/>
<p:separator />
<p:menuitem value="Homepage" url=" http://www.primefaces.org
" icon="ui-icon-extlink"/>
</p:splitButton>
Client Side API
Widget: PrimeFaces.widget.SplitButton show()
Method
hide()
Params
-
-
Return Type
void void
Description
Displays overlay.
Hides overlay.
Skinning
SplitButton renders a container element which style and styleClass applies. Following is the list of structural style classes;
Style Class
.ui-splitbutton
.ui-button
.ui-splitbutton-menubutton
.ui-button-text-only
.ui-button-text
.ui-menu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Applies
Container element.
Button element
Dropdown button
Button element when icon is not used
Label of button
Container element of menu
List container
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
452
PrimeFaces User Guide
3.122 Submenu
Submenu is nested in menu components and represents a sub menu items.
Info
Tag
Component Class
submenu org.primefaces.component.submenu.Submenu
Component Type
org.primefaces.component.Submenu
Component Family
org.primefaces.component
Attributes
Name
id rendered binding label icon style styleClass null null null null null
Default
null true
Type
String
Boolean
Object
String
String
String
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Label of the submenu header.
Icon of a submenu, see menuitem to see how it is used
Inline style of the submenu.
Style class of the submenu.
Getting started with Submenu
Please see Menu or Menubar section to find out how submenu is used with the menus.
453
3.123 Stack
Stack is a navigation component that mimics the stacks feature in Mac OS X.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
stack org.primefaces.component.stack.Stack
org.primefaces.component.Stack
org.primefaces.component
org.primefaces.component.StackRenderer
org.primefaces.component.stack.StackRenderer
Attributes
Name
id rendered
Default
null true binding null icon null openSpeed 300 closeSpeed 300 widgetVar model expanded null null false
Type
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
String
Integer
An el expression that maps to a server side UIComponent instance in a backing bean.
An optional image to contain stacked items.
Speed of the animation when opening the stack.
Speed of the animation when opening the stack.
String Name of the client side widget.
MenuModel MenuModel instance to create menus programmatically
Boolean Whether to display stack as expanded or not.
454
PrimeFaces User Guide
Getting started with Stack
Each item in the stack is represented with menuitems. Stack below has five items with different icons and labels.
<p:stack icon="/images/stack/stack.png">
<p:menuitem value="Aperture" icon="/images/stack/aperture.png" url="#"/>
<p:menuitem value="Photoshop" icon="/images/stack/photoshop.png" url="#"/>
//...
</p:stack>
Initially stack will be rendered in collapsed mode;
Location
Stack is a fixed positioned element and location can be change via css. There’s one important css selector for stack called .ui-stack. Override this style to change the location of stack.
.ui-stack { bottom: 28px; right: 40px;
}
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.
Skinning
.ui-stack
.ui-stack ul li
.ui-stack ul li img
.ui-stack ul li span
Class Applies
Main container element of stack
Each item in stack
Icon of a stack item
Label of a stack item
455
PrimeFaces User Guide
3.124 Sticky
Sticky component positions other components as fixed so that these components stay in window viewport during scrolling.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
sticky org.primefaces.component.sticky.Sticky
org.primefaces.component.Sticky
org.primefaces.component
org.primefaces.component.StickyRenderer
org.primefaces.component.sticky.StickyRenderer
Attributes
Name
id rendered
Default
null true
Type
String
Boolean binding null Object target margin null
0
String
Integer
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean.
Component to make sticky.
Margin to the top of the page during fixed scrolling.
456
PrimeFaces User Guide
Getting started with Sticky
Sticky requires a target to keep in viewport on scroll. Here is a sticky toolbar;
<p:toolbar id="tb">
<p:toolbarGroup align="left">
<p:commandButton type="button" value="New" icon="ui-icon-document" />
<p:commandButton type="button" value="Open" icon="ui-icon-folder-open"/>
<p:separator />
<p:commandButton type="button" title="Print" icon="ui-icon-print"/>
</p:toolbarGroup>
</p:toolbar>
<p:commandButton type="button" title="Save" icon="ui-icon-disk"/>
<p:commandButton type="button" title="Delete" icon="ui-icon-trash"/>
<p:sticky target="tb" />
Skinning
There are no visual styles of sticky however, ui-sticky class is applied to the target when the position is fixed. When target is restored to its original location this is removed.
457
3.125 SubTable
SubTable is a helper component of datatable used for grouping.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
subTable org.primefaces.component.subtable.SubTable
org.primefaces.component.SubTable
org.primefaces.component
org.primefaces.component.SubTableRenderer
org.primefaces.component.subtable.SubTableRenderer
Attributes
Name
id rendered
Default
null true
Type
String
Boolean binding value var null null null
Object
Object
String
Getting started with SubTable
See DataTable section for more information.
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Data of the component.
Name of the data iterator.
458
3.126 SummaryRow
SummaryRow is a helper component of datatable used for dynamic grouping.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
summaryRow org.primefaces.component.summaryrow.SummaryRow
org.primefaces.component.SummaryRow
org.primefaces.component
org.primefaces.component.SummaryRowRenderer
org.primefaces.component.summaryrow.SummaryRowRenderer
Attributes
Name
id rendered
Default
null true binding listener null null
Type
String
Boolean
Object
MethodExpr
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side UIComponent instance in a backing bean
Method expression to execute before rendering summary row. (e.g. to calculate totals).
Getting started with SummaryRow
See DataTable section for more information.
459
PrimeFaces User Guide
3.127 Tab
Tab is a generic container component used by other PrimeFaces components such as tabView and accordionPanel.
Info
Tag
Component Class
Component Type
Component Family
tab org.primefaces.component.TabView.Tab
org.primefaces.component.Tab
org.primefaces.component
Attributes
Name
id rendered binding title titleStyle titleStyleClass disabled closable titletip
Default
null true
Type
String
Boolean null null null null false false null
Object
Boolean
String
String
Boolean
Boolean
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Title text of the tab
Inline style of the tab.
Style class of the tab.
Disables tab element.
Makes the tab closable when enabled.
Tooltip of the tab header.
Getting started with the Tab
See the sections of components who utilize tab component for more information. As tab is a shared component, not all attributes may apply to the components that use tab.
460
PrimeFaces User Guide
3.128 TabMenu
TabMenu is a navigation component that displays menuitems as tabs.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
tabMenu org.primefaces.component.tabmenu.TabMenu
org.primefaces.component.TabMenu
org.primefaces.component
org.primefaces.component.TabMenuRenderer
org.primefaces.component.tabmenu.TabMenuRenderer
Attributes
Name
id rendered binding model style styleClass activeIndex widgetVar null null null
0 null
Default
null true null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
MenuModel MenuModel instance to build menu dynamically.
String Inline style of the component.
String
Integer
String
Style class of the component.
Index of the active tab.
Name of the client side widget.
Getting started with TabMenu
TabMenu requires menuitems as children components, each menuitem is rendered as a tab. Just like in any other menu component, menuitems can be utilized to do ajax requests, non-ajax requests and simple GET navigations.
461
PrimeFaces User Guide
<p:tabMenu activeIndex="0">
<p:menuitem value="Overview" outcome="main" icon="ui-icon-star"/>
<p:menuitem value="Demos" outcome="demos" icon="ui-icon-search" />
<p:menuitem value="Documentation" outcome="docs" icon="ui-icon-document"/>
<p:menuitem value="Support" outcome="support" icon="ui-icon-wrench"/>
<p:menuitem value="Social" outcome="social" icon="ui-icon-person" />
</p:tabMenu>
Skinning TabMenu
TabMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Applies Style Class
.ui-tabmenu
.ui-tabmenu-nav
.ui-tabmenuitem
.ui-menuitem
Main container element.
Container for tabs.
Menuitem container.
Anchor of a menuitem.
As skinning style classes are global, see the main theming section for more information.
462
3.129 TabView
TabView is a container component to group content in tabs.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name
binding widgetVar activeIndex effect effectDuration dynamic
tabView org.primefaces.component. tabview.TabView
org.primefaces.component.TabView
org.primefaces.component
org.primefaces.component.TabViewRenderer
org.primefaces.component.tabview.TabViewRenderer
null
0 null null false
Default
null true null
Type
String
Boolean
Object
String
Integer
String
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean.
Variable name of the client side widget.
Index of the active tab.
Name of the transition effect.
Duration of the transition effect.
Enables lazy loading of inactive tabs.
463
cache
Name
onTabChange onTabShow onTabClose style styleClass var value orientation dir scrollable prependId null null null null null null null top ltr false
Default
true
Type
Boolean true
String
String
String
String
String
String
Object
String
String
Boolean
Boolean
PrimeFaces User Guide
Description
When tab contents are lazy loaded by ajax toggleMode, caching only retrieves the tab contents once and subsequent toggles of a cached tab does not communicate with server. If caching is turned off, tab contents are reloaded from server each time tab is clicked.
Client side callback to execute when a tab is clicked.
Client side callback to execute when a tab is shown.
Client side callback to execute on tab close.
Inline style of the main container.
Style class of the main container.
Name of iterator to refer an item in collection.
Collection model to display dynamic tabs.
Orientation of tab headers.
Defines text direction, valid values are ltr and rtl.
When enabled, tab headers can be scrolled horizontally instead of wrapping.
TabView is a naming container thus prepends its id to its children by default, a false value turns this behavior off except for dynamic tabs.
Getting started with the TabView
TabView requires one more child tab components to display. Titles can also be defined by using
“title” facet.
<p:tabView>
<p:tab title="Tab One">
<h:outputText value="Lorem" />
</p:tab>
<p:tab title="Tab Two">
<h:outputText value="Ipsum" />
</p:tab>
<p:tab title="Tab Three">
<h:outputText value="Dolor" />
</p:tab>
</p:tabView>
464
PrimeFaces User Guide
Dynamic Tabs
There’re two toggleModes in tabview, non-dynamic (default) and dynamic. By default, all tab contents are rendered to the client, on the other hand in dynamic mode, only the active tab contents are rendered and when an inactive tab header is selected, content is loaded with ajax. Dynamic mode is handy in reducing page size, since inactive tabs are lazy loaded, pages will load faster. To enable dynamic loading, simply set dynamic option to true.
<p:tabView dynamic="true">
//tabs
</p:tabView>
Content Caching
Dynamically loaded tabs cache their contents by default, by doing so, reactivating a tab doesn’t result in an ajax request since contents are cached. If you want to reload content of a tab each time a tab is selected, turn off caching by cache to false.
Effects
Content transition effects are controlled with effect and effectDuration attributes. EffectDuration specifies the speed of the effect, slow, normal (default) and fast are the valid options.
<p:tabView effect="fade" effectDuration="fast">
//tabs
</p:tabView>
Ajax Behavior Events
tabChange and tabClose are the ajax behavior events of tabview that are executed when a tab is changed and closed respectively. Here is an example of a tabChange behavior implementation;
<p:tabView>
<p:ajax event=”tabChange” listener=”#{bean.onChange}” />
//tabs
</p:tabView> public void onChange(TabChangeEvent event) {
//Tab activeTab = event.getTab();
//...
}
Your listener(if defined) will be invoked with an org.primefaces.event.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself. For tabClose event, listener will be passed an instance of org.primefaces.event.TabCloseEvent.
Dynamic Number of Tabs
When the tabs to display are not static, use the built-in iteration feature similar to ui:repeat.
465
<p:tabView value="#{bean.list}" var="listItem">
<p:tab title="#{listItem.propertyA}">
<h:outputText value= "#{listItem.propertyB}"/>
...More content
</p:tab>
</p:tabView>
Orientations
Four different orientations are available; top(default), left, right and bottom.
<p:tabView orientation="left">
//tabs
</p:tabView>
PrimeFaces User Guide
Scrollable Tabs
Tab headers wrap to the next line in case there is not enough space at header area by default. Using scrollable feature, it is possible to keep headers aligned horizontally and use navigation buttons to access hidden headers.
<p:tabView scrollable="true">
//tabs
</p:tabView>
Client Side Callbacks
Tabview has three callbacks for client side. onTabChange is executed when an inactive tab is clicked, onTabShow is executed when an inactive tab becomes active to be shown and onTabClose when a closable tab is closed. All these callbacks receive index parameter as the index of tab.
466
PrimeFaces User Guide
<p:tabView onTabChange="handleTabChange(index)">
//tabs
</p:tabView> function handleTabChange(i) {
//i = Index of the new tab
}
Client Side API
Widget: PrimeFaces.widget.TabView
Method
select(index)
Params
index: Index of tab to display
Return Type
void selectTab(index) index: Index of tab to display void disable(index) enable(index) remove(index) getLength() getActiveIndex() index: Index of tab to disable index: Index of tab to enable index: Index of tab to remove
-
void void void
Number
Number
Description
Activates tab with given index
(Deprecated, use select instead)
Activates tab with given index
Disables tab with given index
Enables tab with given index
Removes tab with given index
Returns the number of tabs
Returns index of current tab
Skinning
As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes.
Class
.ui-tabs
.ui-tabs-{orientation}
.ui-tabs-nav
.ui-tabs-panel
.ui-tabs-scrollable
Applies
Main tabview container element
Orientation specific (top, bottom, righ, left) container.
Main container of tab headers
Each tab container
Container element of a scrollable tabview.
467
PrimeFaces User Guide
3.130 TagCloud
TagCloud displays a collection of tag with different strengths.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
tagCloud org.primefaces.component.tagcloud.TagCloud
org.primefaces.component.TagCloud
org.primefaces.component
org.primefaces.component.TagCloudRenderer
org.primefaces.component.tagcloud.TagCloudRenderer
Attributes
Name
id rendered binding widgetVar model style styleClass null null null null
Default
null true null
String
Type
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
String Name of the client side widget.
TagCloudModel Backing tag cloud model.
String
String
Inline style of the container element.
Style class of the container element.
Getting started with the TagCloud
TagCloud requires a backend TagCloud model to display.
<p:tagCloud model="#{tagCloudBean.model}" />
468
PrimeFaces User Guide public class TagCloudBean {
private TagCloudModel model;
public TagCloudBean() {
model = new DefaultTagCloudModel();
model.addTag(new DefaultTagCloudItem("Transformers", "#", 1));
//more
}
//getter
}
Selecting Tags
An item is tagCloud can be selected using select ajax behavior. Note that only items with null urls can be selected.
<h:form>
<p:growl id="msg" showDetail="true" />
<p:tagCloud model="#{tagCloudBean.model}">
<p:ajax event="select" update="msg" listener="#{tagCloudBean.onSelect}" />
</p:tagCloud>
</h:form> public class TagCloudBean {
//model, getter and setter
public void onSelect(SelectEvent event) {
TagCloudItem item = (TagCloudItem) event.getObject();
FacesMessage msg = new FacesMessage(FacesMessage.SEVERITY_INFO,
"Item Selected", item.getLabel());
FacesContext.getCurrentInstance().addMessage(null, msg);
}
}
TagCloud API
org.primefaces.model.tagcloud.TagCloudModel
Method
List<TagCLoudItem> getTags() void addTag(TagCloudItem item) void removeTag(TagCloudItem item) void clear()
Returns all tags in model.
Adds a tag.
Removes a tag.
Removes all tags.
Description
PrimeFaces provides org.primefaces.model.tagcloud.DefaultTagCloudModel as the default implementation.
469
PrimeFaces User Guide
org.primefaces.model.tagcloud.TagCloudItem
Method
String getLabel()
String getUrl() int getStrength()
Description
Returns label of the tag.
Returns url of the tag.
Returns strength of the tag between 1 and 5.
org.primefaces.model.tagcloud.DefaultTagCloudItem is provided as the default implementation.
Skinning
TagCloud resides in a container element that style and styleClass attributes apply. .ui-tagcloud applies to main container and .ui-tagcloud-strength-[1,5] applies to each tag. As skinning style classes are global, see the main theming section for more information.
470
PrimeFaces User Guide
3.131 Terminal
Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
terminal org.primefaces.component.terminal.Terminal
org.primefaces.component.Terminal
org.primefaces.component
org.primefaces.component.TerminalRenderer
org.primefaces.component.terminal.TerminalRenderer
Attributes
Name
id rendered binding style styleClass welcomeMessage prompt commandHandler widgetVar
Default
null true null
Type
String
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean null null null
String
String
String
Inline style of the component.
Style class of the component.
Welcome message to be displayed on initial load.
prime $ String null MethodExpr
Primary prompt text.
Method to be called with arguments to process.
null String Name of the client side widget.
471
PrimeFaces User Guide
Getting started with the Terminal
A command handler is required to interpret commands entered in terminal.
<p:terminal commandHandler="#{terminalBean.handleCommand}" /> public class TerminalBean { public String handleCommand(String command, String[] params) { if(command.equals("greet")) return "Hello " + params[0]; else if(command.equals("date")) return new Date().toString(); else return command + " not found";
}
}
Whenever a command is sent to the server, handleCommand method is invoked with the command name and the command arguments as a String array.
Client Side API
Client side widget exposes clear() and focus() methods. Following shows how to add focus on a terminal nested inside a dialog;
<p:commandButton type="button" Value="Apply Focus" onclick="PF(
' term
'
).focus();"/>
<p:terminal widgetVar="term" commandHandler="#{terminalBean.handleCommand}" />
Skinning
Terminal resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-terminal
.ui-terminal-content
.ui-terminal-prompt
Applies
Main container element.
Content display of previous commands with responses.
Prompt text.
472
PrimeFaces User Guide
3.132 ThemeSwitcher
ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh.
binding widgetVar effect effectSpeed disabled label onchange style styleClass
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
themeSwitcher org.primefaces.component.themeswitcher.ThemeSwitcher
org.primefaces.component.ThemeSwitcher
org.primefaces.component
org.primefaces.component.ThemeSwitcherRenderer
org.primefaces.component.themeswitcher.ThemeSwitcherRenderer
Attributes
Name
id rendered false null null null null null null fade normal null
Default
true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
String
String
String
Name of the client side widget.
Name of the animation.
Duration of the toggle animation, valid values are
"slow", "normal" and "fast".
Boolean Disables the component.
String User presentable name.
String
String
String
Client side callback to execute on theme change.
Inline style of the component.
Style class of the component.
473
Name
var height tabindex null
Default
null null
Type
String
Integer
Integer
PrimeFaces User Guide
Description
Variable name to refer to each item.
Height of the panel.
Position of the element in the tabbing order.
Getting Started with the ThemeSwitcher
ThemeSwitcher usage is very similar to selectOneMenu.
<p:themeSwitcher style="width:150px">
<f:selectItem itemLabel="Choose Theme" itemValue="" />
<f:selectItems value="#{bean.themes}" />
</p:themeSwitcher>
Stateful ThemeSwitcher
By default, themeswitcher just changes the theme on the fly with no page refresh, in case you’d like to get notified when a user changes the theme (e.g. to update user preferences), you can use an ajax behavior.
<p:themeSwitcher value="#{bean.theme}" effect="fade">
<f:selectItem itemLabel="Choose Theme" itemValue="" />
<f:selectItems value="#{themeSwitcherBean.themes}" />
<p:ajax listener="#{bean.saveTheme}" />
</p:themeSwitcher>
Advanced ThemeSwitcher
ThemeSwitcher supports displaying custom content so that you can show theme previews.
<p:themeSwitcher>
<f:selectItem itemLabel="Choose Theme" itemValue="" />
<f:selectItems value="#{themeSwitcherBean.advancedThemes}" var="theme" itemLabel="#{theme.name}" itemValue="#{theme}"/>
<p:column>
<p:graphicImage value="/images/themes/#{t.image}"/>
</p:column>
<p:column>
#{t.name}
</p:column>
</p:themeSwitcher>
474
PrimeFaces User Guide
3.133 TieredMenu
TieredMenu is used to display nested submenus with overlays.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
tieredMenu org.primefaces.component.tieredmenu.TieredMenu
org.primefaces.component.TieredMenu
org.primefaces.component
org.primefaces.component.TieredMenuRenderer
org.primefaces.component.tieredmenu.TieredMenuRenderer
Attributes
Name
id rendered
Default
null true
String
Boolean
Type
binding null widgetVar model style styleClass autoDisplay null null null null true
Object
String
MenuModel
String
String
Boolean trigger my at null null null
String
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
MenuModel instance for programmatic menu.
Inline style of the component.
Style class of the component.
Defines whether the first level of submenus will be displayed on mouseover or not. When set to false, click event is required to display.
Id of the component whose triggerEvent will show the dynamic positioned menu.
Corner of menu to align with trigger element.
Corner of trigger to align with menu element.
475
Name
overlay
Default
false Boolean
Type
triggerEvent click String toggleEvent hover String
PrimeFaces User Guide
Description
Defines positioning, when enabled menu is displayed with absolute position relative to the trigger. Default is false, meaning static positioning.
Event name of trigger that will show the dynamic positioned menu.
Event to toggle the submenus, valid values are
"hover" and "click".
Getting started with the TieredMenu
TieredMenu consists of submenus and menuitems, submenus can be nested and each nested submenu will be displayed in an overlay.
<p:tieredMenu>
<p:submenu label="Ajax Menuitems" icon="ui-icon-refresh">
<p:menuitem value="Save" actionListener="#{buttonBean.save}" update="messages" icon="ui-icon-disk" />
<p:menuitem value="Update" actionListener="#{buttonBean.update}" update="messages" icon="ui-icon-arrowrefresh-1-w" />
</p:submenu>
<p:submenu label="Non-Ajax Menuitem" icon="ui-icon-newwin">
<p:menuitem value="Delete" actionListener="#{buttonBean.delete}" update="messages" ajax="false" icon="ui-icon-close"/>
</p:submenu>
<p:separator />
<p:submenu label="Navigations" icon="ui-icon-extlink">
<p:submenu label="Prime Links">
<p:menuitem value="Prime" url="http://www.prime.com.tr" />
<p:menuitem value="PrimeFaces" url="http://www.primefaces.org" />
</p:submenu>
<p:menuitem value="Mobile" url="/mobile" />
</p:submenu>
</p:tieredMenu>
AutoDisplay
By default, submenus are displayed when mouse is over root menuitems, set autoDisplay to false to require a click on root menuitems to enable autoDisplay mode.
<p:tieredMenu autoDisplay="false">
//content
</p:tieredMenu>
476
PrimeFaces User Guide
Overlay
TieredMenu can be positioned relative to a trigger component, following sample attaches a tieredMenu to the button so that whenever the button is clicked tieredMenu will be displayed in an overlay itself.
<p:commandButton type="button" value="Show" id="btn" />
<p:tieredMenu autoDisplay="false" trigger="btn" my="left top" at="left bottom">
//content
</p:tieredMenu>
Client Side API
Widget: PrimeFaces.widget.TieredMenu
Method
show() hide() align()
Params
-
-
void void void
Return Type Description
Shows overlay menu.
Hides overlay menu.
Aligns overlay menu with trigger.
Skinning
TieredMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class
.ui-menu .ui-tieredmenu
.ui-menu-list
.ui-menuitem
.ui-menuitem-link
.ui-menuitem-text
Container element of menu.
List container
Applies
Each menu item
Anchor element in a link item
Text element in an item
As skinning style classes are global, see the main theming section for more information.
477
3.134 Toolbar
Toolbar is a horizontal grouping component for commands and other content.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
toolbar org.primefaces.component.toolbar.Toolbar
org.primefaces.component.Toolbar
org.primefaces.component
org.primefaces.component.ToolbarRenderer
org.primefaces.component.toolbar.ToolbarRenderer
Attributes
Name
id rendered binding style styleClass null null null null true
Default Type Description
String
Object
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
String
String
Inline style of the container element.
Style class of the container element.
Getting Started with the Toolbar
Toolbar has two placeholders(left and right) that are defined with facets. You can also use toolbarGroup as an alternative to facets.
<p:toolbar>
<f:facet name="left"></f:facet>
<f:facet name="right"></f:facet>
</p:toolbar>
Any content can be placed inside toolbar.
478
PrimeFaces User Guide
<p:toolbar>
<f:facet name="left">
<p:commandButton type="push" value="New" image="ui-icon-document" />
<p:commandButton type="push" value="Open" image="ui-icon-folder-open"/>
<span class="ui-separator">
<span class="ui-icon ui-icon-grip-dotted-vertical" />
</span>
<p:commandButton type="push" title="Save" image="ui-icon-disk"/>
<p:commandButton type="push" title="Delete" image="ui-icon-trash"/>
<p:commandButton type="push" title="Print" image="ui-icon-print"/>
</f:facet>
<f:facet name="right">
<p:menuButton value="Navigate">
<p:menuitem value="Home" url="#" />
<p:menuitem value="Logout" url="#" />
</p:menuButton>
</f:facet>
</p:toolbar>
Skinning
Toolbar resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-toolbar
.ui-toolbar .ui-separator
.ui-toolbar-group-left
.ui-toolbar-group-right
Applies
Main container
Divider in a toolbar
Left toolbarGroup container
Right toolbarGroup container
As skinning style classes are global, see the main theming section for more information.
479
PrimeFaces User Guide
3.135 ToolbarGroup
ToolbarGroup is a helper component for Toolbar component to define placeholders.
Info
Tag
Component Class
Component Type
Component Family
toolbarGroup org.primefaces.component.toolbar.ToolbarGroup
org.primefaces.component.ToolbarGroup
org.primefaces.component
Attributes
Name
id rendered binding align style styleClass null true
Default
null null null null
Type Description
String Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
String
String
String
Defines the alignment within toolbar, valid values are left and right.
Inline style of the container element.
Style class of the container element.
Getting Started with the ToolbarGroup
See toolbar documentation for more information about how Toolbar Group is used.
480
PrimeFaces User Guide
3.136 Tooltip
Tooltip goes beyond the legacy html title attribute by providing custom effects, events, html content and advance theme support.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
Name
id rendered binding value converter widgetVar showEvent showEffect hideEvent hideEffect showDelay
tooltip org.primefaces.component.tooltip.Tooltip
org.primefaces.component.Tooltip
org.primefaces.component
org.primefaces.component.TooltipRenderer
org.primefaces.component.tooltip.TooltipRenderer
Default
null true null null null null String mouseover String fade String mouseout String fade
150
String
Integer
Type
String
Boolean
Object
Object
Converter/
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component than can be either an EL expression of a literal text
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id
Name of the client side widget.
Event displaying the tooltip.
Effect to be used for displaying.
Event hiding the tooltip.
Effect to be used for hiding.
Delay time to show tooltip in milliseconds.
481
Name
hideDelay for style styleClass globalSelector escape trackMouse
Default
0 null null null null
Type
Integer
String
String
String
String true false
Boolean
Boolean
PrimeFaces User Guide
Description
Delay time to hide tooltip in milliseconds.
Component to attach the tooltip.
Inline style of the tooltip.
Style class of the tooltip.
jquery selector for global tooltip, defaults to
"a,:input,:button".
Defines whether html would be escaped or not.
Tooltip position follows pointer on mousemove.
Getting started with the Tooltip
Tooltip can be used by attaching it to a target component. Tooltip value can also be retrieved from target’s title, so following are same;
<h:inputSecret id="pwd" value="#{myBean.password}" />
<p:tooltip for="pwd" value="Only numbers"/>
<h:inputSecret id="pwd" value="#{myBean.password}" title="Only numbers"/>
<p:tooltip for="pwd"/>
Global Tooltip
Global tooltip binds to elements with title attributes. Ajax updates are supported as well, meaning if target component is updated with ajax, tooltip can still bind. As global tooltips are more efficient since only one instance of tooltip is used across all tooltip targets, it is suggested to be used instead of explicit tooltips unless you have a custom case e.g. different options, custom content.
<p:tooltip />
<p:inputText id="focus" title="Tooltip for an input"/>
<h:outputLink id="fade" value="#" title="Tooltip for a link">
<h:outputText value="Fade Effect" />
</h:outputLink>
<p:commandButton value="Up" title="Up" />
IE10 Issue
Due to a bug, IE10 always displays the title text in a native popup when the element receives focus via tabbing and two tooltips might be displayed at once. Solution is to use passthrough data-tooltip attribute instead of title.
482
PrimeFaces User Guide
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:h="http://xmlns.jcp.org/jsf/html"
xmlns:pt="http://xmlns.jcp.org/jsf/passthrough"
xmlns:p="http://primefaces.org/ui">
<h:head></h:head>
<h:body>
<p:inputText pt:data-tooltip="Title here"/>
<p:inputText title="Works fine except tabbed on IE10"/>
</h:body>
</html>
Events and Effects
A tooltip is shown on mouseover event and hidden when mouse is out by default. If you need to change this behavior use the showEvent and hideEvent feature. Tooltip below is displayed when the input gets the focus and hidden with onblur.
<h:inputSecret id="pwd" value="#{myBean.password}" />
<p:tooltip for="pwd" value="Password must contain only numbers" showEvent="focus" hideEvent="blur" showEffect="blind" hideEffect="explode" />
Available options for effects are; blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate,
scale, shake, size and slide.
Html Content
Another powerful feature of tooltip is the ability to display custom content as a tooltip.
<h:outputLink id="lnk" value="#">
<h:outputText value="PrimeFaces Home" />
</h:outputLink>
<p:tooltip for="lnk">
<p:graphicImage value="/images/prime_logo.png" />
<h:outputText value="Visit PrimeFaces Home" />
</p:tooltip>
Skinning
Tooltip has only .ui-tooltip as a style class and is styled with global skinning selectors, see main skinning section for more information.
483
3.137 Tree
Tree is used for displaying hierarchical data and creating site navigations.
PrimeFaces User Guide
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name tree org.primefaces.component.tree.Tree
org.primefaces.component.Tree
org.primefaces.component
org.primefaces.component.TreeRenderer
org.primefaces.component.tree.TreeRenderer
binding widgetVar value var dynamic cache onNodeClick selection
Default
null true
Type
String
Boolean null null null null false true null null
Object
String
Object
String
Boolean
Boolean
String
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Name of the client side widget.
A TreeNode instance as the backing model.
Name of the request-scoped variable that'll be used to refer each treenode data.
Specifies the ajax/client toggleMode
Specifies caching on dynamically loaded nodes.
When set to true expanded nodes will be kept in memory.
Javascript event to process when a tree node is clicked.
TreeNode array to reference the selections.
484
style styleClass selectionMode highlight datakey animate orientation propagateSelectionUp propagateSelectionDown dir draggable droppable dragdropScope dragMode required
Name
dropRestrict requiredMessage
Default
null null null true
Type
String
String
String
Boolean null false vertical true true ltr false false null self none false null
Object
Boolean
String
Boolean
Boolean
String
Boolean
Boolean
String
String
String
Boolean
String
PrimeFaces User Guide
Description
Style of the main container element of tree
Style class of the main container element of tree
Defines the selectionMode
Highlights nodes on hover when selection is enabled.
Unique key of the data presented by nodes.
When enabled, displays slide effect on toggle.
Orientation of layout, vertical or horizontal.
Defines upwards selection propagation for checkbox mode.
Defines downwards selection propagation for checkbox mode.
Defines text direction, valid values are ltr and rtl.
Makes tree nodes draggable.
Makes tree droppable.
Scope key to group a set of tree components for transferring nodes using drag and drop.
Defines parent-child relationship when a node is dragged, valid values are self (default), parent and ancestor.
Defines parent-child restrictions when a node is dropped valid values are none (default) and sibling.
Validation constraint for selection.
Message for required selection validation.
Getting started with the Tree
Tree is populated with a org.primefaces.model.TreeNode instance which corresponds to the root.
<p:tree value="#{treeBean.root}" var="node">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
485
public class TreeBean { private TreeNode root; public TreeBean() { root = new TreeNode("Root", null);
TreeNode node0 = new TreeNode("Node 0", root);
TreeNode node1 = new TreeNode("Node 1", root);
TreeNode node2 = new TreeNode("Node 2", root);
TreeNode node00 = new TreeNode("Node 0.0", node0);
TreeNode node01 = new TreeNode("Node 0.1", node0);
TreeNode node10 = new TreeNode("Node 1.0", node1);
TreeNode node11 = new TreeNode("Node 1.1", node1);
TreeNode node000 = new TreeNode("Node 0.0.0", node00);
TreeNode node001 = new TreeNode("Node 0.0.1", node00);
TreeNode node010 = new TreeNode("Node 0.1.0", node01);
TreeNode node100 = new TreeNode("Node 1.0.0", node10);
}
//getter of root
}
PrimeFaces User Guide
TreeNode vs p:TreeNode
TreeNode API is used to create the node model and consists of org.primefaces.model.TreeNode i ns t a nc e s , on t h e o t he r h a n d <p:treeNode /> represents a component of type
org.primefaces.component.tree.UITreeNode. You can bind a TreeNode to a particular p:treeNode using the type name. Document Tree example in upcoming section demonstrates a sample usage.
TreeNode API
TreeNode has a simple API to use when building the backing model. For example if you call node.setExpanded(true) on a particular node, tree will render that node as expanded.
Property
type data children parent expanded
Type
String
Object
List<TreeNode>
TreeNode
Boolean
Description
type of the treeNode name, default type name is "default".
Encapsulated data
List of child nodes
Parent node
Flag indicating whether the node is expanded or not
486
PrimeFaces User Guide
Dynamic Tree
Tree is non-dynamic by default and toggling happens on client-side. In order to enable ajax toggling set dynamic setting to true.
<p:tree value="#{treeBean.root}" var="node" dynamic="true">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
Non-Dynamic: When toggling is set to client all the treenodes in model are rendered to the client and tree is created, this mode is suitable for relatively small datasets and provides fast user interaction. On the otherhand it’s not suitable for large data since all the data is sent to the client also client side tree is stateless.
Dynamic: Dynamic mode uses ajax to fetch the treenodes from server side on demand, compared to the client toggling, dynamic mode has the advantage of dealing with large data because only the child nodes of the root node is sent to the client initially and whole tree is lazily populated. When a node is expanded, tree only loads the children of the particular expanded node and send to the client for display.
Multiple TreeNode Types
It’s a common requirement to display different TreeNode types with a different UI (eg icon).
Suppose you’re using tree to visualize a company with different departments and different employees, or a document tree with various folders, files each having a different formats (music, video). In order to solve this, you can place more than one <p:treeNode /> components each having a different type and use that "type" to bind TreeNode’s in your model. Following example demonstrates a document explorer. Here is the final output to achieve;
Document Explorer is implemented with four different <p:treeNode /> components and additional
CSS skinning to visualize expanded/closed folder icons.
487
<p:tree value="#{bean.root}" var="doc">
<p:treeNode expandedIcon="ui-icon ui-icon-folder-open" collapsedIcon="ui-icon ui-icon-folder-collapsed">
<h:outputText value="#{doc.name}"/>
</p:treeNode>
<p:treeNode type="document" icon="ui-icon ui-icon-document">
<h:outputText value="#{doc.name}" />
</p:treeNode>
<p:treeNode type="picture" icon="ui-icon ui-icon-image">
<h:outputText value="#{doc.name}" />
</p:treeNode>
<p:treeNode type="mp3" icon="ui-icon ui-icon-video">
<h:outputText value="#{doc.name}" />
</p:treeNode>
</p:tree>
PrimeFaces User Guide
488
PrimeFaces User Guide public class Bean {
private TreeNode root;
public Bean() {
root = new TreeNode("root", null);
TreeNode documents = new TreeNode("Documents", root);
TreeNode pictures = new TreeNode("Pictures", root);
TreeNode music = new TreeNode("Music", root);
TreeNode work = new TreeNode("Work", documents);
TreeNode primefaces = new TreeNode("PrimeFaces", documents);
//Documents
TreeNode expenses = new TreeNode("document", "Expenses.doc", work);
TreeNode resume = new TreeNode("document", "Resume.doc", work);
TreeNode refdoc = new TreeNode("document", "RefDoc.pages", primefaces);
//Pictures
TreeNode barca = new TreeNode("picture", "barcelona.jpg", pictures);
TreeNode primelogo = new TreeNode("picture", "logo.jpg", pictures);
TreeNode optimus = new TreeNode("picture", "optimus.png", pictures);
//Music
TreeNode turkish = new TreeNode("Turkish", music);
TreeNode cemKaraca = new TreeNode("Cem Karaca", turkish);
TreeNode erkinKoray = new TreeNode("Erkin Koray", turkish);
TreeNode mogollar = new TreeNode("Mogollar", turkish);
TreeNode nemalacak = new TreeNode("mp3", "Nem Alacak Felek Benim", cemKaraca);
TreeNode resimdeki = new TreeNode("mp3", "Resimdeki Goz Yaslari", cemKaraca);
TreeNode copculer = new TreeNode("mp3", "Copculer", erkinKoray);
TreeNode oylebirgecer = new TreeNode("mp3", "Oyle Bir Gecer", erkinKoray);
TreeNode toprakana = new TreeNode("mp3", "Toprak Ana", mogollar);
TreeNode bisiyapmali = new TreeNode("mp3", "Bisi Yapmali", mogollar);
}
//getter of root
}
Integration between a TreeNode and a p:treeNode is the type attribute, for example music files in document explorer are represented using TreeNodes with type "mp3", there’s also a p:treeNode component with same type "mp3". This results in rendering all music nodes using that particular p:treeNode representation which displays a note icon. Similarly document and pictures have their own p:treeNode representations.
Folders on the other hand have two states whose icons are defined by expandedIcon and
collapsedIcon attributes.
Ajax Behavior Events
Tree provides various ajax behavior events.
489
Event
expand collapse select collapse
PrimeFaces User Guide
Listener Parameter
org.primefaces.event.NodeExpandEvent
Fired
When a node is expanded.
org.primefaces.event.NodeCollapseEvent
When a node is collapsed.
org.primefaces.event.NodeSelectEvent
When a node is selected.
org.primefaces.event.NodeUnselectEvent
When a node is unselected.
Following tree has three listeners;
<p:tree value="#{treeBean.model}" dynamic="true">
<p:ajax event="select" listener="#{treeBean.onNodeSelect}" />
<p:ajax event="expand" listener="#{treeBean.onNodeExpand}" />
<p:ajax event="collapse" listener="#{treeBean.onNodeCollapse}" />
...
</p:tree> public void onNodeSelect(NodeSelectEvent event) {
String node = event.getTreeNode().getData().toString();
} public void onNodeExpand(NodeExpandEvent event) {
String node = event.getTreeNode().getData().toString();
} public void onNodeCollapse(NodeCollapseEvent event) {
String node = event.getTreeNode().getData().toString();
}
Event listeners are also useful when dealing with huge amount of data. The idea for implementing such a use case would be providing only the root and child nodes to the tree, use event listeners to get the selected node and add new nodes to that particular tree at runtime.
Selection
Node selection is a built-in feature of tree and it supports three different modes. Selection should be a TreeNode for single case and an array of TreeNodes for multiple and checkbox cases, tree finds the selected nodes and assign them to your selection model.
single: Only one at a time can be selected, selection should be a TreeNode reference.
multiple: Multiple nodes can be selected, selection should be a TreeNode[] reference.
checkbox: Multiple selection is done with checkbox UI, selection should be a TreeNode[] reference.
<p:tree value="#{treeBean.root}" var="node" selectionMode="checkbox" selection="#{treeBean.selectedNodes}">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
490
PrimeFaces User Guide public class TreeBean { private TreeNode root; private TreeNode[] selectedNodes; public TreeBean() { root = new CheckboxTreeNode("Root", null);
//populate nodes
}
//getters and setters
}
That’s it, now the checkbox based tree looks like below. When the form is submitted with a command component like a button, selected nodes will be populated in selectedNodes property of
TreeBean. As checkbox selection have a special hierarchy, use CheckboxTreeNode instead.
Node Caching
When caching is turned on by default, dynamically loaded nodes will be kept in memory so reexpanding a node will not trigger a server side request. In case it’s set to false, collapsing the node will remove the children and expanding it later causes the children nodes to be fetched from server again.
Handling Node Click
If you need to execute custom javascript when a treenode is clicked, use the onNodeClick attribute.
Your javascript method will be invoked with passing the html element of the node and the click
event as parameters. In case you have datakey defined, you can access datakey on client side by using node.attr(‘data-datakey’) that represents the data represented by the backing tree model.
DragDrop
Tree nodes can be reordered within a single tree and can even be transferred between multiple trees using dragdrop. For a single tree enable draggable and droppable options.
<p:tree value="#{treeBean.root}" var="node" draggable="true" droppable="true">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
For multiple trees, use a scope attribute to match them and configure dragdrop options depending on your case, following example has 2 trees where one is the source and other is the target. Target can also be reordered within itself.
491
PrimeFaces User Guide
<p:tree value="#{treeBean.root1}" var="node" draggable="true" droppable="false" dragdropScope="myscope">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
<p:tree value="#{treeBean.root2}" var="node" draggable="true" droppable="true" dragdropScope="myscope">
<p:treeNode>
<h:outputText value="#{node}"/>
</p:treeNode>
</p:tree>
Two additional options exist for further configuration, dragMode defines the target node that would be dropped, default value is self and other values are parent and ancestor. dropRestrict on the other hand, can restrict the drop target to be within the parent by setting it to sibling.
Horizontal Tree
Default orientation of tree is vertical, setting it to horizontal displays nodes in an horizontal layout.
All features of vertical tree except dragdrop is available for horizontal tree as well.
492
PrimeFaces User Guide
ContextMenu
Tree has special integration with context menu, you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type. Note that selection must be enabled in tree component for context menu integration.
<p:contextMenu for="tree">
<p:menuitem value="View" update="messages" actionListener="#{bean.view}" icon="ui-icon-search" />
<p:menuitem value="View" update="tree" actionListener="#{bean.delete}" icon="ui-icon-close" />
</p:contextMenu>
<p:tree id="tree" value="#{bean.root}" var="node" selectionMode="single" selection="#{bean.selectedNode}">
<p:treeNode>
<h:outputText value="#{node}" />
</p:treeNode>
</p:tree>
Skinning
Tree resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
Style Class
.ui-tree
.ui-tree-container
.ui-treenode
.ui-treenode-content
.ui-treenode-icon
.ui-tree-toggler
.ui-treenode-label
.ui-treenode-parent
.ui-treenode-leaf
Main container
Root node container.
Tree node
Tree node content
Tree node icon
Toggle icon
Tree node label
Nodes with children
Nodes without children
Applies
As skinning style classes are global, see the main theming section for more information.
493
PrimeFaces User Guide
3.138 TreeNode
TreeNode is used with Tree component to represent a node in tree.
Info
Tag
Component Class
Component Type
Component Family
treeNode org.primefaces.component.tree.UITreeNode
org.primefaces.component.UITreeNode
org.primefaces.component
Attributes
id rendered
Name
binding type styleClass icon expandedIcon collapsedIcon
Default
null true
Type
String
Boolean null Object default String null null
String
String null null
String
String
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Type of the tree node
Style class to apply a particular tree node type
Icon of the node.
Expanded icon of the node.
Collapsed icon of the node.
Getting started with the TreeNode
TreeNode is used by Tree and TreeTable components, refer to sections of these components for more information.
494
3.139 TreeTable
Treetable is is used for displaying hierarchical data in tabular format.
PrimeFaces User Guide binding value var widgetVar style styleClass selection
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
Attributes
id rendered
Name treeTable org.primefaces.component.treetable.TreeTable
org.primefaces.component.TreeTable
org.primefaces.component
org.primefaces.component.TreeTableRenderer
org.primefaces.component.treetable.TreeTableRenderer
null null null null null null null
Default
null true
Type
String
Boolean
Object
Object
String
String
String
String
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
A TreeNode instance as the backing model.
Name of the request-scoped variable used to refer each treenode.
Name of the client side widget.
Inline style of the container element.
Style class of the container element.
Selection reference.
495
resizableColumns rowStyleClass liveResize required requiredMessage sortBy sortOrder sortFunction nativeElements dataLocale caseSensitiveSort
Name
selectionMode scrollable scrollHeight scrollWidth tableStyle tableStyleClass emptyMessage
PrimeFaces User Guide
Default
null false null null null null
No records found false null false
Type
String
Boolean
Integer
Integer
String
String
String
Description
Type of selection mode.
Whether or not the data should be scrollable.
Height of scrollable data.
Width of scrollable data.
Inline style of the table element.
Style class of the table element.
Text to display when there is no data to display.
false null
Boolean
String
Boolean
Boolean
String null ValueExpr ascending String null false null false
Defines if colums can be resized or not.
Style class for each row.
Columns are resized live in this mode without using a resize helper.
Validation constraint for selection.
Message for required selection validation.
Expression for default sorting.
Defines default sorting order.
MethodExpr Custom pluggable sortFunction for default sorting.
Boolean In native mode, treetable uses native checkboxes.
Object Locale to be used in features such as sorting, defaults to view locale.
Boolean Case sensitivity for sorting, insensitive by default.
Getting started with the TreeTable
Similar to the Tree, TreeTable is populated with an org.primefaces.model.TreeNode instance that corresponds to the root node. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. For an example, model to be displayed is a collection of documents similar as in tree section.
496
PrimeFaces User Guide public class Document { private String name; private String size; private String type;
//getters, setters
}
<p:treeTable value="#{bean.root}" var="document">
<p:column>
<f:facet name="header">
Name
</f:facet>
<h:outputText value="#{document.name}" />
</p:column>
//more columns
</p:treeTable>
Selection
Node selection is a built-in feature of tree and it supports two different modes. Selection should be a
TreeNode for single case and an array of TreeNodes for multiple case, tree finds the selected nodes and assign them to your selection model.
single: Only one at a time can be selected, selection should be a TreeNode reference.
multiple or checkbox: Multiple nodes can be selected, selection should be a TreeNode[] reference.
As checkbox selection have a special hierarchy, use CheckboxTreeNode in checkbox mode.
Ajax Behavior Events
TreeTable provides various ajax behavior events to respond user actions.
Event
expand collapse select unselect colResize
Listener Parameter
org.primefaces.event.NodeExpandEvent
Fired
When a node is expanded.
org.primefaces.event.NodeCollapseEvent
When a node is collapsed.
org.primefaces.event.NodeSelectEvent
When a node is selected.
org.primefaces.event.NodeUnselectEvent
When a node is unselected.
org.primefaces.event.ColumnResizeEvent
When a column is resized.
ContextMenu
TreeTable has special integration with context menu, you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type.
497
PrimeFaces User Guide
Scrolling
Scrollable TreeTable implementation is same as DataTable Scrollable, refer to scrolling part in
DataTable section for detailed information.
Sorting
Sorting is enabled by setting sortBy expressions at column level.
<p:treeTable value="#{bean.root}" var="document">
<p:column sortBy="#{document.name}">
<h:outputText value="#{document.name}" />
</p:column>
//more columns
</p:treeTable>
In case you'd like to display treeTable as sorted on page load use sortBy attribute of treeTable, optional sortOrder and sortFunction attributes are provided to define the default sort order
(ascending or descinding) and a java method to do the actual sorting respectively. Refer to datatable sorting section for an example usage of sortFunction.
Skinning
TreeTable content resides in a container element which style and styleClass attributes apply.
Following is the list of structural style classes;
.ui-treetable
.ui-treetable-header
.ui-treetable-data
Class Applies
Main container element.
Header of treetable.
Body element of the table containing data
As skinning style classes are global, see the main theming section for more information.
498
PrimeFaces User Guide
3.140 Watermark
Watermark displays a hint on an input field.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
watermark org.primefaces.component.watermark.Watermark
org.primefaces.component.Watermark
org.primefaces.component
org.primefaces.component.WatermarkRenderer
org.primefaces.component.watermark.WatermarkRenderer
Attributes
Name
id rendered binding value for null null null
Default
null true
String
Boolean
Type
Object
Object
String
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Text of watermark.
Component to attach the watermark
Getting started with Watermark
Watermark requires a target of the input component. In case you don't need to support legacy browsers, prefer placeholder attribute of input components over watermark.
<h:inputText id="txt" value="#{bean.searchKeyword}" />
<p:watermark for="txt" value="Search with a keyword" />
499
PrimeFaces User Guide
Form Submissions
Watermark is set as the text of an input field which shouldn’t be sent to the server when an enclosing for is submitted. This would result in updating bean properties with watermark values.
Watermark component is clever enough to handle this case, by default in non-ajax form submissions, watermarks are cleared. However ajax submissions requires a little manual effort.
Please note that this only applies to legacy browsers, as watermark uses HTML5 placeholder option when available.
<h:inputText id="txt" value="#{bean.searchKeyword}" />
<p:watermark for="txt" value="Search with a keyword" />
<p:commandButton value="Submit" onclick="PrimeFaces.cleanWatermarks()" oncomplete="PrimeFaces.showWatermarks()" />
Skinning
For browsers that do not support placeholder, there’s only one css style class applying watermark which is ‘.ui-watermark’, you can override this class to bring in your own style.
500
PrimeFaces User Guide
3.141 Wizard
Wizard provides an ajax enhanced UI to implement a workflow easily in a single page. Wizard consists of several child tab components where each tab represents a step in the process.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
wizard org.primefaces.component.wizard.Wizard
org.primefaces.component.Wizard
org.primefaces.component
org.primefaces.component.WizardRenderer
org.primefaces.component.wizard.WizardRenderer
Attributes
id
Name
rendered binding step style styleClass flowListener showNavBar
Default
null true null
0 null null null true showStepStatus true
Type
String
Boolean
Description
Unique identifier of the component.
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Id of the current step in flow
String
String
Style of the main wizard container element.
Style class of the main wizard container element.
MethodExpr Server side listener to invoke when wizard attempts to go forward or back.
Boolean
Boolean
Specifies visibility of default navigator arrows.
Specifies visibility of default step title bar.
501
Name
onback onnext nextLabel backLabel widgetVar
Default
null
Type
String null null null null
String
String
String
String
PrimeFaces User Guide
Description
Javascript event handler to be invoked when flow goes back.
Javascript event handler to be invoked when flow goes forward.
Label of next navigation button.
Label of back navigation button.
Name of the client side widget
Getting Started with Wizard
Each step in the flow is represented with a tab. As an example following wizard is used to create a new user in a total of 4 steps where last step is for confirmation of the information provided in first
3 steps. To begin with create your backing bean, it’s important that the bean lives across multiple requests so avoid a request scope bean. Optimal scope for wizard is viewScope.
public class UserWizard { private User user = new User(); public User getUser() { return user;
} public void setUser(User user) { this.user = user;
} public void save(ActionEvent actionEvent) {
//Persist user
FacesMessage msg = new FacesMessage("Successful",
"Welcome :" + user.getFirstname());
FacesContext.getCurrentInstance().addMessage(null, msg);
}
}
User is a simple pojo with properties such as firstname, lastname, email and etc. Following wizard requires 3 steps to get the user data; Personal Details, Address Details and Contact Details. Note that last tab contains read-only data for confirmation and the submit button.
502
PrimeFaces User Guide
<h:form>
<p:wizard>
<p:tab id="personal">
<p:panel header="Personal Details">
<h:messages errorClass="error"/>
<h:panelGrid columns="2">
<h:outputText value="Firstname: *" />
<h:inputText value="#{userWizard.user.firstname}" required="true"/>
<h:outputText value="Lastname: *" />
<h:inputText value="#{userWizard.user.lastname}" required="true"/>
</h:panelGrid>
</p:panel>
</p:tab>
<h:outputText value="Age: " />
<h:inputText value="#{userWizard.user.age}" />
<p:tab id="address">
<p:panel header="Adress Details">
<h:messages errorClass="error"/>
<h:panelGrid columns="2" columnClasses="label, value">
<h:outputText value="Street: " />
<h:inputText value="#{userWizard.user.street}" />
<h:outputText value="Postal Code: " />
<h:inputText value="#{userWizard.user.postalCode}" />
</h:panelGrid>
</p:panel>
</p:tab>
<h:outputText value="City: " />
<h:inputText value="#{userWizard.user.city}" />
<p:tab id="contact">
<p:panel header="Contact Information">
<h:messages errorClass="error"/>
<h:panelGrid columns="2">
<h:outputText value="Email: *" />
<h:inputText value="#{userWizard.user.email}" required="true"/>
<h:outputText value="Phone: " />
<h:inputText value="#{userWizard.user.phone}"/>
</h:panelGrid>
</p:panel>
</p:tab>
<h:outputText value="Additional Info: " />
<h:inputText value="#{userWizard.user.info}"/>
503
PrimeFaces User Guide
<p:tab id="confirm">
<p:panel header="Confirmation">
<h:panelGrid id="confirmation" columns="6">
<h:outputText value="Firstname: " />
<h:outputText value="#{userWizard.user.firstname}"/>
<h:outputText value="Lastname: " />
<h:outputText value="#{userWizard.user.lastname}"/>
<h:outputText value="Age: " />
<h:outputText value="#{userWizard.user.age}" />
<h:outputText value="Street: " />
<h:outputText value="#{userWizard.user.street}" />
<h:outputText value="Postal Code: " />
<h:outputText value="#{userWizard.user.postalCode}"/>
<h:outputText value="City: " />
<h:outputText value="#{userWizard.user.city}"/>
<h:outputText value="Email: " />
<h:outputText value="#{userWizard.user.email}" />
<h:outputText value="Phone " />
<h:outputText value="#{userWizard.user.phone}"/>
<h:outputText value="Info: " />
<h:outputText value="#{userWizard.user.info}"/>
<h:outputText />
<h:outputText />
</h:panelGrid>
<p:commandButton value="Submit" actionListener="#{userWizard.save}" />
</p:panel>
</p:tab>
</p:wizard>
</h:form>
AJAX and Partial Validations
Switching between steps is based on ajax, meaning each step is loaded dynamically with ajax.
Partial validation is also built-in, by this way when you click next, only the current step is validated, if the current step is valid, next tab’s contents are loaded with ajax. Validations are not executed when flow goes back.
Navigations
Wizard provides two icons to interact with; next and prev. Please see the skinning wizard section to know more about how to change the look and feel of a wizard.
504
PrimeFaces User Guide
Custom UI
By default wizard displays right and left arrows to navigate between steps, if you need to come up with your own UI, set showNavBar to false and use the provided the client side api.
<p:wizard showNavBar="false" widgetVar="wiz">
...
</p:wizard>
<h:outputLink value="#" onclick="PF('wiz').next();">Next</h:outputLink>
<h:outputLink value="#" onclick="PF('wiz').back();">Back</h:outputLink>
FlowListener
If you’d like get notified on server side when wizard attempts to go back or forward, define a flowListener.
<p:wizard flowListener="#{userWizard.handleFlow}">
...
</p:wizard> public String handleFlow(FlowEvent event) {
String currentStepId = event.getCurrentStep();
String stepToGo = event.getNextStep(); if(skip) return "confirm"; else return event.getNextStep();
}
Steps here are simply the ids of tab, by using a flowListener you can decide which step to display next so wizard does not need to be linear always. If you need to update other component(s) on page within a flow, use RequestContext.update(String clientId) api.
Client Side Callbacks
Wizard is equipped with onback and onnext attributes, in case you need to execute custom javascript after wizard goes back or forth. You just need to provide the names of javascript functions as the values of these attributes.
<p:wizard onnext="alert(‘Next’)" onback="alert(‘Back’)">
...
</p:wizard>
Client Side API
Widget: PrimeFaces.widget.Wizard
505
Method
next() back() getStepIndex() showNextNav() hideNextNav() showBackNav() hideBackNav() -
-
-
-
Params
-
-
-
PrimeFaces User Guide void void void void
Return Type
void
Description
Proceeds to next step.
void
Number
Goes back in flow.
Returns the index of current step.
Shows next button.
Hides next button.
Shows back button.
Hides back button.
Skinning
Wizard resides in a container element that style and styleClass attributes apply. Following is the list of structural css classes.
Selector
.ui-wizard
.ui-wizard-content
.ui-wizard-step-titles
.ui-wizard-step-title
.ui-wizard-navbar
.ui-wizard-nav-back
.ui-wizard-nav-next
Applies
Main container element.
Container element of content.
Container of step titles.
Each step title.
Container of navigation controls.
Back navigation control.
Forward navigation control.
As skinning style classes are global, see the main theming section for more information.
506
PrimeFaces User Guide
4. Partial Rendering and Processing
PrimeFaces provides a partial rendering and view processing feature based on standard JSF 2 APIs to enable choosing what to process in JSF lifecyle and what to render in the end with ajax.
4.1 Partial Rendering
In addition to components like autoComplete, datatable, slider with built-in ajax capabilities,
PrimeFaces also provides a generic PPR (Partial Page Rendering) mechanism to update JSF components with ajax. Several components are equipped with the common PPR attributes (e.g.
update, process, onstart, oncomplete).
4.1.1 Infrastructure
PrimeFaces Ajax Framework is based on standard server side APIs of JSF 2. There are no additional artfacts like custom AjaxViewRoot, AjaxStateManager, AjaxViewHandler, Servlet Filters,
HtmlParsers, PhaseListeners and so on. PrimeFaces aims to keep it clean, fast and lightweight.
On client side rather than using client side API implementations of JSF implementations like
Mojarra and MyFaces, PrimeFaces scripts are based on the most popular javascript library; jQuery which is far more tested, stable regarding ajax, dom handling, dom tree traversing than a JSF implementations scripts.
4.1.2 Using IDs
Getting Started
When using PPR you need to specify which component(s) to update with ajax. If the component that triggers PPR request is at the same namingcontainer (eg. form) with the component(s) it renders, you can use the server ids directly. In this section although we’ll be using commandButton, same applies to every component that’s capable of PPR such as commandLink, poll, remoteCommand and etc.
<h:form>
<p:commandButton update="display" />
<h:outputText id="display" value="#{bean.value}"/>
</h:form>
PrependId
Setting prependId setting of a form has no effect on how PPR is used.
<h:form prependId="false">
<p:commandButton update="display" />
<h:outputText id="display" value="#{bean.value}"/>
</h:form>
507
PrimeFaces User Guide
ClientId
It is also possible to define the client id of the component to update.
<h:form id="myform">
<p:commandButton update="myform:display" />
<h:outputText id="display" value="#{bean.value}"/>
</h:form>
Different NamingContainers
If your page has different naming containers (e.g. two forms), you also need to add the container id to search expression so that PPR can handle requests that are triggered inside a namingcontainer that updates another namingcontainer. Following is the suggested way using separator char as a prefix, note that this uses same search algorithm as standard JSF 2 implementation;
<h:form id="form1">
<p:commandButton update=":form2:display" />
</h:form>
<h:form id="form2">
<h:outputText id="display" value="#{bean.value}"/>
</h:form>
Please read findComponent algorithm described in link below used by both JSF core and
PrimeFaces to fully understand how component referencing works.
http://docs.oracle.com/javaee/6/api/javax/faces/component/UIComponent.html
JSF h:form, datatable, composite components are naming containers, in addition tabView, accordionPanel, dataTable, dataGrid, dataList, carousel, galleria, ring, sheet and subTable are
PrimeFaces component that implement NamingContainer.
Multiple Components
Multiple components to update can be specified with providing a list of ids separated by a comma, whitespace or even both.
<h:form>
<p:commandButton update="display1,display2" />
<p:commandButton update="display1 display2" />
<h:outputText id="display1" value="#{bean.value1}"/>
<h:outputText id="display2" value="#{bean.value2}"/>
</h:form>
508
PrimeFaces User Guide
4.1.3 Notifying Users
ajaxStatus is the component to notify the users about the status of global ajax requests. See the ajaxStatus section to get more information about the component.
Global vs Non-Global
By default ajax requests are global, meaning if there is an ajaxStatus component present on page, it is triggered.
If you want to do a "silent" request not to trigger ajaxStatus instead, set global to false. An example with commandButton would be;
<p:commandButton value="Silent" global="false" />
<p:commandButton value="Notify" global="true" />
4.1.4 Bits&Pieces
PrimeFaces Ajax Javascript API
See the javascript section to learn more about the PrimeFaces Javascript Ajax API.
509
PrimeFaces User Guide
4.2 Partial Processing
In Partial Page Rendering, only specified components are rendered, similarly in Partial Processing only defined components are processed. Processing means executing Apply Request Values,
Process Validations, Update Model and Invoke Application JSF lifecycle phases only on defined components.
This feature is a simple but powerful enough to do group validations, avoiding validating unwanted components, eliminating need of using immediate and many more use cases. Various components such as commandButton, commandLink are equipped with process attribute, in examples we’ll be using commandButton.
4.2.1 Partial Validation
A common use case of partial process is doing partial validations, suppose you have a simple contact form with two dropdown components for selecting city and suburb, also there’s an inputText which is required. When city is selected, related suburbs of the selected city is populated in suburb dropdown.
<h:form>
<h:selectOneMenu id="cities" value="#{bean.city}">
<f:selectItems value="#{bean.cityChoices}" />
<p:ajax listener="#{bean.populateSuburbs}" update="suburbs" process="@all"/>
</h:selectOneMenu>
<h:selectOneMenu id="suburbs" value="#{bean.suburb}">
<f:selectItems value="#{bean.suburbChoices}" />
</h:selectOneMenu>
<h:inputText value="#{bean.email}" required="true"/>
</h:form>
When the city dropdown is changed an ajax request is sent to execute populateSuburbs method which populates suburbChoices and finally update the suburbs dropdown. Problem is populateSuburbs method will not be executed as lifecycle will stop after process validations phase to jump render response as email input is not provided. Reason is p:ajax has @all as the value stating to process every component on page but there is no need to process the inputText.
The solution is to define what to process in p:ajax. As we’re just making a city change request, only processing that should happen is cities dropdown.
510
PrimeFaces User Guide
<h:form>
<h:selectOneMenu id="cities" value="#{bean.city}">
<f:selectItems value="#{bean.cityChoices}" />
<p:ajax actionListener="#{bean.populateSuburbs}" event="change" update="suburbs" process="@this"/>
</h:selectOneMenu>
<h:selectOneMenu id="suburbs" value="#{bean.suburb}">
<f:selectItems value="#{bean.suburbChoices}" />
</h:selectOneMenu>
<h:inputText value="#{bean.email}" required="true"/>
</h:form>
That is it, now populateSuburbs method will be called and suburbs list will be populated. Note that default value for process option is @this already for p:ajax as stated in AjaxBehavior documentation, it is explicitly defined here to give a better understanding of how partial processing works.
4.2.2 Using Ids
Partial Process uses the same technique applied in partial updates to specify component identifiers to process.
511
PrimeFaces User Guide
4.3 Search Expression Framework
Core JSF component referencing is based on component identifiers only with basic keyword support. PrimeFaces Search Expression Framework (SEF) provides both server side and client side extensions to make it easier to reference components. SEF is utilized in partial update, process and whenever a component references another component.
4.3.1 Keywords
Keywords are the easier way to reference components, they resolve to ids so that if an id changes, the reference does not need to change. Core JSF provides a couple of keywords and PrimeFaces provides more along with composite expression support.
@this
@all
@form
@none
Keyword
@namingcontainer
@parent
@composite
@child(n)
@previous
@next
@widgetVar(name)
Type
Standard
Standard
Standard
Standard
PrimeFaces
PrimeFaces
PrimeFaces
PrimeFaces
PrimeFaces
PrimeFaces
PrimeFaces
Description
Current component.
Whole view.
Closest ancestor form of current component.
No component.
Closest ancestor naming container of current component.
Parent of the current component.
Closest composite component ancestor.
nth child.
Previous sibling.
Next sibling.
Component with given widgetVar.
Consider the following case where ids are used for referencing;
<h:form id="form1">
<p:commandButton id="btn" update="form1" process="btn" />
<h:outputText value="#{bean.value}"/>
</h:form>
Using keywords, same can be written as;
<h:form id="form1">
<p:commandButton id="btn" update="@form" process="@this" />
<h:outputText value="#{bean.value}"/>
</h:form>
512
PrimeFaces User Guide
Composite Expressions
Multiple keywords can be combined in a single expression using colon;
• @form:@parent
• @composite:mybuttonid
• @this:@parent:@parent
• @form:@child(2)
Usage Scenarios
SEF is not just at partial process and update, they are also available whenever a component is referencing another.
<h:form>
<p:commandButton id="dynaButton" value="Show" type="button" />
<p:menu overlay="true" trigger="@parent:dynaButton">
//items
</p:menu>
</h:form>
4.3.2 PrimeFaces Selectors (PFS)
PFS integrates jQuery Selector API with JSF component referencing model so that referencing can be done using jQuery Selector API instead of core id based JSF model. Best way to explain the power of PFS is examples;
Update all forms update="@(form)"
Update first form update="@(form:first)"
Update all components that has styleClass named mystyle update="@(.mystyle)"
Update and process all inputs update="@(:input)" process="@(:input)"
513
PrimeFaces User Guide
Update all datatables update="@(.ui-datatable)"
Process input components inside any panel and update all panels process="@(.ui-panel :input)" update="@(.ui-panel)"
Process input components but not select components process="@(:input:not(select))"
Update input components that are disabled update="@(:input:disabled)"
PFS can be used with other referencing approaches as well; update="compId :form:compId @(:input) @parent:@child(2)"
<h:form>
<p:commandButton id="dynaButton" value="Show" type="button" styleClass="btn"/>
<p:menu overlay="true" trigger="@(.btn)">
//items
</p:menu>
</h:form>
PFS provides an alternative, flexible, grouping based approach to reference components to partially process and update. There is less CPU server load compared to regular referencing because JSF component tree is not traversed on server side to find a component and figure out the client id as
PFS is implemented on client side by looking at dom tree. Another advantage is avoiding naming container limitations, just remember the times you’ve faced with cannot find component exception since the component you are looking for is in a different naming container like a form or a datatable. PFS can help you out in tricky situations by following jQuery’s “write less do more” style.
For PFS to function properly and not to miss any component, it is required to have explicitly defined ids on the matched set as core JSF components usually do not render auto ids. So even though manually defined ids won't be referenced directly, they are still required for PFS to be collected and send in the request.
For full reference of jQuery selector api, see; http://api.jquery.com/category/selectors/
514
PrimeFaces User Guide
4.4 PartialSubmit
Core JSF Ajax implementation and by default PrimeFaces serializes the whole form to build the post data in ajax requests so the same data is posted just like in a non-ajax request. This has a downside in large views where you only need to process/execute a minor part of the view. Assume you have a form with 100 input fields, there is an input field with ajaxbehavior attached processing only itself(@this) and then updates another field onblur. Although only a particular input field is processed, whole form data will be posted with the unnecessary information that would be ignored during server side processing but consume resources.
PrimeFaces provides partialSubmit feature to reduce the network traffic and computing on client side. When partialSubmit is enabled, only data of components that will be partially processed on the server side are serialized. By default partialSubmit is disabled and you can enable it globally using a context parameter.
<context-param>
<param-name>primefaces.SUBMIT</param-name>
<param-value>partial</param-value>
</context-param>
Components like buttons and behaviors like p:ajax are equipped with partialSubmit option so you can override the global setting per component.
<p:commandButton value="Submit" partialSubmit="true|false" />
515
PrimeFaces User Guide
5. Javascript API
PrimeFaces renders unobstrusive javascript which cleanly separates behavior from the html. Client side engine is powered by jQuery version 1.8.1 which is the latest at the time of the writing.
5.1 PrimeFaces Namespace
PrimeFaces is the main javascript object providing utilities and namespace.
Method
escapeClientId(id) addSubmitParam(el, name, param) getCookie(name)
Description
Escaped JSF ids with semi colon to work with jQuery.
Adds request parameters dynamically to the element.
Returns cookie with given name.
setCookie(name, value) skinInput(input) info(msg), debug(msg), warn(msg), error(msg) Client side log API.
changeTheme(theme) Changes theme on the fly with no page refresh.
cleanWatermarks()
Sets a cookie with given nam and value.
Progressively enhances an input element with theming.
showWatermarks()
Watermark component extension, cleans all watermarks on page before submitting the form.
Shows watermarks on form.
To be compatible with other javascript entities on a page, PrimeFaces defines two javascript namespaces;
PrimeFaces.widget.*
Contains custom PrimeFaces widgets like;
- PrimeFaces.widget.DataTable
- PrimeFaces.widget.Tree
- PrimeFaces.widget.Poll
- and more...
Most of the components have a corresponding client side widget with same name.
PrimeFaces.ajax.*
PrimeFaces.ajax namespace contains the ajax API which is described in next section.
516
PrimeFaces User Guide
5.2 Ajax API
PrimeFaces Ajax Javascript API is powered by jQuery and optimized for JSF. Whole API consists of three properly namespaced simple javascript functions.
PrimeFaces.ajax.Request
Sends ajax requests that execute JSF lifecycle and retrieve partial output. Function signature is as follows;
PrimeFaces.ajax.Request.handle(cfg);
Configuration Options
Option
formId async global update process source params onstart() onsuccess(data, status, xhr) onerror(xhr, status, error) oncomplete(xhr, status, args)
Description
Id of the form element to serialize, if not defined parent form of source is used.
Flag to define whether request should go in ajax queue or not, default is false.
Flag to define if p:ajaxStatus should be triggered or not, default is true.
Component(s) to update with ajax.
Component(s) to process in partial request.
Client id of the source component causing the request.
Additional parameters to send in ajax request.
Javascript callback to process before sending the ajax request, return false to cancel the request.
Javascript callback to process when ajax request returns with success code. Takes three arguments, xml response, status code and xmlhttprequest.
Javascript callback to process when ajax request fails. Takes three arguments, xmlhttprequest, status string and exception thrown if any.
Javascript callback to process when ajax request completes. Takes three arguments, xmlhttprequest, status string and optional arguments provided by RequestContext API.
517
PrimeFaces User Guide
Examples
Suppose you have a JSF page called createUser with a simple form and some input components.
<h:form id="userForm">
<h:inputText id="username" value="#{userBean.user.name}" />
... More components
</h:form>
You can post all the information with ajax using;
PrimeFaces.ajax.Request.handle({ formId:’userForm’
,source:’userForm’
,process:’userForm’
});
More complex example with additional options;
PrimeFaces.ajax.Request.handle({
formId: 'userForm',
source: 'userForm',
process: 'userForm',
update: 'msgs',
params:{
'param_name1':'value1',
'param_name2':'value2'
},
oncomplete:function(xhr, status) {alert('Done');}
});
We highly recommend using p:remoteComponent instead of low level javascript api as it generates the same with much less effort and less possibility to do an error.
PrimeFaces.ajax.Response
PrimeFaces.ajax.Response.handle() updates the specified components if any and synchronizes the client side JSF state. DOM updates are implemented using jQuery which uses a very fast algorithm.
Abort
Use the abort API in case you'd like to cancel all the ongoing requests;
PrimeFaces.ajax.Queue.abortAll()
518
PrimeFaces User Guide
6. Dialog Framework
Dialog Framework (DF) is used to open an external xhtml page in a dialog that is generated dynamically on runtime. This is quite different to regular usage of dialogs with declarative p:dialog components as DF is based on a programmatic API where dialogs are created and destroyed at runtime. Note that DF and the declarative approach are two different ways and both can even be used together. Usage is quite simple, RequestContext has openDialog and closeDialog methods;
/**
* Open a view in dialog.
* @param outcome The logical outcome used to resolve a navigation case.
*/
public abstract void openDialog(String outcome);
/**
* Open a view in dialog.
* @param outcome The logical outcome used to resolve a navigation case.
* @param options Configuration options for the dialog.
* @param params Parameters to send to the view displayed in a dialog.
*/ public abstract void openDialog(String outcome, Map<String,Object> options,
Map<String,List<String>> params);
/**
* Close a dialog.
* @param data Optional data to pass back to a dialogReturn event.
*/ public abstract void closeDialog(Object data);
Configuration
DF requires the following configuration to be present in faces config file.
<application>
<action-listener> org.primefaces.application.DialogActionListener
</action-listener>
<navigation-handler> org.primefaces.application.DialogNavigationHandler
</navigation-handler>
<view-handler> org.primefaces.application.DialogViewHandler
</view-handler>
</application>
Getting Started
Simplest use case of DF is opening an xhtml view like cars.xhtml in a dialog;
519
PrimeFaces User Guide
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:p="http://primefaces.org/ui">
<h:head>
<title>Cars</title>
</h:head>
<h:body>
<p:dataTable var="car" value="#{tableBean.cars}">
//columns
</p:dataTable>
</h:body>
</html>
On the host page, call RequestContext.openDialog("viewname");
<p:commandButton value="View Cars" actionListener="#{hostBean.view}" /> public void view() {
RequestContext.getCurrentInstance().openDialog("viewCars");
}
Once the response is received from the request caused by command button a dialog would be generated with the contents of viewCars.xhtml. Title of the dialog is retrieved from the title element of the viewCars, in this case, Cars.
Dialog Configuration
Overloaded openDialog method provides advanced configuration regarding the visuals of dialog along with parameters to send to the dialog content.
<p:commandButton value="View Cars" actionListener="#{hostBean.viewCustomized}" /> public void view() {
Map<String,Object> options = new HashMap<String, Object>(); options.put("modal", true); options.put("draggable", false);
RequestContext.getCurrentInstance().openDialog("viewCars", options, null);
} options.put("resizable", false); options.put("contentHeight", 320);
520
PrimeFaces User Guide
Here is the full list of configuration options; modal resizable draggable width
Name
height contentWidth contentHeight closable includeViewParams auto
640 auto true false
Default
0
1
1 auto
Type
Boolean
Boolean
Boolean
Integer
Integer
Integer
Integer
Boolean
Boolean
Description
Controls modality of the dialog.
When enabled, makes dialog resizable.
When enabled, makes dialog draggable.
Width of the dialog.
Height of the dialog.
Width of the dialog content.
Height of the dialog content.
Whether the dialog can be closed or not.
When enabled, includes the view parameters.
Data Communication
Page displayed in the dialog can pass data back to the parent page. The trigger component needs to have dialogReturn ajax behavior event to hook-in when data is returned from dialog.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:p="http://primefaces.org/ui">
<h:head>
<title>Cars</title>
</h:head>
<h:body>
<p:dataTable var="car" value="#{tableBean.cars}">
//columns
<p:column headerText="Select">
<p:commandButton icon="ui-icon-search" actionListener="#{tableBean.selectCarFromDialog(car)}" />
</p:column>
</p:dataTable>
</h:body>
</html> public void selectCarFromDialog(Car car) {
RequestContext.getCurrentInstance().closeDialog(car);
}
At host page, the button that triggered the dialog should have dialogReturn event.
521
PrimeFaces User Guide
<p:commandButton value="View Cars" actionListener="#{hostBean.viewCars}">
<p:ajax event="dialogReturn" listener="#{hostBean.handleReturn}"
</p:commandButton> public void view() {
RequestContext.getCurrentInstance().openDialog("viewCars");
} public void handleReturn(SelectEvent event) {
Car car = (Car) event.getObject();
}
Remarks on Dialog Framework
• At the moment, p:commandButton and p:commandLink supports dialogReturn.
• Nested dialogs are not supported.
• Calls to DialogFramework API within a non-ajax are ignored.
Dialog Messages
Displaying FacesMessages in a Dialog is a common case where a facesmessage needs to be added to the context first, dialog content containing a message component needs to be updated and finally dialog gets shown with client side api. DF has a simple utility to bypass this process by providing a shortcut;
/**
* Displays a message in a dialog.
* @param message FacesMessage to be displayed.
*/ public abstract void showMessageInDialog(FacesMessage message);
Using this shortcut it is just one line to implement the same functionality;
<p:commandButton value="Show" actionListener="#{bean.save}" /> public void save() {
//business logic
RequestContext.getCurrentInstance().showMessageInDialog(new
FacesMessage(FacesMessage.SEVERITY_INFO,
"What we do in life", "Echoes in eternity."););
}
522
PrimeFaces User Guide
7. Client Side Validation
PrimeFaces Client Side Validation (CSV) Framework is the most complete and advanced CSV solution for JavaServer Faces and Java EE. CSV support for JSF is not an easy task, it is not simple as integrating a 3rd party javascript plugin as JSF has its own lifecycle, concepts like conversion and then validation, partial processing, facesmessages and many more. Real CSV for JSF should be compatible with server side implementation, should do what JSF does, so that users do not experience difference behaviors on client side and server side.
• Compatible with Server Side Implementation.
• Conversion and Validation happens at client side.
• Partial Process&Update support for Ajax.
• I18n support along with component specific messages.
• Client side Renderers for message components.
• Easy to write custom client converters and validators.
• Global or Component based enable/disable.
• Advanced Bean Validation Integration.
• Little footprint using HTML5.
7.1 Configuration
CVS is disabled by default and a global parameter is required to turn it on.
<context-param>
<param-name>primefaces.CLIENT_SIDE_VALIDATION</param-name>
<param-value>true</param-value>
</context-param>
At page level, enable validateClient attribute of commandButton and commandLink components.
<h:form>
<p:messages />
<p:inputText required="true" />
<p:inputTextarea required="true" />
<p:commandButton value="Save" validateClient="true" ajax="false"/>
</h:form>
That is all for the basics, clicking the button validates the form at client side and displays the errors using messages component.
CSV works for PrimeFaces components only, standard h: * components are not supported.
7.2 Ajax vs Non-Ajax
CSV works differently depending on the request type of the trigger component to be compatible with cases where CVS is not enabled.
523
PrimeFaces User Guide
Non-Ajax
In non-ajax case, all visible and editable input components in the form are validated and message components must be placed inside the form.
Ajax
CSV supports partial processing and updates on client side as well, if process attribute is enabled, the components that would be processed at server side gets validated at client side. Similary if update attribute is defined, only message components inside the updated parts gets rendered. Whole process happens at client side.
7.3 Events
CSV provides a behavior called p:clientBehavior to do instant validation in case you do not want to wait for the users to fill in the form and hit commandButton/commandLink. Using clientBehavior and custom events, CSV for a particular component can run with events such as change (default), blur, keyup.
<h:form>
<p:panel header="Validate">
<h:panelGrid columns="4" cellpadding="5">
<h:outputLabel for="text" value="Text: (Change)" />
<p:inputText id="text" value="#{validationBean.text}" required="true">
<f:validateLength minimum="2" maximum="5" />
<p:clientValidator />
</p:inputText>
<p:message for="text" display="icon" />
<h:outputText value="#{validationBean.text}" />
<h:outputLabel for="integer" value="Integer: (Keyup)" />
<p:inputText id="integer" value="#{validationBean.integer}">
<p:clientValidator event="keyup"/>
</p:inputText>
<p:message for="integer" display="icon" />
<h:outputText value="#{validationBean.integer}" />
</h:panelGrid>
<p:commandButton value="Save" ajax="false" icon="ui-icon-check" validateClient="true"/>
</p:panel>
</h:form>
7.4 Messages
Validation errors are displayed as the same way in server side validation, texts are retrieved from a client side bundle and message components are required for the displays.
I18N
Default language is English for the CSV messages and for other languages or to customize the default messages, PrimeFaces Locales bundle needs to be present at the page if you'd like to provide t r a n s l a t i o n s . F o r m o r e i n f o o n P r i m e F a c e s L o c a l e s , v i s i t http://code.google.com/p/primefaces/wiki/PrimeFacesLocales .
524
PrimeFaces User Guide
Rendering
PrimeFaces message components have client side renderers for CSV support, these are p:message, p:messages and p:growl. Component options like showSummary, showDetail, globalOnly, mode are all implemented by client side renderer for compatibility.
7.5 Bean Validation
CSV has built-in integration with Bean Validation by validating the constraints defined with annotations at client side.
<h:form>
<p:growl />
<h:panelGrid>
<h:outputLabel for="name" value="Name:" />
<p:inputText id="name" value="#{bean.name}" label="Name"/>
<p:message for="name" />
<h:outputLabel for="age" value="Age: (@Min(10) @Max(20))" />
<p:inputText id="age" value="#{bean.age}" label="Age"/>
<p:message for="age" />
</h:panelGrid>
<p:commandButton value="Save" validateClient="false" ajax="false" />
</h:form> public class Bean {
@Size(min=2,max=5)
private String name;
@Min(10) @Max(20)
private Integer age;
}
All of the standard constraints are supported.
7.6 Extending CSV
Using CSV APIs, it is easy to write your own custom converters and validators.
Email Validator with JSF
Your custom validator must implement ClientValidator interface to provide the client validator id and the optional metadata.
525
PrimeFaces User Guide package org.primefaces.examples.validate; import java.util.Map; import java.util.regex.Pattern; import javax.faces.application.FacesMessage; import javax.faces.component.UIComponent; import javax.faces.context.FacesContext; import javax.faces.validator.FacesValidator; import javax.faces.validator.Validator; import javax.faces.validator.ValidatorException; import org.primefaces.validate.ClientValidator;
@FacesValidator("custom.emailValidator") public class EmailValidator implements Validator, ClientValidator {
private Pattern pattern; private static final String EMAIL_PATTERN = "^[_A-Za-z0-9-\\+]+(\\.[_A-Za-z0-
9-]+)*@" + "[A-Za-z0-9-]+(\\.[A-Za-z0-9]+)*(\\.[A-Za-z]{2,})$"; public EmailValidator() { pattern = Pattern.compile(EMAIL_PATTERN);
}
public void validate(FacesContext context, UIComponent component, Object value) throws ValidatorException {
if(value == null) {
return;
}
if(!pattern.matcher(value.toString()).matches()) {
throw new ValidatorException(new
FacesMessage(FacesMessage.SEVERITY_ERROR, "Validation Error",
value + " is not a valid email;"));
}
}
public Map<String, Object> getMetadata() {
return null;
}
public String getValidatorId() {
return "custom.emailValidator";
}
}
Validator is plugged-in using the standard way.
<h:form>
<p:messages />
<p:inputText id="email" value="#{bean.value}">
<f:validator validatorId="custom.emailValidator" />
</p:inputText>
<p:message for="email" />
<p:commandButton value="Save" validateClient="true" ajax="false"/>
</h:form>
526
PrimeFaces User Guide
Last step is implementing the validator at client side and configuring it.
PrimeFaces.validator['custom.emailValidator'] = {
pattern: /\S+@\S+/,
validate: function(element, value) {
//use element.data() to access validation metadata, in this case there is none.
if(!this.pattern.test(value)) {
throw {
summary: 'Validation Error',
detail: value + ' is not a valid email.'
}
}
}
};
In some cases your validator might need metadata, for example LengthValidator requires min and max constraints to validate against. Server side validator can pass these by overriding the
getMetadata() method by providing a map of name,value pairs. At client side, these are accessed via
element.data(key).
public Map<String, Object> getMetadata() {
Map<String,Object> data = new HashMap<String,Object>(); data.put("data-prime", 10); return data;
} validate: function(element, value) {
var prime = element.data("prime"); //10
//validate
}
Similarly a client side converter can be written by implementing ClientConverter API and overriding convert: function(element, submittedValue) {} method to return a javascript object.
Email Validator with Bean Validation
Bean Validation is also supported for extensions, here is an example of a @Email validator.
//imports import org.primefaces.validate.bean.ClientConstraint;
@Target({METHOD,FIELD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Constraint(validatedBy=EmailConstraintValidator.class)
@ClientConstraint(resolvedBy=EmailClientValidationConstraint.class)
@Documented public @interface Email {
String message() default "{org.primefaces.examples.primefaces}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
527
PrimeFaces User Guide
@Constraint is the regular validator from Bean Validation API and @ClientConsraint is from CSV
API to resolve metadata.
public class EmailConstraintValidator implements ConstraintValidator<Email, String>{
private Pattern pattern; private static final String EMAIL_PATTERN = "^[_A-Za-z0-9-\\+]+(\\.[_A-Za-z0-
9-]+)*@"
+ "[A-Za-z0-9-]+(\\.[A-Za-z0-
9]+)*(\\.[A-Za-z]{2,})$";
public void initialize(Email a) {
pattern = Pattern.compile(EMAIL_PATTERN);
}
public boolean isValid(String value, ConstraintValidatorContext cvc) {
if(value == null)
return true;
else
return pattern.matcher(value.toString()).matches();
}
} public class EmailClientValidationConstraint implements ClientValidationConstraint {
public static final String MESSAGE_METADATA = "data-p-email-msg";
public Map<String, Object> getMetadata(ConstraintDescriptor constraintDescriptor)
{
Map<String,Object> metadata = new HashMap<String, Object>();
Map attrs = constraintDescriptor.getAttributes();
Object message = attrs.get("message");
if(message != null) {
metadata.put(MESSAGE_METADATA, message);
}
return metadata;
}
public String getValidatorId() {
return Email.class.getSimpleName();
}
}
528
Final part is implementing the client side validator;
PrimeFaces.validator['Email'] = {
pattern: /\S+@\S+/,
MESSAGE_ID: 'org.primefaces.examples.validate.email.message',
validate: function(element, value) {
var vc = PrimeFaces.util.ValidationContext;
if(!this.pattern.test(value)) {
var msgStr = element.data('p-email-msg'),
msg = msgStr ? {summary:msgStr, detail: msgStr} : vc.getMessage(this.MESSAGE_ID);
throw msg;
}
}
};
PrimeFaces User Guide
Usage is same as using standard constraints;
<h:form>
<p:messages />
<p:inputText id="email" value="#{bean.value}" />
<p:message for="email" />
<p:commandButton value="Save" validateClient="true" ajax="false"/>
</h:form> public class Bean {
@Email private String value;
//getter-setter
}
3 rd Party Annotations
When using 3 rd party constraints like Hibernate Validator specific annotations, use
BeanValidationMetadataMapper to define a ClientValidationConstraint for them.
BeanValidationMetadataMapper.registerConstraintMapping(Class<? extends Annotation> constraint, ClientValidationConstraint clientValidationConstraint);
BeanValidationMetadataMapper.removeConstraintMapping(Class<? extends Annotation> constraint);
529
PrimeFaces User Guide
8. Themes
PrimeFaces is integrated with powerful ThemeRoller CSS Framework. Currently there are 30+ predesigned themes that you can preview and download from PrimeFaces theme gallery.
http://www.primefaces.org/themes.html
530
PrimeFaces User Guide
8.1 Applying a Theme
Applying a theme to your PrimeFaces project is very easy. Each theme is packaged as a jar file, download the theme you want to use, add it to the classpath of your application and then define primefaces.THEME context parameter at your deployment descriptor (web.xml) with the theme name as the value.
Download
Each theme is available for manual download at PrimeFaces Theme Gallery. If you are a maven user, define theme artifact as;
<dependency>
<groupId>org.primefaces.themes</groupId>
<artifactId>cupertino</artifactId>
<version>1.0.8</version>
</dependency> artifactId is the name of the theme as defined at Theme Gallery page.
Configure
Once you've downloaded the theme, configure PrimeFaces to use it.
<context-param>
<param-name>primefaces.THEME</param-name>
<param-value>aristo</param-value>
</context-param>
That's it, you don't need to manually add any css to your pages or anything else, PrimeFaces will handle everything for you.
In case you’d like to make the theme dynamic, define an EL expression as the param value.
<context-param>
<param-name>primefaces.THEME</param-name>
<param-value>#{loggedInUser.preferences.theme}</param-value>
</context-param>
531
PrimeFaces User Guide
8.2 Creating a New Theme
If you’d like to create your own theme instead of using the pre-defined ones, that is easy as well because ThemeRoller provides a powerful and easy to use online visual tool.
Applying your own custom theme is same as applying a pre-built theme however you need to migrate the downloaded theme files from ThemeRoller to PrimeFaces Theme Infrastructure.
PrimeFaces Theme convention is the integrated way of applying your custom themes to your project, this approach requires you to create a jar file and add it to the classpath of your application.
Jar file must have the following folder structure. You can have one or more themes in same jar.
jar
-
META-INF
resources
primefaces-yourtheme
theme.css
images
1) The theme package you've downloaded from ThemeRoller will have a css file and images folder.
Make sure you have “deselect all components” option on download page so that your theme only includes skinning styles. Extract the contents of the package and rename jquery-ui-
{version}.custom.css to theme.css.
2) Image references in your theme.css must also be converted to an expression that JSF resource loading can understand, example would be; url("images/ui-bg_highlight-hard_100_f9f9f9_1x100.png") should be; url("#{resource['primefaces-yourtheme:images/ui-bg_highlight-hard_100_f9f9f9_1x100.png']}")
Once the jar of your theme is in classpath, you can use your theme like;
<context-param>
<param-name>primefaces.THEME</param-name>
<param-value>yourtheme</param-value>
</context-param>
532
PrimeFaces User Guide
8.3 How Themes Work
Powered by ThemeRoller, PrimeFaces separates structural css from skinning css.
Structural CSS
These style classes define the skeleton of the components and include css properties such as margin, padding, display type, dimensions and positioning.
Skinning CSS
Skinning defines the look and feel properties like colors, border colors, background images.
Skinning Selectors
ThemeRoller features a couple of skinning selectors, most important of these are;
Selector
.ui-widget
.ui-widget-header
.ui-widget-content
.ui-state-default
.ui-state-hover
.ui-state-active
.ui-state-disabled
.ui-state-highlight
.ui-icon
All PrimeFaces components
Header section of a component
Content section of a component
Applies
Default class of a clickable
Hover class of a clickable
When a clickable is selected
Disabled elements.
Highlighted elements.
An element to represent an icon.
These classes are not aware of structural css like margins and paddings, mostly they only define colors. This clean separation brings great flexibility in theming because you don’t need to know each and every skinning selectors of components to change their style.
For example Panel component’s header section has the .ui-panel-titlebar structural class, to change the color of a panel header you don’t need to about this class as .ui-widget-header also that defines the panel colors also applies to the panel header.
533
PrimeFaces User Guide
8.4 Theming Tips
• Default font size of themes might be bigger than expected, to change the font-size of PrimeFaces components globally, use the .ui-widget style class. An example of smaller fonts;
.ui-widget, .ui-widget .ui-widget { font-size: 90% !important;
}
• When creating your own theme with themeroller tool, select one of the pre-designed themes that is close to the color scheme you want and customize that to save time.
• If you are using Apache Trinidad or JBoss RichFaces, PrimeFaces Theme Gallery includes
Trinidad’s Casablanca and RichFaces’s BlueSky theme. You can use these themes to make
PrimeFaces look like Trinidad or RichFaces components during migration.
• To change the style of a particular component instead of all components of same type use namespacing, example below demonstrates how to change header of all panels.
.ui-panel-titlebar {
//css
} or
.ui-panel-titlebar.ui-widget-header {
//css
}
To apply css on a particular panel;
<p:panel styleClass="custom">
...
</p:panel>
.custom .ui-panel-titlebar {
//css
}
534
9. PrimeFaces Push
PrimeFaces User Guide
PrimeFaces Push (PFP) is a push framework built on top of Atmosphere. Atmospheres creator
AsyncIO is a partner company of PrimeTek and the developer of PFP. Atmosphere is highly scalable, supports several containers and browsers, utilizes various transports such as websockets, see, long-polling, streaming and jsonp. For more information please visit; https://github.com/Atmosphere/atmosphere
9.1 Setup
Atmosphere
Atmosphere is required to run PrimeFaces Push, in your pom.xml define the dependency as;
<dependency>
<groupId>org.atmosphere</groupId>
<artifactId>atmosphere-runtime</artifactId>
<version>2.2.2</version>
</dependency>
Push Servlet
Push Servlet is used as a gateway for clients.
<servlet>
<servlet-name>Push Servlet</servlet-name>
<servlet-class>org.primefaces.push.PushServlet</servlet-class>
<async-supported>true</async-supported>
</servlet>
<servlet-mapping>
<servlet-name>Push Servlet</servlet-name>
<url-pattern>/primepush/*</url-pattern>
</servlet-mapping>
535
PrimeFaces User Guide
9.2 Annotations
Design of PFP is annotation driven centralized around the main @PushEndPoint.
@PushEndPoint
The easiest way to create PFP application is by using the @PushEndPoint annotation. This annotation simplifies the process to build an application using PFP avoding the need to interact with
Atmospheres more sophisticated API. This annotation significantly reduces the number of code required to build a powerful real time application by transparently installing Atmospheres components like heartbeat, idle connections detections, disconnect state recovery etc. It also allows the use of external dependency injection framework like CDI, Spring or Guice. Annotation provides one attribute called path to define the resource path.
path: The path to the resource.
The default is "/" so if your have mapped the PushServlet to "/*", all request will be delivered to your annotated class. You can also customize the path. The path value will be used to map an incoming request uris path to an annotated PushEndpoint class.
@PushEndPoint("/chat")
@Singleton
Singleton annotation is used to force creating a single, thread safe instance of a PushEndpoint annotated classes. For example, if your application set the @PushEndpoint’s path attribute with a path, by default a new instance of the annotated classes will be created. When annotated with
Singleton however, a single class will be created.
@OnOpen
The OnOpen() will be invoked when the underlying connection is ready to be used, e.g for write operations. Annotated method needs to take the form of;
@OnOpen public void onOpen();
@OnOpen public void onOpen(RemoteEndpoint r);
@OnOpen public void onOpen(RemoteEndpoint r, EventBus e);
The RemoteEndpoint represents the physical connection and can be used to write some data back to the browser. The EventBus can be used to fire messages to one or more RemoteEndpoints using regex expressions.
@OnMessage
The OnMessage() will be invoked when a message is ready to be deliver, e.g as a result of a
EventBus publish operation or when a browser is POSTing some bytes. The annotation’s attributes available are;
536
PrimeFaces User Guide
encoders: A list of [Encoder]() that will be used to encode the annotated method return value. The returned value of an annotated OnMessage method will be broadcasted to all resource associated with the Broadcaster, associated with this annotated classes.
decoders: A list of [Decoder]() used to decode a broadcasted messages into an object matching the methods signature.
Both of the encoders and decoders can be chained, meaning the returned value of an encoderdecoder can be used as an input for the next one.
@OnMessage(encoders = {JSONEncoder.class})
public String onMessage(String count) { return count;
}
Out of the box, PrimeFaces PUSH provides JSON implementations that are;
- org.primefaces.push.impl.JSONEncoder
- org.primefaces.push.impl.JSONDecoder
It is also easy to create your own encoders-decoders by implementing org.primefaces.push.Encoder and org.primefaces.push.Decoder interfaces.
@OnClose
The @OnClose() will be invoked when the client disconnect, e.g close the connection, when a network outage happens or when a proxy close the connection. Annotated method needs to take the form of;
@OnClose public void onClose();
@OnClose public void onClose(RemoteEndpoint r);
@OnClose public void onClose(RemoteEndpoint r, EventBus e);
Only one method in a class can be annotated with @OnClose.
@PathParam
@PathParam is used to automatically parse the path and assign path tokens to class variables.
@PushEndpoint("/somepath/{room}/{user}")
@Singleton public class ChatResource {
@PathParam("room")
private String room;
@PathParam("user")
private String username;
//...
537
PrimeFaces User Guide
9.3 API
RemoteEndPoint
The RemoteEndpoint() class represents the remote connection, e.g the Browser. An instance of
RemoteEndpoint hold information about the headers, queryString, body, uri, path and path segments that can be used for manipulating the incoming request. If you are familiar with the Servlets
"HttpServletRequest", the RemoteEndpoint can be seen as an improved version. You can also use a
RemoteEndpoint#write to write back messages that will be delivered uniquely to the browser.
EventBus
A distributed lightweight event bus which can encompass multiple PushEndpoint instances. The event bus implements publish / subscribe and point to point messaging. Messages sent over the event bus can be of any type. For publish / subscribe, messages can be published to a Java class annotated with the [PushEndpoint#value]() using one of the method annotated with [OnMessage]().
The EventBus is the recommended way for delivering messages. EventBus is retrieved via;
EventBus eventBus = EventBusFactory.getDefault().eventBus();
Once an EventBus instance is available, publishing data to subscribers is done with overloaded publish methods.
publish(Object o): Fires given object to all connected RemoteEndPoints.
publish(String path, Object o): Fires given object to RemoteEndPoints that connected to the path.
publish(String path, Object o, Reply reply): Fires given object to RemoteEndPoints that connected to the path by passing a Reply instance. Reply is an interface with a callback called
completed(String path) that is invoked when the EventBus delivered the message to the
PushEndPoint that matches the path used to initiate the publish operation.
9.4 Socket Component
Socket is a PrimeFaces component that handles the connection between the server and the browser, common way to use socket is by defining a path and a callback to handle broadcasts.
<p:push channel="/chat" onmessage="handlePublish"/>
See Socket component documentation for the full list of available options.
Client Side API
Widget: PrimeFaces.widget.Socket
Method
connect(uri) push(json) disconnect
Params
uri json
void void void
Return Type Description
Connects to given uri.
Pushes data from client side.
Disconnects from channel.
538
PrimeFaces User Guide
9.5 Putting It All Together
PrimeFaces Showcase has various push demos, in this section two of them are covered.
9.5.1 Counter
Counter is a global counter where each button click increments the count value and new value is pushed to all subscribers.
View page has an outputText to display the value, a button to increment current value to push, a socket component to connect to /counter channel and finally the onMessage client side callback to update the UI.
<h:form>
<h:outputText value="#{counterView.count}" styleClass="display" />
<p:commandButton value="Click" actionListener="#{counterView.increment}" />
</h:form>
<p:socket onMessage="handleMessage" channel="/counter" />
<script type="text/javascript"> function handleMessage(data) {
$('.display').text(data);
}
</script> package org.primefaces.examples.push.counter; import java.io.Serializable; import javax.faces.bean.ApplicationScoped; import javax.faces.bean.ManagedBean; import org.primefaces.push.EventBus; import org.primefaces.push.EventBusFactory;
@ManagedBean
@ApplicationScoped public class CounterView implements Serializable{ private volatile int count; public int getCount() { return count;
} public void setCount(int count) { this.count = count;
} public void increment() { count++;
EventBus eventBus = EventBusFactory.getDefault().eventBus(); eventBus.publish("/counter", String.valueOf(count));
}
}
539
PrimeFaces User Guide increment button actionlistener first adds one to the counter value, gets an EventBus and then pushes the new value to all connected clients. Final piece is writing the CounterResource to handle messages whenever a data is pushed.
package org.primefaces.examples.push.counter; import org.primefaces.push.annotation.OnMessage; import org.primefaces.push.annotation.PushEndpoint; import org.primefaces.push.impl.JSONEncoder;
@PushEndpoint("/counter") public class CounterResource {
@OnMessage(encoders = {JSONEncoder.class})
public String onMessage(String count) {
return count;
}
}
In case you’d like to update components and/or invoke listeners in your backing bean on broadcast, you can use the optional message ajax behavior to implement the same functionality but with an extra request.
<h:form id="form">
<h:outputText id="out" value="#{globalCounter.count}" />
<p:commandButton value="Click" actionListener="#{globalCounter.increment}" />
</h:form>
<p:socket channel="/counter">
<p:ajax event="message" update="form:out" />
</p:socket>
540
PrimeFaces User Guide
9.5.2 FacesMessage
This sample shows how to push FacesMessages from one client to all others and display them using
Growl Component.
<p:growl widgetVar="growl" showDetail="true" />
<h:form>
<p:panel header="Growl">
<h:panelGrid columns="2">
<p:outputLabel for="summary" value="Summary: " />
<p:inputText id="summary" value="#{growlBean.summary}" required="true" />
<p:outputLabel for="detail" value="Detail: " />
<p:inputText id="detail" value="#{growlBean.detail}" required="true" />
</h:panelGrid>
<p:commandButton value="Send" actionListener="#{growlBean.send}" />
</p:panel>
</h:form>
<p:socket onMessage="handleMessage" channel="/notify" />
<script type="text/javascript"> function handleMessage(facesmessage) {
facesmessage.severity = 'info';
PF('growl').show([facesmessage]);
}
</script> package org.primefaces.examples.view; import javax.faces.application.FacesMessage; import javax.faces.bean.ManagedBean; import javax.faces.bean.RequestScoped; import javax.faces.context.FacesContext; import javax.faces.event.ActionEvent; import org.primefaces.push.EventBus; import org.primefaces.push.EventBusFactory;
@ManagedBean
@RequestScoped public class GrowlBean {
private final static String CHANNEL = "/notify";
private String text, summary, detail;
//getters-setters
public void send() {
EventBus eventBus = EventBusFactory.getDefault().eventBus();
eventBus.publish(CHANNEL, new FacesMessage(summary, detail));
}
}
541
NotifyResource simply encodes the pushed messages as JSON.
package org.primefaces.examples.push.notify; import javax.faces.application.FacesMessage; import org.primefaces.push.annotation.OnMessage; import org.primefaces.push.annotation.PushEndpoint; import org.primefaces.push.impl.JSONEncoder;
@PushEndpoint("/notify") public class NotifyResource {
@OnMessage(encoders = {JSONEncoder.class})
public FacesMessage onMessage(FacesMessage message) {
return message;
}
}
PrimeFaces User Guide
542
PrimeFaces User Guide
9.6 Tips and Tricks
Dynamic Paths
Client side API would be handy to create dynamic channels, channel name of the socket does not need to be static and you can create dynamic channels on runtime since a channel is basically a path name. @PathParam is very handy to automatically parse the Path and assign the path tokens to variables.
See chat sample in showcase for an example of dynamic channels used to send private messages.
Proxies
Proxies are problematic not just for PrimeFaces Push - Atmosphere solution but in all solutions. If your proxy supports websockets, make sure to add the necessary configuration. Another solution that is considered as a workaround is to override the default uri of the push server. Default uri is protocol://contextPath/primepush/channel, for example PrimeFaces online showcase is running on jetty that is behind an apache mod proxy which doesn’t support websockets at time of the writing.
Solution is to configure PrimeFaces to use another push server like;
<context-param>
<param-name>primefaces.PUSH_SERVER_URL</param-name>
<param-value>http://www.primefaces.org:8080</param-value>
</context-param>
So that socket component bypasses the proxy and directly communicates with the application.
Supported Server and Client Environments
Atmosphere does a agreat job in supporting different servers and browsers. See the detailed list at; https://github.com/Atmosphere/atmosphere/wiki/Supported-WebServers-and-Browsers
Scalability
Atmosphere is build to scale via plugins such as JMS, Redix, XMPP, Hazelcast and more. Refer to atmosphere documentation to see how to configure atmosphere in more than one server.
PushServlet extends from AtmosphereServlet so any configuration option for AtmosphereServlet also applies PushServlet.
543
PrimeFaces User Guide
10. PrimeFaces Mobile
PrimeFaces Mobile (PFM) is a UI Kit to create JSF applications optimized for mobile devices. PFM is built on top of jQuery Mobile, a touch-optimized HTML5 UI framework providing support for various platforms.
In addition to the seamless integration with jQuery Mobile, PFM features a Mobile Renderkit for popular PrimeFaces components, ajax framework extensions, mobile ajax behavior events, integrated navigation model, lazy loading of pages, responsive widgets and more.
10.1 Setup
Mobile ships with PrimeFaces Core so no additional download is required.
Configuration
A mobile navigation handler is necessary inside faces configuration to enable navigations support.
<application>
<navigation-handler> org.primefaces.mobile.application.MobileNavigationHandler
</navigation-handler>
</application>
Taglib
PFM provides mobile specific components with the following taglib.
xmlns:pm="http://primefaces.org/mobile"
RenderKit
RenderKit is the core part of PFM featuring optimized renderers for mobile environments. There are two main ways to enable PFM RenderKit.
Core view tag has a renderKitId attribute to set the renderer kit of the page.
<f:view renderKitId="PRIMEFACES_MOBILE" />
If your application fully consists of mobile pages, then a global configuration in faces configuration file should be preferred instead of per page configuration.
<application>
<default-render-kit-id>PRIMEFACES_MOBILE</application>
</application>
544
PrimeFaces User Guide
10.2 Pages
A mobile page is a regular facelets xhtml file with mobile page containers defined with pm:page.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:p="http://primefaces.org/ui"
xmlns:pm="http://primefaces.org/mobile">
<f:view renderKitId="PRIMEFACES_MOBILE" />
<h:head>
</h:head>
<h:body>
<pm:page>
<pm:header title="Basic Page"></pm:header>
<pm:content></pm:content>
</pm:page>
</html>
</h:body>
A single page xhtml view can have more than one page. By default the first page is visible on load.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:p="http://primefaces.org/ui"
xmlns:pm="http://primefaces.org/mobile">
<f:view renderKitId="PRIMEFACES_MOBILE" />
<h:head>
</h:head>
<h:body>
<pm:page id="main">
<pm:header title="Main Page"></pm:header>
<pm:content></pm:content>
</pm:page>
<pm:page id="second">
<pm:header title="Second Page"></pm:header>
<pm:content></pm:content>
</pm:page>
</html>
</h:body>
545
PrimeFaces User Guide
10.2 Navigations
PFM supports all kinds of standard navigations with the addition of a custom navigation model.
Internal
Internal navigation is between pages in the same xhtml view. Outcome should have the pm: prefix for this kind of navigation. Using the multi page sample at section 10.1;
<p:button outcome="pm:second" />
<p:link outcome="pm:second" />
Button and Link components displays the page whose id is second. In case you'd like to navigate after a POST request, usage would be similar.
<p:commandButton value="Go to Second" action="#{bean.go}" /> public String go() { return "pm:second";
}
External
External navigations to another xhtml in same domain or a resource in another domain is same as standard approach.
<p:button outcome="/ui/home" value="Home" />
<p:button href=" http://www.primefaces.org
" value="Home" />
Transitions
Various animations are available to run during the navigation. Name of the effect is appended to the outcome. In addition, reverse option is provided for back navigations.
<p:button outcome="pm:second?transition=pop" />
<p:link outcome="pm:second?transition=flip&reverse=true" />
List of possible transitions is fade, pop, flip, turn, flow, slide, slidefade, slideup and slidedown. Fade is the default transition and to turn off animation, set none as the value.
Client API
A client side API is available to navigate manually from a custom javascript code. Signature is;
PrimeFaces.Mobile.navigate(to, cfg);
PrimeFaces.Mobile.navigate('#second', { reverse: true|false, transition: 'fade'
});
546
PrimeFaces User Guide
10.3 Components
10.3.1 Content
Content is container component for the content area of a page.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
content org.primefaces.mobile.component.content.Content
org.primefaces.mobile.Content
org.primefaces.mobile.component
org.primefaces.mobile.component.ContentRenderer
org.primefaces.mobile.component.content.ContentRenderer
Attributes
Name
id rendered binding style styleClass null null null null true
Default Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object
String
An el expression that maps to a server side
UIComponent instance in a backing bean
Inline style of the component.
String Style class of the component.
Getting Started with the Content
Content is a children component of a page.
<pm:page>
<pm:content>
//page content
</pm:content>
</pm:page>
547
10.3.2 Field
Field is a responsive layout component for label-input pairs.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
field org.primefaces.mobile.component.field.Field
org.primefaces.mobile.Field
org.primefaces.mobile.component
org.primefaces.mobile.component.FieldRenderer
org.primefaces.mobile.component.field.FieldRenderer
PrimeFaces User Guide
Attributes
Name
id rendered binding null true
Default
null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
Getting Started with the Field
Field is used as the container of a label and an input component. As a responsive component, field displays the optimal placement for its children based on available width.
<pm:field>
<p:outputLabel for="text" value="Text:" />
<p:inputText id="txt" />
</pm:field>
548
PrimeFaces User Guide
10.3.3 Footer
Footer is container component for the bottom area of a page.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
footer org.primefaces.mobile.component.footer.Footer
org.primefaces.mobile.Footer
org.primefaces.mobile.component
org.primefaces.mobile.component.FooterRenderer
org.primefaces.mobile.component.footer.FooterRenderer
Attributes
Name
id rendered binding title fixed theme tapToggle style styleClass
Default
null true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Title text of the footer.
false null true null null
Boolean
String
Positions the footer as fixed on scroll.
Swatch of the component.
Boolean For fixed footers, sets whether the fixed toolbar's visibility can be toggled by tapping on the page.
String Inline style of the component.
String Style class of the component.
Getting Started with the Footer
Footer is a children component of a page.
<pm:page>
<pm:footer title="Footer"></pm:footer>
</pm:page>
549
PrimeFaces User Guide
10.3.4 Header
Header is container component for the top area of a page.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
header org.primefaces.mobile.component.header.Header
org.primefaces.mobile.Header
org.primefaces.mobile.component.Header
org.primefaces.mobile.component.HeaderRenderer
org.primefaces.mobile.component.header.HeaderRenderer
Attributes
Name
id rendered binding title fixed theme style styleClass
Default
null true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Title text of the header.
false null null null
Boolean
String
String
String
Positions the header as fixed on scroll.
Swatch of the component.
Inline style of the component.
Style class of the component.
Getting Started with the Header
Header is a children component of a page.
<pm:page>
<pm:header title="Footer"></pm:header>
</pm:page>
550
PrimeFaces User Guide
10.3.5 InputSlider
InputSlider is an input component with a touch enabled slider.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
inputSlider org.primefaces.mobile.component.inputslider.InputSlider
org.primefaces.mobile.InputSlider
org.primefaces.mobile.component.
org.primefaces.mobile.component.InputSliderRenderer
org.primefaces.mobile.component.inputslider.InputSliderRenderer
Attributes
id rendered binding value converter immediate required validator
Name
valueChangeListener requiredMessage
Default
null true null null null false false null null null
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
Object An el expression that maps to a server side
UIComponent instance in a backing bean
Object Value of the component.
Object An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id.
Boolean When set true, process validations logic is executed at apply request values phase for this component.
Boolean Marks component as required
Object
Object
String
A method binding expression that refers to a method validationg the input.
A method binding expression that refers to a method for handling a valuechangeevent.
Message to be displayed when required field validation fails.
551
Name
converterMessage validatorMessage minValue maxValue style styleClass step disabled label highlight
100 null null
1
Default
null null
0 false null false
PrimeFaces User Guide
Type
String
String
Integer
Integer
String
String
String
Description
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Minimum value of the slider.
Maximum value of the slider.
Inline style of the component.
Style class of the component.
Step factor to apply on slider move.
Boolean Disables or enables the slider.
String User presentable name.
Boolean Highlights the value range when enabled.
Getting Started with the InputSlider
InputSlider requires an integer as its value.
<pm:inputSlider value="50" />
<pm:inputSlider value="#{backingView.integerProperty}" />
Boundaries
0 and 100 are the default boundaries, these can be customized using minValue and maxValue.
<pm:inputSlider minValue="100" maxValue="200" value="#{backingView.intProperty}"/>
552
10.3.6 Page
Page is main component to define an internal page within an xhtml.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
page org.primefaces.mobile.component.page.Page
org.primefaces.mobile.Page
org.primefaces.mobile.component
org.primefaces.mobile.component.PageRenderer
org.primefaces.mobile.component.page.PageRenderer
PrimeFaces User Guide
Attributes
Name
id rendered binding title theme style styleClass lazy null null null false
Default
null true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null
Object
String
An el expression that maps to a server side UIComponent instance in a backing bean
Title text of the page.
String
String
Swatch of the page.
Inline style of the component.
String Style class of the component.
Boolean Lazy loading views are not rendered on initial page load to improve performance and instead lazily loaded on demand when there are first navigated to.
Getting Started with the Page
Please see section 10.1 Pages for the usage and more information.
553
PrimeFaces User Guide
10.3.7 RangeSlider
RangeSlider is a grouping component for dual sliders to create a range selection.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
rangeSlider org.primefaces.mobile.component.rangeslider.RangeSlider
org.primefaces.mobile.RangeSlider
org.primefaces.mobile.component
org.primefaces.mobile.component.RangeSlider
org.primefaces.mobile.component.rangeslider.RangeSlider
Attributes
Name
id rendered binding style styleClass highlight
Default
null true
Type
String
Description
Unique identifier of the component
Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.
null null null false
Object An el expression that maps to a server side UIComponent instance in a backing bean
String
String
Inline style of the component.
Style class of the component.
Boolean Highlights the value range when enabled.
Getting Started with the RangeSlider
RangeSlider needs two sliders as children, first slider is for the start of range and second for the end.
<pm:rangeSlider>
<pm:inputSlider value="#{backingView.start}"/>
<pm:inputSlider value="#{backingView.end}"/>
</pm:rangeSlider>
554
PrimeFaces User Guide
10.3.8 Switch (Deprecated)
Switch is deprecated, use p:inputSwitch instead.
Switch is an input component to select a boolean value.
Info
Tag
Component Class
Component Type
Component Family
Renderer Type
Renderer Class
switch org.primefaces.mobile.component.uiswitch.UISwitch
org.primefaces.mobile.UISwitch
org.primefaces.mobile.component
org.primefaces.mobile.component.UISwitchRenderer
org.primefaces.mobile.component.uiswitch.UISwitchRenderer
Attributes
id rendered
Name
binding value converter immediate required validator
Default
null true null null null false false null
Type
String
Boolean
Object
Object
Object
Boolean
Boolean
Object
Description
Unique identifier of the component
Boolean value to specify the rendering of the component, when set to false component will not be rendered.
An el expression that maps to a server side
UIComponent instance in a backing bean
Value of the component.
An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id.
When set true, process validations logic is executed at apply request values phase for this component.
Marks component as required
A method binding expression that refers to a method validationg the input.
555
Name Default
valueChangeListener null requiredMessage converterMessage validatorMessage onLabel offLabel label style styleClass label disabled onchange null null null null null null null on off false false
Type
Object
String
PrimeFaces User Guide
Description
A method binding expression that refers to a method for handling a valuechangeevent.
Message to be displayed when required field validation fails.
String
String
Integer
Integer
String
String
String
String
Message to be displayed when conversion fails.
Message to be displayed when validation fields.
Minimum value of the slider.
Maximum value of the slider.
User presentable name.
Inline style of the component.
Style class of the component.
User presentable name.
Boolean Disables or enables the switch.
String Client side callback to execute on change event.
Getting Started with the Switch
Value of switch should be a boolean property, if the value is false offLabel would be displayed and onLabel would be used otherwise.
<pm:switch value="#{backingView.booleanProperty}" />
556
PrimeFaces User Guide
10.4 RenderKit
In addition to the mobile components, various core components have been enhanced with mobile renderers so that same component can be optimized for a mobile browser. Since usage is same in desktop and mobile environments, refer to chapter 3 for documentation about these components.
10.4.1 AccordionPanel
10.4.2 AutoComplete
10.4.3 Button
557
10.4.4 Calendar
10.4.5 DataList
10.4.6 Dialog
10.4.7 FileUpload
558
PrimeFaces User Guide
10.4.8 Growl
10.4.9 InputText
10.4.10 InputTextarea
10.4.11 Link
10.4.12 Menu
10.4.13 Panel
PrimeFaces User Guide
559
10.4.14 PanelGrid
10.4.15 SelectBooleanCheckbox
10.4.16 SelectCheckboxMenu
10.4.17 SelectManyButton
10.4.18 SelectManyCheckbox
10.4.19 SelectOneButton
10.4.20 SelectOneMenu
10.4.21 SelectOneRadio
10.4.22 TabMenu
560
PrimeFaces User Guide
10.4.24 TabView
10.4.25 Toolbar
PrimeFaces User Guide
561
PrimeFaces User Guide
10.5 Themes
Mobile theming is similar to the core theming documented at chapter 8. Main difference is the swatch concept of mobile themes where one theme can contain multiple swatches. Default theme has two swatches a and b. A swatch can be applied using swatch attribute when available.
<pm:header title="Header" swatch="b"></pm:header>
Custom Theme
There is a mobile themeroller application to create a custom theme.
http://themeroller.jquerymobile.com
After creating the theme and downloading it as a zip file, a jar file has to be created to install the theme with the same folder structure as a desktop theme.
jar
-
META-INF
resources
primefaces-mytheme
theme.css
images
1) The theme package downloaded from ThemeRoller will have a themename.css file and images folder. Extract the contents of the package and rename themename.css to theme.css.
2) Image references in your theme.css must also be converted to an expression that JSF resource loading can understand, example would be; url("images/ui-bg_highlight-hard_100_f9f9f9_1x100.png") should be; url("#{resource['primefaces-mytheme:images/ui-bg_highlight-hard_100_f9f9f9_1x100.png']}")
Once the jar of your theme is in classpath, you can enable the theme by the following configuration.
<context-param>
<param-name>primefaces.mobile.THEME</param-name>
<param-value>mytheme</param-value>
</context-param> param-value can be an EL expression as well to implement dynamic theming.
562
PrimeFaces User Guide
10.6 Framework
In addition to the UI components, PFM provides seamless integration with jQuery Mobile.
10.6.1 Ajax Updates
Plain jQuery Mobile UI elements use progressive enhancement approach that runs once on page load, this breaks JSF ajax updates since the updated parts cannot be enhanced again. PFM takes care of this problem under the hood.
As an example, the plain jquery mobile datalist and inputtext will lose all styling and functionality when updated with standard ajax commandbutton whereas PFM commandButton will properly update the datalist and inputtext.
<h:commandButton value="Standard">
<f:ajax render="panel1" />
</h:commandButton>
<p:commandButton value="PFM" update="panel2" icon="ui-icon-refresh"/>
<h:panelGroup id="panel1">
<ul data-role="listview" data-inset="true">
<li><a href="#">Item 1</a></li>
<li><a href="#">Item 2</a></li>
<li><a href="#">Item 3</a></li>
</ul>
<h:inputText />
</h:panelGroup>
<p:outputPanel id="panel2">
<p:menu styleClass="ui-listview-inset ui-corner-all">
<p:menuitem value="Item1" url="#" />
<p:menuitem value="Item2" url="#" />
<p:menuitem value="Item3" url="#" />
</p:menu>
<p:inputText />
</p:outputPanel>
10.6.2 Pass Through Elements
jQM is data attribute driven, thanks to JSF 2.2's dynamic attributes support, PrimeFaces
Components can have mobile specific options easily. Example below adds inset setting to a datalist.
<p:dataList value="#{ringBean.players}" var="player" pt:data-inset="true">
//content
</p:dataList>
Note that pt is the standard taglib; xmlns:pt="http://xmlns.jcp.org/jsf/passthrough". For the full list of available data attributes, consult the jQuery Mobile documentation.
563
PrimeFaces User Guide
10.6.3 Lazy Pages
For a mobile device with bandwith concerns, loading all the pages in same xhtml at once in an eager fashion is not optimal and might cause performance issues if the page size is big. PFM supports lazy loading pages where a page content is not rendered at first but loaded with ajax just before accessed for the first time. Lazy loading is disabled and activated by setting lazy option on page component.
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://java.sun.com/jsf/html" xmlns:f="http://java.sun.com/jsf/core" xmlns:p="http://primefaces.org/ui"
xmlns:pm="http://primefaces.org/mobile">
<f:view renderKitId="PRIMEFACES_MOBILE" />
<h:head></h:head>
<h:body>
<pm:page id="main">
<pm:header title="Main Page"></pm:header>
<pm:content>
<p:link outcome="pm:second" value="Go" />
</pm:content>
</pm:page>
<pm:page id="second" lazy="true">
<pm:header title="Second Page"></pm:header>
<pm:content>
//Lazy loaded content
</pm:content>
</html>
</pm:page>
</h:body>
At first page load, second page contents are not available on page, clicking the link first makes an ajax request to fetch the contents, create the UI and then finally navigate to it.
10.6.4 Touch Events
Touch events like swipe are enabled in some components. In following, items in the list can be removed by swipeleft or swiperight and detail is displayed with taphold.
<h:form id="form">
<p:growl id="msgs" showDetail="true" />
<p:dataList value="#{tableBean.carsSmall}" var="car" pt:data-inset="true">
<p:ajax event="swipeleft" listener="#{tableBean.swipeCar}"
update=":form:msgs @this"/>
<p:ajax event="swiperight" listener="#{tableBean.swipeCar}"
update=":form:msgs @this"/>
<p:ajax event="taphold" listener="#{tableBean.onRowSelect}" update=":form:msgs"/>
<h:outputText value="#{car.manufacturer} - #{car.color}" />
</p:dataList>
</h:form>
564
PrimeFaces User Guide public void onRowSelect(SelectEvent event) {
FacesMessage msg = new FacesMessage("Car Selected",
((Car) event.getObject()).getModel());
FacesContext.getCurrentInstance().addMessage(null, msg);
} public void swipeCar(SwipeEvent event) {
Car car = (Car) event.getData(); carsSmall.remove(car);
FacesContext.getCurrentInstance().addMessage(null, new FacesMessage(FacesMessage.SEVERITY_INFO,
"Car Swiped", "Removed: " + car.getModel()));
}
Sections 10.4 and 10.5 contains supported mobile events for a component when available.
565
PrimeFaces User Guide
11. Utilities
11.1 RequestContext
RequestContext is a simple utility that provides useful goodies such as adding parameters to ajax callback functions. RequestContext is available in both ajax and non-ajax requests.
RequestContext can be obtained similarly to the FacesContext.
RequestContext requestContext = RequestContext.getCurrentInstance();
RequestContext API
Method
Specifies component(s) to update at runtime.
Executes script after ajax request completes or on page load.
Description
isAjaxRequest() Returns a boolean value if current request is a
PrimeFaces ajax request.
addCallBackParam(String name, Object value) Adds parameters to ajax callbacks like oncomplete.
update(String clientId); execute(String script) scrollTo(String clientId) Scrolls to the component with given clientId after ajax request completes.
Callback Parameters
There may be cases where you need values from backing beans in ajax callbacks. Callback parameters are serialized to JSON and provided as an argument in ajax callbacks for this.
<p:commandButton actionListener="#{bean.validate}" oncomplete="handleComplete(xhr, status, args)" /> public void validate() {
//isValid = calculate isValid
RequestContext requestContext = RequestContext.getCurrentInstance(); requestContext.addCallbackParam("isValid", true or false);
}
isValid parameter will be available in handleComplete callback as;
<script type="text/javascript"> function handleComplete(xhr, status, args) { var isValid = args.isValid;
}
</script>
You can add as many callback parameters as you want with addCallbackParam API. Each parameter is serialized as JSON and accessible through args parameter so pojos are also supported just like
566
PrimeFaces User Guide primitive values. Following example sends a pojo called User that has properties like firstname and lastname to the client in addition to isValid boolean value.
public void validate() {
//isValid = calculate isValid
RequestContext requestContext = RequestContext.getCurrentInstance();
requestContext.addCallbackParam("isValid", true or false);
requestContext.addCallbackParam("user", user);
}
<script type="text/javascript"> function handleComplete(xhr, status, args) { var firstname = args.user.firstname; var lastname = args.user.lastname;
}
</script>
By default validationFailed callback parameter is added implicitly if validation fails.
Runtime Updates
Conditional UI update is quite common where different parts of the page need to be updated based on a dynamic condition. In this case, it is not efficient to use declarative update and defined all update areas since this will cause unncessary updates.There may be cases where you need to define which component(s) to update at runtime rather than specifying it declaratively. update method is added to handle this case. In example below, button actionListener decides which part of the page to update on-the-fly.
<p:commandButton value="Save" actionListener="#{bean.save}" />
<p:panel id="panel"> ... </p:panel>
<p:dataTable id="table"> ... </p:panel> public void save() {
//boolean outcome = ...
RequestContext requestContext = RequestContext.getCurrentInstance(); if(outcome) requestContext.update("panel"); else requestContext.update("table");
}
When the save button is clicked, depending on the outcome, you can either configure the datatable or the panel to be updated with ajax response.
Execute Javascript
RequestContext provides a way to execute javascript when the ajax request completes, this approach is easier compared to passing callback params and execute conditional javascript.
Example below hides the dialog when ajax request completes;
567
PrimeFaces User Guide public void save() {
RequestContext requestContext = RequestContext.getCurrentInstance(); requestContext.execute(“dialog.hide()”);
}
568
PrimeFaces User Guide
11.2 EL Functions
PrimeFaces provides built-in EL extensions that are helpers to common use cases.
Common Functions
Function
component('id') widgetVar('id')
Description
Returns clientId of the component with provided server id parameter. This function is useful if you need to work with javascript.
Provides the widgetVar of a component in PF('') format.
Component
<h:form id="form1">
<h:inputText id="name" />
</h:form>
//#{p:component(‘name’)} returns ‘form1:name’
WidgetVar
<p:dialog id="dlg">
//contents
</p:dialog>
<p:commandButton type="button" value="Show" onclick="#{p:widgetVar(‘dlg’)}.show()" />
Page Authorization
Authorization function use HttpServletRequest API for the backend information.
Function
ifGranted(String role) ifAllGranted(String roles) ifAnyGranted(String roles) ifNotGranted(String roles) remoteUser() userPrincipal()
Description
Returns true if user has the given role, else false.
Returns true if user has all of the given roles, else false.
Returns true if user has any of the given roles, else false.
Returns true if user has none of the given roles, else false.
Returns the name of the logged in user.
Returns the principal instance of the logged in user.
<p:commandButton rendered="#{p:ifGranted('ROLE_ADMIN')}" />
<h:inputText disabled="#{p:ifGranted('ROLE_GUEST')}" />
<p:inputMask rendered="#{p:ifAllGranted('ROLE_EDITOR, ROLE_READER')}" />
569
PrimeFaces User Guide
11.3 Exception Handler
PrimeFaces provides a built-in exception handler to take care of exceptions in ajax and non-ajax requests easily.
Configuration
ExceptionHandler and an ElResolver configured is required in faces configuration file.
<application>
<el-resolver> org.primefaces.application.exceptionhandler.PrimeExceptionHandlerELResolver
</el-resolver>
</application>
<factory>
<exception-handler-factory> org.primefaces.application.exceptionhandler.PrimeExceptionHandlerFactory
</exception-handler-factory>
</factory>
Error Pages
ExceptionHandler is integrated with error-page mechanism of Servlet API. At application startup,
PrimeFaces parses the error pages and uses this information to find the appropriate page to redirect to based on the exception type. Here is an example web.xml configuration with a generic page for exceptions and a special page for ViewExpiredException type.
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" >
<!-- Other application configuration -->
<error-page>
<exception-type>java.lang.Throwable</exception-type>
<location>/ui/error/error.jsf</location>
</error-page>
<error-page>
<exception-type>javax.faces.application.ViewExpiredException</exception-type>
<location>/ui/error/viewExpired.jsf</location>
</error-page>
</web-app>
570
PrimeFaces User Guide
Exception Information
In the error page, information about the exception is provided via the pfExceptionHandler EL keyword. Here is the list of exposed properties.
- exception: Throwable instance.
- type: Type of the exception.
- message: Exception message:
- stackTrace: An array of java.lang.StackTraceElement instances.
- formattedStackTrace: Stack trace as presentable string.
- timestamp: Timestamp as date.
- formattedTimestamp: Timestamp as presentable string.
In error page, exception metadata is accessed using EL;
<h:outputText value="Message:#{pfExceptionHandler.message}" />
<h:outputText value="#{pfExceptionHandler.formattedStackTrace}" escape="false" />
Ajax Exception Handler Component
A specialized exception handler component provides a way to execute callbacks on client side, update other components on the same page. This is quite useful in case you don't want to create a separate error page. Following example shows the exception in a dialog on the same page.
<p:ajaxExceptionHandler type="javax.faces.application.ViewExpiredException" update="exceptionDialog" onexception="PF('exceptionDialog').show();" />
<p:dialog id="exceptionDialog" header="Exception: #{pfExceptionHandler.type} occured!" widgetVar="exceptionDialog" height="500px">
Message: #{pfExceptionHandler.message} <br/>
StackTrace: <h:outputText value="#{pfExceptionHandler.formattedStackTrace}" escape="false" />
<p:button onclick="document.location.href = document.location.href;"
value="Reload!"/>
</p:dialog>
Ideal location for p:ajaxExceptionHandler component is the facelets template so that it gets included in every page. Refer to component documentation of p:ajaxExceptionHandler for the available attributes.
Render Response Exceptions
To support exception handling in the RENDER_RESPONSE phase, it's required to set the
javax.faces.FACELETS_BUFFER_SIZE parameter. Otherwise you will probably see a
ServletException with "Response already committed" message.
571
PrimeFaces User Guide
11.4 BeanValidation Transformation
Since JavaEE 6, validation metadata is already available for many components via the value reference and BeanValidation (e.g. @NotNull, @Size). The JSF Implementations use this information for server side validation and PrimeFaces enhances this feature with client side validation framework.
PrimeFaces makes use of these metadata by transforming them to component and html attributes.
For example sometimes it’s required to manually maintain the required or maxlength attribute for input components. The required attribute also controls the behavior of p:outputLabel to show or hide the required indicator (*) whereas the maxlength attribute is used to limit the characters on input fields. BeanValidation transformation features enables avoiding manually maintaining these attributes anymore by implicility handling them behind the scenes.
Configuration
To start with, transformation should be enabled.
<context-param>;
<param-name>primefaces.TRANSFORM_METADATA</param-name>
<param-value>true</param-value>
</context-param>
Usage
Define constraints at bean level.
@NotNull
@Max(30) private String firstname;
Component at view does not have any constraints;
<p:inputText value="#{bean.firstname}" />
Final output has html maxlength attribute generated from the @Max annotation, also the component instance has required enabled.
<input type="text" maxlength="30" … />
572
PrimeFaces User Guide
11.5 PrimeFaces Locales
Components may require translations and other settings based on different locales. This is handled with a client side api called PrimeFaces Locales. A client side locale is basically a javascript object with various settings, en_US is the default locale provided out of the box. In case you need to support another locale, settings should be extended with the new information.
A wiki page is available for user contributed settings, the list is community driven and a good starting point although it might be incomplete.
https://code.google.com/p/primefaces/wiki/PrimeFacesLocales
Default Locale
Here is the list of all key-value pairs for en_US locale that is provided by PrimeFaces. DateTime related properties are utilized by components such as calendar and schedule. If you are using Client
Side Validation, messages property is used as the bundle for the locale.
{
closeText: 'Close',
prevText: 'Previous',
nextText: 'Next',
monthNames: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September',
'October', 'November', 'December' ],
monthNamesShort: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' ],
dayNames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
dayNamesShort: ['Sun', 'Mon', 'Tue', 'Wed', 'Tue', 'Fri', 'Sat'],
dayNamesMin: ['S', 'M', 'T', 'W ', 'T', 'F ', 'S'],
weekHeader: 'Week',
firstDay: 0,
isRTL: false,
showMonthAfterYear: false,
yearSuffix:'',
timeOnlyTitle: 'Only Time',
timeText: 'Time',
hourText: 'Time',
minuteText: 'Minute',
secondText: 'Second',
currentText: 'Current Date',
ampm: false,
month: 'Month',
week: 'week',
day: 'Day',
allDayText: 'All Day',
messages: {
'javax.faces.component.UIInput.REQUIRED': '{0}: Validation Error: Value is required.',
'javax.faces.converter.IntegerConverter.INTEGER': '{2}: \'{0}\' must be a number consisting of one or more digits.',
'javax.faces.converter.IntegerConverter.INTEGER_detail': '{2}: \'{0}\' must be a number between -2147483648 and 2147483647 Example: {1}',
573
PrimeFaces User Guide
'javax.faces.converter.DoubleConverter.DOUBLE': '{2}: \'{0}\' must be a number consisting of one or more digits.',
'javax.faces.converter.DoubleConverter.DOUBLE_detail': '{2}: \'{0}\' must be a number between 4.9E-324 and 1.7976931348623157E308 Example: {1}',
'javax.faces.converter.BigDecimalConverter.DECIMAL': '{2}: \'{0}\' must be a signed decimal number.',
'javax.faces.converter.BigDecimalConverter.DECIMAL_detail': '{2}: \'{0}\' must be a signed decimal number consisting of zero or more digits, that may be followed by a decimal point and fraction. Example: {1}',
'javax.faces.converter.BigIntegerConverter.BIGINTEGER': '{2}: \'{0}\' must be a number consisting of one or more digits.',
'javax.faces.converter.BigIntegerConverter.BIGINTEGER_detail': '{2}: \'{0}\' must be a number consisting of one or more digits. Example: {1}',
'javax.faces.converter.ByteConverter.BYTE': '{2}: \'{0}\' must be a number between 0 and
255.',
'javax.faces.converter.ByteConverter.BYTE_detail': '{2}: \'{0}\' must be a number between
0 and 255. Example: {1}',
'javax.faces.converter.CharacterConverter.CHARACTER': '{1}: \'{0}\' must be a valid character.',
'javax.faces.converter.CharacterConverter.CHARACTER_detail': '{1}: \'{0}\' must be a valid ASCII character.',
'javax.faces.converter.ShortConverter.SHORT': '{2}: \'{0}\' must be a number consisting of one or more digits.',
'javax.faces.converter.ShortConverter.SHORT_detail': '{2}: \'{0}\' must be a number between -32768 and 32767 Example: {1}',
'javax.faces.converter.BooleanConverter.BOOLEAN': '{1}: \'{0}\' must be \'true\' or \'false\'',
'javax.faces.converter.BooleanConverter.BOOLEAN_detail': '{1}: \'{0}\' must be \'true\' or
\'false\'. Any value other than \'true\' will evaluate to \'false\'.',
'javax.faces.validator.LongRangeValidator.MAXIMUM': '{1}: Validation Error: Value is greater than allowable maximum of \'{0}\'',
'javax.faces.validator.LongRangeValidator.MINIMUM': '{1}: Validation Error: Value is less than allowable minimum of \'{0}\'',
'javax.faces.validator.LongRangeValidator.NOT_IN_RANGE': '{2}: Validation Error:
Specified attribute is not between the expected values of {0} and {1}.',
'javax.faces.validator.LongRangeValidator.TYPE={0}': 'Validation Error: Value is not of the correct type.',
'javax.faces.validator.DoubleRangeValidator.MAXIMUM': '{1}: Validation Error: Value is greater than allowable maximum of \'{0}\'',
'javax.faces.validator.DoubleRangeValidator.MINIMUM': '{1}: Validation Error: Value is less than allowable minimum of \'{0}\'',
'javax.faces.validator.DoubleRangeValidator.NOT_IN_RANGE': '{2}: Validation Error:
Specified attribute is not between the expected values of {0} and {1}',
'javax.faces.validator.DoubleRangeValidator.TYPE={0}': 'Validation Error: Value is not of the correct type',
'javax.faces.converter.FloatConverter.FLOAT': '{2}: \'{0}\' must be a number consisting of one or more digits.',
'javax.faces.converter.FloatConverter.FLOAT_detail': '{2}: \'{0}\' must be a number between 1.4E-45 and 3.4028235E38 Example: {1}',
'javax.faces.converter.DateTimeConverter.DATE': '{2}: \'{0}\' could not be understood as a date.',
574
PrimeFaces User Guide
'javax.faces.converter.DateTimeConverter.DATE_detail': '{2}: \'{0}\' could not be understood as a date. Example: {1}',
'javax.faces.converter.DateTimeConverter.TIME': '{2}: \'{0}\' could not be understood as a time.',
'javax.faces.converter.DateTimeConverter.TIME_detail': '{2}: \'{0}\' could not be understood as a time. Example: {1}',
'javax.faces.converter.DateTimeConverter.DATETIME': '{2}: \'{0}\' could not be understood as a date and time.',
'javax.faces.converter.DateTimeConverter.DATETIME_detail': '{2}: \'{0}\' could not be understood as a date and time. Example: {1}',
'javax.faces.converter.DateTimeConverter.PATTERN_TYPE': '{1}: A \'pattern\' or \'type\' attribute must be specified to convert the value \'{0}\'',
'javax.faces.converter.NumberConverter.CURRENCY': '{2}: \'{0}\' could not be understood as a currency value.',
'javax.faces.converter.NumberConverter.CURRENCY_detail': '{2}: \'{0}\' could not be understood as a currency value. Example: {1}',
'javax.faces.converter.NumberConverter.PERCENT': '{2}: \'{0}\' could not be understood as a percentage.',
'javax.faces.converter.NumberConverter.PERCENT_detail': '{2}: \'{0}\' could not be understood as a percentage. Example: {1}',
'javax.faces.converter.NumberConverter.NUMBER': '{2}: \'{0}\' could not be understood as a date.',
'javax.faces.converter.NumberConverter.NUMBER_detail': '{2}: \'{0}\' is not a number.
Example: {1}',
'javax.faces.converter.NumberConverter.PATTERN': '{2}: \'{0}\' is not a number pattern.',
'javax.faces.converter.NumberConverter.PATTERN_detail': '{2}: \'{0}\' is not a number pattern. Example: {1}',
'javax.faces.validator.LengthValidator.MINIMUM': '{1}: Validation Error: Length is less than allowable minimum of \'{0}\'',
'javax.faces.validator.LengthValidator.MAXIMUM': '{1}: Validation Error: Length is greater than allowable maximum of \'{0}\'',
'javax.faces.validator.RegexValidator.PATTERN_NOT_SET': 'Regex pattern must be set.',
'javax.faces.validator.RegexValidator.PATTERN_NOT_SET_detail': 'Regex pattern must be set to non-empty value.',
'javax.faces.validator.RegexValidator.NOT_MATCHED': 'Regex Pattern not matched',
'javax.faces.validator.RegexValidator.NOT_MATCHED_detail': 'Regex pattern of \'{0}\' not matched',
'javax.faces.validator.RegexValidator.MATCH_EXCEPTION': 'Error in regular expression.',
'javax.faces.validator.RegexValidator.MATCH_EXCEPTION_detail': 'Error in regular expression, \'{0}\''
}
}
Usage
To add another locale to the API, first create the locale object first with settings and assign it as a property of PrimeFaces.locales javascript object such as;
PrimeFaces.locales['de'] = {//settings}
It is suggested to put this code in a javascript file and include the file into your pages.
575
PrimeFaces User Guide
12. Portlets
PrimeFaces supports portlet environments based on JSF 2 and Portlet 2 APIs. A portlet bridge is necessary to run a JSF application as a portlet and we suggest LiferayFaces bridge as the implementation. Both teams work together time to time to make sure PrimeFaces runs well on liferay. A kickstart example with necessary configuration is available at LiferayFaces Demos; http://www.liferay.com/community/liferay-projects/liferay-faces/demos
Demo contains a single "Job Application" portlet within the WAR that demonstrates several of the key features of JSF 2 and PrimeFaces;
- Uses the PrimeFaces <p:calendar/> tag for a popup date selector
- Uses the JSF 2 <f:ajax /> tag on the postal (zip) code field in order to provide the ability to autofill fields via Ajax
- Uses the JSF 2 <f:ajax /> tag on the show/hide comments links in order to show/hide the comments field via Ajax
- Model managed-bean is marked with the JSF 2 @ViewScoped annotation in order to support a rich UI with the <f:ajax /> tag
- Uses the JSF 2 <f:ajax /> tag to show navigation-rules executing without full page refreshes
- File upload capabilities via <h:form enctype="multipart/form-data">
- Managed-beans defined by marking POJOs with the JSF 2 @ManagedBean annotation
- Dependency injection of managed-beans done via the JSF 2 @ManagedProperty annotation
- Uses the PrimeFaces p:fileUpload tag for multi-file Ajax-based file upload
- Uses the PrimeFaces p:dataTable tag to list the uploaded files
- Uses the PrimeFaces p:confirmDialog tag to popup a yes/no dialog to verify file deletion
576
PrimeFaces User Guide
13. Right-To-Left
Right-To-Left language support in short RTL is provided out of the box by a subset of PrimeFaces components. Any component equipped with dir attribute has the official support and there is also a global setting to switch to RTL mode globally.
Here is an example of an RTL AccordionPanel enabled via dir setting.
<p:accordionPanel dir="rtl">
//tabs
</p:accordionPanel>
Global Configuration
Using primefaces.DIR global setting to rtl instructs PrimeFaces RTL aware components such as datatable, accordion, tabview, dialog, tree to render in RTL mode.
<context-param>
<param-name>primefaces.DIR</param-name>
<param-value>rtl</param-value>
</context-param>
Parameter value can also be an EL expression for dynamic values.
In upcoming PrimeFaces releases, more components will receive built-in RTL support. Until then if the component you use doesn’t provide it, overriding css and javascript in your application would be the solution.
577
PrimeFaces User Guide
14. IDE Support
14.1 NetBeans
NetBeans 7.0+ bundles PrimeFaces, when creating a new project you can select PrimeFaces from components tab;
Code completion is supported by NetBeans 6.9+ ;
578
PrimeFaces User Guide
PrimeFaces and NetBeans teams are in communication to discuss the next step of PrimeFaces integration in NetBeans at the time of writing.
PrimeFaces CRUD Plugin
Starting with NetBeans 8, the IDE provides a built-in CRUD plugin for PrimeFaces out of the box.
www.youtube.com/watch?v=5aTFiNxzXF4
There is also another 3 rd party plugin for NetBeans called PrimeFaces CRUD Generator.
http://sourceforge.net/projects/nbpfcrudgen/
14.2 Eclipse
Code completion works out of the box for Eclipse when JSF facet is enabled.
579
PrimeFaces User Guide
15. Project Resources
Documentation
This guide is the main resource for documentation, for additional documentation like apidocs, taglib docs, wiki and more please visit; http://www.primefaces.org/documentation.html
Support Forum
PrimeFaces discussions take place at the support forum. Forum is public to everyone and registration is required to do a post.
http://forum.primefaces.org
Source Code
PrimeFaces source is at google code subversion repository.
http://code.google.com/p/primefaces/source/
Issue Tracker
PrimeFaces issue tracker uses google code’s issue management system. Please use the forum beforecreating an issue instead.
http://code.google.com/p/primefaces/issues/list
WIKI
PrimeFaces Wiki is a community driven additional documentation resource.
http://wiki.primefaces.org
Showcase
Showcase is a great resource as a live documentation.
http://www.primefaces.org/showcase
Social Networks
You can follow PrimeFaces on twitter using @primefaces and join the Facebook group for news and more.
580
PrimeFaces User Guide
16. FAQ
1. Who develops PrimeFaces?
PrimeFaces is developed and maintained by PrimeTek, a software development company specialized in UI solutions for JavaEE.
2. How can I get support?
Support forum is the main area to ask for help, it’s publicly available and free registration is required before posting. Please do not email the developers of PrimeFaces directly and use support forum instead.
3. Is enterprise support available?
Yes, enterprise support is also available. Please visit support page on PrimeFaces website for more information.
http://www.primefaces.org/support
4. Where is the source for the example demo applications?
Source code of demo applications are in the svn repository of PrimeFaces at /examples/trunk folder.
Snapshot builds of samples are deployed at PrimeFaces Repository time to time.
5. Some components like charts do not work in Safari or Chrome but there’s no problem with
Firefox.
The common reason is the response mimeType when using with PrimeFaces. You need to make sure responseType is "text/html". You can use the <f:view contentType="text/html"> to enforce this.
6. What is the license of PrimeFaces?
PrimeFaces is free to use and licensed under Apache License V2, Elite versions are licensed under
Elite License.
7. Can I use PrimeFaces in a commercial software?
Yes, Apache V2 License is a commercial friendly library. PrimeFaces does not bundle any third party software that conflicts with Apache. Same goes for Elite Releases for ELITE and PRO users.
8. Which browsers are supported by PrimeFaces?
IE 8-9-10-11, Safari, Firefox, Chrome and Opera.
581
THE END
582
PrimeFaces User Guide
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Rich set of UI components
Built-in AJAX capabilities
Lightweight and zero-configuration
Push support via Atmosphere Framework
Mobile UI kit
Skinning Framework with 35+ built-in themes
Extensive documentation
Large and active user community
Developed by application developers for application developers
Frequently asked questions
PrimeFaces is an open-source JSF component suite that simplifies web application development with JSF. It provides a rich set of user interface components, built-in AJAX capabilities, and a lightweight, zero-configuration approach.
PrimeFaces includes features like a rich set of UI components, built-in AJAX, push support, a mobile UI kit, a skinning framework, extensive documentation, and a large and active user community.
You can easily download PrimeFaces from the official website. PrimeFaces only requires a JAVA 5+ runtime and a JSF 2.x implementation as mandatory dependencies. For more detailed setup instructions, refer to the PrimeFaces documentation.
