Primefaces User Guide 6.1
Primefaces User Guide 6.1
Primefaces User Guide 6.1
6.1
Author
aatay ivici
PrimeFaces User Guide
First Edition
Table of Contents
About the Author..................................................................................................................................9
1. Introduction....................................................................................................................................10
1.1 What is PrimeFaces?.............................................................................................................10
2. Setup...............................................................................................................................................11
2.1 Download...............................................................................................................................11
2.2 Dependencies.........................................................................................................................12
2.3 Configuration.........................................................................................................................13
2.4 Hello World...........................................................................................................................13
3. Component Suite............................................................................................................................14
3.1 AccordionPanel......................................................................................................................14
3.2 AjaxBehavior.........................................................................................................................19
3.3 AjaxExceptionHandler..........................................................................................................22
3.4 AjaxStatus..............................................................................................................................23
3.5 AutoComplete........................................................................................................................26
3.6 Barcode..................................................................................................................................36
3.7 BlockUI.................................................................................................................................39
3.8 BreadCrumb..........................................................................................................................42
3.9 Button....................................................................................................................................44
3.10 Cache...................................................................................................................................47
3.11 Calendar...............................................................................................................................49
3.12 Captcha................................................................................................................................60
3.13 Carousel...............................................................................................................................63
3.14 CellEditor............................................................................................................................69
3.15 Chart....................................................................................................................................70
3.15.1 PieChart.......................................................................................................................71
3.15.2 LineChart.....................................................................................................................73
3.15.3 BarChart.......................................................................................................................76
3.15.4 DonutChart..................................................................................................................78
3.15.5 BubbleChart.................................................................................................................80
3.15.6 Ohlc Chart....................................................................................................................82
3.15.7 MeterGauge Chart.......................................................................................................84
3.15.8 Combined Chart...........................................................................................................86
3.15.9 Multiple Axis...............................................................................................................87
3.15.10 Date Axis...................................................................................................................89
3.15.11 Interactive Chart........................................................................................................90
3.15.12 Export........................................................................................................................91
3.15.13 Static Images..............................................................................................................92
3.15.14 Skinning.....................................................................................................................93
3.15.15 Extender.....................................................................................................................94
3.15.16 Chart API...................................................................................................................95
3.16 Checkbox...........................................................................................................................100
2
PrimeFaces User Guide
3.17 Chips..................................................................................................................................101
3.18 Clock..................................................................................................................................103
3.19 Collector............................................................................................................................105
3.20 Color Picker.......................................................................................................................106
3.21 Column..............................................................................................................................109
3.22 Columns.............................................................................................................................111
3.23 ColumnGroup....................................................................................................................113
3.24 ColumnToggler..................................................................................................................114
3.25 CommandButton................................................................................................................115
3.26 CommandLink...................................................................................................................120
3.27 Confirm..............................................................................................................................124
3.28 ConfirmDialog...................................................................................................................125
3.29 ContentFlow......................................................................................................................128
3.30 ContextMenu.....................................................................................................................130
3.31 Dashboard..........................................................................................................................133
3.32 DataExporter......................................................................................................................138
3.33 DataGrid............................................................................................................................142
3.34 DataList.............................................................................................................................149
3.35 DataScroller.......................................................................................................................153
3.36 DataTable...........................................................................................................................157
3.37 DefaultCommand..............................................................................................................182
3.38 Diagram.............................................................................................................................184
3.39 Dialog................................................................................................................................188
3.40 Drag&Drop........................................................................................................................193
3.40.1 Draggable...................................................................................................................193
3.40.2 Droppable..................................................................................................................197
3.41 Dock..................................................................................................................................202
3.42 Editor.................................................................................................................................204
3.43 Effect.................................................................................................................................208
3.44 FeedReader........................................................................................................................211
3.45 Fieldset..............................................................................................................................212
3.46 FileDownload....................................................................................................................215
3.47 FileUpload.........................................................................................................................218
3.48 Focus..................................................................................................................................225
3.49 Fragment............................................................................................................................227
3.50 Galleria..............................................................................................................................229
3.51 GMap.................................................................................................................................232
3.52 GMapInfoWindow.............................................................................................................244
3.53 GraphicImage....................................................................................................................245
3.54 Grid CSS............................................................................................................................249
3.55 Growl.................................................................................................................................252
3.56 HeaderRow........................................................................................................................256
3.57 HotKey..............................................................................................................................257
3
PrimeFaces User Guide
3.58 IdleMonitor........................................................................................................................260
3.59 ImageCompare..................................................................................................................262
3.60 ImageCropper....................................................................................................................264
3.61 ImageSwitch......................................................................................................................268
3.62 ImportConstants................................................................................................................271
3.63 ImportEnum.......................................................................................................................272
3.64 Inplace...............................................................................................................................273
3.65 InputMask..........................................................................................................................277
3.66 InputNumber......................................................................................................................281
3.67 InputSwitch........................................................................................................................286
3.68 InputText............................................................................................................................289
3.69 InputTextarea.....................................................................................................................292
3.70 Keyboard...........................................................................................................................297
3.71 KeyFilter............................................................................................................................302
3.72 Knob..................................................................................................................................304
3.73 Layout................................................................................................................................307
3.74 LayoutUnit.........................................................................................................................312
3.75 Lifecycle............................................................................................................................314
3.76 LightBox............................................................................................................................315
3.77 Link....................................................................................................................................318
3.78 Log.....................................................................................................................................321
3.79 Media.................................................................................................................................323
3.80 MegaMenu.........................................................................................................................325
3.81 Menu..................................................................................................................................328
3.82 Menubar.............................................................................................................................334
3.83 MenuButton.......................................................................................................................337
3.84 MenuItem..........................................................................................................................339
3.85 Message.............................................................................................................................342
3.86 Messages............................................................................................................................344
3.87 Mindmap............................................................................................................................347
3.88 MultiSelectListbox............................................................................................................350
3.89 NotificationBar..................................................................................................................353
3.90 OrderList............................................................................................................................355
3.91 Organigram........................................................................................................................359
3.92 OrganigramNode...............................................................................................................362
3.93 OutputLabel.......................................................................................................................363
3.94 OutputPanel.......................................................................................................................366
3.95 OverlayPanel.....................................................................................................................368
3.96 Panel..................................................................................................................................371
3.97 PanelGrid...........................................................................................................................374
3.98 PanelMenu.........................................................................................................................377
3.99 Password............................................................................................................................379
3.100 PhotoCam........................................................................................................................383
4
PrimeFaces User Guide
3.101 PickList............................................................................................................................386
3.102 Poll...................................................................................................................................393
3.103 Printer..............................................................................................................................396
3.104 ProgressBar......................................................................................................................397
3.105 RadioButton.....................................................................................................................401
3.106 Rating..............................................................................................................................402
3.107 RemoteCommand............................................................................................................406
3.108 Repeat..............................................................................................................................409
3.109 ResetInput........................................................................................................................410
3.110 Resizable..........................................................................................................................412
3.111 Ribbon..............................................................................................................................416
3.112 RibbonGroup...................................................................................................................419
3.113 Ring.................................................................................................................................420
3.114 Row..................................................................................................................................423
3.115 RowEditor........................................................................................................................424
3.116 RowExpansion.................................................................................................................425
3.117 RowToggler.....................................................................................................................426
3.118 Schedule...........................................................................................................................427
3.119 ScrollPanel.......................................................................................................................437
3.120 SelectBooleanButton.......................................................................................................439
3.121 SelectBooleanCheckbox..................................................................................................441
3.122 SelectCheckboxMenu......................................................................................................444
3.123 SelectManyButton...........................................................................................................448
3.124 SelectManyCheckbox......................................................................................................450
3.125 SelectManyMenu.............................................................................................................453
3.126 SelectOneButton..............................................................................................................457
3.127 SelectOneListbox............................................................................................................459
3.128 SelectOneMenu...............................................................................................................462
3.129 SelectOneRadio...............................................................................................................468
3.130 Separator..........................................................................................................................471
3.131 Signature..........................................................................................................................473
3.132 SlideMenu........................................................................................................................478
3.133 Slider................................................................................................................................481
3.134 Spotlight..........................................................................................................................486
3.135 Socket..............................................................................................................................488
3.136 Spacer..............................................................................................................................490
3.137 Spinner.............................................................................................................................491
3.138 SplitButton.......................................................................................................................496
3.139 Submenu..........................................................................................................................501
3.140 Stack................................................................................................................................502
3.141 Steps................................................................................................................................504
3.142 Sticky...............................................................................................................................506
3.143 SubTable..........................................................................................................................508
5
PrimeFaces User Guide
3.144 SummaryRow..................................................................................................................509
3.145 Tab...................................................................................................................................510
3.146 TabMenu..........................................................................................................................511
3.147 TabView...........................................................................................................................513
3.148 TagCloud.........................................................................................................................518
3.149 Terminal...........................................................................................................................521
3.150 TextEditor........................................................................................................................523
3.151 ThemeSwitcher................................................................................................................526
3.152 TimeLine.........................................................................................................................528
3.153 TieredMenu......................................................................................................................535
3.154 Toolbar.............................................................................................................................538
3.155 ToolbarGroup...................................................................................................................540
3.156 Tooltip..............................................................................................................................541
3.157 Tree..................................................................................................................................544
3.158 TreeNode.........................................................................................................................555
3.159 TreeTable.........................................................................................................................556
3.160 TriStateCheckbox............................................................................................................561
3.161 Watermark.......................................................................................................................564
3.162 Wizard..............................................................................................................................566
4. Partial Rendering and Processing.................................................................................................572
4.1 Partial Rendering.................................................................................................................572
4.1.1 Infrastructure................................................................................................................572
4.1.2 Using IDs.....................................................................................................................572
4.1.3 Notifying Users............................................................................................................574
4.1.4 Bits&Pieces..................................................................................................................574
4.2 Partial Processing................................................................................................................575
4.2.1 Partial Validation..........................................................................................................575
4.2.2 Using Ids......................................................................................................................576
4.3 Search Expression Framework............................................................................................577
4.3.1 Keywords.....................................................................................................................577
4.3.2 PrimeFaces Selectors (PFS).........................................................................................578
4.4 PartialSubmit.......................................................................................................................580
5. Javascript API...............................................................................................................................581
5.1 PrimeFaces Namespace.......................................................................................................581
5.2 Ajax API..............................................................................................................................583
6. Dialog Framework........................................................................................................................585
7. Client Side Validation...................................................................................................................589
7.1 Configuration.......................................................................................................................589
7.2 Ajax vs Non-Ajax................................................................................................................589
7.3 Events..................................................................................................................................590
7.4 Messages..............................................................................................................................590
7.5 Bean Validation...................................................................................................................591
7.6 Extending CSV....................................................................................................................592
6
PrimeFaces User Guide
8. Themes..........................................................................................................................................597
8.1 Applying a Theme...............................................................................................................598
8.2 Creating a New Theme........................................................................................................599
8.3 How Themes Work..............................................................................................................600
8.4 Theming Tips.......................................................................................................................601
8.5 FontAwesome......................................................................................................................602
9. PrimeFaces Push...........................................................................................................................603
9.1 Setup....................................................................................................................................603
9.2 Annotations..........................................................................................................................604
9.3 API.......................................................................................................................................606
9.4 Socket Component...............................................................................................................606
9.5 Putting It All Together.........................................................................................................607
9.5.1 Counter........................................................................................................................607
9.5.2 FacesMessage..............................................................................................................609
9.6 Tips and Tricks.....................................................................................................................611
10. PrimeFaces Mobile.....................................................................................................................612
10.1 Setup..................................................................................................................................612
10.2 Pages..................................................................................................................................613
10.2 Navigations........................................................................................................................614
10.3 Components.......................................................................................................................615
10.3.1 Content.......................................................................................................................615
10.3.2 Field...........................................................................................................................616
10.3.3 Footer.........................................................................................................................617
10.3.4 Header........................................................................................................................618
10.3.5 InputSlider.................................................................................................................619
10.3.6 Page............................................................................................................................621
10.3.7 RangeSlider................................................................................................................622
10.3.8 Switch (Deprecated)..................................................................................................623
10.4 RenderKit..........................................................................................................................625
10.4.1 AccordionPanel..........................................................................................................625
10.4.2 AutoComplete............................................................................................................625
10.4.3 Button........................................................................................................................625
10.4.4 Calendar.....................................................................................................................626
10.4.5 ConfirmDialog...........................................................................................................626
10.4.6 DataList......................................................................................................................626
10.4.7 DataGrid....................................................................................................................627
10.4.8 DataTable...................................................................................................................627
10.4.9 Dialog........................................................................................................................627
10.4.10 FileUpload...............................................................................................................628
10.4.11 Growl.......................................................................................................................628
10.4.12 InputText..................................................................................................................628
10.4.13 InputTextarea...........................................................................................................628
10.4.14 Link..........................................................................................................................628
7
PrimeFaces User Guide
10.4.15 Menu........................................................................................................................628
10.4.16 Panel........................................................................................................................628
10.4.17 PanelGrid.................................................................................................................629
10.4.17 SelectBooleanCheckbox..........................................................................................629
10.4.18 SelectCheckboxMenu..............................................................................................629
10.4.18 SelectManyButton...................................................................................................629
10.4.19 SelectManyCheckbox..............................................................................................629
10.4.20 SelectOneButton......................................................................................................629
10.4.21 SelectOneMenu........................................................................................................629
10.4.22 SelectOneRadio.......................................................................................................629
10.4.23 TabMenu..................................................................................................................630
10.4.24 TabView...................................................................................................................630
10.4.25 Toolbar.....................................................................................................................630
10.5 Themes..............................................................................................................................631
10.6 Framework.........................................................................................................................632
10.6.1 Ajax Updates..............................................................................................................632
10.6.2 Pass Through Elements..............................................................................................632
10.6.3 Lazy Pages.................................................................................................................633
10.6.4 Touch Events..............................................................................................................633
11. Misc............................................................................................................................................635
11.1 RequestContext..................................................................................................................635
11.2 EL Functions......................................................................................................................638
11.3 Exception Handler.............................................................................................................639
11.4 BeanValidation Transformation.........................................................................................641
11.5 PrimeFaces Locales...........................................................................................................642
11.6 Right to Left.......................................................................................................................645
11.7 Responsive Design............................................................................................................646
11.8 WAI-ARIA.........................................................................................................................647
12. Portlets........................................................................................................................................648
13. IDE Support................................................................................................................................649
13.1 NetBeans............................................................................................................................649
13.2 Eclipse...............................................................................................................................650
14. Project Resources.......................................................................................................................651
15. FAQ............................................................................................................................................652
8
PrimeFaces User Guide
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 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.
Premium themes and layouts
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
Manual downloads are actually links to the maven repository, for more information please visit;
http://www.primefaces.org/downloads
<dependency>
<groupId>org.primefaces</groupId>
<artifactId>primefaces</artifactId>
<version>6.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. Therere some optional libraries for certain features. Licenses of all dependencies and
any 3rd part work incorporated are compatible with the PrimeFaces Licenses.
JSF runtime 2.0, 2.1, 2.2, 2.3 Required Apache MyFaces or Oracle Mojarra
* 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, 2.2 and 2.3 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 JavaEE. Here is the list of all configuration options defined with a context-param such as;
<context-param>
<param-name>primefaces.THEME</param-name>
<param-value>omega</param-value>
</context-param>
13
PrimeFaces User Guide
<!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.
14
PrimeFaces User Guide
3. Component Suite
3.1 AccordionPanel
AccordionPanel is a container component that displays content in stacked format.
Info
Tag accordionPanel
Attributes
rendered true boolean Boolean value to specify the rendering of the component.
activeIndex false String Index of the active tab or a comma separated string of
indexes when multiple mode is on.
15
PrimeFaces User Guide
onTabChange null String Client side callback to invoke when an inactive tab is
clicked.
onTabShow null String Client side callback to invoke when a tab gets activated.
onTabClose null String Client side callback to invoke when a tab is closed.
cache true Boolean Defines if activating a dynamic tab should load the
contents from server again.
dir ltr String Defines text direction, valid values are ltr and rtl.
tabController null MethodEx Server side listener to decide whether a tab change or tab
pr close should be allowed.
<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>
16
PrimeFaces User Guide
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.
<p:accordionPanel dynamic="true">
//..tabs
</p:accordionPanel>
<p:accordionPanel onTabChange="handleChange(panel)">
//..tabs
</p:accordionPanel>
<script type="text/javascript">
function handleChange(panel) {
//panel: new tab content container
}
</script>
<p:accordionPanel>
<p:ajax event=tabChange listener=#{bean.onChange} />
</p:accordionPanel>
17
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>
TabController
TabController is a server side listener that can be utilized to decide if a client side tab change or tab
close action is allowed. When one of these two events occur, an ajax call is made to invoke the tab
controller, then the boolean return value of this controller is sent back to click to decide if the event
should be performed. An example use case is disallowing tab change if current tab has invalid
inputs.
select(index) index: Index of tab void Activates tab with given index.
unselect(index) index: Index of tab void 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;
18
PrimeFaces User Guide
Class Applies
19
PrimeFaces User Guide
3.2 AjaxBehavior
AjaxBehavior is an extension to standard f:ajax.
Info
Tag ajax
Behavior Id org.primefaces.component.AjaxBehavior
Attributes
immediate false boolean Boolean value that determines the phaseId, when true
actions are processed at apply_request_values, when false
at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
global true Boolean Global ajax requests are listened by ajaxStatus component,
setting global to false will not trigger ajaxStatus.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is ":input"
to select all descendant inputs of a partially processed
components.
20
PrimeFaces User Guide
form null String Form to serialize for an ajax request. Default is the
enclosing form.
skipChildren true Boolean Containers components like, datatable, panel, tabview skip
their children if the request owner is them. For example,
sort, page event of a datatable. As children are skipped,
input values get lost, assume a case with a datatable and
inputs components in a column. Sorting the column
discards the changes and data is sorted according to
original value. Setting skipChildren to false, enabled input
values to update the value and sorting to be happened with
user values.
<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}" />
21
PrimeFaces User Guide
//getter setter
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.
22
PrimeFaces User Guide
3.3 AjaxExceptionHandler
AjaxExceptionHandler is a utility component for the built-in ExceptionHandler.
Info
Tag ajaxExceptionHandler
Attributes
23
PrimeFaces User Guide
3.4 AjaxStatus
AjaxStatus is a global notifier for ajax requests.
Info
Tag ajaxStatus
Attributes
onstart null String Client side callback to execute after ajax requests
start.
oncomplete null String Client side callback to execute after ajax requests
complete.
onsuccess null String Client side callback to execute after ajax requests
completed succesfully.
24
PrimeFaces User Guide
<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;
<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 youd like to implement advanced cases with scripting you
can take advantage of on* callbacks which are the event handler counterparts of the facets.
25
PrimeFaces User Guide
Skinning
AjaxStatus is equipped with style and styleClass. Styling directly applies to a container element
which contains the facets.
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.
26
PrimeFaces User Guide
3.5 AutoComplete
AutoComplete provides live suggestions while an input is being typed.
Info
Tag autoComplete
Attributes
27
PrimeFaces User Guide
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
var null String Name of the iterator used in pojo based suggestion.
accesskey null String Access key that when pressed transfers focus to the
input element.
28
PrimeFaces User Guide
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element
loses focus.
onchange null String Client side callback to execute when input element
loses focus and its value has been modified since
gaining focus.
onclick null String Client side callback to execute when input element
is clicked.
ondblclick null String Client side callback to execute when input element
is double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
onselect null String Client side callback to execute when text within
input element is selected by user.
29
PrimeFaces User Guide
readonly false Boolean Flag indicating that this component will prevent
changes by the user.
tabindex null Integer Position of the input element in the tabbing order.
resultsMessage null String Hint text for screen readers to provide information
about the search results.
queryEvent keyup String Event to initiate the query, valid options are
"keyup" and "enter".
30
PrimeFaces User Guide
moreText ... String The text shown in panel when the suggested list is
greater than maxResults.
return results;
}
//getter setter
}
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"/>
31
PrimeFaces User Guide
return players;
}
}
<p:autoComplete value="#{bean.text}"
completeMethod="#{bean.complete}"
maxResults="5" />
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 youd like to tune the load balance, give a longer
value. Following autoComplete waits for 1 second after user types an input.
32
PrimeFaces User Guide
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.
Depending on dropdownMode configuration, clicking this button will either do a search with an
empty query or search with the current value in input.
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.
<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>
33
PrimeFaces User Guide
//...
}
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.
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
34
PrimeFaces User Guide
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.
query - 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.
35
PrimeFaces User Guide
search(value) value: keyword for search void Initiates a search with given value
Skinning
Following is the list of structural style classes;
Class Applies
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.
36
PrimeFaces User Guide
3.6 Barcode
Barcode component is used to display various barcode formats.
Info
Tag barcode
Attributes
format svg String Format of the generated barcode, valid values are
"svg" (default) and "png".
37
PrimeFaces User Guide
int2of5
codabar
code39
code128
ean8
ean13
upca
postnet
pdf417
datamatrix
qr
38
PrimeFaces User Guide
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.
Orientation
In order to change the orientation, choose the angle from the 4 pre-defined values.
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.
39
PrimeFaces User Guide
3.7 BlockUI
BlockUI is used to block interactivity of JSF components with optional ajax integration.
Info
Tag blockUI
Attributes
40
PrimeFaces User Guide
Multiple triggers are defined as a comma separated list. Multiple block targets are also possible
using a search expression.
Custom Content
In order to display custom content like a loading text and animation, place the content inside the
blockUI.
//more columns
</p:dataTable>
41
PrimeFaces User Guide
Skinning
Following is the list of structural style classes;
Class Applies
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.
42
PrimeFaces User Guide
3.8 BreadCrumb
Breadcrumb is a navigation component that provides contextual information about page hierarchy
in the workflow.
Info
Tag breadCrumb
Attributes
homeDisplay icon String Defines display mode of root link, valid values are
"icon" default and "text".
43
PrimeFaces User Guide
<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.
Options Facet
In order to place custom content inside breadcrumb, options facet is provided. Options facet content
is aligned right by default.
Skinning
Breadcrumb resides in a container element that style and styleClass options apply. Following is the
list of structural style classes;
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 youd like to
use menuitem to execute command with or without ajax, do not define the url option.
44
PrimeFaces User Guide
3.9 Button
Button is an extension to the standard h:button component with skinning capabilities.
Info
Tag button
Attributes
rendered true Boolean Boolean value to specify the rendering of the component.
value null Object Value of the component than can be either an EL expression
of a literal text.
fragment null String Identifier of the target page which should be scrolled to.
accesskey null String Access key that when pressed transfers focus to button.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
image null String Style class for the button icon. (deprecated: use icon)
lang null String Code describing the language used in the generated markup
45
PrimeFaces User Guide
onblur null String Client side callback to execute when button loses focus.
onchange null String Client side callback to execute when button loses focus and
its value has been modified since gaining focus.
onclick null String Client side callback to execute when button is clicked.
ondblclick null String Client side callback to execute when button is double
clicked.
onfocus null String Client side callback to execute when button receives focus.
onkeydown null String Client side callback to execute when a key is pressed down
over button.
onkeypress null String Client side callback to execute when a key is pressed and
released over button.
onkeyup null String Client side callback to execute when a key is released over
button.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over button.
onmousemove null String Client side callback to execute when a pointer button is
moved within button
onmouseout null String Client side callback to execute when a pointer button is
moved away from button.
onmouseover null String Client side callback to execute when a pointer button is
moved onto button.
onmouseup null String Client side callback to execute when a pointer button is
released over button.
inline false String Displays as inline instead of 100% width, mobile only.
46
PrimeFaces User Guide
Parameters
Parameters in URI are defined with nested <f:param /> tags.
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.
.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;
47
PrimeFaces User Guide
3.10 Cache
Cache component is used to reduce page load time by caching the content after initial rendering.
Info
Tag cache
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
region View Id String Unique id of the cache region, defaults to view id.
key null String Unique id of the cache entry in region, defaults to client id of
component.
processEvents false Boolean When enabled, lifecycle events such as button actions are
executed.
<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.
48
PrimeFaces User Guide
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.
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.
49
PrimeFaces User Guide
3.11 Calendar
Calendar is an input component used to select a date featuring display modes, paging, localization,
ajax selection and more.
Info
Tag calendar
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
50
PrimeFaces User Guide
showButtonPanel false Boolean Visibility of button panel containing today and done
buttons.
effect null String Effect to use when displaying and showing the
popup calendar.
showOn both String Client side event that displays the popup calendar.
showWeek false Boolean Displays the week number next to each week.
yearRange null String Year range for the navigator, default "c-10:c+10"
51
PrimeFaces User Guide
accesskey null String Access key that when pressed transfers focus to the
input element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element
loses focus.
onchange null String Client side callback to execute when input element
loses focus and its value has been modified since
gaining focus.
ondblclick null String Client side callback to execute when input element
is double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
52
PrimeFaces User Guide
onselect null String Client side callback to execute when text within
input element is selected by user.
readonly false Boolean Flag indicating that this component will prevent
changes by the user.
tabindex null Integer Position of the input element in the tabbing order.
timeControlType slider String Defines the type of element to use for time picker,
valid values are "slider" and "select".
maskAutoClear true Boolean Clears the field on blur when incomplete input is
entered
53
PrimeFaces User Guide
inputStyle null String Inline style of the input element. Used when mode
is popup.
inputStyleClass null String Style class of the input element. Used when mode is
popup.
<p:calendar value="#{dateBean.date}"/>
Display Modes
Calendar has two main display modes, popup (default) and inline.
Inline
54
PrimeFaces User Guide
Popup
showOn option defines the client side event to display the calendar. Valid values are;
Popup Button
55
PrimeFaces User Guide
Paging
Calendar can also be rendered in multiple pages where each page corresponds to one month. This
feature is tuned with the pages attribute.
Localization
By default locale information is retrieved from the views 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.
56
PrimeFaces User Guide
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.
<p:calendar value="#{calendarBean.date}">
<p:ajax event=dateSelect listener=#{bean.handleDateSelect} update=msg />
</p:calendar>
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.
57
PrimeFaces User Guide
Navigator
Navigator is an easy way to jump between months/years quickly.
TimePicker
TimePicker functionality is enabled by adding time format to your pattern.
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.
58
PrimeFaces User Guide
Function tuesdaysAndFridaysDisabled(date) {
var day = date.getDay();
Mask
Calendar has a built-in mask feature similar to the InputMask component. Set mask option to true to
enable mask support.
Skinning
Calendar resides in a container element which style and styleClass options apply.
.ui-datepicker-title Title
59
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
60
PrimeFaces User Guide
3.12 Captcha
Captcha is a form validation component based on Recaptcha API V2.
Info
Tag captcha
Attributes
tabindex null Integer Position of the input element in the tabbing order.
<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>
<p:captcha />
Themes
Captcha features light and dark modes for theme, light is the default one.
62
PrimeFaces User Guide
<p:captcha theme="dark"/>
Languages
Text instructions displayed on captcha is customized with the language attribute. Below is a captcha
with Turkish text.
<p:captcha language="tr"/>
Summary primefaces.captcha.INVALID
Detail 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.
63
PrimeFaces User Guide
3.13 Carousel
Carousel is a multi purpose component to display a set of data or general content with slide effects.
Info
Tag carousel
Attributes
64
PrimeFaces User Guide
65
PrimeFaces User Guide
public CarListController() {
cars = new ArrayList<Car>();
cars.add(new Car("myModel", 2005, "ManufacturerX", "blue"));
//add more cars
}
//getter setter
}
Carousel iterates through the cars collection and renders its children for each car.
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
66
PrimeFaces User Guide
easeNone
easeOut
easeInOutCirc
easeOutStrong
elasticBoth
elasticIn
elasticOut
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.
Content Display
Another use case of carousel is tab based content display.
67
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>
68
PrimeFaces User Guide
Responsive
When responsive mode is enabled via setting responsive option to true, carousel switches between
small and large viewport depending on the breakpoint value which is 560 by default.
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;
As skinning style classes are global, see the main theming section for more information.
69
PrimeFaces User Guide
3.14 CellEditor
CellEditor is a helper component of datatable used for incell editing.
Info
Tag cellEditor
Attributes
70
PrimeFaces User Guide
3.15 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 chart
Attributes
71
PrimeFaces User Guide
3.15.1 PieChart
PieChart is created with PieChartModel.
Basic
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");
}
Customized
72
PrimeFaces User Guide
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);
}
73
PrimeFaces User Guide
3.15.2 LineChart
LineChartModel is used to create a line chart.
Basic
public Bean() {
model = new LineChartModel();
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);
}
74
PrimeFaces User Guide
Customized
public Bean() {
model = new LineChartModel();
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);
}
75
PrimeFaces User Guide
Area
public Bean() {
model = new LineChartModel();
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);
}
76
PrimeFaces User Guide
3.15.3 BarChart
BarChartModel is used to created a BarChart.
Basic
77
PrimeFaces User Guide
public ChartBean() {
model = new HorizontalBarChartModel();
model.addSeries(boys);
model.addSeries(girls);
78
PrimeFaces User Guide
3.15.4 DonutChart
DonutChart is generated using DonutChartModel.
Basic
public ChartBean() {
model = new DonutChartModel();
model.setTitle("Donut Chart");
model.setLegendPosition("w");
}
79
PrimeFaces User Guide
Customized
public ChartBean() {
model = new DonutChartModel();
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);
}
80
PrimeFaces User Guide
3.15.5 BubbleChart
BubbleChart is created with a BubbleChartModel.
Basic
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");
}
81
PrimeFaces User Guide
Customized
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);
}
82
PrimeFaces User Guide
Basic
Candlestick
83
PrimeFaces User Guide
Basic
public ChartBean() {
List<Number> intervals = new ArrayList<Number>(){{
add(20);
add(50);
add(120);
add(220);
}};
Customized
84
PrimeFaces User Guide
public ChartBean() {
List<Number> intervals = new ArrayList<Number>(){{
add(20);
add(50);
add(120);
add(220);
}};
85
PrimeFaces User Guide
Basic
public ChartBean() {
combinedModel = new BarChartModel();
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);
}
86
PrimeFaces User Guide
Basic
public ChartBean() {
model = new LineChartModel();
model.addSeries(boys);
model.addSeries(girls);
model.getAxes().put(AxisType.Y2, y2Axis);
}
87
PrimeFaces User Guide
88
PrimeFaces User Guide
Basic
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);
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);
}
89
PrimeFaces User Guide
Basic
public ChartBean() {
model = new PieChartModel();
model.setTitle("Simple Pie");
model.setLegendPosition("w");
}
FacesContext.getCurrentInstance().addMessage(null, msg);
}
}
90
PrimeFaces User Guide
3.15.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.
function exportChart() {
//export image
$('#output').empty().append(PF('chart').exportAsImage());
91
PrimeFaces User Guide
Basic
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");
}
return dataset;
}
}
92
PrimeFaces User Guide
3.15.14 Skinning
Charts can be styled using regular css. Following is the list of style classes;
.jqplot-axis Axes.
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.
In case youd like to change the colors of series, use the seriesColors option in ChartModel API.
93
PrimeFaces User Guide
3.15.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".
function ext() {
//this = chart widget instance
//this.cfg = options
this.cfg.seriesDefaults = {
shadowDepth: 5
};
}
94
PrimeFaces User Guide
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 Default Type Description
barPadding 8 Integer Padding between bars.
barMargin 10 Integer Margin between bars.
stacked false Boolean Displays series in stacked format.
BarChartSeries
org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries
Property Default Type Description
disableStack false Boolean When true, series data is not included in a stacked chart.
BubbleChartModel
org.primefaces.model.chart.BubbleChartModel extends org.primefaces.model.chart.ChartModel
Property Default Type Description
data null List<BubbleChartSeries> Data as a list of BubbleChartSeries.
bubbleGradients false Boolean Displays bubbles with gradients.
bubbleAlpha 1.0 Double Opacity of bubbles.
showLabels true Boolean Displays label of a series inside a bubble.
95
PrimeFaces User Guide
BubbleChartSeries
org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries
Property Default Type Description
x null Integer X-Axis value of the bubble.
y null Integer Y-Axis value of the bubble.
radius null Integer Radius of the bubble.
label null String Label text of the bubble.
CartesianChartModel
org.primefaces.model.chart.CartesianChartModel
Property Default Type Description
series null List<ChartSeries> List of series.
axes HashMap Map<AxisType,Axis> Map of chart axis.
zoom false Boolean Adds zoom feature when enabled.
animate false Boolean When enabled, series are drawn with an effect.
showDatatip true Boolean Displays a tooltip on hover.
datatipFormat null String Format of the data tooltip.
showPointLabels false Boolean Displays data inline in plot.
datatipEditor function String Javascript callback to customize the datatips.
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 Default Type Description
title null String Title text for the plot
shadow true Boolean To show shadow or not on series.
seriesColors null String Comma separated list of series colors e.g. "#4BB2C5",
"CCCCC"
negativeSeriesColors null String Similar to seriesColors but for negative values.
legendPosition null String Position of the legend like "n" or "ne".
legendCols 0 Integer Maximum number of columns in the legend.
legendRows 0 Integer Maximum number of rows in the legend.
legendPlacement null Enum Defines the location of the legend.
mouseoverHighlight true Boolean Highlights series on hover.
extender null String Name of javascript function to extend chart with.
resetAxesOnResize true Boolean Resets axes on resize for responsive charts.
96
PrimeFaces User Guide
ChartSeries
org.primefaces.model.chart.ChartSeries
Property Default Type Description
label null String Title text of the series.
data null Map<Object,Number> Data of the series as a map.
xaxis null AxisType X-Axis of the series.
yaxis null AxisType 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 Default Type Description
data null List>Map<String,Object>> Data as a list of map instances.
sliceMargin 0 Integer Angular spacing between pie slices in degrees.
fill true Boolean True or False to fill the slices.
showDataLabels false Boolean True to False show data labels on slices.
dataFormat percent String Either label, value, percent or an array of
labels to place on the pie slices.
dataLabelFormat null String Format string for data labels. If none, %s is
String used for label and for arrays, %d for value
and %d%% for percentage.
dataLabelThreshold 3 Integer Threshhold in percentage (0-100) of pie area,
below which no label will be displayed. This
applies to all label types, not just to percentage
labels.
showDatatip true Boolean Displays tooltip when enabled.
datatipFormat %s-%d String Format string for datatip.
datatipEditor null String Name of client side function that returns html
to provide custom content in datatip.
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 Type Description
markerStyle filledCircle String Style of the markers, valid values are diamond, circle, square,
97
PrimeFaces User Guide
LinearAxis
org.primefaces.model.chart.LinearAxis extends org.primefaces.model.chart.Axis
LinearAxis is the Axis implementation used to display numbers.
LineChartModel
org.primefaces.model.chart.LineChartModel extends
org.primefaces.model.chart.CartesianChartModel
Property Default Type Description
stacked null List<ChartSeries> Displays series in stacked format.
breakOnNull HashMap Map<AxisType,Axis> Discontinues line plot for null values.
MeterGaugeChartModel
org.primefaces.model.chart.MeterGaugeChartModel extends
org.primefaces.model.chart.ChartModel
Property Default Type Description
value null Number Value of the gauge.
intervals null List<Number> List of ranges to be drawn around the gauge.
ticks 0 List<Number> List of tick values.
gaugeLabel true String Label text of the gauge.
gaugeLabelPosition false String Where to position the label, either inside or bottom.
min null Double Minimum value on the gauge.
max null Double Minimum value on the gauge.
showTickLabels true Boolean Displays tick labels next to ticks.
intervalInnerRadius null Integer Radius of the inner circle of the interval ring.
intervalOuterRadius 85 Integer Radius of the outer circle of the interval ring.
labelHeightAdjust -25 Integer 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 Default Type Description
data null List<OhlcChartSeries> Data as a list of OhlChartSeries.
98
PrimeFaces User Guide
OhlcChartSeries
org.primefaces.model.chart.OhlcChartSeries extends org.primefaces.model.chart.ChartSeries
Property Default Type Description
value null List<OhlcChartSeries> Data as a list of OhlChartSeries.
open null Double Open value.
high null Double High value.
low null Double Low value.
close null Double Close value.
PieChartModel
org.primefaces.model.chart.PieChartModel extends org.primefaces.model.chart.ChartModel
Property Default Type Description
data null Map<String,Object> Data as a Map instance.
diameter null Integer Outer diameter of the pie, auto computed by default
sliceMargin 0 Integer Angular spacing between pie slices in degrees.
fill true Boolean True or False to fill the slices.
showDataLabels false Boolean True to False show data labels on slices.
dataFormat percent String Either label, value, percent or an array of labels
to place on the pie slices.
dataLabelFormat null String Format string for data labels. If none, %s is used
String for label and for arrays, %d for value and %d%
% for percentage.
dataLabelThreshold 3 Integer Threshhold in percentage (0-100) of pie area, below
which no label will be displayed. This applies to all
label types, not just to percentage labels.
showDatatip true Boolean Displays tooltip when enabled.
datatipFormat %s-%d String Format string for datatip.
datatipEditor null String Name of client side function that returns html to
provide custom content in datatip.
99
PrimeFaces User Guide
3.16 Checkbox
Checkbox is a helper component of SelectManyCheckbox to implement custom layouts.
Info
Tag checkbox
Attributes
tabindex null String Specifies the tab order of element in tab navigation.
100
PrimeFaces User Guide
3.17 Chips
Chips is used to enter multiple values on an inputfield.
Info
Tag chips
Attributes
101
PrimeFaces User Guide
Skinning
Following is the list of structural style classes;
102
PrimeFaces User Guide
3.18 Clock
Clock displays server or client datetime live.
Info
Tag clock
Attributes
mode client String Mode value, valid values are client and server.
<p:clock />
103
PrimeFaces User Guide
Server Mode
In server mode, clock initialized itself with the servers 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.
Skinning
Clock resides in a container element which style and styleClass options apply. Following is the list
of structural style classes;
104
PrimeFaces User Guide
3.19 Collector
Collector is a simple utility to manage collections declaratively.
Info
Tag collector
Attributes
public CreateBookBean() {
books = new ArrayList<Book>();
}
<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>
105
PrimeFaces User Guide
Info
Tag colorPicker
Attributes
106
PrimeFaces User Guide
mode popup String Display mode, valid values are popup and
inline.
Display Mode
ColorPicker has two modes, default mode is popup and other available option is inline.
107
PrimeFaces User Guide
Skinning
ColorPicker resides in a container element which style and styleClass options apply. Following is
the list of structural style classes;
108
PrimeFaces User Guide
3.21 Column
Column is an extended version of the standard column used by various components like datatable,
treetable and more.
Info
Tag column
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
filterPosition bottom String Location of the column filter with respect to header
content. Options are 'bottom'(default) and 'top'.
109
PrimeFaces User Guide
field null 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.
selectRow true Boolean Whether clicking the column selects the row when
parent component has row selection enabled, default is
true.
ariaHeaderText null String Label to read by screen readers, when not specified
headerText is used.
Note
Not all attributes of column are implemented by the components that utilize column.
110
PrimeFaces User Guide
3.22 Columns
Columns is used by datatable to create columns dynamically.
Info
Tag columns
Attributes
111
PrimeFaces User Guide
field null 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.
selectRow true Boolean Whether clicking the column selects the row when
parent component has row selection enabled, default is
true.
112
PrimeFaces User Guide
3.23 ColumnGroup
ColumnGroup is used by datatable for column grouping.
Info
Tag columnGroup
Attributes
type null String Type of group, valid values are header and footer.
113
PrimeFaces User Guide
3.24 ColumnToggler
ColumnToggler is a helper component for datatable to toggle visibility of columns.
Info
Tag columnToggler
Attributes
114
PrimeFaces User Guide
3.25 CommandButton
CommandButton is an extended version of standard commandButton with ajax and theming.
Info
Tag commandButton
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean Boolean value that determines the phaseId, when true
actions are processed at apply_request_values, when
false at invoke_application phase.
ajax true Boolean Specifies the submit mode, when set to true(default),
submit would be made with Ajax.
async false Boolean When set to true, ajax requests are not queued.
115
PrimeFaces User Guide
onstart null String Client side callback to execute before ajax request is
begins.
oncomplete null String Client side callback to execute when ajax request is
completed.
onsuccess null String Client side callback to execute when ajax request
succeeds.
onerror null String Client side callback to execute when ajax request fails.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is
":input" to select all descendant inputs of a partially
processed components.
onblur null String Client side callback to execute when button loses focus.
onchange null String Client side callback to execute when button loses focus
and its value has been modified since gaining focus.
onclick null String Client side callback to execute when button is clicked.
ondblclick null String Client side callback to execute when button is double
clicked.
onfocus null String Client side callback to execute when button receives
focus.
onkeydown null String Client side callback to execute when a key is pressed
down over button.
onkeypress null String Client side callback to execute when a key is pressed and
released over button.
116
PrimeFaces User Guide
onkeyup null String Client side callback to execute when a key is released
over button.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over button.
onmousemove null String Client side callback to execute when a pointer button is
moved within button.
onmouseout null String Client side callback to execute when a pointer button is
moved away from button.
onmouseover null String Client side callback to execute when a pointer button is
moved onto button.
onmouseup null String Client side callback to execute when a pointer button is
released over button.
onselect null String Client side callback to execute when text within button is
selected by user.
accesskey null String Access key that when pressed transfers focus to the
button.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
image null String Style class for the button icon. (deprecated: use icon)
lang null String Code describing the language used in the generated
markup for this component.
tabindex null Integer Position of the button element in the tabbing order.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
RenderDisabled true Boolean When enabled, click event can be added to disabled
Click button.
117
PrimeFaces User Guide
Reset Buttons
Reset buttons do not submit the form, just resets the form contents.
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".
The 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.
118
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.
.disk {
background-image: url(disk.png) !important;
}
You can also use the pre-defined icons from ThemeRoller like ui-icon-search.
Skinning
CommandButton renders a button tag which style and styleClass applies. Following is the list of
structural style classes;
As skinning style classes are global, see the main theming section for more information.
119
PrimeFaces User Guide
3.26 CommandLink
CommandLink extends standard JSF commandLink with Ajax capabilities.
Info
Tag commandLink
Attributes
immediate false Boolean Boolean value that determines the phaseId, when true
actions are processed at apply_request_values, when
false at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
ajax true Boolean Specifies the submit mode, when set to true(default),
submit would be made with Ajax.
onstart null String Client side callback to execute before ajax request is
begins.
120
PrimeFaces User Guide
oncomplete null String Client side callback to execute when ajax request is
completed.
onsuccess null String Client side callback to execute when ajax request
succeeds.
onerror null String Client side callback to execute when ajax request fails.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is
":input" to select all descendant inputs of a partially
processed components.
onblur null String Client side callback to execute when link loses focus.
onclick null String Client side callback to execute when link is clicked.
ondblclick null String Client side callback to execute when link is double
clicked.
onfocus null String Client side callback to execute when link receives
focus.
onkeydown null String Client side callback to execute when a key is pressed
down over link.
onkeypress null String Client side callback to execute when a key is pressed
and released over link.
onkeyup null String Client side callback to execute when a key is released
over link.
121
PrimeFaces User Guide
onmousedown null String Client side callback to execute when a pointer button is
pressed down over link.
onmousemove null String Client side callback to execute when a pointer button is
moved within link.
onmouseout null String Client side callback to execute when a pointer button is
moved away from link.
onmouseover null String Client side callback to execute when a pointer button is
moved onto link.
onmouseup null String Client side callback to execute when a pointer button is
released over link.
accesskey null String Access key that when pressed transfers focus to the link.
coords null String Position and shape of the hot spot on the screen for
client use in image maps.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
hreflang null String Languae code of the resource designated by the link.
rel null String Relationship from the current document to the anchor
specified by the link, values are provided by a space-
separated list of link types.
rev null String 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 null String Shape of hot spot on the screen, valid values are default,
rect, circle and poly.
tabindex null Integer Position of the button element in the tabbing order.
target null String Name of a frame where the resource targeted by this
link will be displayed.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
<p:commandLink actionListener="#{bookBean.saveBook}">
<h:outputText value="Save" />
</p:commandLink>
Skinning
CommandLink renders an html anchor element that style and styleClass attributes apply.
123
PrimeFaces User Guide
3.27 Confirm
Confirm is a behavior element used to integrate with global confirm dialog.
Info
Tag confirm
Behavior Id org.primefaces.behavior.ConfirmBehavior
Attributes
124
PrimeFaces User Guide
3.28 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 confirmDialog
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
125
PrimeFaces User Guide
appendTo null String Appends the dialog to the element defined by the given
search expression.
dir ltr String Defines text direction, valid values are ltr and rtl.
global false Boolean When enabled, confirmDialog becomes a shared for other
components that require confirmation.
responsive false Boolean In responsive mode, dialog adjusts itself based on screen
width.
<h:form>
<p:commandButton type="button" onclick="PF('cd').show()" />
126
PrimeFaces User Guide
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
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, p:commandLink and p:menuitem.
<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>
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;
127
PrimeFaces User Guide
3.29 ContentFlow
ContentFlow is a horizontal content gallery component with a slide animation.
Info
Tag contentFlow
Attributes
128
PrimeFaces User Guide
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
Caption
To present a caption along with an item, embed a div with "caption" style class inside.
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;
129
PrimeFaces User Guide
3.30 ContextMenu
ContextMenu provides an overlay menu displayed on mouse right-click event.
Info
Tag contextMenu
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
selectionMode multiple String Defines the selection behavior, e.g "single" or "multiple".
130
PrimeFaces User Guide
targetFilter null String Selector to filter the elements to attach 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="www.primefaces.org" 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:contextMenu for="images">
<p:menuitem value="Previous" url="#" onclick="PF('gallery').previous()" />
<p:menuitem value="Next" url="#" onclick="PF('gallery').next()" />
</p:contextMenu>
131
PrimeFaces User Guide
Data Components
Data components like datatable, tree and treeTable has special integration with context menu, see
the documentation of these component for more information.
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;
As skinning style classes are global, see the main theming section for more information.
132
PrimeFaces User Guide
3.31 Dashboard
Dashboard provides a portal like layout with drag&drop based reorder capabilities.
Info
Tag dashboard
Attributes
133
PrimeFaces User Guide
<p:dashboard model="#{bean.model}">
<p:panel id="sports">
//Sports Content
</p:panel>
<p:panel id="finance">
//Finance Content
</p:panel>
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 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.
134
PrimeFaces User Guide
<p:dashboard model="#{bean.model}">
<p:ajax event=reorder update=messages listener=#{bean.handleReorder} />
//panels
</p:dashboard>
...
//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 its model.
Disabling Dashboard
If youd like to disable reordering feature, set disabled option to true.
<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.
135
PrimeFaces User Guide
Skinning
Dashboard resides in a container element which style and styleClass options apply. Following is the
list of structural style classes;
div.ui-state-hover 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.
Method Description
void transferWidget(DashboardColumn from, Relocates the widget identifed with widget id to the
DashboardColumn to, String widgetId, int index) given index of the new column from old column.
136
PrimeFaces User Guide
org.primefaces.model.DashboardColumn (org.primefaces.model.map.DefaultDashboardModel is
the default implementation)
Method Description
String getWidget(int index) Returns the widget id with the given index
void addWidget(int index, String widgetId) Adds a new widget at given index
void reorderWidget(int index, String widgetId) Updates the index of widget in column
137
PrimeFaces User Guide
3.32 DataExporter
DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats
such as excel, pdf, csv and xml.
Info
Tag dataExporter
Attributes
PageOnly
By default dataExporter works on whole dataset, if youd like export only the data displayed on
current page, set pageOnly to 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.
Custom Export
If you need to provide a custom way to retrieve the string value of a column in export, use
exportFunction property of a column that resolves to a method expression. This method takes the
column instance and should return a string to be included exported document.
139
PrimeFaces User Guide
First example of processors changes the background color of the exported excels headers.
Customization
Excel and PDF documents can be further customized using exporterOptions property that takes a
configuration object that implements ExporterOptions.
140
PrimeFaces User Guide
@PostConstruct
public void init() {
excelOpt = new ExcelOptions();
excelOpt.setFacetBgColor("#F88017");
excelOpt.setFacetFontSize("10");
excelOpt.setFacetFontColor("#0000ff");
excelOpt.setFacetFontStyle("BOLD");
excelOpt.setCellFontColor("#00ff00");
excelOpt.setCellFontSize("8");
}
141
PrimeFaces User Guide
3.33 DataGrid
DataGrid displays a collection of data in a grid layout.
Info
Tag dataGrid
Attributes
142
PrimeFaces User Guide
rowIndexVar null String Name of the iterator to refer each row index.
lazy false Boolean Defines if lazy loading is enabled for the data
component.
143
PrimeFaces User Guide
The code for CarBean that would be used to bind the datagrid to the car list.
public CarBean() {
cars = new ArrayList<Car>();
cars.add(new Car("myModel",2005,"ManufacturerX","blue"));
//add more cars
}
<p:column>
<p:panel header="#{car.model}">
<h:panelGrid columns="1">
<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>
</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;
144
PrimeFaces User Guide
Ajax Pagination
DataGrid has a built-in paginator that is enabled by setting paginator option to true.
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
JumpToPageDropdown
Note that {RowsPerPageDropdown} has its own template, options to display is provided via
rowsPerPageTemplate attribute (e.g. rowsPerPageTemplate="9,12,15").
Also {CurrentPageReport} has its 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;
Paginator Position
Paginator can be positoned using paginatorPosition attribute in three different locations, "top",
"bottom" or "both" (default).
145
PrimeFaces User Guide
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: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>
</h:form>
146
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.
147
PrimeFaces User Guide
Skinning
DataGrid resides in a main div container which style and styleClass attributes apply. Following is
the list of structural style classes;
Class Applies
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.
148
PrimeFaces User Guide
3.34 DataList
DataList presents a collection of data in list layout with several display types.
Info
Tag dataList
Attributes
149
PrimeFaces User Guide
type unordered String Type of the list, valid values are "unordered",
"ordered", "definition" and "none".
rowIndexVar null String Name of the iterator to refer each row index.
lazy false Boolean Defines if lazy loading is enabled for the data
component.
Ordered Lists
DataList displays the data in unordered format by default, if youd like to use ordered display set
type option to "ordered".
150
PrimeFaces User Guide
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
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".
Ajax Pagination
DataList has a built-in paginator that is enabled by setting paginator option to true.
Pagination configuration and usage is same as dataGrid, see pagination section in dataGrid
documentation for more information and examples.
151
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.
Skinning
DataList resides in a main div container which style and styleClass attributes apply. Following is the
list of structural style classes;
Class 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.
152
PrimeFaces User Guide
3.35 DataScroller
DataScroller displays a collection of data with on demand loading using scrolling.
Info
Tag dataScroller
Attributes
153
PrimeFaces User Guide
mode document String Defines the target to listen for scroll event,
valid values are "document" (default) and
"inline".
lazy false Boolean Defines if lazy loading is enabled for the data
component.
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.
154
PrimeFaces User Guide
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.
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.
Header
Header of the component is defined using header facet.
155
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 Applies
As skinning style classes are global, see the main theming section for more information.
156
PrimeFaces User Guide
3.36 DataTable
DataTable displays data in tabular format.
Info
Tag dataTable
Attributes
157
PrimeFaces User Guide
selectionMode null String Enables row selection, valid values are single
and multiple.
158
PrimeFaces User Guide
sortMode single String Defines sorting mode, valid values are single and
multiple.
editMode row String Defines edit mode, valid values are row and cell.
dir ltr String Defines text direction, valid values are ltr and rtl.
liveResize false Boolean Columns are resized live in this mode without
using a resize helper.
rowExpandMode new String Defines row expand mode, valid values are
"single" and "multiple" (default).
159
PrimeFaces User Guide
sortField null String Name of the field to pass lazy load method for
sorting. If not specified, sortBy expression is
used to extract the name.
rowHover false Boolean Adds hover effect to rows, default is false. Hover
is always on when selection is enabled.
resizeMode fit String Defines the resize behavior, valid values are "fit"
(default) and expand.
saveOnCellBlur true Boolean Saves the changes in cell editing on blur, when
set to false changes are discarded..
multiViewState false Boolean Whether to keep table state across views, defaults
to false.
160
PrimeFaces User Guide
globalFilter null String Value of the global filter to use when filtering by
default.
cellEditMode eager String Defines the cell edit behavior, valid values are
"eager" (default) and "lazy".
virtualScroll false Boolean Loads data on demand as the scrollbar gets close
to the bottom. Default is false.
161
PrimeFaces User Guide
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.
Optionally enabling clientCache property loads the next page asynchronously so that when user
clicks the second page, data is displayed instantly from client side.
Sorting
Defining sortBy attribute enables ajax based sorting on that particular column.
Instead of using the default sorting algorithm which uses a java comparator, you can plug-in your
own sort method as well.
162
PrimeFaces User Guide
...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.
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.
...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.
Filtering is triggered with keyup event and filter inputs can be styled using filterStyle,
filterStyleClass attributes. If youd 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.
163
PrimeFaces User Guide
<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: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.
164
PrimeFaces User Guide
165
PrimeFaces User Guide
filterMatchMode defines which built-in filtering algorithm would be used per column, valid values
for this attribute are;
In case the built-in methods do not suffice, custom filtering can be implemented using
filterFunction approach.
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.
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. Lets begin by adding a Car reference for
single selection and a Car array for multiple selection to the CarBean to hold the selected data.
166
PrimeFaces User Guide
<p:column>
<p:commandButton value="Select">
<f:setPropertyActionListener value="#{car}"
target="#{carBean.selectedCar}" />
</p:commandButton>
</p:column>
...columns
</p:dataTable>
167
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 cant 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.
168
PrimeFaces User Guide
public CarBean() {
populateColumns();
cars = //populate cars;
}
Column Grouping
Grouping is defined by ColumnGroup component used to combine datatable header and footers.
169
PrimeFaces User Guide
</p:dataTable>
public CarBean() {
sales = //create a list of BrandSale objects
}
For frozen columns, use frozenHeader, frozenFooter, scrollableHeader and scrollableFooter types.
170
PrimeFaces User Guide
Row Grouping
Rows can be grouped in two ways, using headerRow, summaryRow components or with groupRow
attribute on a column.
Alternative approach is using row spans where a row can group multiple rows within the same
group. To enable this method, set groupRow to true on the grouping column.
171
PrimeFaces User Guide
Scrolling
Scrolling makes the header-footer of the table fixed and the body part scrollable. Scrolling is
enabled using scrollable property and has 3 modes; x, y and x-y scrolling that are defined by
scrollHeight and scrollWidth. These two scroll attributes can be specified using integer values
indicating fixed pixels or percentages relative to the container dimensions.
Simple scrolling renders all data to client whereas virtual scrolling combined with lazy loading is
useful to deal with huge data, in this case data is fetched on-demand. Set virtualScroll to enable this
option and provide LazyDataModel;
<p:column />
//columns
</p:dataTable>
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: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.
172
PrimeFaces User Guide
<p:column />
//columns
</p:dataTable>
Expandable Rows
RowToggler and RowExpansion facets are used to implement expandable rows.
<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>
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.
173
PrimeFaces User Guide
<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>
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, youd need to bind 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.
174
PrimeFaces User Guide
public CarBean() {
model = new LazyDataModel() {
@Override
public void load(int first, int pageSize, String sortField,
SortOrder sortOrder, Map<String,Object> filters) {
//load physical data
}
};
DataTable calls your load implementation whenever a paging, sorting or filtering occurs with
following parameters;
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.
175
PrimeFaces User Guide
Column Toggler
Visibility of columns can be toggled using the column toggler helper component.
176
PrimeFaces User Guide
<f:facet name="header">
List of Cars
<p:column headerText="Model">
#{car.model}
</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 and for certain ones to
be hidden by default, set visible 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.
Add Row
When a new data needs to be added to the datatable, instead of updating the whole table to show it,
just call addRow() client side method and it will append the tr element only.
177
PrimeFaces User Guide
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.
<p:column headerText="Model">
#{car.model}
</p:column>
//columns
</p:dataTable>
//...
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:column headerText="Model">
#{car.model}
</p:column>
//columns
</p:dataTable>
Responsive DataTable
DataTable has two responsive modes; priority and reflow. In priority mode, responsiveness is based
on column priorities that vary between 1 and 6. Lower value means higher priority. On the other
hand in reflow mode that is enabled by setting reflow to true, all columns will be visible but
displayed as stacked.
178
PrimeFaces User Guide
For example, datatable below makes an ajax request when a row is selected with a click on row.
179
PrimeFaces User Guide
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 Applies
180
PrimeFaces User Guide
Class Applies
181
PrimeFaces User Guide
3.37 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 doesnt 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 defaultCommand
Attributes
182
PrimeFaces User Guide
<h:form id="form">
</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.
183
PrimeFaces User Guide
3.38 Diagram
Diagram is generic component to create visual elements and connect them on a web page. SVG is
used on modern browsers and VML on IE 8 and below. Component is highly flexible in terms of
api, events and theming.
Info
Tag diagram
Attributes
184
PrimeFaces User Guide
@PostConstruct
public void init() {
model = new DefaultDiagramModel();
model.setMaxConnections(-1);
model.addElement(elementA);
model.addElement(elementB);
model.addElement(elementC);
model.connect(new Connection(elementA.getEndPoints().get(0),
elementB.getEndPoints().get(0)));
model.connect(new Connection(elementA.getEndPoints().get(0),
elementC.getEndPoints().get(0)));
}
In diagram above, there are 3 elements each having endpoints of dot type. After adding them to the
model, 2 connections are made, first one being A to B and second one from A to C.
185
PrimeFaces User Guide
Elements
Elements are the main part of diagram. Styling is done with css and positioning can be done using
model. An element should have at least width and height defined to be displayed on page. They can
be styled globally using .ui-diagram-element style class or individually using the styleClass
property on DiagramElement class.
EndPoints
EndPoints are the ports available on an element that can be used for connections. An endpoint has a
location defined by EndPointAnchor. Anchors can be static like "TopLeft" or dynamic like
"AutoDefault". There are 4 types of EndPoints differentiated by their shapes;
- BlankEndPoint
- DotEndPoint
- RectangleEndPoint
- ImagEndPoint
element.addEndPoint(new DotEndPoint(EndPointAnchor.TOP));
Connections
A connection requires two endpoints, connector and optional decorators like overlays. There are
four connector types;
- Bezier
- FlowChart
- Straight
- StateMachine
Default is bezier and it can be customized using default connector method globally in model or at
connection level.
Global
Per Connection
model.connect(new Connection(elementA.getEndPoints().get(0),
elementB.getEndPoints().get(0), new FlowChartConnector()));
Overlays
Overlays are decorators for connectors and endpoints. Available ones are;
186
PrimeFaces User Guide
- ArrowOverlay
- DiamondOverlay
- LabelOverlay
Dynamic Diagrams
A diagram can be edited after being initialized, to create new connections an element should be set
as source and to receive new connections it should be a target. Ajax event callbacks such as
"connect", "disconnect" and "connectionChange" are available.
ElementA.setSource(true);
ElementB.setTarget(true);
187
PrimeFaces User Guide
3.39 Dialog
Dialog is a panel component that can overlay other elements on page.
Info
Tag dialog
Attributes
188
PrimeFaces User Guide
onHide null String Client side callback to execute when dialog is hidden.
appendTo null String Appends the dialog to the element defined by the given
search expression.
dynamic false Boolean Enables lazy loading of the content with ajax.
dir ltr String Defines text direction, valid values are ltr and rtl.
fitViewport false 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.
189
PrimeFaces User Guide
<p:dialog>
<h:outputText value="Resistance to PrimeFaces is Futile!" />
//Other content
</p:dialog>
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.
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)
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.
190
PrimeFaces User Guide
Example below adds a FacesMessage when dialog is closed and updates the messages component to
display the added message.
<p:dialog>
<p:ajax event="close" listener="#{dialogBean.handleClose}" update="msg" />
//Content
</p:dialog>
Other provided ajax behavior events are maximize, minimize, move, restoreMinimize,
restoreMaximize and open.
Skinning
Dialog resides in a main container element which styleClass option apply. Following is the list of
structural style classes;
191
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 non-
visible 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.
A facet called header is available to provide custom content inside header instead of using
header attribute.
192
PrimeFaces User Guide
3.40 Drag&Drop
Drag&Drop utilities of PrimeFaces consists of two components; Draggable and Droppable.
3.40.1 Draggable
Info
Tag draggable
Attributes
axis null String Specifies drag axis, valid values are x and y.
revert false Boolean Reverts draggable to its original position when not
dropped onto a valid droppable
snapMode null String Specifies the snap mode. Valid values are both,
inner and outer.
193
PrimeFaces User Guide
<p:draggable for="pnl"/>
If you omit the for attribute, parent component will be selected as the draggable target.
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 its header only.
194
PrimeFaces User Guide
Drag Axis
Dragging can be limited to either horizontally or vertically.
Clone
By default, actual component is used as the drag indicator, if you need to keep the component at its
original location, use a clone helper.
Revert
When a draggable is not dropped onto a matching droppable, revert option enables the component
to move back to its original position with an animation.
Opacity
During dragging, opacity option can be used to give visual feedback, helper of following panels
opacity is reduced in dragging.
Grid
Defining a grid enables dragging in specific pixels. This value takes a comma separated dimensions
in x,y format.
195
PrimeFaces User Guide
Containment
A draggable can be restricted to a certain section on page, following draggable cannot go outside of
its parent.
196
PrimeFaces User Guide
3.40.2 Droppable
Info
Tag droppable
Attributes
197
PrimeFaces User Guide
<style type="text/css">
.slot {
background:#FF9900;
width:64px;
height:96px;
display:block;
}
</style>
198
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.
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 TableBean() {
availableCars = //populate data
}
199
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>
</h:form>
<script type="text/javascript">
function handleDrop(event, ui) {
ui.draggable.fadeOut(fast); //fade out the dropped item
}
</script>
200
PrimeFaces User Guide
Tolerance
There are four different tolerance modes that define the way of accepting a draggable.
Mode Description
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.
Skinning
hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when
interacting with a draggable.
201
PrimeFaces User Guide
3.41 Dock
Dock component mimics the well known dock interface of Mac OS X.
Info
Tag dock
Attributes
202
PrimeFaces User Guide
<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.
As skinning style classes are global, see the main theming section for more information.
203
PrimeFaces User Guide
3.42 Editor
Editor is an input component with rich text editing capabilities. (Deprecated: Use TextEditor
instead)
Info
Tag editor
Attributes
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
204
PrimeFaces User Guide
onchange null String Client side callback to execute when editor data
changes.
Custom Toolbar
Toolbar of editor is easy to customize using controls option;
205
PrimeFaces User Guide
bold justify
italic undo
underline redo
strikethrough rule
subscript image
superscript link
font unlink
size cut
style copy
color paste
highlight pastetext
bullets print
numbering source
alignleft outdent
center indent
alignright removeFormat
206
PrimeFaces User Guide
Skinning
Following is the list of structural style classes.
Editor is not integrated with ThemeRoller as there is only one icon set for the controls.
207
PrimeFaces User Guide
3.43 Effect
Effect component is based on the jQuery UI effects library.
Info
Tag effect
Attributes
event null String Dom event to attach the event that executes the
animation
208
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.
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: Its important for components that have the effect component as a child to have an
assigned id because some components do not render their clientIds if you dont 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
209
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>
<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>
210
PrimeFaces User Guide
3.44 FeedReader
FeedReader is used to display content from a feed.
Info
Tag feedReader
Attributes
FeedReader requires a feed url to display and renders its content for each feed item.
Note that you need the ROME library in your classpath to make feedreader work.
211
PrimeFaces User Guide
3.45 Fieldset
Fieldset is a grouping component as an extension to html fieldset.
Info
Tag fieldset
Attributes
212
PrimeFaces User Guide
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.
213
PrimeFaces User Guide
Here is an example that adds a facesmessage and updates growl component when fieldset is
toggled.
//content
</p:fieldset>
FacesContext.getCurrentInstance().addMessage(null, msg);
}
Skinning
style and styleClass options apply to the fieldset. Following is the list of structural style classes;
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 dont need to manage this using toggleListener and collapsed option.
214
PrimeFaces User Guide
3.46 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
Attributes
public FileDownloadController() {
InputStream stream = this.getClass().getResourceAsStream("yourfile.pdf");
file = new DefaultStreamedContent(stream, "application/pdf",
"downloaded_file.pdf");
}
}
}
<h:commandButton value="Download">
<p:fileDownload value="#{fileBean.file}" />
</h:commandButton>
215
PrimeFaces User Guide
<h:commandLink value="Download">
<p:fileDownload value="#{fileBean.file}"/>
<h:graphicImage value="pdficon.gif" />
</h:commandLink>
If youd like to use PrimeFaces commandButton and commandLink, disable ajax option as
fileDownload requires a full page refresh to present the file.
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>
216
PrimeFaces User Guide
<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>
217
PrimeFaces User Guide
3.47 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 fileUpload
Attributes
218
PrimeFaces User Guide
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
multiple false Boolean Allows choosing of multi file uploads from native
file browse dialog
auto false Boolean When set to true, selecting a file starts the upload
process implicitly.
219
PrimeFaces User Guide
onstart null String Client side callback to execute when upload begins.
oncomplete null String Client side callback to execute when upload ends.
sequential false Boolean Uploads are concurrent by default, set this option to
true for sequential uploads.
<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.
220
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.
<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;
//getter-setter
}
Enable skinSimple option to style the simple uploader to have a themed look that works the same
across different environments.
221
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.
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.
File Filters
Users can be restricted to only select the file types youve 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.
222
PrimeFaces User Guide
File Limit
FileLimit restricts the number of maximum files that can be uploaded.
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 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.
thresholdSize Maximum file size in bytes to keep uploaded files in memory. If a file
exceeds this limit, itll be temporarily written to disk.
uploadDirectory Disk repository path to keep temporary files that exceeds the threshold size.
By default it is System.getProperty("java.io.tmpdir")
223
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.
224
PrimeFaces User Guide
3.48 Focus
Focus is a utility component that makes it easy to manage the element focus on a JSF page.
Info
Tag focus
Attributes
context null String The root component to start first input search.
<p:focus />
225
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" />
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"/>
226
PrimeFaces User Guide
3.49 Fragment
Fragment component is used to define automatically partially process and update sections whenever
ajax request is triggered by a descendant component.
Info
Tag fragment
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when
set to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
227
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:" />
<p:inputText id="name" value="#{pprBean.firstname}" />
<p:commandButton value="Submit"/>
<h:outputText value="#{pprBean.firstname}" />
</h:panelGrid>
</p:fragment>
</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.
228
PrimeFaces User Guide
3.50 Galleria
Galleria is used to display a set of images.
Info
Tag galleria
Attributes
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.
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.
230
PrimeFaces User Guide
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
231
PrimeFaces User Guide
3.51 GMap
GMap is a map component integrated with Google Maps API V3.
Info
Tag gmap
Attributes
232
PrimeFaces User Guide
<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.
233
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.
public MapBean() {
model.addOverlay(new Marker(new LatLng(36.879466, 30.667648), "M1"));
//more overlays
}
Polylines
A polyline is represented by org.primefaces.model.map.Polyline.
234
PrimeFaces User Guide
public MapBean() {
model = new DefaultMapModel();
model.addOverlay(polyline);
}
Polygons
A polygon is represented by org.primefaces.model.map.Polygon.
public MapBean() {
model = new DefaultMapModel();
model.addOverlay(polygon);
}
Circles
A circle is represented by org.primefaces.model.map.Circle.
235
PrimeFaces User Guide
public MapBean() {
model = new DefaultMapModel();
Circle circle = new Circle(new LatLng(36.879466, 30.667648), 500);
model.addOverlay(circle);
}
Rectangles
A circle is represented by org.primefaces.model.map.Rectangle.
public MapBean() {
model = new DefaultMapModel();
LatLng coord1 = new LatLng(36.879466, 30.667648);
LatLng coord2 = new LatLng(36.883707, 30.689216);
model.addOverlay(circle);
}
GeoCoding
Geocoding support is provided by client side api. Results are then passed to the backing bean using
GeocodeEvent and ReverseGeocodeEvent instances via ajax behavior callbacks.
<p:gmap widgetVar="pmap">
<p:ajax event="geocode" listener="#{bean.onGeocode}" />
</p:map>
<script>
PF('pmap').geocode('Barcelona');
</script>
236
PrimeFaces User Guide
Following example displays a FacesMessage about the selected marker with growl component.
<h:form>
<p:growl id="growl" />
public MapBean() {
model = new DefaultMapModel();
//add markers
}
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.
237
PrimeFaces User Guide
<h:form>
<p:gmapInfoWindow>
<p:graphicImage value="/images/#{mapBean.marker.data.image}" />
<h:outputText value="#{mapBean.marker.data.title}" />
</p:gmapInfoWindow>
</p:gmap>
</h:form>
public MapBean() {
model = new DefaultMapModel();
//add markers
}
Street View
StreeView is enabled simply by setting streetView option to true.
238
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.
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)
239
PrimeFaces User Guide
Method Description
org.primefaces.model.map.Overlay
240
PrimeFaces User Guide
241
PrimeFaces User Guide
org.primefaces.model.map.LatLng
org.primefaces.model.map.LatLngBounds
org.primefaces.model.map.GeocodeResult
org.primefaces.event.map.MarkerDragEvent
org.primefaces.event.map.OverlaySelectEvent
242
PrimeFaces User Guide
org.primefaces.event.map.PointSelectEvent
org.primefaces.event.map.StateChangeEvent
org.primefaces.event.map.GeocodeEvent
org.primefaces.event.map.ReverseGeocodeEvent
243
PrimeFaces User Guide
3.52 GMapInfoWindow
GMapInfoWindow is used with GMap component to open a window on map when an overlay is
selected.
Info
Tag gmapInfoWindow
Attributes
244
PrimeFaces User Guide
3.53 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 graphicImage
Attributes
245
PrimeFaces User Guide
public DynamicImageController() {
InputStream stream = this.getClass().getResourceAsStream("barcalogo.jpg");
image = new DefaultStreamedContent(stream, "image/jpeg");
}
DefaultStreamedContent gets an inputstream as the first parameter and mime type as the second.
246
PrimeFaces User Guide
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.
Displaying a Barcode
Similar to the chart example, a barcode can be generated as well. This sample uses barbecue project
for the barcode API.
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();
}
}
How It Works
Default dynamic image display works as follows;
247
PrimeFaces User Guide
Custom PrimeFaces ResourceHandler gets the key from the url, decrypts it to get the instance of
StreamedContent from session, evaluates the content and streams it to client. Finally key is
removed from http session.
As a result there will be 2 requests to display an image, at first browser will make a request to load
the page initially and then another one to the dynamic image url that points to JSF resource handler.
Note that you cannot use viewscope beans in this way as they are not available in resource loading
request. See Data URI section below for an alternative to support view scope.
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.
248
PrimeFaces User Guide
<div class="ui-g">
<div class="ui-g-4">Col1</div>
<div class="ui-g-4">Col2</div>
<div class="ui-g-4">Col3</div>
</div>
249
PrimeFaces User Guide
Multi Line
When the number of columns exceed 12, columns wrap to a new line.
<div class="ui-g">
<div class="ui-g-6">Col1</div>
<div class="ui-g-6">Col2</div>
<div class="ui-g-6">Col3</div>
<div class="ui-g-6">Col4</div>
</div>
Same can also be achieved by having two ui-g containers to semantically define a row.
<div class="ui-g">
<div class="ui-g-6">Col1</div>
<div class="ui-g-6">Col2</div>
</div>
<div class="ui-g">
<div class="ui-g-6">Col3</div>
<div class="ui-g-6">Col4</div>
</div>
Nested
Columns can be nested to create more complex layouts.
<div class="ui-g">
<div class="ui-g-8 ui-g-nopad">
<div class="ui-g-6">6</div>
<div class="ui-g-6">6</div>
<div class="ui-g-12">12</div>
</div>
<div class="ui-g-4">4</div>
</div>
Direct children of ui-g has the same height automatically, in example above if the inside columns is
likely to have different height with different content.
<div class="ui-g">
<div class="ui-g-8 ui-g-nopad">
<div class="ui-g-6">6 <br /><br /><br /> Content </div>
<div class="ui-g-6">6</div>
<div class="ui-g-12">12</div>
</div>
<div class="ui-g-4">4</div>
</div>
250
PrimeFaces User Guide
<div class="ui-g">
<div class="ui-g-8 ui-g-nopad">
<div class="ui-g">
<div class="ui-g-6">6 <br /><br /><br /> Content </div>
<div class="ui-g-6">6</div>
<div class="ui-g-12">12</div>
</div>
</div>
<div class="ui-g-4">4</div>
</div>
Responsive
Responsive layout is achieved by applying additional classes to the columns whereas ui-g-* define
the default behavior. Four screen sizes are supported with different breakpoints.
Prefix Devices Media Query Example
ui-sm-* Phones max-width: 40em (640px) ui-sm-6, ui-sm-4
ui-md-* Tablets min-width: 40.063em (641px) ui-md-2, ui-sm-8
ui-lg-* Desktops min-width: 64.063em (1025px) ui-lg-6, ui-sm-12
ui-xl-* Big screen monitors min-width: 90.063em (1441px) ui-xl-2, ui-sm-10
Most of the time, ui-md-* styles are used with default ui-g-* classes, to customize small or large
screens apply ui-sm, ui-lg and ui-xl can be utilized.
In example below, large screens display 4 columns, medium screens display 2 columns in 2 rows
and default behavior gets only displayed in a mobile phone where each column is rendered in a
separate row.
<div class="ui-g">
<div class="ui-g-12 ui-md-6 ui-lg-3">ui-g-12 ui-md-6 ui-lg-3</div>
<div class="ui-g-12 ui-md-6 ui-lg-3">ui-g-12 ui-md-6 ui-lg-3</div>
<div class="ui-g-12 ui-md-6 ui-lg-3">ui-g-12 ui-md-6 ui-lg-3</div>
<div class="ui-g-12 ui-md-6 ui-lg-3">ui-g-12 ui-md-6 ui-lg-3</div>
</div>
In this second example below, 3 columns are displayed in large screens and in medium screens first
two columns are placed side by side where the last column displayed below them. In a mobile
phone, they all get displayed in a separate row.
<div class="ui-g">
<div class="ui-g-12 ui-md-6 ui-lg-4">ui-g-12 ui-md-6 ui-lg-4</div>
<div class="ui-g-12 ui-md-6 ui-lg-4">ui-g-12 ui-md-6 ui-lg-4</div>
<div class="ui-g-12 ui-lg-4">ui-g-12 ui-lg-4</div>
</div>
Note: A column has a default padding by default, to remove it you may apply ui-g-nopad style class.
251
PrimeFaces User Guide
3.55 Growl
Growl is based on the Macs growl notification widget and used to display FacesMessages in an
overlay.
Info
Tag growl
Attributes
sticky false Boolean Specifies if the message should stay instead of hidden
automatically.
globalOnly false Boolean When true, only facesmessages without clientids are
displayed.
252
PrimeFaces User Guide
for null String Name of associated key, takes precedence when used
with globalOnly.
<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 itll never be hidden automatically.
If growl is not working in sticky mode, its also possible to tune the duration of displaying
messages. Following growl will display the messages for 5 seconds and then fade-out.
<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;
}
253
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.
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.
Escaping
Growl escapes html content in messages, in case you need to display html via growl set escape
option to false.
Skinning
Following is the list of structural style classes;
254
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
255
PrimeFaces User Guide
3.56 HeaderRow
HeaderRow is a helper component of datatable used for dynamic grouping.
Info
Tag headerRow
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
256
PrimeFaces User Guide
3.57 HotKey
HotKey is a generic key binding component that can bind any formation of keys to javascript event
handlers or ajax calls.
Info
Tag hotkey
Attributes
immediate false Boolean Boolean value that determines the phaseId, when
true actions are processed at apply_request_values,
when false at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
257
PrimeFaces User Guide
begins.
partialSubmitFilter null String Selector to use when partial submit is on, default is
":input" to select all descendant inputs of a
partially processed components.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
When this hotkey is on page, pressing the a key will alert the Pressed key a text.
Key combinations
Most of the time youd need key combinations rather than a single key.
258
PrimeFaces User Guide
Integration
Heres 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.
<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>
<h:panelGrid columns="2">
<h:outputLabel for="name" value="Name:" />
<h:inputText id="name" value="#{bean.name}" />
</h:panelGrid>
</h:form>
Note that hotkey will not be triggered if there is a focused input on page.
259
PrimeFaces User Guide
3.58 IdleMonitor
IdleMonitor watches user actions on a page and notify callbacks in case they go idle or active again.
Info
Tag idleMonitor
Attributes
timeout 300000 Integer Time to wait in milliseconds until deciding if the user
is idle. Default is 5 minutes.
onidle null String Client side callback to execute when user goes idle.
onactive null String Client side callback to execute when user goes idle.
<p:idleMonitor onidle="PF('idleDialog').show();"
onactive="PF('idleDialog').hide();"/>
260
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.
261
PrimeFaces User Guide
3.59 ImageCompare
ImageCompare provides a user interface to compare two images.
Info
Tag imageCompare
Attributes
262
PrimeFaces User Guide
leftImage null String Source of the image placed on the left side
rightImage null String Source of the image placed on the right side
Skinning
Both images are placed inside a div container element, style and styleClass attributes apply to this
element.
263
PrimeFaces User Guide
3.60 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 imageCropper
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
264
PrimeFaces User Guide
265
PrimeFaces User Guide
External Images
ImageCropper has the ability to crop external images as well.
<p:imageCropper value="#{cropper.croppedImage}"
image="http://primefaces.prime.com.tr/en/images/schema.png">
</p:imageCropper>
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.
Boundaries
minSize and maxSize attributes are control to limit the size of the area to crop.
Saving Images
Below is an example to save the cropped image to file system.
266
PrimeFaces User Guide
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;
}
}
267
PrimeFaces User Guide
3.61 ImageSwitch
Imageswitch component is a simple image gallery component.
Info
Tag imageSwitch
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
268
PrimeFaces User Guide
<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 youd like manual transitions disable slideshow
and use client side api to create controls.
<span onclick="PF('imageswitch').previous();">Previous</span>
<span onclick="PF('imageswitch').next();">Next</span>
269
PrimeFaces User Guide
Effect Speed
The speed is considered in terms of milliseconds and specified via the speed attribute.
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
270
PrimeFaces User Guide
3.62 ImportConstants
In older EL versions (< 3.0), it's not possible to use constants or any other static fields/methods in
an EL expression. As it is not really a good practive to create beans with getter/setter for each
constants class. ImportConstant is an utility tag which allows to import constant fields in a page.
The constants can be accessed via the name of the class (default setting) or via a custom name (var
attribute).
Info
Tag importConstants
Handler org.primefaces.component.importconstants.ImportConstantsTagHandler
Attributes
package org.primefaces.util;
271
PrimeFaces User Guide
3.63 ImportEnum
In older EL versions (< 3.0), it's not possible to use enum constants or any other static
fields/methods in an EL expression. As it is not really a good practive to create beans with
getter/setter for each constants class, we provide an utils tag which allows to import enum values in
a page.
The enum values can be accessed via the name of the class (default setting) or via a custom name
(var attribute). It also possible to get all enum values of the class with the "ALL_VALUES" suffix
or a custom prefix via the "allSuffix" attribute.
Info
Tag importEnums
Handler org.primefaces.component.importenum.ImportEnumTagHandler
Attributes
Development: \#{JsfProjectStages.Development}
ALL:
<ui:repeat var="current" value="#{JsfProjectStages.ALL_ENUM_VALUES}">
<h:outputText value="#{current}" />
</ui:repeat>>
272
PrimeFaces User Guide
3.64 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.
Info
Tag inplace
Attributes
event click String Name of the client side event to display inline
content.
<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.
<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>
274
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.
Editor
Inplace editing is enabled via the editor option.
//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.
//getter-setter
}
<p:inplace editor="true">
<p:ajax event="save" listener="#{inplaceBean.handleSave}" update="msgs" />
<h:inputText value="#{inplaceBean.text}" />
</p:inplace>
275
PrimeFaces User Guide
Skinning
Inplace resides in a main container element which style and styleClass options apply. Following is
the list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
276
PrimeFaces User Guide
3.65 InputMask
InputMask forces an input to fit in a defined mask template.
Info
Tag inputMask
Attributes
277
PrimeFaces User Guide
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
accesskey null String Access key that when pressed transfers focus to the
input element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element
loses focus.
onchange null String Client side callback to execute when input element
loses focus and its value has been modified since
gaining focus.
onclick null String Client side callback to execute when input element is
clicked.
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
278
PrimeFaces User Guide
onkeydown null String Client side callback to execute when a key is pressed
down over input element.
onkeypress null String Client side callback to execute when a key is pressed
and released over input element.
onkeyup null String Client side callback to execute when a key is released
over input element.
onmousedown null String Client side callback to execute when a pointer button
is pressed down over input element
onmousemove null String Client side callback to execute when a pointer button
is moved within input element.
onmouseout null String Client side callback to execute when a pointer button
is moved away from input element.
onmouseover null String Client side callback to execute when a pointer button
is moved onto input element.
onmouseup null String Client side callback to execute when a pointer button
is released over input element.
onselect null String Client side callback to execute when text within input
element is selected by user.
readonly false Boolean Flag indicating that this component will prevent
changes by the user.
tabindex null Integer Position of the input element in the tabbing order.
autoClear true Boolean Clears the field on blur when incomplete input is
entered.
279
PrimeFaces User Guide
Mask Samples
Here are more samples based on different masks;
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.
280
PrimeFaces User Guide
3.66 InputNumber
InputNumber formats input fields with numeric Strings. It supports currency symbols, minimum
and maximum value, negative numbers, and a lot of round methods.
Info
Tag inputNumber
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
value null Object Value of the component than can be either an EL expression
of a literal text
converter null Converter An el expression or a literal text that defines a converter for
/String the component. When its an EL expression, its resolved to
a converter instance. In case its a static text, it must refer to
a converter id
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuchangeevent
281
PrimeFaces User Guide
accesskey null String Access key that when pressed transfers focus to the input
element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated markup
for this component.
maxlength null Integer Maximum number of characters that may be entered in this
field.
onblur null String Client side callback to execute when input element loses
focus.
onchange null String Client side callback to execute when input element loses
focus and its value has been modified since gaining focus.
onclick null String Client side callback to execute when input element is
clicked.
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute on input element focus.
onkeydown null String Client side callback to execute when a key is pressed down
over input element.
onkeypress null String Client side callback to execute when a key is pressed and
released over input element.
onkeyup null String Client side callback to execute when a key is released over
input element.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over input element
onmousemove null String Client side callback to execute when a pointer button is
moved within input element.
onmouseout null String Client side callback to execute when a pointer button is
moved away from input element.
onmouseover null String Client side callback to execute when a pointer button is
moved onto input element.
onmouseup null String Client side callback to execute when a pointer button is
282
PrimeFaces User Guide
onselect null String Client side callback to execute when text within input
element is selected by user.
readonly 0 Boolean Flag indicating that this component will prevent changes by
the user.
size null Integer Number of characters used to determine the width of the
input element.
tabindex null Integer Position of the input element in the tabbing order.
emptyValue empty String Controls empty input display behavior, options are empty,
zero, sign.
padControl true Boolean Controls padding of the decimal places. If true, always pads
the decimal with zeros.
283
PrimeFaces User Guide
Examples
Here are some examples demonstrating various cases;
284
PrimeFaces User Guide
285
PrimeFaces User Guide
3.67 InputSwitch
InputSwitch is used to select a boolean value.
Info
Tag inputSwitch
Attributes
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
286
PrimeFaces User Guide
onchange false Boolean Client side callback to execute on value change event.
tabindex null Integer The tabindex attribute specifies the tab order of an
element when the "tab" button is used for navigating.
showLabels null String Controls the visibility of the labels, defaults to true.
onblur null Sring Client side callback to execute when component loses
focus.
Labels
Labels are customized using onLabel and offLabel options. Setting showLabels as false, turns off
labels altogether.
287
PrimeFaces User Guide
Skinning
InputSwitch resides in a main container element which style and styleClass options apply.
Following is the list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
288
PrimeFaces User Guide
3.68 InputText
InputText is an extension to standard inputText with skinning capabilities.
Info
Tag inputText
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
value null Object Value of the component than can be either an EL expression
of a literal text
converter null Converter An el expression or a literal text that defines a converter for
/String the component. When its an EL expression, its resolved to
a converter instance. In case its a static text, it must refer to
a converter id
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuchangeevent
289
PrimeFaces User Guide
accesskey null String Access key that when pressed transfers focus to the input
element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated markup
for this component.
maxlength null Integer Maximum number of characters that may be entered in this
field.
onblur null String Client side callback to execute when input element loses
focus.
onchange null String Client side callback to execute when input element loses
focus and its value has been modified since gaining focus.
onclick null String Client side callback to execute when input element is
clicked.
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute on input element focus.
onkeydown null String Client side callback to execute when a key is pressed down
over input element.
onkeypress null String Client side callback to execute when a key is pressed and
released over input element.
onkeyup null String Client side callback to execute when a key is released over
input element.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over input element
onmousemove null String Client side callback to execute when a pointer button is
moved within input element.
onmouseout null String Client side callback to execute when a pointer button is
moved away from input element.
290
PrimeFaces User Guide
onmouseover null String Client side callback to execute when a pointer button is
moved onto input element.
onmouseup null String Client side callback to execute when a pointer button is
released over input element.
onselect null String Client side callback to execute when text within input
element is selected by user.
readonly 0 Boolean Flag indicating that this component will prevent changes by
the user.
size null Integer Number of characters used to determine the width of the
input element.
tabindex null Integer Position of the input element in the tabbing order.
291
PrimeFaces User Guide
3.69 InputTextarea
InputTextarea is an extension to standard inputTextarea with autoComplete, autoResize, remaining
characters counter and theming features.
Info
Tag inputTextarea
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
292
PrimeFaces User Guide
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuchangeevent
accesskey null String Access key that when pressed transfers focus to the input
element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element loses
focus.
onchange null String Client side callback to execute when input element loses
focus and its value has been modified since gaining
focus.
onclick null String Client side callback to execute when input element is
clicked.
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
onkeydown null String Client side callback to execute when a key is pressed
down over input element.
onkeypress null String Client side callback to execute when a key is pressed and
released over input element.
onkeyup null String Client side callback to execute when a key is released
over input element.
onmousedown null String Client side callback to execute when a pointer button is
293
PrimeFaces User Guide
onmousemove null String Client side callback to execute when a pointer button is
moved within input element.
onmouseout null String Client side callback to execute when a pointer button is
moved away from input element.
onmouseover null String Client side callback to execute when a pointer button is
moved onto input element.
onmouseup null String Client side callback to execute when a pointer button is
released over input element.
onselect null String Client side callback to execute when text within input
element is selected by user.
readonly false Boolean Flag indicating that this component will prevent changes
by the user.
size null Integer Number of characters used to determine the width of the
input element.
tabindex null Integer Position of the input element in the tabbing order.
294
PrimeFaces User Guide
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.
Remaining Characters
InputTextarea can limit the maximum allowed characters with maxLength option and display the
remaining characters count as well.
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.
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);
}
}
return results;
}
}
295
PrimeFaces User Guide
Skinning
InputTextarea renders a textarea element which style and styleClass options apply. Following is the
list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
296
PrimeFaces User Guide
3.70 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 keyboard
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
297
PrimeFaces User Guide
buttonImageOnly false boolean When set to true only image of the button would be
displayed.
accesskey null String Access key that when pressed transfers focus to the
input element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
298
PrimeFaces User Guide
onblur null String Client side callback to execute when input element
loses focus.
onchange null String Client side callback to execute when input element
loses focus and its value has been modified since
gaining focus.
onclick null String Client side callback to execute when input element is
clicked.
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
onkeydown null String Client side callback to execute when a key is pressed
down over input element.
onkeypress null String Client side callback to execute when a key is pressed
and released over input element.
onmousedown null String Client side callback to execute when a pointer button
is pressed down over input element
onmousemove null String Client side callback to execute when a pointer button
is moved within input element.
onmouseout null String Client side callback to execute when a pointer button
is moved away from input element.
onmouseover null String Client side callback to execute when a pointer button
is moved onto input element.
onmouseup null String Client side callback to execute when a pointer button
is released over input element.
onselect null String Client side callback to execute when text within
input element is selected by user.
readonly false Boolean Flag indicating that this component will prevent
changes by the user.
tabindex null Integer Position of the input element in the tabbing order.
299
PrimeFaces User Guide
Built-in Layouts
Therere a couple of built-in keyboard layouts these are qwerty, qwertyBasic and alphabetic. For
example keyboard below has the alphabetic layout.
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-space-
spacebar"/>
300
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.
ShowMode
Therere 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.
Button can also be customized using the buttonImage and buttonImageOnly attributes.
301
PrimeFaces User Guide
3.71 KeyFilter
KeyFilter is used to filter keyboard input on specified input components.
Info
Tag keyFilter
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
value null Object Value of the component than can be either an EL expression
of a literal text
regEx null String Defines the regular expression which should be used for
filtering the input.
inputRegEx null String Defines the regular expression which should be used to test
the complete input text content.
mask null String Defines the predefined mask which should be used (pint,
int, pnum, num, hex, email, alpha, alphanum).
testFunction null String Defines a javascript code or function which should be used
for filtering.
preventPaste true Boolean Boolean value to specify if the component also should
prevent paste.
302
PrimeFaces User Guide
<h:form>
<h:panelGrid columns="2">
<h:outputText value="KeyFilter with regEx on a p:inputText"/>
<p:inputText id="text1">
<p:keyFilter regEx="/[ABC]/i"/>
</p:inputText>
303
PrimeFaces User Guide
3.72 Knob
Knob is an input component to insert numeric values in a range.
Info
Tag knob
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
value null Object Value of the component than can be either an EL expression
of a literal text
converter null Converter An el expression or a literal text that defines a converter for
/String the component. When its an EL expression, its resolved to
a converter instance. In case its a static text, it must refer to
a converter id
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
304
PrimeFaces User Guide
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuchangeevent
foregroundColor null Object Foreground color of the component, you can use an hex
value, a css constant or a java.awt.Color object
backgroundColor null Object Background color of the component, you can use an hex
value, a css constant or a java.awt.Color object.
cursor false Boolean Set true to show only a cursor instead of the full bar.
onchange null String Client side callback to invoke when value changes.
305
PrimeFaces User Guide
Label
Label at the center is visible by default and can be hidden by setting showLabel to false. In addition
it can be customized using labelTemplate option.
Colors
Color scheme of the know are changed with foregroundColor and backgroundColor options.
306
PrimeFaces User Guide
3.73 Layout
Layout component features a highly customizable borderLayout model making it very easy to
create complex layouts even if youre not familiar with web design.
Info
Tag layout
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when
set to false component will not be rendered.
fullPage false Boolean Specifies whether layout should span all page or not.
307
PrimeFaces User Guide
style null String Style to apply to container element, this is only applicable to
element based layouts.
styleClass null String Style class to apply to container element, this is only applicable
to element based layouts.
onResize null String Client side callback to execute when a layout unit is resized.
onClose null String Client side callback to execute when a layout unit is closed.
onToggle null String Client side callback to execute when a layout unit is toggled.
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.
308
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>
<p:layout fullPage="true">
<h:form>
<p:layoutUnit position="center">
<h:outputText value="Right Pane" />
</p:layoutUnit>
</h:form>
</p:layout>
A layout unit must have its own form instead, also avoid trying to update layout units because of
same reason, update its content instead.
Dimensions
Except center layoutUnit, other layout units must have dimensions defined via size option.
309
PrimeFaces User Guide
<p:layout style="width:400px;height:200px">
<p:layoutUnit position="center">
<h:outputText value="Right Pane" />
</p:layoutUnit>
</p:layout>
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.
310
PrimeFaces User Guide
Skinning
Following is the list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
311
PrimeFaces User Guide
3.74 LayoutUnit
LayoutUnit represents a region in the border layout model of the Layout component.
Info
Tag layoutUnit
Attributes
312
PrimeFaces User Guide
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.
313
PrimeFaces User Guide
3.75 Lifecycle
Lifecycle is a utility component which displays the execution time of each JSF phase. It also
synchronizes automatically after each AJAX request.
Info
Tag lifecycle
Attributes
<p:lifecycle />
314
PrimeFaces User Guide
3.76 LightBox
Lightbox is a powerful overlay that can display images, multimedia content, custom content and
external urls.
Info
Tag lightBox
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when set
to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
style null String Style of the container element not the overlay element.
styleClass null String Style class of the container element not the overlay element.
315
PrimeFaces User Guide
visible false Boolean Displays lightbox without requiring any user interaction by default.
onHide null String Client side callback to execute when lightbox is displayed.
onShow null String 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>
//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>
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.
316
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 doesnt support advanced content like complex widgets. Use a dialog instead
for advanced cases involving custom content.
showURL(opt) opt void 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;
317
PrimeFaces User Guide
3.77 Link
Link is an extension to standard h:link component.
Info
Tag link
Attributes
rendered true Boolean Boolean value to specify the rendering of the component.
value null Object Value of the component than can be either an EL expression
of a literal text.
fragment null String Identifier of the target page which should be scrolled to.
accesskey null String Access key that when pressed transfers focus to button.
coords null String Position and shape of the hot spot on the screen for client
use in image maps.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
hreflang null String Language code of the resource designated by the link.
318
PrimeFaces User Guide
rel null String Relationship from the current document to the anchor
specified by the link, values are provided by a space-
separated list of link types.
rev null String 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 null String Shape of hot spot on the screen, valid values are default,
rect, circle and poly.
target null String Name of a frame where the resource targeted by this link
will be displayed.
onblur null String Client side callback to execute when button loses focus.
onclick null String Client side callback to execute when button is clicked.
ondblclick null String Client side callback to execute when button is double
clicked.
onfocus null String Client side callback to execute when button receives focus.
onkeydown null String Client side callback to execute when a key is pressed down
over button.
onkeypress null String Client side callback to execute when a key is pressed and
released over button.
onkeyup null String Client side callback to execute when a key is released over
button.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over button.
onmousemove null String Client side callback to execute when a pointer button is
moved within button
onmouseout null String Client side callback to execute when a pointer button is
moved away from button.
onmouseover null String Client side callback to execute when a pointer button is
moved onto button.
onmouseup null String Client side callback to execute when a pointer button is
released over button.
320
PrimeFaces User Guide
3.78 Log
Log component is a visual console to display logs on JSF pages.
Info
Tag log
Attributes
<p:log />
321
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 youd 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>
If project stage is development, log messages are also available at browser console.
322
PrimeFaces User Guide
3.79 Media
Media component is used for embedding multimedia content.
Info
Tag media
Attributes
323
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.
Player Types
quicktime aif, aiff, aac, au, bmp, gsm, mov, mid, midi, mpg, mpeg, mp4, m4a, psd, qt, qtif, qif,
qti, snd, tif, tiff, wav, 3g2, 3pg
pdf 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.
public MediaController() {
InputStream stream = //Create binary stream from database
media = new DefaultStreamedContent(stream, "video/quicktime");
}
public StreamedContent getMedia() { return media; }
}
324
PrimeFaces User Guide
3.80 MegaMenu
MegaMenu is a horizontal navigation component that displays submenus together.
Info
Tag megaMenu
Attributes
325
PrimeFaces User Guide
<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>
326
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;
As skinning style classes are global, see the main theming section for more information.
327
PrimeFaces User Guide
3.81 Menu
Menu is a navigation component with submenus and menuitems.
Info
Tag menu
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
328
PrimeFaces User Guide
overlay false Boolean Defines positioning type of menu, either static or overlay.
toggleable false Boolean Defines whether clicking the header of a submenu toggles
the visibility of children 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>
329
PrimeFaces User Guide
<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>
Overlay Menu
Menu can be positioned on a page in two ways; "static" and "dynamic". By default its 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
330
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>
<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).
331
PrimeFaces User Guide
public MenuBean() {
model = new DefaultMenuModel();
//First submenu
DefaultSubMenu firstSubmenu = new DefaultSubMenu("Dynamic Submenu");
model.addElement(firstSubmenu);
//Second submenu
DefaultSubMenu secondSubmenu = new DefaultSubMenu("Dynamic Actions");
model.addElement(secondSubmenu);
}
MenuModel API is supported by all menu components that have model attribute.
332
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;
As skinning style classes are global, see the main theming section for more information.
333
PrimeFaces User Guide
3.82 Menubar
Menubar is a horizontal navigation component.
Info
Tag menubar
Attributes
autoDisplay false Boolean Defines whether the first level of submenus will
be displayed on mouseover or not. When
set to false, click event is required to display.
334
PrimeFaces User Guide
toggleEvent hover String Event to toggle the submenus, valid values are
"hover" and "click".
<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>
335
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>
<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;
As skinning style classes are global, see the main theming section for more information.
336
PrimeFaces User Guide
3.83 MenuButton
MenuButton displays different commands in a popup menu.
Info
Tag menuButton
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
iconPos left String Position of the icon, valid values are left and right.
appendTo null String Appends the overlay to the element defined by search
337
PrimeFaces User Guide
<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;
338
PrimeFaces User Guide
3.84 MenuItem
MenuItem is used by various menu components.
Info
Tag menuItem
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean When true, action of this menuitem is processed after
apply request phase.
async false Boolean When set to true, ajax requests are not queued.
339
PrimeFaces User Guide
onstart null String Javascript handler to execute before ajax request is begins.
onsuccess null String Javascript handler to execute when ajax request succeeds.
onerror null String Javascript handler to execute when ajax request fails.
global true Boolean Global ajax requests are listened by ajaxStatus component,
setting global to false will not trigger ajaxStatus.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is
":input" to select all descendant inputs of a partially
processed components.
fragment null String Identifier of the target page element to scroll to.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
rel null String Defines the relationship between the current document
and the linked document.
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
Custom Icons
.barca {
background: url(barca_logo.png) no-repeat;
height:16px;
width:16px;
}
341
PrimeFaces User Guide
3.85 Message
Message is a pre-skinned extended version of the standard JSF message component.
Info
Tag message
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
342
PrimeFaces User Guide
Display Mode
Message component has three different display modes;
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.
Escaping
Component escapes html content in messages by default, in case you need to display html, disable
escape option.
Skinning
Full list of CSS selectors of message is as follows;
343
PrimeFaces User Guide
3.86 Messages
Messages is a pre-skinned extended version of the standard JSF messages component.
Info
Tag messages
Attributes
globalOnly false String When true, only facesmessages with no clientIds are
displayed.
for null String Name of associated key, takes precedence when used
with globalOnly.
344
PrimeFaces User Guide
<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.
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.
Escaping
Messages escapes html content in messages, disable escape option to display content as html.
345
PrimeFaces User Guide
Skinning
Full list of CSS selectors of message is as follows;
346
PrimeFaces User Guide
3.87 Mindmap
Mindmap is an interactive tool to visualize mindmap data featuring lazy loading, callbacks,
animations and more.
Info
Tag mindmap
Attributes
347
PrimeFaces User Guide
public MindmapBean() {
root = new DefaultMindmapNode("google.com", "Google", "FFCC00", false);
root.addNode(ips);
root.addNode(ns);
root.addNode(malware);
}
348
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.
MindmapNode API
org.primefaces.model.mindmap.MindmapNode
Tips
IE 7 and IE 8 are not supported due to technical limitations, IE 9 is supported.
349
PrimeFaces User Guide
3.88 MultiSelectListbox
MultiSelectListbox is used to select an item from a collection of listboxes that are in parent-child
relationship.
Info
Tag multiSelectListbox
Attributes
350
PrimeFaces User Guide
@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");
categories.add(group1);
categories.add(group2);
categories.add(group3);
categories.add(group4);
}
351
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).
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;
352
PrimeFaces User Guide
3.89 NotificationBar
NotificationBar displays a multipurpose fixed positioned panel for notification.
Info
Tag notificationBar
Attributes
<p:notificationBar>
//Content
</p:notificationBar>
353
PrimeFaces User Guide
<p:notificationBar widgetVar="nv">
//Content
</p:notificationBar>
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 youd 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 its 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 pre-
defined css selectors used to customize the look and feel.
Selector Applies
354
PrimeFaces User Guide
3.90 OrderList
OrderList is used to sort a collection featuring drag&drop based reordering, transition effects and
pojo support.
Info
Tag orderList
Attributes
rendered True Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
355
PrimeFaces User Guide
valueChangeListener null Method A method expression that refers to a method for handling
Expr a valuechangeevent
controlsLocation left String Location of the reorder buttons, valid values are left,
right and none.
356
PrimeFaces User Guide
public OrderListBean() {
cities = new ArrayList<String>();
cities.add("Istanbul");
cities.add("Ankara");
cities.add("Izmir");
cities.add("Antalya");
cities.add("Bursa");
}
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 OrderListBean() {
players = new ArrayList<Player>();
357
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;
358
PrimeFaces User Guide
3.91 Organigram
Organigram is a data component to display an organizational hierarchy.
Info
Tag organigram
Attributes
LeafNodeConnectorHeight 10 Integer The height of the connector line for leaf nodes.
359
PrimeFaces User Guide
@PostConstruct
public void init() {
selection = new DefaultOrganigramNode(null, "Ridvan Agar", null);
if (employees != null) {
for (String employee : employees) {
OrganigramNode employeeNode = new DefaultOrganigramNode("employee", employee,
divisionNode);
employeeNode.setDraggable(true);
employeeNode.setSelectable(true);
}
}
return divisionNode;
}
}
employeeNode.setDraggable(true);
360
PrimeFaces User Guide
<p:organigram id="organigram"
widgetVar="organigram"
value="#{organigramView.rootNode}"
var="node"
leafNodeConnectorHeight="#{organigramView.leafNodeConnectorHeight}"
autoScrollToSelection="#{organigramView.autoScrollToSelection}"
zoom="#{organigramView.zoom}"
selection="#{organigramView.selection}"
style="#{organigramView.style}">
<p:organigramNode>
<h:outputText value="#{node.data}" />
</p:organigramNode>
<p:organigramNode type="root"
style="border-radius: 10px;">
<h:outputText value="#{node.data}" />
</p:organigramNode>
<p:organigramNode type="division"
styleClass="division"
icon="ui-icon-suitcase"
iconPos="left">
<h:outputText value="#{node.data}" />
</p:organigramNode>
<p:organigramNode type="employee"
styleClass="employee"
icon="ui-icon-person">
<h:outputText value="#{node.data}" />
</p:organigramNode>
</p:organigram>
361
PrimeFaces User Guide
3.92 OrganigramNode
Represents a node in an Organigram model.
Info
Tag organigramNode
Attributes
362
PrimeFaces User Guide
3.93 OutputLabel
OutputLabel is a an extension to the standard outputLabel component.
Info
Tag outputLabel
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
accesskey null String The accesskey attribute is a standard HTML attribute that
sets the access key that transfers focus to this element when
pressed.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
363
PrimeFaces User Guide
onblur null String Client side callback to execute when component loses
focus.
onclick null String Client side callback to execute when component is clicked.
ondblclick null String Client side callback to execute when component is double
clicked.
onfocus null String Client side callback to execute when component receives
focus.
onkeydown null String Client side callback to execute when a key is pressed down
over component.
onkeypress null String Client side callback to execute when a key is pressed and
released over component.
onkeyup null String Client side callback to execute when a key is released over
component.
onmousedown null String Client side callback to execute when a pointer is pressed
down over component.
onmouseout null String Client side callback to execute when a pointer is moved
away from component.
onmouseover null String Client side callback to execute when a pointer is moved
onto component.
onmouseup null String Client side callback to execute when a pointer is released
over component.
364
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.
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;
365
PrimeFaces User Guide
3.94 OutputPanel
OutputPanel is a panel component with the ability to auto update.
Info
Tag outputPanel
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
layout block String Shortcut for the css display property, valid values are block
(default) and inline.
deferred false Boolean Deferred mode loads the contents after page load to speed
up page load.
deferredMode load String Defines deferred loading mode, valid values are "load"
(after page load) and "visible" (once the panel is visible on
scroll).
global false Boolean Global ajax requests are listened by ajaxStatus component,
setting global to false will not trigger ajaxStatus on
deferred loading.
366
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
doesnt exist.
<p:outputPanel id="out">
<p:dataTable id="tbl" rendered="#{bean.condition}" ...>
//columns
</p:dataTable>
</p:outputPanel>
Note that you wont 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.
367
PrimeFaces User Guide
3.95 OverlayPanel
OverlayPanel is a generic panel component that can be displayed on top of other content.
Info
Tag overlayPanel
Attributes
368
PrimeFaces User Guide
onShow null String Client side callback to execute when panel is shown.
onHide null String Client side callback to execute when panel is hidden.
dismissable true Boolean When set true, clicking outside of the panel hides the
overlay.
showCloseIcon false Boolean Displays a close icon to hide the overlay, default is false.
modal false Boolean Boolean value that specifies whether the document
should be shielded with a partially transparent mask to
require the user to close the Panel before being able to
activate any elements in the document.
<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.
369
PrimeFaces User Guide
Effects
blind, bounce, clip, drop, explode, fold, highlight, puff, pulsate, scale, shake, size, slide are
available values for showEffect and hideEffect options if youd like display animations.
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.
Standalone
OverlayPanel is positioned relative to its target based on a one-to-one relationship, this causes
limitations when used inside a data iteration because every row needs an overlaypanel which is far
from ideal, requires client side memory and slows down page performance. Instead a single
overlayPanel can be used by calling show passing the client id of the component to be relatively
positioned. See overlayPanel demo in showcase for an example.
Skinning
Panel resides in a main container which style and styleClass attributes apply. Following is the list of
structural style classes;
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.
370
PrimeFaces User Guide
3.96 Panel
Panel is a grouping component with content toggle, close and menu integration.
Info
Tag panel
Attributes
371
PrimeFaces User Guide
<p:panel>
//Child components here...
</p:panel>
372
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 youd 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">
<h:outputText styleClass="ui-icon ui-icon-help" />
</h:commandLink>
</f:facet>
//content
</p:panel>
Skinning Panel
Panel resides in a main container which style and styleClass attributes apply. Following is the list of
structural style classes;
As skinning style classes are global, see the main theming section for more information.
373
PrimeFaces User Guide
3.97 PanelGrid
PanelGrid is an extension to the standard panelGrid component with additional features such as
theming and colspan-rowspan.
Info
Tag panelGrid
Attributes
374
PrimeFaces User Guide
layout tabular String Displays data in a 'table' layout or 'grid' layout. The
grid layout is a responsive layout.
<p:panelGrid columns="2">
<h:outputLabel for="firstname" value="Firstname:" />
<p:inputText id="firstname" value="#{bean.firstname}" label="Firstname" />
<p:panelGrid columns="2">
<f:facet name="header">
Basic PanelGrid
</f:facet>
<f:facet name="footer">
<p:commandButton type="button" value="Save" icon="ui-icon-check" />
</f:facet>
</p:panelGrid>
375
PrimeFaces User Guide
<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>
Blank Mode
To remove borders add ui-noborder style class to the component using styleClass attribute and to
remove borders plus background color, apply ui-panelgrid-blank style.
Skinning
PanelGrid resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
.ui-panelgrid-header Header.
.ui-panelgrid-footer Footer.
As skinning style classes are global, see the main theming section for more information.
376
PrimeFaces User Guide
3.98 PanelMenu
PanelMenu is a hybrid component of accordionPanel and tree components.
Info
Tag panelMenu
Attributes
377
PrimeFaces User Guide
<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>
Default State
By default, all submenus are collapsed, set expanded on a submenu to true to initially display a
submenu as expanded.
Skinning
PanelMenu resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
378
PrimeFaces User Guide
3.99 Password
Password component is an extended version of standard inputSecret component with theme
integration and strength indicator.
Info
Tag password
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
379
PrimeFaces User Guide
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuechangeevent
inline false boolean Displays feedback inline rather than using a popup.
accesskey null String Access key that when pressed transfers focus to the input
element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element loses
focus.
onchange null String Client side callback to execute when input element loses
focus and its value has been modified since gaining focus.
onclick null String Client side callback to execute when input element is
clicked.
380
PrimeFaces User Guide
ondblclick null String Client side callback to execute when input element is
double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
onkeydown null String Client side callback to execute when a key is pressed
down over input element.
onkeypress null String Client side callback to execute when a key is pressed and
released over input element.
onkeyup null String Client side callback to execute when a key is released
over input element.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over input element
onmousemove null String Client side callback to execute when a pointer button is
moved within input element.
onmouseout null String Client side callback to execute when a pointer button is
moved away from input element.
onmouseover null String Client side callback to execute when a pointer button is
moved onto input element.
onmouseup null String Client side callback to execute when a pointer button is
released over input element.
onselect null String Client side callback to execute when text within input
element is selected by user.
readonly false Boolean Flag indicating that this component will prevent changes
by the user.
size null Integer Number of characters used to determine the width of the
input element.
tabindex null Integer Position of the input element in the tabbing order.
381
PrimeFaces User Guide
I18N
Although all labels are in English by default, you can provide custom labels as well. Following
password gives feedback in Turkish.
Confirmation
Password confirmation is a common case and password provides an easy way to implement. The
other password components id should be used to define the match option.
Skinning
Structural selectors for password are;
Name Applies
As skinning style classes are global, see the main theming section for more information.
382
PrimeFaces User Guide
3.100 PhotoCam
PhotoCam is used to take photos with webcam and send them to the JSF backend model.
Info
Tag photoCam
Attributes
rendered false Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
valueChangeListener null Method A method binding expression that refers to a method for
Expr handling a valuechangeevent
383
PrimeFaces User Guide
format jpeg Boolean Format of the image, valid values are "jpeg" default and
png.
jpegQuality 90 Integer Quality of the image between 0 and 100 when the format
is jpeg, default value is 90.
forceFlash false Boolean Enables always using flash fallback even in an HTML5
environment.
<h:form>
<p:photoCam widgetVar="pc" listener="#{photoCamBean.oncapture}" update="photos"/>
384
PrimeFaces User Guide
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.");
}
}
}
385
PrimeFaces User Guide
3.101 PickList
PickList is used for transferring data between two different collections.
Info
Tag pickList
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
386
PrimeFaces User Guide
showSourceFilter false Boolean Displays and input filter for source list.
showTargetFilter false Boolean Displays and input filter for target list.
387
PrimeFaces User Guide
filterMatchMode startsWith String Match mode for filtering, valid values are
startsWith, contains, endsWith and custom.
filterFunction null String Name of the javascript function for custom filtering.
labelDisplay tooltip String Defines how the button labels displayed, valid
values are "tooltip" (default) and "inline".
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
388
PrimeFaces User Guide
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.
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 ...).
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;
389
PrimeFaces User Guide
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.
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.
onTransfer
If youd like to execute custom javascript when an item is transferred, bind your javascript function
to onTransfer attribute.
<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>
//DualListModel code
Skinning
PickList resides in a main container which style and styleClass attributes apply. Following is the list
of structural style classes;
391
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
392
PrimeFaces User Guide
3.102 Poll
Poll is an ajax component that has the ability to send periodical ajax requests.
Info
Tag poll
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean Boolean value that determines the phaseId, when true
actions are processed at apply_request_values, when false
at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
onstart null String Javascript handler to execute before ajax request is begins.
onsuccess null String Javascript handler to execute when ajax request succeeds.
onerror null String Javascript handler to execute when ajax request fails.
393
PrimeFaces User Guide
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is
":input" to select all descendant inputs of a partially
processed components.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
394
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:form>
</h:form>
Or bind a boolean variable to the stop attribute and set it to false at any arbitrary time.
395
PrimeFaces User Guide
3.103 Printer
Printer allows sending a specific JSF component to the printer, not the whole page.
Info
Tag printer
Attributes
396
PrimeFaces User Guide
3.104 ProgressBar
ProgressBar is a process status indicator that can either work purely on client side or interact with
server side using ajax.
Info
Tag propressBar
Attributes
397
PrimeFaces User Guide
<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.
//getter-setter
}
398
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.
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.
399
PrimeFaces User Guide
Skinning
ProgressBar resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
400
PrimeFaces User Guide
3.105 RadioButton
RadioButton is a helper component of SelectOneRadio to implement custom layouts.
Info
Tag radioButton
Attributes
tabindex null String Specifies the tab order of element in tab navigation.
401
PrimeFaces User Guide
3.106 Rating
Rating component features a star based rating system.
Info
Tag rating
Attributes
402
PrimeFaces User Guide
onRate null String Client side callback to execute when rate happens.
//getter-setter
}
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.
403
PrimeFaces User Guide
<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" />
//getter-setter
}
setValue(value) value: Value to set void Updates rating value with provided one.
Skinning
Rating resides in a main container which style and styleClass attributes apply. Following is the list
of structural style classes;
405
PrimeFaces User Guide
3.107 RemoteCommand
RemoteCommand provides a way to execute backing bean methods directly from javascript.
Info
Tag remoteCommand
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean Boolean value that determines the phaseId, when true
actions are processed at apply_request_values, when false
at invoke_application phase.
async false Boolean When set to true, ajax requests are not queued.
onstart null String Javascript handler to execute before ajax request is begins.
onsuccess null String Javascript handler to execute when ajax request succeeds.
onerror null String Javascript handler to execute when ajax request fails.
406
PrimeFaces User Guide
global true Boolean Global ajax requests are listened by ajaxStatus component,
setting global to false will not trigger ajaxStatus.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is ":input"
to select all descendant inputs of a partially processed
components.
form null String Form to serialize for an ajax request. Default is the
enclosing form.
<script type="text/javascript">
function customfunction() {
//your custom code
Thats 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.
407
PrimeFaces User Guide
Passing Parameters
Remote command can send dynamic parameters in the following way;
408
PrimeFaces User Guide
3.108 Repeat
Repeat is an extension to the standard ui:repeat component to provide compatibility between
Mojarra and MyFaces. There are no additonal features and usage is same as ui:repeat.
409
PrimeFaces User Guide
3.109 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
Attributes
clearModel false Boolean When enabled, reset input also sets null values to the
bound values so it reset inputs values and model values.
<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>
410
PrimeFaces User Guide
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
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>
Tip
p:ajax has built-in resetValues attribute to reset values of processed components during a request.
411
PrimeFaces User Guide
3.110 Resizable
Resizable component is used to make another JSF component resizable.
Info
Tag resizable
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when
set to false component will not be rendered.
ghost false Boolean In ghost mode, resize helper is displayed as the original
element with less opacity.
412
PrimeFaces User Guide
onStart null String Client side callback to execute when resizing begins.
onStop null String Client side callback to execute after resizing end.
Another example is the input fields, if users need more space for a textarea, make it resizable by;
Boundaries
To prevent overlapping with other elements on page, boundaries need to be specified. Therere 4
attributes for this minWidth, maxWidth, minHeight and maxHeight. The valid values for these
attributes are numbers in terms of pixels.
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".
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.
413
PrimeFaces User Guide
.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.
<p:resizable for="area">
<p:ajax listener="#{resizeBean.handleResize}">
</p:resizable>
414
PrimeFaces User Guide
Skinning
415
PrimeFaces User Guide
3.111 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 ribbon
Attributes
416
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: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.
417
PrimeFaces User Guide
Skinning
Ribbon resides in a main container which style and styleClass attributes apply. Following is the list
of structural style classes.
Ribbon shares the same structure with TabView for the tabbing functionality, refer to TabView for
the styles of the Tabs.
418
PrimeFaces User Guide
3.112 RibbonGroup
RibbonGroup is a helper component for Ribbon to define groups in a tab.
Info
Tag ribbonGroup
Attributes
419
PrimeFaces User Guide
3.113 Ring
Ring is a data display component with a circular animation.
Info
Tag ring
Attributes
autoplay false Boolean When true, Ring will automatically advance the
moving elements to the next child at a regular
interval.
autoplayPauseOnHover false Boolean When true, Ring will pause autoPlay when the user
420
PrimeFaces User Guide
public RingBean() {
players = new ArrayList<Player>();
Item Selection
A column is required to process item selection from ring properly.
Easing
Following is the list of available options for easing animation.
421
PrimeFaces User Guide
Skinning
Ring resides in a main container which style and styleClass attributes apply. Following is the list of
structural style classes.
422
PrimeFaces User Guide
3.114 Row
Row is a helper component for datatable.
Info
Tag row
Attributes
423
PrimeFaces User Guide
3.115 RowEditor
RowEditor is a helper component for datatable.
Info
Tag rowEditor
Attributes
424
PrimeFaces User Guide
3.116 RowExpansion
RowExpansion is a helper component of datatable used to implement expandable rows.
Info
Tag rowExpansion
Attributes
425
PrimeFaces User Guide
3.117 RowToggler
RowToggler is a helper component for datatable.
Info
Tag rowToggler
Attributes
426
PrimeFaces User Guide
3.118 Schedule
Schedule provides an Outlook Calendar, iCal like JSF component to manage events.
Info
Tag schedule
Attributes
427
PrimeFaces User Guide
view month String The view type to use, possible values are
'month', 'agendaDay', 'agendaWeek',
'basicWeek', 'basicDay'
initialDate null Object The initial date that is used when schedule
loads. If ommitted, the schedule starts on the
current date
428
PrimeFaces User Guide
nextDayThreshold 09:00:00 String When an event's end time spans into another
day, the minimum time it must be in order for
it to render as if it were on that day. Default
is 09:00:00.
urlTarget _blank String Target for events with urls. Clicking on such
events in the schedule will not trigger the
selectEvent but open the url using this target
instead. Default is "_blank".
429
PrimeFaces User Guide
public ScheduleBean() {
eventModel = new ScheduleModel<ScheduleEvent>();
eventModel.addEvent(new DefaultScheduleEvent("title", new Date(),
new Date()));
}
Property Description
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
Lets put it altogether to come up a fully editable and complex schedule.
431
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>
432
PrimeFaces User Guide
public ScheduleBean() {
eventModel = new ScheduleModel<ScheduleEvent>();
}
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.
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.
433
PrimeFaces User Guide
public ScheduleBean() {
@Override
public void loadEvents(Date start, Date end) {
//addEvent(...);
//addEvent(...);
}
};
}
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>
434
PrimeFaces User Guide
Views
5 different views are supported, these are "month", "agendaWeek", "agendaDay", "basicWeek" and
"basicDay".
agendaWeek
agendaDay
basicWeek
435
PrimeFaces User Guide
basicDay
Locale Support
By default locale information is retrieved from the views 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.
Event Limit
To display a link when there are too many events on a slot, use setEventLimit(true) on model.
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.
436
PrimeFaces User Guide
3.119 ScrollPanel
ScrollPanel is used to display scrollable content with theme aware scrollbars instead of native
browser scrollbars.
Info
Tag scrollPanel
Attributes
mode default String Scrollbar display mode, valid values are default
and native.
437
PrimeFaces User Guide
<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.
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;
438
PrimeFaces User Guide
3.120 SelectBooleanButton
SelectBooleanButton is used to select a binary decision with a toggle button.
Info
Tag selectBooleanButton
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
valueChangeListener null Method A method expression that refers to a method for handling
Expr a valuechangeevent
439
PrimeFaces User Guide
onfocus null String Client side callback to execute when button receives
focus.
onblur null String Client side callback to execute when button loses focus.
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 Applies
440
PrimeFaces User Guide
3.121 SelectBooleanCheckbox
SelectBooleanCheckbox is an extended version of the standard checkbox with theme integration.
Info
Tag selectBooleanCheckbox
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
converter null Convert An el expression or a literal text that defines a converter for
er/ the component. When its an EL expression, its resolved to
String a converter instance. In case its a static text, it must refer to
a converter id
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
validator null Method A method expression that refers to a method validationg the
Expr input
valueChangeListener null Method A method expression that refers to a method for handling a
Expr valuechangeevent
tabindex null String Specifies tab order for tab key navigation.
onfocus null String Client side callback to execute when checkbox receives
focus.
onblur null String Client side callback to execute when checkbox loses focus.
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;
442
PrimeFaces User Guide
443
PrimeFaces User Guide
3.122 SelectCheckboxMenu
SelectCheckboxMenu is a multi select component that displays options in an overlay.
Info
Tag selectCheckboxMenu
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
444
PrimeFaces User Guide
handling a valuechangeevent
filterMatchMode startsWith String Match mode for filtering, valid values are
startsWith, contains, endsWith and custom.
updateLabel false Boolean When enabled, the selected items are displayed on
label.
445
PrimeFaces User Guide
Labels
Selected items are not displayed as the component label by default, setting updateLabel to true
displays item as a comma separated list and for an advanced display use multiple property instead
which renders the items as separate tokens similar to the chips component.
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.
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;
446
PrimeFaces User Guide
.ui-selectcheckboxmenu-label Label.
447
PrimeFaces User Guide
3.123 SelectManyButton
SelectManyButton is a multi select component using button UI.
Info
Tag selectManyButton
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
448
PrimeFaces User Guide
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;
449
PrimeFaces User Guide
3.124 SelectManyCheckbox
SelectManyCheckbox is an extended version of the standard SelectManyCheckbox.
Info
Tag selectManyCheckbox
Attributes
450
PrimeFaces User Guide
validation fails.
Layouts
There are five layouts options for the checkboxes;
Custom Layout
Custom layout is defined using the standalone checkbox components that match the selectItems of
the selectManyCheckbox by their itemIndex option. Note that in this mode selectManyCheckbox
does not render anything visible.
451
PrimeFaces User Guide
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;
452
PrimeFaces User Guide
3.125 SelectManyMenu
SelectManyMenu is an extended version of the standard SelectManyMenu.
Info
Tag selectManyMenu
Attributes
immediate false Boolean When set true, process validations logic is executed
at apply request values phase for this component.
453
PrimeFaces User Guide
handling a valuechangeevent
tabindex null String Position of the input element in the tabbing order.
filterMatchMode null String Match mode for filtering, valid values are
startsWith (default), contains, endsWith and
custom.
Custom Content
Custom content can be displayed for each item using column components.
454
PrimeFaces User Guide
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;
Checkbox
SelectManyMenu has built-in support for checkbox based multiple selection, when enabled by
showCheckbox option, checkboxes are displayed next to each column.
455
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;
456
PrimeFaces User Guide
3.126 SelectOneButton
SelectOneButton is an input component to do a single select.
Info
Tag selectOneButton
Attributes
457
PrimeFaces User Guide
validation fails.
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;
458
PrimeFaces User Guide
3.127 SelectOneListbox
SelectOneListbox is an extended version of the standard selectOneListbox component.
Info
Tag selectOneListbox
Attributes
459
PrimeFaces User Guide
handling a valuechangeevent
tabindex null String Position of the input element in the tabbing order.
filterMatchMode null String Match mode for filtering, valid values are
startsWith (default), contains, endsWith and
custom.
Custom Content
Custom content can be displayed for each item using column components.
460
PrimeFaces User Guide
<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;
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;
461
PrimeFaces User Guide
3.128 SelectOneMenu
SelectOneMenu is an extended version of the standard SelectOneMenu.
Info
Tag selectOneMenu
Attributes
462
PrimeFaces User Guide
effectSpeed normal String Duration of toggle animation, valid values are "slow",
"normal" and "fast".
filterMatchMode starts String Match mode for filtering, valid values are startsWith,
With contains, endsWith and custom.
appendTo null String Appends the overlay to the element defined by search
expression. Defaults to document body.
syncTooltip false Boolean Updates the title of the component with the description
of the selected item.
463
PrimeFaces User Guide
onfocus null String Client side callback to execute when element receives
focus.
onblur null String Client side callback to execute when element loses
focus.
autoWidth true Boolean Calculates a fixed width based on the width of the
maximum option label. Set to false for custom width.
Custom Content
SelectOneMenu can display custom content in overlay panel by using column component and the
var option to refer to each item.
public OrderListBean() {
players = new ArrayList<Player>();
<p:column>
#{p.name} - #{p.number}
</p:column>
</p:selectOneMenu>
464
PrimeFaces User Guide
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.
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>
465
PrimeFaces User Guide
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;
467
PrimeFaces User Guide
3.129 SelectOneRadio
SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.
Info
Tag selectOneRadio
Attributes
468
PrimeFaces User Guide
tabindex null String Specifies the tab order of element in tab navigation.
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.
469
PrimeFaces User Guide
<h:panelGrid columns="3">
<p:radioButton id="opt1" for="customRadio" itemIndex="0"/>
<h:outputLabel for="opt1" value="Option 1" />
<p:spinner />
RadioButtons 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;
470
PrimeFaces User Guide
3.130 Separator
Separator displays a horizontal line to separate content.
Info
Tag separator
Attributes
//content
<p:separator />
//content
Dimensions
Separator renders a <hr /> tag which style and styleClass options apply.
471
PrimeFaces User Guide
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
As skinning style classes are global, see the main theming section for more information.
472
PrimeFaces User Guide
3.131 Signature
Signature is used to draw a signature as an input. Various options such as background color,
foreground color, thickness are available for customization. Signature also supports touch enabled
devices and legacy browsers without canvas support.
Info
Tag signature
Attributes
immediate false Boolean Boolean value that specifies the lifecycle phase the
valueChangeEvents should be processed, when true
473
PrimeFaces User Guide
base65Value null String Write-only value used to pass the value in base64
to backing bean
474
PrimeFaces User Guide
Guideline
Guideline adds a horizontal line to indicate the area to sign, attributes such as guidelineColor,
guidelineOffset and guidelineIndent can be used to customize this area.
Convert to Binary
Signature value is represented as a JSON array at client side and this value is also passed as a java
string to backend bean, however if you need to convert this to a byte[] or write it to an outputStream
following helper class can be used.
475
PrimeFaces User Guide
import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.Graphics2D;
import java.awt.RenderingHints;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.imageio.ImageIO;
/**
* A point along a line within a signature.
*/
private static class Point {
private int x;
private int y;
476
PrimeFaces User Guide
/**
* Extract a signature from its JSON encoding and redraw it as an image.
*
* @param jsonEncoding the JSON representation of the signature
* @param output the destination stream for the image
* @throws IOException if a problem writing the signature
*/
public static void generateSignature(String jsonEncoding, OutputStream output)
throws IOException {
output.write(redrawSignature(extractSignature(jsonEncoding)));
output.close();
}
/**
* Extract the signature lines and points from the JSON encoding.
*
* @param jsonEncoding the JSON representation of the signature
* @return the retrieved lines and points
*/
private static List<List<Point>> extractSignature(String jsonEncoding) {
List<List<Point>> lines = new ArrayList<List<Point>>();
Matcher lineMatcher =
Pattern.compile("(\\[(?:,?\\[-?[\\d\\.]+,-?[\\d\\.]+\\])+\\])").
matcher(jsonEncoding);
while (lineMatcher.find()) {
Matcher pointMatcher =
Pattern.compile("\\[(-?[\\d\\.]+),(-?[\\d\\.]+)\\]").
matcher(lineMatcher.group(1));
List<Point> line = new ArrayList<Point>();
lines.add(line);
while (pointMatcher.find()) {
line.add(new Point(Float.parseFloat(pointMatcher.group(1)),
Float.parseFloat(pointMatcher.group(2))));
}
}
return lines;
}
/**
* Redraw the signature from its lines definition.
*
* @param lines the individual lines in the signature
* @return the corresponding signature image
* @throws IOException if a problem generating the signature
*/
private static byte[] redrawSignature(List<List<Point>> lines) throws IOException {
BufferedImage signature = new BufferedImage(
SIGNATURE_WIDTH, SIGNATURE_HEIGHT, BufferedImage.TYPE_BYTE_GRAY);
Graphics2D g = (Graphics2D)signature.getGraphics();
g.setColor(Color.WHITE);
g.fillRect(0, 0, signature.getWidth(), signature.getHeight());
g.setColor(Color.BLACK);
g.setStroke(new BasicStroke(2, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND));
g.setRenderingHint(
RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
Point lastPoint = null;
for (List<Point> line : lines) {
for (Point point : line) {
if (lastPoint != null) {
g.drawLine(lastPoint.x, lastPoint.y, point.x, point.y);
}
lastPoint = point;
}
lastPoint = null;
}
ByteArrayOutputStream output = new ByteArrayOutputStream();
ImageIO.write(signature, IMAGE_FORMAT, output);
ImageIO.write(signature, IMAGE_FORMAT, output);
return output.toByteArray();
}
}
return output.toByteArray();
477
PrimeFaces User Guide
3.132 SlideMenu
SlideMenu is used to display nested submenus with sliding animation.
Info
Tag slideMenu
Attributes
478
PrimeFaces User Guide
triggerEvent click String Event name of trigger that will show the dynamic
positioned menu.
<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:separator />
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.
//content
</p:slideMenu>
479
PrimeFaces User Guide
Skinning
SlideMenu resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
480
PrimeFaces User Guide
3.133 Slider
Slider is used to provide input with various customization options like orientation, display modes
and skinning.
Info
Tag slider
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
for null String Id of the input text that the slider will be used for
animate true Boolean Boolean value to enable/disable the animated move when
background of slider is clicked
type horizontal String Sets the type of the slider, "horizontal" or "vertical".
onSlideStart null String Client side callback to execute when slide begins.
481
PrimeFaces User Guide
onSlideEnd null String Client side callback to execute when slide ends.
range false Boolean When enabled, two handles are provided for selection a
range.
displayTemplate null String String template to use when updating the display. Valid
placeholders are {value}, {min} and {max}.
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.
482
PrimeFaces User Guide
Vertical Slider
By default sliders orientation is horizontal, vertical sliding is also supported and can be set using
the type attribute.
Step
Step factor defines the interval between each point during sliding. Default value is one and it is
customized using step option.
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.
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;
483
PrimeFaces User Guide
<h:outputText id="displayRange"
value="Between #{sliderBean.number6} and #{sliderBean.number7}"/>
<p:slider for="number">
<p:ajax event="slideEnd" listener="#{sliderBean.onSlideEnd}" update="msgs" />
</p:slider>
484
PrimeFaces User Guide
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;
Class Applies
As skinning style classes are global, see the main theming section for more information.
485
PrimeFaces User Guide
3.134 Spotlight
Spotlight highlights a certain component on page.
Info
Tag spotlight
Attributes
rendered false Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
486
PrimeFaces User Guide
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 Applies
487
PrimeFaces User Guide
3.135 Socket
Socket component is an agent that creates a push channel between the server and the client.
Info
Tag socket
Attributes
489
PrimeFaces User Guide
3.136 Spacer
Spacer is used to put spaces between elements.
Info
Tag spacer
Attributes
Spacer in this example separates this text <p:spacer width="100" height="10"> and
<p:spacer width="100" height="10"> this text.
490
PrimeFaces User Guide
3.137 Spinner
Spinner is an input component to provide a numerical input via increment and decrement buttons.
Info
Tag spinner
Attributes
immediate false Boolean 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
491
PrimeFaces User Guide
accesskey null String Access key that when pressed transfers focus to the
input element.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
lang null String Code describing the language used in the generated
markup for this component.
onblur null String Client side callback to execute when input element
loses focus.
onchange null String Client side callback to execute when input element
loses focus and its value has been modified since
gaining focus.
onclick null String Client side callback to execute when input element
is clicked.
ondblclick null String Client side callback to execute when input element
is double clicked.
onfocus null String Client side callback to execute when input element
receives focus.
492
PrimeFaces User Guide
onselect null String Client side callback to execute when text within
input element is selected by user.
readonly false Boolean Flag indicating that this component will prevent
changes by the user.
tabindex null Integer Position of the input element in the tabbing order.
493
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.
Boundaries
In order to restrict the boundary values, use min and max options.
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>
494
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 Applies
As skinning style classes are global, see the main theming section for more information.
495
PrimeFaces User Guide
3.138 SplitButton
SplitButton displays a command by default and additional ones in an overlay.
Info
Tag splitButton
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
immediate false Boolean Boolean value that determines the phaseId, when true actions
are processed at apply_request_values, when false at
invoke_application phase.
ajax true Boolean Specifies the submit mode, when set to true(default), submit
would be made with Ajax.
496
PrimeFaces User Guide
async false Boolean When set to true, ajax requests are not queued.
onstart null String Client side callback to execute before ajax request is begins.
oncomplete null String Client side callback to execute when ajax request is
completed.
onsuccess null String Client side callback to execute when ajax request succeeds.
onerror null String Client side callback to execute when ajax request fails.
delay null 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.
partialSubmitFilter null String Selector to use when partial submit is on, default is ":input"
to select all descendant inputs of a partially processed
components.
resetValues false Boolean If true, local values of input components to be updated within
the ajax request would be reset.
onblur null String Client side callback to execute when button loses focus.
onchange null String Client side callback to execute when button loses focus and
its value has been modified since gaining focus.
onclick null String Client side callback to execute when button is clicked.
ondblclick null String Client side callback to execute when button is double clicked.
onfocus null String Client side callback to execute when button receives focus.
onkeydown null String Client side callback to execute when a key is pressed down
over button.
497
PrimeFaces User Guide
onkeypress null String Client side callback to execute when a key is pressed and
released over button.
onkeyup null String Client side callback to execute when a key is released over
button.
onmousedown null String Client side callback to execute when a pointer button is
pressed down over button.
onmousemove null String Client side callback to execute when a pointer button is
moved within button.
onmouseout null String Client side callback to execute when a pointer button is
moved away from button.
onmouseover null String Client side callback to execute when a pointer button is
moved onto button.
onmouseup null String Client side callback to execute when a pointer button is
released over button.
onselect null String Client side callback to execute when text within button is
selected by user.
accesskey null String Access key that when pressed transfers focus to the button.
dir null String Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
image null String Style class for the button icon. (deprecated: use icon)
lang null String Code describing the language used in the generated markup
for this component.
tabindex null Integer Position of the button element in the tabbing order.
readonly false Boolean Flag indicating that this component will prevent changes by
the user.
appendTo null String Appends the overlay to the element defined by search
expression. Defaults to document body.
form null String Form to serialize for an ajax request. Default is the enclosing
form.
498
PrimeFaces User Guide
Skinning
SplitButton renders a container element which style and styleClass applies. Following is the list of
structural style classes;
499
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
500
PrimeFaces User Guide
3.139 Submenu
Submenu is nested in menu components and represents a sub menu items.
Info
Tag submenu
Attributes
icon null String Icon of a submenu, see menuitem to see how it is used
501
PrimeFaces User Guide
3.140 Stack
Stack is a navigation component that mimics the stacks feature in Mac OS X.
Info
Tag stack
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
openSpeed 300 String Speed of the animation when opening the stack.
closeSpeed 300 Integer Speed of the animation when opening the stack.
502
PrimeFaces User Guide
<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>
Location
Stack is a fixed positioned element and location can be change via css. Theres 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
Class Applies
503
PrimeFaces User Guide
3.141 Steps
Steps components is an indicator for the steps in a workflow. Layout of steps component is
optimized for responsive design.
Info
Tag steps
Attributes
504
PrimeFaces User Guide
<p:steps activeIndex="1">
<p:menuitem value="Personal" />
<p:menuitem value="Seat Selection" />
<p:menuitem value="Payment" />
<p:menuitem value="Confirmation" />
</p:steps>
Skinning Steps
Steps resides in a main container which style and styleClass attributes apply. Following is the list of
structural style classes;
As skinning style classes are global, see the main theming section for more information. Here is an
example of a styled steps having "custom" as its styleClass;
.ui-steps.custom {
margin-bottom: 30px;
}
.ui-steps.custom .ui-steps-item .ui-menuitem-link {
height: 10px;
padding: 0 1em;
}
.ui-steps.custom .ui-steps-item .ui-steps-number {
background-color: #0081c2;
color: #FFFFFF;
display: inline-block;
width: 30px;
border-radius: 10px;
margin-top: -10px;
margin-bottom: 10px;
margin-bottom: 10px;
}
505
PrimeFaces User Guide
3.142 Sticky
Sticky component positions other components as fixed so that these components stay in window
viewport during scrolling.
Info
Tag sticky
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
margin 0 Integer Margin to the top of the page during fixed scrolling.
506
PrimeFaces User Guide
<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 />
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.
507
PrimeFaces User Guide
3.143 SubTable
SubTable is a helper component of datatable used for grouping.
Info
Tag subTable
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
508
PrimeFaces User Guide
3.144 SummaryRow
SummaryRow is a helper component of datatable used for dynamic grouping.
Info
Tag summaryRow
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
509
PrimeFaces User Guide
3.145 Tab
Tab is a generic container component used by other PrimeFaces components such as tabView and
accordionPanel.
Info
Tag tab
Attributes
510
PrimeFaces User Guide
3.146 TabMenu
TabMenu is a navigation component that displays menuitems as tabs.
Info
Tag tabMenu
Attributes
511
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;
As skinning style classes are global, see the main theming section for more information.
512
PrimeFaces User Guide
3.147 TabView
TabView is a container component to group content in tabs.
Info
Tag tabView
Attributes
cache true Boolean 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
513
PrimeFaces User Guide
onTabChange null String Client side callback to execute when a tab is clicked.
onTabShow null String Client side callback to execute when a tab is shown.
dir ltr String Defines text direction, valid values are ltr and rtl.
<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>
Dynamic Tabs
Therere 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.
514
PrimeFaces User Guide
<p:tabView dynamic="true">
//tabs
</p:tabView>
Content Caching
Dynamically loaded tabs cache their contents by default, by doing so, reactivating a tab doesnt
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>
<p:ajax event=tabChange listener=#{bean.onChange} />
//tabs
</p:tabView>
515
PrimeFaces User Guide
Orientations
Four different orientations are available; top(default), left, right and bottom.
<p:tabView orientation="left">
//tabs
</p:tabView>
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>
<p:tabView onTabChange="handleTabChange(index)">
//tabs
</p:tabView>
function handleTabChange(i) {
//i = Index of the new tab
}
select(index) index: Index of tab to display void Activates tab with given index
selectTab(index) index: Index of tab to display void (Deprecated, use select instead)
Activates tab with given index
disable(index) index: Index of tab to disable void Disables tab with given index
enable(index) index: Index of tab to enable void Enables tab with given index
remove(index) index: Index of tab to remove void Removes tab with given index
Skinning
As skinning style classes are global, see the main theming section for more information. Following
is the list of structural style classes.
Class Applies
517
PrimeFaces User Guide
3.148 TagCloud
TagCloud displays a collection of tag with different strengths.
Info
Tag tagCloud
Attributes
518
PrimeFaces User Guide
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>
TagCloud API
org.primefaces.model.tagcloud.TagCloudModel
Method Description
org.primefaces.model.tagcloud.TagCloudItem
Method Description
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.
520
PrimeFaces User Guide
3.149 Terminal
Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.
Info
Tag terminal
Attributes
Whenever a command is sent to the server, handleCommand method is invoked with the command
name and the command arguments as a String array.
Skinning
Terminal resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
522
PrimeFaces User Guide
3.150 TextEditor
Editor is an input component with rich text editing capabilities based on Quill.
Info
Tag textEditor
Attributes
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
523
PrimeFaces User Guide
Custom Toolbar
Toolbar of editor is easy to customize using toolbar facet;
524
PrimeFaces User Guide
Skinning
Refer to QuillJS documentation for styling;
https://quilljs.com/guides/how-to-customize-quill/
525
PrimeFaces User Guide
3.151 ThemeSwitcher
ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh.
Info
Tag themeSwitcher
Attributes
effectSpeed normal String Duration of the toggle animation, valid values are
"slow", "normal" and "fast".
526
PrimeFaces User Guide
<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 youd like
to get notified when a user changes the theme (e.g. to update user preferences), you can use an ajax
behavior.
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>
527
PrimeFaces User Guide
3.152 TimeLine
Timeline is an interactive graph to visualize events in time.
Info
Tag timeLine
Attributes
528
PrimeFaces User Guide
locale null Object User locale for i18n messages. The attribute can be
either a String or Locale object.
timeZone null Object Target time zone to convert start / end dates for
displaying. This time zone is the time zone the user
would like to see dates in UI. The attribute can be
either a String or TimeZone object or null. If null,
timeZone defaults to the server's time zone the
application is running in.
browserTimeZone null Object Time zone the user's browser / PC is running in.
This time zone allows to correct the conversion of
start / end dates to the target timeZone for
displaying. The attribute can be either a String or
TimeZone object or null. Note: browserTimeZone
should be provided if the target timeZone is
provided. If null, browserTimeZone defaults to the
server's timeZone.
responsive true Boolean Check if the timeline container is resized, and if so,
resize the timeline. Useful when the webpage
(browser window) or a layout pane / unit containing
529
PrimeFaces User Guide
axisOnTop false Boolean If false, the horizontal axis is drawn at the bottom. If
true, the axis is drawn on top.
dragAreaWidth 10 Integer The width of the drag areas in pixels. When an event
with date range is selected, it has a drag area on the
left and right side, with which the start or end dates
of the event can be manipulated.
editable false Boolean If true, the events can be edited, changed, created
and deleted. Events can only be editable when the
option selectable is true (default). When editable is
true, the timeline can fire AJAX events "change",
"edit", "add", "delete", "drop". This global setting
"editable" can be overwritten for individual events
by setting a value in field "editable".
unselectable true Boolean If true, you can unselect an item by clicking in the
empty space of the timeline. If false, you cannot
unselect an item, there will be always one item
selected.
zoomable true Boolean If true, the timeline is zoomable. When the timeline
is zoomed, AJAX "rangechange" events are fired.
moveable true Boolean If true, the timeline is movable. When the timeline is
moved, AJAX "rangechange" events are fired.
start null Date The initial start date for the axis of the timeline. If
not provided, the earliest date present in the events
is taken as start date.
end null Date The initial end date for the axis of the timeline. If
not provided, the latest date present in the events is
taken as end date.
min null Date Set a minimum Date for the visible range. It will not
be possible to move beyond this minimum.
max null Date Set a maximum Date for the visible range. It will not
be possible to move beyond this maximum.
zoomMin 10L Long Set a minimum zoom interval for the visible range in
530
PrimeFaces User Guide
zoomMax 3153600 Long Set a maximum zoom interval for the visible range
0000000 in milliseconds. It will not be possible to zoom out
0L further than this maximum. Default value equals
315360000000000 ms (about 10000 years).
eventStyle box String Specifies the style for the timeline events. Choose
from "dot" or "box".
groupsChangeable true Boolean If true, items can be moved from one group to
another. Only applicable when groups are used.
groupsOnRight false Boolean If false, the groups legend is drawn at the left side of
the timeline. If true, the groups legend is drawn on
the right side.
groupsOrder true Boolean Allows to customize the way groups are ordered.
When true (default), groups will be ordered by
content alphabetically (when the list of groups is
missing) or by native ordering of TimelineGroup
object in the list of groups (when the list of groups is
available). When false, groups will not be ordered at
all.
snapEvents true Boolean If true, the start and end of an event will be snapped
nice integer values when moving or resizing the
event. Default is true.
stackEvents true Boolean If true, the start and end of an event will be snapped
nice integer values when moving or resizing the
event.
showCurrentTime true Boolean If true, the timeline shows a red, vertical line
displaying the current time.
showMajorLabels true Boolean By default, the timeline shows both minor and major
date labels on the horizontal axis. For example the
minor labels show minutes and the major labels
show hours. When "showMajorLabels" is false, no
major labels are shown.
showMinorLabels true Boolean By default, the timeline shows both minor and major
date labels on the horizontal axis. For example the
minor labels show minutes and the major labels
show hours. When "showMinorLabels" is false, no
minor labels are shown.
When both "showMajorLabels" and
"showMinorLabels" are false, no horizontal axis will
be visible.
showButtonNew false Boolean Show the button "Create new event" in the a
navigation menu.
showNavigation false Boolean Show a navigation menu with buttons to move and
zoom the timeline.
532
PrimeFaces User Guide
animate true Boolean When true, events are moved animated when
resizing or moving them. This is very pleasing for
the eye, but does require more computational power.
animateZoom true Boolean When true, events are moved animated when
zooming the Timeline. This looks cool, but does
require more computational power.
@PostConstruct
protected void initialize() {
model = new TimelineModel();
Examples
For examples on editing, grouping, styling, ranges, linked timelines and lazy loading please visit;
533
PrimeFaces User Guide
http://www.primefaces.org/showcase-ext/sections/timeline/basic.jsf
534
PrimeFaces User Guide
3.153 TieredMenu
TieredMenu is used to display nested submenus with overlays.
Info
Tag tieredMenu
Attributes
autoDisplay true Boolean Defines whether the first level of submenus will be
displayed on mouseover or not. When set to false,
click event is required to display.
535
PrimeFaces User Guide
triggerEvent click String Event name of trigger that will show the dynamic
positioned menu.
toggleEvent hover String Event to toggle the submenus, valid values are
"hover" and "click".
<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:separator />
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>
536
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.
//content
</p:tieredMenu>
Skinning
TieredMenu resides in a main container which style and styleClass attributes apply. Following is the
list of structural style classes;
As skinning style classes are global, see the main theming section for more information.
537
PrimeFaces User Guide
3.154 Toolbar
Toolbar is a horizontal grouping component for commands and other content.
Info
Tag toolbar
Attributes
<p:toolbar>
<f:facet name="left"></f:facet>
<f:facet name="right"></f:facet>
</p:toolbar>
538
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>
<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;
As skinning style classes are global, see the main theming section for more information.
539
PrimeFaces User Guide
3.155 ToolbarGroup
ToolbarGroup is a helper component for Toolbar component to define placeholders.
Info
Tag toolbarGroup
Attributes
align null String Defines the alignment within toolbar, valid values
are left and right.
540
PrimeFaces User Guide
3.156 Tooltip
Tooltip goes beyond the legacy html title attribute by providing custom effects, events, html content
and advance theme support.
Info
Tag tooltip
Attributes
541
PrimeFaces User Guide
beforeShow null String Client side callback to execute before tooltip is shown.
Returning false will prevent display.
onHide null String Client side callback to execute after tooltip is shown.
onShow null String Client side callback to execute after tooltip is shown.
position right String Position of the tooltip, valid values are right, left, top
and bottom.
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 />
542
PrimeFaces User Guide
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.
<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>
Position
Tooltip has four possible position, default is right and other valid values are left, top and bottom.
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.
<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.
543
PrimeFaces User Guide
3.157 Tree
Tree is used for displaying hierarchical data and creating site navigations.
Info
Tag tree
Attributes
544
PrimeFaces User Guide
styleClass null String Style class of the main container element of tree
dir ltr String Defines text direction, valid values are ltr and rtl.
dragdropScope null String Scope key to group a set of tree components for
transferring nodes using drag and drop.
545
PrimeFaces User Guide
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);
//getter of root
}
TreeNode vs p:TreeNode
TreeNode API is used to create the node model and consists of org.primefaces.model.TreeNode
instances, on the other hand <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.
type String type of the treeNode name, default type name is "default".
546
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.
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 its 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.
547
PrimeFaces User Guide
Document Explorer is implemented with four different <p:treeNode /> components and additional
CSS skinning to visualize expanded/closed folder icons.
548
PrimeFaces User Guide
public Bean() {
root = new DefaultTreeNode("root", null);
//Documents
TreeNode expenses = new DefaultTreeNode("document", "Expenses.doc", work);
TreeNode resume = new DefaultTreeNode("document", "Resume.doc", work);
TreeNode refdoc = new DefaultTreeNode("document", "RefDoc.pages", primefaces);
//Pictures
TreeNode barca = new DefaultTreeNode("picture", "barcelona.jpg", pictures);
TreeNode primelogo = new DefaultTreeNode("picture", "logo.jpg", pictures);
TreeNode optimus = new DefaultTreeNode("picture", "optimus.png", pictures);
//Music
TreeNode turkish = new DefaultTreeNode("Turkish", music);
TreeNode cemKaraca = new DefaultTreeNode("Cem Karaca", turkish);
TreeNode erkinKoray = new DefaultTreeNode("Erkin Koray", turkish);
TreeNode mogollar = new DefaultTreeNode("Mogollar", turkish);
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", theres 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.
Filtering
Tree has built-in support for filtering that is enabled by using filterBy property.
549
PrimeFaces User Guide
startsWith is the default filter method and filterMatchMode is used to customize this. Valid values
are startsWith, endsWidth, contains, exact, lt, lte, gt, gte, equals and in.
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.
550
PrimeFaces User Guide
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.
public TreeBean() {
root = new CheckboxTreeNode("Root", null);
//populate nodes
}
//getters and setters
}
Thats 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 re-
expanding a node will not trigger a server side request. In case its set to false, collapsing the node
will remove the children and expanding it later causes the children nodes to be fetched from server
again.
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.
551
PrimeFaces User Guide
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.
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.
552
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: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;
553
PrimeFaces User Guide
As skinning style classes are global, see the main theming section for more information.
554
PrimeFaces User Guide
3.158 TreeNode
TreeNode is used with Tree component to represent a node in tree.
Info
Tag treeNode
Attributes
styleClass null String Style class to apply a particular tree node type
555
PrimeFaces User Guide
3.159 TreeTable
Treetable is is used for displaying hierarchical data in tabular format.
Info
Tag treeTable
Attributes
556
PrimeFaces User Guide
liveResize false Boolean Columns are resized live in this mode without
using a resize helper.
557
PrimeFaces User Guide
editMode row String Defines edit mode, valid values are "row"
(default) and "cell".
558
PrimeFaces User Guide
//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.
Paginator
Node hierarchy can be displayed as paged using paginator. Usage is similar to DataTable, DataList
and DataGrid where paginator is enabled by setting paginator=true and defining a rows property
to define the number of nodes to be displayed per page.
559
PrimeFaces User Guide
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.
Scrolling
Scrollable TreeTable implementation is same as DataTable Scrollable, refer to scrolling part in
DataTable section for detailed information.
Dynamic Columns
TreeTable supports dynamic columns via p:columns component, refer to dynamic columns in
DataTable section for detailed information.
Colum Priorities
Similar to DataTable, TreeTable columns can also be hidden depending on their priorities with
respect to screen size.
Sorting
Sorting is enabled by setting sortBy expressions at column level.
//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.
Editing
Similar to DataTable, TreeTable supports row and cell based editing. Refer to datatable for more
information.
Skinning
TreeTable content resides in a container element which style and styleClass attributes apply.
Following is the list of structural style classes;
Class Applies
As skinning style classes are global, see the main theming section for more information.
560
PrimeFaces User Guide
3.160 TriStateCheckbox
TriStateCheckbox adds a new state to a checkbox value.
Info
Tag triStateCheckbox
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
converter null Convert An el expression or a literal text that defines a converter for
er/ the component. When its an EL expression, its resolved to
String a converter instance. In case its a static text, it must refer to
a converter id
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
validator null Method A method expression that refers to a method validationg the
Expr input
valueChangeListener null Method A method expression that refers to a method for handling a
Expr valuechangeevent
561
PrimeFaces User Guide
tabindex null String Specifies tab order for tab key navigation.
<p:triStateCheckbox value="#{bean.value}"/>
562
PrimeFaces User Guide
Skinning
TriStateCheckbox 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;
563
PrimeFaces User Guide
3.161 Watermark
Watermark displays a hint on an input field.
Info
Tag watermark
Attributes
564
PrimeFaces User Guide
Form Submissions
Watermark is set as the text of an input field which shouldnt 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.
Skinning
For browsers that do not support placeholder, theres only one css style class applying watermark
which is .ui-watermark, you can override this class to bring in your own style.
565
PrimeFaces User Guide
3.162 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 wizard
Attributes
rendered true Boolean Boolean value to specify the rendering of the component,
when set to false component will not be rendered.
styleClass null String Style class of the main wizard container element.
flowListener null MethodExpr Server side listener to invoke when wizard attempts to go
forward or back.
566
PrimeFaces User Guide
onback null String Javascript event handler to be invoked when flow goes
back.
onnext null String Javascript event handler to be invoked when flow goes
forward.
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.
567
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"/>
<p:tab id="address">
<p:panel header="Adress Details">
<h:messages errorClass="error"/>
<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"/>
568
PrimeFaces User Guide
<p:tab id="confirm">
<p:panel header="Confirmation">
<h:outputText />
<h:outputText />
</h:panelGrid>
</p:panel>
</p:tab>
</p:wizard>
</h:form>
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.
569
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.
FlowListener
If youd like get notified on server side when wizard attempts to go back or forward, define a
flowListener.
<p:wizard flowListener="#{userWizard.handleFlow}">
...
</p:wizard>
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.
570
PrimeFaces User Guide
Skinning
Wizard resides in a container element that style and styleClass attributes apply. Following is the list
of structural css classes.
Selector Applies
As skinning style classes are global, see the main theming section for more information.
571
PrimeFaces User Guide
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.
<h:form>
<p:commandButton update="display" />
PrependId
Setting prependId setting of a form has no effect on how PPR is used.
<h:form prependId="false">
<p:commandButton update="display" />
572
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">
</h:form>
<h:form id="form2">
</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>
</h:form>
573
PrimeFaces User Guide
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;
4.1.4 Bits&Pieces
PrimeFaces Ajax Javascript API
See the javascript section to learn more about the PrimeFaces Javascript Ajax API.
574
PrimeFaces User Guide
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 well be
using commandButton.
<h:form>
</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 were just making a city change request, only
processing that should happen is cities dropdown.
575
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>
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.
576
PrimeFaces User Guide
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.
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>
577
PrimeFaces User Guide
<h:form id="form1">
<p:commandButton id="btn" update="@form" process="@this" />
<h:outputText value="#{bean.value}"/>
</h:form>
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>
update="@(form)"
update="@(form:first)"
update="@(.mystyle)"
update="@(:input)" process="@(:input)"
578
PrimeFaces User Guide
update="@(.ui-datatable)"
Process input components inside any panel and update all panels
process="@(:input:not(select))"
update="@(:input:disabled)"
<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 youve 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 jQuerys 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.
http://api.jquery.com/category/selectors/
579
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.
580
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.
Method Description
escapeClientId(id) Escaped JSF ids with semi colon to work with jQuery.
setCookie(name, value, cfg) Sets a cookie with given name, value and options. e.g.
PrimeFaces.setCookie('name', 'test');
PrimeFaces.setCookie('name','test',{expires:7,
path:'/'})
Second example creates cookie for entire site that
expires in 7 days.
To be compatible with other javascript entities on a page, PrimeFaces defines two javascript
namespaces;
PrimeFaces.widget.*
- 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.*
581
PrimeFaces User Guide
PrimeFaces.ajax namespace contains the ajax API which is described in next section.
582
PrimeFaces User Guide
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 Description
async Flag to define whether request should go in ajax queue or not, default
is false.
onstart() Javascript callback to process before sending the ajax request, return
false to cancel the request.
onsuccess(data, status, xhr) Javascript callback to process when ajax request returns with success
code. Takes three arguments, xml response, status code and
xmlhttprequest.
onerror(xhr, status, error) Javascript callback to process when ajax request fails. Takes three
arguments, xmlhttprequest, status string and exception thrown if any.
oncomplete(xhr, status, args) Javascript callback to process when ajax request completes. Takes
three arguments, xmlhttprequest, status string and optional arguments
provided by RequestContext API.
583
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>
PrimeFaces.ajax.Request.handle({
formId:userForm
,source:userForm
,process:userForm
});
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()
584
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;
585
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>
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.
586
PrimeFaces User Guide
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>
587
PrimeFaces User Guide
At host page, the button that triggered the dialog should have dialogReturn event.
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;
588
PrimeFaces User Guide
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>
<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.
589
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:clientValidator 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}" />
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
translations. For more info on PrimeFaces Locales, visit
http://code.google.com/p/primefaces/wiki/PrimeFacesLocales.
590
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.
MyFaces vs Mojarra
Bean validation messages between implementations have a slight difference regarding labels,
mojarra do not the label of the field but myfaces does. For example;
Mojarra:
javax.faces.validator.BeanValidator.MESSAGE={0}
MyFaces:
javax.faces.validator.BeanValidator.MESSAGE={1}: {0}
Default CSV messages follow the convention of Mojarra however if you prefer to display the label
along with the message, override can be done by adding {1} to the message;
Default:
PrimeFaces.locales['en_US'].messages['javax.faces.validator.BeanValidator.MESSAGE'] =
'{0}';
With Label:
PrimeFaces.locales['en_US'].messages['javax.faces.validator.BeanValidator.MESSAGE'] =
'{1}: {0}';
<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" />
591
PrimeFaces User Guide
@Size(min=2,max=5)
private String name;
@Min(10) @Max(20)
private Integer age;
}
Your custom validator must implement ClientValidator interface to provide the client validator id
and the optional metadata.
592
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 {
public EmailValidator() {
pattern = Pattern.compile(EMAIL_PATTERN);
}
if(!pattern.matcher(value.toString()).matches()) {
throw new ValidatorException(new
FacesMessage(FacesMessage.SEVERITY_ERROR, "Validation Error",
value + " is not a valid email;"));
}
}
<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>
593
PrimeFaces User Guide
Last step is implementing the validator at client side and configuring it.
PrimeFaces.validator['custom.emailValidator'] = {
pattern: /\S+@\S+/,
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).
//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.
//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 {};
}
594
PrimeFaces User Guide
@Constraint is the regular validator from Bean Validation API and @ClientConsraint is from CSV
API to resolve metadata.
return metadata;
}
595
PrimeFaces User Guide
PrimeFaces.validator['Email'] = {
pattern: /\S+@\S+/,
MESSAGE_ID: 'org.primefaces.examples.validate.email.message',
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;
}
}
};
<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>
@Email
private String value;
//getter-setter
}
596
PrimeFaces User Guide
8. Themes
PrimeFaces is integrated with powerful ThemeRoller CSS Framework. Currently there are 30+ pre-
designed themes that you can preview and download from PrimeFaces theme gallery.
http://www.primefaces.org/themes.html
597
PrimeFaces User Guide
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>
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 youd 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>
598
PrimeFaces User Guide
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>
599
PrimeFaces User Guide
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 Applies
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 dont need to know
each and every skinning selectors of components to change their style.
For example Panel components header section has the .ui-panel-titlebar structural class, to change
the color of a panel header you dont need to about this class as .ui-widget-header also that defines
the panel colors also applies to the panel header.
600
PrimeFaces User Guide
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
Trinidads Casablanca and RichFacess 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
}
<p:panel styleClass="custom">
...
</p:panel>
.custom .ui-panel-titlebar {
//css
}
601
PrimeFaces User Guide
8.5 FontAwesome
Font Awesome gives you scalable vector icons that can instantly be customized size, color, drop
shadow, and anything that can be done with the power of CSS. PrimeFaces bundles FontAwesome
4.6.1 and provides the CSS tuning of components for the icons. Any component that provides an
icon attribute such as buttons or menuitems can accept one of the icons of Font Awesome. In order
to enable this feature, a context param is required to be enabled.
<context-param>
<param-name>primefaces.FONT_AWESOME</param-name>
<param-value>true</param-value>
</context-param>
http://www.primefaces.org/showcase/ui/misc/fa.xhtml
602
PrimeFaces User Guide
9. PrimeFaces Push
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.4.6</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>
603
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.
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 @PushEndpoints 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 annotations attributes
available are;
604
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 encoder-
decoder 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
@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);
@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;
//...
605
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;
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.
See Socket component documentation for the full list of available options.
606
PrimeFaces User Guide
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>
<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{
607
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 youd 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>
608
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.
<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" />
<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 {
609
PrimeFaces User Guide
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;
}
610
PrimeFaces User Guide
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 doesnt 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.
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.
611
PrimeFaces User Guide
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.
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>
612
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">
<h:head>
</h:head>
<h:body>
<pm:page>
<pm:header title="Basic Page"></pm:header>
<pm:content></pm:content>
</pm:page>
</h:body>
</html>
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">
<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>
</h:body>
</html>
613
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;
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.
External
External navigations to another xhtml in same domain or a resource in another domain is same as
standard approach.
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.
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'
});
614
PrimeFaces User Guide
10.3 Components
10.3.1 Content
Content is container component for the content area of a page.
Info
Tag content
Attributes
<pm:page>
<pm:content>
//page content
</pm:content>
</pm:page>
615
PrimeFaces User Guide
10.3.2 Field
Field is a responsive layout component for label-input pairs.
Info
Tag field
Attributes
<pm:field>
<p:outputLabel for="text" value="Text:" />
<p:inputText id="txt" />
</pm:field>
616
PrimeFaces User Guide
10.3.3 Footer
Footer is container component for the bottom area of a page.
Info
Tag footer
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when set
to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
tapToggle true Boolean For fixed footers, sets whether the fixed toolbar's visibility can be
toggled by tapping on the page.
<pm:page>
<pm:footer title="Footer"></pm:footer>
</pm:page>
617
PrimeFaces User Guide
10.3.4 Header
Header is container component for the top area of a page.
Info
Tag header
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when set
to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
<pm:page>
<pm:header title="Footer"></pm:header>
</pm:page>
618
PrimeFaces User Guide
10.3.5 InputSlider
InputSlider is an input component with a touch enabled slider.
Info
Tag inputSlider
Attributes
immediate false Boolean When set true, process validations logic is executed at
apply request values phase for this component.
valueChangeListener null Object A method binding expression that refers to a method for
handling a valuechangeevent.
619
PrimeFaces User Guide
Boundaries
0 and 100 are the default boundaries, these can be customized using minValue and maxValue.
620
PrimeFaces User Guide
10.3.6 Page
Page is main component to define an internal page within an xhtml.
Info
Tag page
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when set
to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
lazy false 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.
621
PrimeFaces User Guide
10.3.7 RangeSlider
RangeSlider is a grouping component for dual sliders to create a range selection.
Info
Tag rangeSlider
Attributes
rendered true Boolean Boolean value to specify the rendering of the component, when set
to false component will not be rendered.
binding null Object An el expression that maps to a server side UIComponent instance
in a backing bean
<pm:rangeSlider>
<pm:inputSlider value="#{backingView.start}"/>
<pm:inputSlider value="#{backingView.end}"/>
</pm:rangeSlider>
622
PrimeFaces User Guide
Info
Tag switch
Attributes
623
PrimeFaces User Guide
624
PrimeFaces User Guide
10.4 RenderKit
In addition to the mobile components, various core components have been enhanced with touch
optimized 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
625
PrimeFaces User Guide
10.4.4 Calendar
10.4.5 ConfirmDialog
10.4.6 DataList
Additional supported ajax events are swiperight, swiperight, tap and taphold.
626
PrimeFaces User Guide
10.4.7 DataGrid
10.4.8 DataTable
Additional supported ajax events are swiperight, swiperight, tap and taphold.
10.4.9 Dialog
627
PrimeFaces User Guide
10.4.10 FileUpload
10.4.11 Growl
10.4.12 InputText
10.4.13 InputTextarea
10.4.14 Link
10.4.15 Menu
10.4.16 Panel
628
PrimeFaces User Guide
10.4.17 PanelGrid
10.4.17 SelectBooleanCheckbox
10.4.18 SelectCheckboxMenu
10.4.18 SelectManyButton
10.4.19 SelectManyCheckbox
10.4.20 SelectOneButton
10.4.21 SelectOneMenu
10.4.22 SelectOneRadio
629
PrimeFaces User Guide
10.4.23 TabMenu
10.4.24 TabView
10.4.25 Toolbar
630
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.
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>
631
PrimeFaces User Guide
10.6 Framework
In addition to the UI components, PFM provides seamless integration with jQuery Mobile.
<h:commandButton value="Standard">
<f:ajax render="panel1" />
</h:commandButton>
<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>
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.
632
PrimeFaces User Guide
<!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>
</pm:page>
</h:body>
</html>
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.
<h:form id="form">
<p:growl id="msgs" showDetail="true" />
633
PrimeFaces User Guide
FacesContext.getCurrentInstance().addMessage(null, msg);
}
Sections 10.4 and 10.5 contains supported mobile events for a component when available.
634
PrimeFaces User Guide
11. Misc
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 API
Method Description
addCallBackParam(String name, Object value) Adds parameters to ajax callbacks like oncomplete.
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)" />
<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
635
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.
<script type="text/javascript">
function handleComplete(xhr, status, args) {
var firstname = args.user.firstname;
var lastname = args.user.lastname;
}
</script>
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.
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;
636
PrimeFaces User Guide
requestContext.execute(dialog.hide());
}
637
PrimeFaces User Guide
11.2 EL Functions
PrimeFaces provides built-in EL extensions that are helpers to common use cases.
Common Functions
Function Description
component('id') Returns clientId of the component with provided server id parameter. This function
is useful if you need to work with javascript.
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 Description
ifGranted(String role) Returns true if user has the given role, else false.
ifAllGranted(String roles) Returns true if user has all of the given roles, else false.
ifAnyGranted(String roles) Returns true if user has any of the given roles, else false.
ifNotGranted(String roles) Returns true if user has none of the given roles, else false.
638
PrimeFaces User Guide
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.
<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>
639
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.
<p:ajaxExceptionHandler type="javax.faces.application.ViewExpiredException"
update="exceptionDialog" onexception="PF('exceptionDialog').show();" />
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.
640
PrimeFaces User Guide
PrimeFaces makes use of these metadata by transforming them to component and html attributes.
For example sometimes its 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;
Final output has html maxlength attribute generated from the @Max annotation, also the component
instance has required enabled.
641
PrimeFaces User Guide
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}',
642
PrimeFaces User Guide
643
PrimeFaces User Guide
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.
644
PrimeFaces User Guide
<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>
In upcoming PrimeFaces releases, more components will receive built-in RTL support. Until then if
the component you use doesnt provide it, overriding css and javascript in your application would be
the solution.
645
PrimeFaces User Guide
Page Layout
Page layout typically consists of the menus, header, footer and the content section. A responsive
page layout should optimize these sections according to the screen size. You may create your own
layout with CSS, pick one from a responsive css framework or choose PrimeFaces Premium
Layouts such as Sentinel, Spark, Modena, Rio and more.
Grid Framework
Grid framework is used to define container where you place the content and the components. A
typical grid framework usually consists of columns with varying widths and since they are also
responsive, containers adjust themselves according to the screen size. There are 3rd party grid
frameworks you can use whereas PrimeFaces also provides Grid CSS as a solution.
Components
Components also must be flexible enough to use within a responsive layout, if a component has
fixed width, it will not work well with a responsive page layout and grid framework as it does not
adjust its dimensions based on its container. There are two important points in PrimeFaces
components related to responsive design.
First is the fluid mode support for components where component gets 100% width meaning when
used within a grid, it will take the width of the grid. Fluid usually effects the form components. To
enable fluid mode, add ui-fluid to a container element.
<div class="ui-fluid">
<p:panelGrid columns="2" layout="grid">
<p:outputLabel for="input" value="Input"/>
<p:inputText id="input"/>
</p:panelGrid>
</div>
Second is the built-in responsive modes for complex components such Dialog, Charts, Carousel and
PickList. These types of components get a responsive attribute, when enabled they hook-in to
screen size change to optimize their content.
<p:dialog responsive="true"...
For a detailed example of a responsive page that uses all of the parts above, visit;
http://www.primefaces.org/showcase/ui/misc/responsive.xhtml
646
PrimeFaces User Guide
11.8 WAI-ARIA
WAI-ARIA (Web Accessibility Initiative Accessible Rich Internet Applications) is a technical
specification published by the World Wide Web Consortium (W3C) that specifies how to increase
the accessibility of web pages, in particular, dynamic content and user interface components
developed with Ajax, HTML, JavaScript and related technologies. Wikipedia
647
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;
648
PrimeFaces User Guide
649
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.
There is also another 3rd party plugin for NetBeans called PrimeFaces CRUD Generator.
http://sourceforge.net/projects/nbpfcrudgen/
13.2 Eclipse
Code completion works out of the box for Eclipse when JSF facet is enabled.
650
PrimeFaces User Guide
http://www.primefaces.org/documentation
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.
https://github.com/primefaces/primefaces
Issue Tracker
PrimeFaces issue tracker uses google codes issue management system. Please use the forum
beforecreating an issue instead.
https://github.com/primefaces/primefaces/issues
WIKI
PrimeFaces Wiki is a community driven additional documentation resource.
https://github.com/primefaces/primefaces/wiki
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.
651
PrimeFaces User Guide
15. FAQ
1. Who develops PrimeFaces?
PrimeFaces is developed and maintained by PrimeTek, a software development company
specialized in UI solutions.
5. Some components like charts do not work in Safari or Chrome but theres 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.
652
PrimeFaces User Guide
THE END
653