Primefaces User Guide 6 1
primefaces_user_guide_6_1
primefaces_user_guide_6_1
User Manual: Pdf
Open the PDF directly: View PDF 
.
Page Count: 653
| Download | |
| Open PDF In Browser | View PDF |
USER GUIDE
6.1
Author
Çağatay Ç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
About the Author
Çağatay Çivici is a member of JavaServer Faces Expert Group, the founder of PrimeFaces,
PrimeNG, PrimeReact, PrimeUI and a PMC member of open source JSF implementation Apache
MyFaces. He is a recognized speaker in international conferences and in many local events.
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
Download with Maven
Group id is org.primefaces and artifact id is primefaces.
org.primefaces
primefaces
6.1
11
PrimeFaces User Guide
2.2 Dependencies
PrimeFaces only requires a JAVA 5+ runtime and a JSF 2.x implementation as mandatory
dependencies. There’re some optional libraries for certain features. Licenses of all dependencies and
any 3rd part work incorporated are compatible with the PrimeFaces Licenses.
Dependency
Version *
Type
Description
JSF runtime
2.0, 2.1, 2.2, 2.3
Required
Apache MyFaces or Oracle Mojarra
itext
2.1.7
Optional
DataExporter (PDF)
apache poi
3.13
Optional
DataExporter (Excel)
rome
1.0
Optional
FeedReader
commons-fileupload
1.3
Optional
FileUpload
commons-io
2.2
Optional
FileUpload
atmosphere
2.4.6
Optional
PrimeFaces Push
barcode4j-light
2.1
Optional
Barcode
qrgen
1.4
Optional
QR Code support for Barcode
* Listed versions are tested and known to be working with PrimeFaces, other versions of these
dependencies may also work but not tested.
JSF Runtime
PrimeFaces supports JSF 2.0, 2.1, 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.
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;
primefaces.THEME
omega
Name
Default
Description
THEME
omega
Theme of the application.
mobile.THEME
null
Theme of the mobile application.
PUSH_SERVER_URL
null
Custom server url for PrimeFaces Push.
SUBMIT
full
Defines ajax submit mode, full or partial.
DIR
ltr
Defines orientation, ltr or rtl.
RESET_VALUES
false
When enabled, ajax updated inputs are reset.
SECRET
primefaces
Secret key to encrypt-decrypt value expressions exposed
in rendering StreamedContents.
CLIENT_SIDE_VALIDATION
false
Controls client side validatation.
UPLOADER
auto
Defines uploader mode; auto, native or commons.
TRANSFORM_METADATA
false
Transforms bean validation metadata to html attributes.
LEGACY_WIDGET_
NAMESPACE
false
Enables window scope so that widgets can be accessed
using widgetVar.method() in addition to default PF
namespace approach like PF('widgetVar').method().
FONT_AWESOME
false
Enabled font-awesome icons.
INTERPOLATE_CLIENT_SID
E_VALIDATION_MESSAGES
false
Whether to load the CSV messages from server.
2.4 Hello World
Once you have added the primefaces jar to your classpath, you need to add the PrimeFaces
namespace to your page to begin using the components. Here is a simple page like test.xhtml;
13
PrimeFaces User Guide
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
Component Class
org.primefaces.component.accordionpanel.Accordionpanel
Component Type
org.primefaces.component.AccordionPanel
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.AccordionPanelRenderer
Renderer Class
org.primefaces.component.accordionpanel.AccordionPanelRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
rendered
true
boolean
Boolean value to specify the rendering of the component.
binding
null
Object
An EL expression that maps to a server side
UIComponent instance in a backing bean.
activeIndex
false
String
Index of the active tab or a comma separated string of
indexes when multiple mode is on.
15
PrimeFaces User Guide
Name
Default
Type
Description
style
null
String
Inline style of the container element.
styleClass
null
String
Style class of the container element.
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.
dynamic
false
Boolean
Defines the toggle mode.
cache
true
Boolean
Defines if activating a dynamic tab should load the
contents from server again.
value
null
List
List to iterate to display dynamic number of tabs.
var
null
String
Name of iterator to use in a dynamic number of tabs.
multiple
false
Boolean
Controls multiple selection.
dir
ltr
String
Defines text direction, valid values are ltr and rtl.
prependId
true
Boolean
AccordionPanel is a naming container thus prepends its
id to its children by default, a false value turns this
behavior off except for dynamic tabs.
widgetVar
null
String
Name of the client side widget.
tabindex
0
String
Position of the headers in the tabbing order.
tabController
null
MethodEx
pr
Server side listener to decide whether a tab change or tab
close should be allowed.
Getting Started with Accordion Panel
Accordion panel consists of one or more tabs and each tab can group any content. Titles can also be
defined with “title” facet.
//any number of tabs
16
PrimeFaces User Guide
Dynamic Content Loading
AccordionPanel supports lazy loading of tab content, when dynamic option is set true, only active
tab contents will be rendered to the client side and clicking an inactive tab header will do an ajax
request to load the tab contents.
This feature is useful to reduce bandwidth and speed up page loading time. By default activating a
previously loaded dynamic tab does not initiate a request to load the contents again as tab is cached.
To control this behavior use cache option.
//..tabs
Client Side Callbacks
onTabChange is called before a tab is shown and onTabShow is called after. Both receive container
element of the tab to show as the parameter.
//..tabs
Ajax Behavior Events
tabChange and tabClose are the ajax behavior events of accordion panel. An example with
tabChange would be;
public void onChange(TabChangeEvent event) {
//Tab activeTab = event.getTab();
//...
}
Your listener(if defined) will be invoked with an org.primefaces.event.TabChangeEvent instance
that contains a reference to the new active tab and the accordion panel itself. Similarly
org.primefaces.event.TabCloseEvent is passed to the listener of tabClose event when an active tab is
closed.
Dynamic Number of Tabs
When the tabs to display are not static, use the built-in iteration feature similar to ui:repeat.
17
PrimeFaces User Guide
Disabled Tabs
A tab can be disabled by setting disabled attribute to true.
//any number of tabs
Multiple Selection
By default, only one tab at a time can be active, enable multiple mode to activate multiple tabs.
//tabs
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.
Client Side API
Widget: PrimeFaces.widget.AccordionPanel
Method
Params
Return Type
Description
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
.ui-accordion
Main container element
.ui-accordion-header
Tab header
.ui-accordion-content
Tab content
19
PrimeFaces User Guide
3.2 AjaxBehavior
AjaxBehavior is an extension to standard f:ajax.
Info
Tag
ajax
Behavior Id
org.primefaces.component.AjaxBehavior
Behavior Class
org.primefaces.component.behavior.ajax.AjaxBehavior
Attributes
Name
Default
Type
Description
listener
null
Method
Expr
Method to process in partial request.
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.
process
null
String
Component(s) to process in partial request.
update
null
String
Component(s) to update with ajax.
onstart
null
String
Callback to execute before ajax request is begins.
oncomplete
null
String
Callback to execute when ajax request is completed.
onsuccess
null
String
Callback to execute when ajax request succeeds.
onerror
null
String
Callback 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.
partialSubmit
false
Boolean
Enables serialization of values belonging to the partially
processed components only.
partialSubmitFilter
null
String
Selector to use when partial submit is on, default is ":input"
to select all descendant inputs of a partially processed
components.
disabled
false
Boolean
Disables ajax behavior.
20
PrimeFaces User Guide
Name
Default
Type
Description
event
null
String
Client side event to trigger ajax request.
resetValues
false
Boolean
If true, local values of input components to be updated
within the ajax request would be reset.
ignoreAutoUpdate
false
Boolean
If true, components which autoUpdate="true" will not be
updated for this request. If not specified, or the value is
false, no such indication is made.
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.
Getting Started with AjaxBehavior
AjaxBehavior is attached to the component to ajaxify.
Events
Here is the full list of available event names;
default: Initially visible when page is loaded.
start: Before ajax request begins.
success: When ajax response is received without error.
error: When ajax response is received with an http error.
complete: When everything finishes.
Custom Events
Facets are the declarative way to use, if you’d like to implement advanced cases with scripting you
can take advantage of on* callbacks which are the event handler counterparts of the facets.
Please Wait
Client Side API
Widget: PrimeFaces.widget.AjaxStatus
Method
trigger(event)
Params
Return Type
event: Name of event.
void
Description
Triggers given event.
Skinning
AjaxStatus is equipped with style and styleClass. Styling directly applies to a container element
which contains the facets.
complete(String query) {
List results = new ArrayList();
for (int i = 0; i < 10; i++)
results.add(query + i);
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.
complete(String query) {
List players = readPlayersFromDatasource(query);
return players;
}
}
public class Player {
private String name;
//getter setter
}
Limiting the Results
Number of results shown can be limited, by default there is no limit. When the suggestions exceed
the number of results, a text defined by moreText is displayed to indicate this case. There is no
default action when the moreText is clicked, you need to use moreText ajax behavior event to handle
more results.
#{p.name} - #{p.number}
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.
#{p.name} - #{p.number}
33
PrimeFaces User Guide
public class AutoCompleteBean {
private List selectedPlayers;
//...
}
Caching
Suggestions can be cached on client side so that the same query does not do a request which is
likely to return same suggestions again. To enable this, set cache option to true. There is also a
cacheTimeout option to configure how long it takes to clear a cache automatically.
Client Side API
Widget: PrimeFaces.widget.AutoComplete
35
PrimeFaces User Guide
Method
Params
Return Type
value: keyword for search
void
Initiates a search with given value
close()
-
void
Hides suggested items menu
disable()
-
void
Disables the input field
enable()
-
void
Enables the input field
deactivate()
-
void
Deactivates search behavior
activate()
-
void
Activates search behavior
search(value)
Description
Skinning
Following is the list of structural style classes;
Class
Applies
.ui-autocomplete
Container element.
.ui-autocomplete-input
Input field.
.ui-autocomplete-panel
Container of suggestions list.
.ui-autocomplete-items
List of items
.ui-autocomplete-item
Each item in the list.
.ui-autocomplete-query
Highlighted part in suggestions.
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
Component Class
org.primefaces.component.barcode.Barcode
Component Type
org.primefaces.component.Barcode
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.BarcodeRenderer
Renderer Class
org.primefaces.component.barcode.BarcodeRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
value
null
Object
Binary data to stream or context relative path.
type
null
String
Type of the barcode.
cache
true
Boolean
Controls browser caching mode of the resources.
format
svg
String
Format of the generated barcode, valid values are
"svg" (default) and "png".
orientation
0
Integer
Orientation in terms of angle. (0, 90, 180, 270)
alt
null
String
Alternate text for the image
url
null
String
Alias to value attribute
37
PrimeFaces User Guide
Name
Default
Type
Description
width
null
String
Width of the image
height
null
String
Height of the image
title
null
String
Title of the image
dir
null
String
Direction of the text displayed
lang
null
String
Language code
ismap
false
Boolean
Specifies to use a server-side image map
usemap
null
String
Name of the client side map
style
null
String
Style of the image
styleClass
null
String
Style class of the image
onclick
null
String
onclick dom event handler
ondblclick
null
String
ondblclick dom event handler
onkeydown
null
String
onkeydown dom event handler
onkeypress
null
String
onkeypress dom event handler
onkeyup
null
String
onkeyup dom event handler
onmousedown
null
String
onmousedown dom event handler
onmousemove
null
String
onmousemove dom event handler
onmouseout
null
String
onmouseout dom event handler
onmouseover
null
String
onmouseover dom event handler
onmouseup
null
String
onmouseup dom event handler
Getting started with Barcode
Barcode type should be provided along with the value to display. Supported formats are;
•
•
•
•
•
•
•
•
•
•
•
int2of5
codabar
code39
code128
ean8
ean13
upca
postnet
pdf417
datamatrix
qr
net.glxn
qrgen
1.4
net.sf.barcode4j
barcode4j-light
2.1
* 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
Component Class
org.primefaces.component.blockui.BlockUI
Component Type
org.primefaces.component.BlockUI
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.BlockUIRenderer
Renderer Class
org.primefaces.component.blockui.BlockUIRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
rendered
true
Boolean
Boolean value to specify the rendering of the
component.
binding
null
Object
An el expression that maps to a server side
UIComponent instance in a backing bean
widgetVar
null
String
Name of the client side widget.
trigger
null
String
Identifier of the component(s) to bind.
40
PrimeFaces User Guide
Name
Default
Type
Description
block
null
String
Search expression for block targets.
blocked
false
Boolean
Blocks the UI by default when enabled.
animate
true
Boolean
When disabled, displays block without animation
effect.
styleClass
null
String
Style class of the component.
Getting Started with BlockUI
BlockUI requires trigger and block attributes to be defined. With the special ajax integration, ajax
requests whose source are the trigger components will block the ui onstart and unblock oncomplete.
Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response
is received.
//content
//more columns
LOADING
41
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.BlockUI
Method
Params
Return Type
Description
show()
-
void
Blocks the UI.
hide()
-
void
Unblocks the UI
Skinning
Following is the list of structural style classes;
Class
Applies
.ui-blockui
Container element.
.ui-blockui-content
Container for custom content.
As skinning style classes are global, see the main theming section for more information.
Tips
• BlockUI does not support absolute or fixed positioned components. e.g. dialog.
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
Component Class
org.primefaces.component.breadcrumb.BreadCrumb
Component Type
org.primefaces.component.BreadCrumb
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.BreadCrumbRenderer
Renderer Class
org.primefaces.component.breadcrumb.BreadCrumbRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
rendered
true
Boolean
Boolean value to specify the rendering of the
component.
binding
null
Object
An el expression that maps to a server side
UIComponent instance in a backing bean
widgetVar
null
String
Name of the client side widget.
model
null
MenuModel
MenuModel instance to create menus
programmatically
style
null
String
Style of main container element.
styleClass
null
String
Style class of main container
homeDisplay
icon
String
Defines display mode of root link, valid values are
"icon" default and "text".
43
PrimeFaces User Guide
Getting Started with BreadCrumb
Steps are defined as child menuitem components in 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;
Style Class
Applies
.ui-breadcrumb
Main breadcrumb container element.
.ui-breadcrumb .ui-menu-item-link
Each menuitem.
.ui-breadcrumb .ui-menu-item-text
Each menuitem label.
.ui-breadcrumb-chevron
Seperator of menuitems.
As skinning style classes are global, see the main theming section for more information.
Tips
• If there is a dynamic flow, use model option instead of creating declarative p:menuitem
components and bind your MenuModel representing the state of the flow.
• Breadcrumb can do ajax/non-ajax action requests as well since p:menuitem has this option. In this
case, breadcrumb must be nested in a form.
• url option is the key for a menuitem, if it is defined, it will work as a simple link. If you’d like to
use menuitem to execute command with or without ajax, do not define the url option.
44
PrimeFaces User Guide
3.9 Button
Button is an extension to the standard h:button component with skinning capabilities.
Info
Tag
button
Component Class
org.primefaces.component.button.Button
Component Type
org.primefaces.component.Button
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ButtonRenderer
Renderer Class
org.primefaces.component.button.ButtonRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
rendered
true
Boolean
Boolean value to specify the rendering of the component.
binding
null
Object
An el expression that maps to a server side UIComponent
instance in a backing bean.
widgetVar
null
String
Name of the client side widget.
value
null
Object
Value of the component than can be either an EL expression
of a literal text.
outcome
null
String
Used to resolve a navigation case.
includeViewParams
false
Boolean
Whether to include page parameters in target URI
fragment
null
String
Identifier of the target page which should be scrolled to.
disabled
false
Boolean
Disables button.
accesskey
null
String
Access key that when pressed transfers focus to button.
alt
null
String
Alternate textual description.
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
Name
Default
Type
Description
for this component.
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.
style
null
String
Inline style of the button.
styleClass
null
String
Style class of the button.
tabindex
null
Integer
Position in the tabbing order.
title
null
String
Advisory tooltip informaton.
href
null
String
Resource to link directly to implement anchor behavior.
icon
null
String
Icon of the button.
iconPos
left
String
Position of the button icon.
target
_self
String
The window target.
escape
true
Boolean
Defines whether label would be escaped or not.
inline
false
String
Displays as inline instead of 100% width, mobile only.
disableClientWindow
false
Boolean
Disable appending the ClientWindow
46
PrimeFaces User Guide
Name
Default
Type
Description
on the rendering of this element.
Getting Started with Button
p:button usage is same as standard h:button, an outcome is necessary to navigate using GET
requests. Assume you are at source.xhtml and need to navigate target.xhtml.
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.
primefaces.CACHE_PROVIDER
org.primefaces.cache.EHCacheProvider
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.
//content to cache
Once the page is loaded initially, content inside p:cache component is cached inside the cache
region of the cache provider. Postbacks on the same page or reopening the page retrieve the output
from cache instead of rendering the content regularly.
Cache Provider API
CacheProvider can be accessed via;
RequestContext.getCurrentInstance().getApplicationContext().getCacheProvider()
For example using this API, all cache regions can be cleaned using clear() method. Refer to javadoc
of CacheProvider for the full list of available methods.
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
Component Class
org.primefaces.component.calendar.Calendar
Component Type
org.primefaces.component.Calendar
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.CalendarRenderer
Renderer Class
org.primefaces.component.calendar.CalendarRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
rendered
true
Boolean
Boolean value to specify the rendering of the
component.
binding
null
Object
An el expression that maps to a server side
UIComponent instance in a backing bean
value
null
java.util
.Date
Value of the component
converter
null
Convert
er/Strin
g
An el expression or a literal text that defines a
converter for the component. When it’s an EL
expression, it’s resolved to a converter instance. In
case it’s a static text, it must refer to a converter id
immediate
false
Boolean
When set true, process validations logic is executed
at apply request values phase for this component.
required
false
Boolean
Marks component as required
50
PrimeFaces User Guide
Name
Default
Type
Description
validator
null
Method
Expr
A method expression that refers to a method
validationg the input
valueChangeListener
null
Method
Expr
A method expression that refers to a method for
handling a valuchangeevent
requiredMessage
null
String
Message to be displayed when required field
validation fails.
converterMessage
null
String
Message to be displayed when conversion fails.
validatorMessage
null
String
Message to be displayed when validation fails.
widgetVar
null
String
Name of the client side widget.
mindate
null
Date or
String
Sets calendar's minimum visible date
maxdate
null
Date or
String
Sets calendar's maximum visible date
pages
1
Integer
Enables multiple page rendering.
disabled
false
Boolean
Disables the calendar when set to true.
mode
popup
String
Defines how the calendar will be displayed.
pattern
MM/dd/yyyy
String
DateFormat pattern for localization
locale
null
Object
Locale to be used for labels and conversion.
navigator
false
Boolean
Enables month/year navigator
timeZone
null
Time
Zone
String or a java.util.TimeZone instance to specify
the timezone used for date conversion, defaults to
TimeZone.getDefault()
readonlyInput
false
Boolean
Makes input text of a popup calendar readonly.
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.
effectDuration
normal
String
Duration of the effect.
showOn
both
String
Client side event that displays the popup calendar.
showWeek
false
Boolean
Displays the week number next to each week.
disabledWeekends
false
Boolean
Disables weekend columns.
showOtherMonths
false
Boolean
Displays days belonging to other months.
selectOtherMonths
false
Boolean
Enables selection of days belonging to other
months.
yearRange
null
String
Year range for the navigator, default "c-10:c+10"
51
PrimeFaces User Guide
Name
Default
Type
Description
timeOnly
false
Boolean
Shows only timepicker without date.
stepHour
1
Integer
Hour steps.
stepMinute
1
Integer
Minute steps.
stepSecond
1
Integer
Second steps.
minHour
0
Integer
Minimum boundary for hour selection.
maxHour
23
Integer
Maximum boundary for hour selection.
minMinute
0
Integer
Minimum boundary for minute selection.
maxMinute
59
Integer
Maximum boundary for hour selection.
minSecond
0
Integer
Minimum boundary for second selection.
maxSecond
59
Integer
Maximum boundary for second selection.
pagedate
null
Object
Initial date to display if value is null.
accesskey
null
String
Access key that when pressed transfers focus to the
input element.
alt
null
String
Alternate textual description of the input field.
autocomplete
null
String
Controls browser autocomplete behavior.
dir
null
String
Direction indication for text that does not inherit
directionality. Valid values are LTR and RTL.
label
null
String
A localized user presentable name.
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 onclick event.
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
52
PrimeFaces User Guide
Name
Default
Type
Description
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.
placeholder
null
String
Specifies a short hint.
readonly
false
Boolean
Flag indicating that this component will prevent
changes by the user.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
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.
title
null
String
Advisory tooltip informaton.
beforeShowDay
null
String
Client side callback to execute before displaying a
date, used to customize date display.
mask
null
String
Applies a mask using the pattern.
timeControlType
slider
String
Defines the type of element to use for time picker,
valid values are "slider" and "select".
beforeShow
null
String
Callback to execute before displaying calendar,
element and calendar instance are passed as
parameters
maskSlotChar
null
String
Placeholder in mask template.
maskAutoClear
true
Boolean
Clears the field on blur when incomplete input is
entered
53
PrimeFaces User Guide
Name
Default
Type
Description
timeControlObject
null
String
Client side object to use in custom
timeControlType.
timeInput
false
Boolean
Allows direct input in time field.
showHour
null
String
Whether to show the hour control.
shıwMinute
null
String
Whether to show the minute control.
showSecond
null
String
Whether to show the second control.
showMillisec
null
String
Whether to show the millisec control
showTodayButton
true
Boolean
Whether to show the "Current Date" button if
showButtonPanel is rendered.
buttonTabindex
null
String
Position of the button in the tabbing order.
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.
Getting Started with Calendar
Value of the calendar should be a java.util.Date.
primefaces.PRIVATE_CAPTCHA_KEY
YOUR_PRIVATE_KEY
primefaces.PUBLIC_CAPTCHA_KEY
YOUR_PUBLIC_KEY
That is it, now you can use captcha as follows;
cars;
public CarListController() {
cars = new ArrayList();
cars.add(new Car("myModel", 2005, "ManufacturerX", "blue"));
//add more cars
}
//getter setter
}
Carousel iterates through the cars collection and renders it’s children for each car.
Limiting Visible Items
Bu default carousel lists its items in pages with size 3. This is customizable with the rows attribute.
...
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.
public class CarBean {
private List cars;
private Car selected;
//getters and setters
}
68
PrimeFaces User Guide
Header and Footer
Header and Footer of carousel can be defined in two ways either, using headerText and footerText
options that take simple strings as labels or by header and footer facets that can take any custom
content.
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.
Client Side API
Widget: PrimeFaces.widget.Carousel
Method
Params
Return Type
next()
-
void
Displays next page.
prev()
-
void
Displays previous page.
index
void
Displays page with given index.
startAutoplay()
-
void
Starts slideshow.
stopAutoplay()
-
void
Stops slideshow.
setPage()
Description
Skinning
Carousel resides in a container element which style and styleClass options apply. itemStyle and
itemStyleClass attributes apply to each item displayed by carousel. Following is the list of structural
style classes;
Style Class
Applies
.ui-carousel
Main container
.ui-carousel-header
Header container
.ui-carousel-header-title
Header content
.ui-carousel-viewport
Content container
.ui-carousel-button
Navigation buttons
.ui-carousel-next-button
Next navigation button of paginator
.ui-carousel-prev-button
Prev navigation button of paginator
.ui-carousel-page-links
Page links of paginator.
.ui-carousel-page-link
Each page link of paginator.
.ui-carousel-item
Each item.
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
Component Class
org.primefaces.component.celleditor.CellEditor
Component Type
org.primefaces.component.CellEditor
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.CellEditorRenderer
Renderer Class
org.primefaces.component.celleditor.CellEditorRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
Getting Started with CellEditor
See inline editing section in datatable documentation for more information about usage.
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
Component Class
org.primefaces.component.chart.Chart
Component Type
org.primefaces.component.Chart
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ChartRenderer
Renderer Class
org.primefaces.component.chart.ChartRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
type
null
String
Type of the chart.
model
null
ChartModel
Model object of data and settings.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
widgetVar
null
String
Name of the client side widget.
responsive
false
Boolean
In responsive mode, chart is redrawn when
window is resized.
71
PrimeFaces User Guide
3.15.1 PieChart
PieChart is created with PieChartModel.
Basic
circle1 = new LinkedHashMap();
circle1.put("Brand 1", 150);
circle1.put("Brand 2", 400);
circle1.put("Brand 3", 200);
circle1.put("Brand 4", 10);
model.addCircle(circle1);
Map circle2 = new LinkedHashMap();
circle2.put("Brand 1", 540);
circle2.put("Brand 2", 125);
circle2.put("Brand 3", 702);
circle2.put("Brand 4", 421);
model.addCircle(circle2);
Map circle3 = new LinkedHashMap();
circle3.put("Brand 1", 40);
circle3.put("Brand 2", 325);
circle3.put("Brand 3", 402);
circle3.put("Brand 4", 421);
model.addCircle(circle3);
model.setTitle("Donut Chart");
model.setLegendPosition("w");
}
public DonutChartModel getModel() { return model; }
}
79
PrimeFaces User Guide
Customized
circle1 = new LinkedHashMap();
circle1.put("Brand 1", 150);
circle1.put("Brand 2", 400);
circle1.put("Brand 3", 200);
circle1.put("Brand 4", 10);
model.addCircle(circle1);
Map circle2 = new LinkedHashMap();
circle2.put("Brand 1", 540);
circle2.put("Brand 2", 125);
circle2.put("Brand 3", 702);
circle2.put("Brand 4", 421);
model.addCircle(circle2);
Map circle3 = new LinkedHashMap();
circle3.put("Brand 1", 40);
circle3.put("Brand 2", 325);
circle3.put("Brand 3", 402);
circle3.put("Brand 4", 421);
model.addCircle(circle3);
model.setTitle("Donut Chart");
model.setLegendPosition("w");
model.setTitle("Custom Options");
model.setLegendPosition("e");
model.setSliceMargin(5);
model.setShowDataLabels(true);
model.setDataFormat("value");
model.setShadow(false);
}
public DonutChartModel getModel() { return model; }
}
80
PrimeFaces User Guide
3.15.5 BubbleChart
BubbleChart is created with a BubbleChartModel.
Basic
intervals = new ArrayList(){{
add(20);
add(50);
add(120);
add(220);
}};
model = new MeterGaugeChartModel(140, intervals);
model.setTitle("MeterGauge Chart");
model.setGaugeLabel("km/h");
}
public MeterGaugeChartModel getModel() { return model; }
}
Customized
intervals = new ArrayList(){{
add(20);
add(50);
add(120);
add(220);
}};
model = new MeterGaugeChartModel(140, intervals);
model.setTitle("Custom Options");
model.setSeriesColors("66cc66,93b75f,E7E658,cc6666");
model.setGaugeLabel("km/h");
model.setGaugeLabelPosition("bottom");
model.setShowTickLabels(false);
model.setLabelHeightAdjust(110);
model.setIntervalOuterRadius(130);
}
public MeterGaugeChartModel getModel() { return model; }
}
85
PrimeFaces User Guide
3.15.8 Combined Chart
On same graph, different series type can be displayed together.
Basic
public class Bean {
private PieChartModel model;
public ChartBean() {
model = new PieChartModel();
model.set("Brand
model.set("Brand
model.set("Brand
model.set("Brand
1",
2",
3",
4",
540);
325);
702);
421);
model.setTitle("Simple Pie");
model.setLegendPosition("w");
}
public PieChartModel getModel() { return model; }
public void itemSelect(ItemSelectEvent event) {
FacesMessage msg = new FacesMessage(FacesMessage.SEVERITY_INFO,
"Item selected", "Item Index: " + event.getItemIndex() +
", Series Index:" + event.getSeriesIndex());
FacesContext.getCurrentInstance().addMessage(null, msg);
}
}
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());
//show the dialog
PF('dlg').show();
}
91
PrimeFaces User Guide
3.15.13 Static Images
JFreeChart with GraphicImage component is an alternative to the chart component.
Basic
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
List of series.
axes
HashMap Map 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
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> 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
String
null
String
Format string for data labels. If none, ‘%s’ is
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
Property
Default
Type
Description
x, plus, dash, filledDiamond, filledCircle, filledSquare.
showLine
true
Boolean
Whether to actually draw the line or not.
showMarker
true
Boolean
Displays markes at data points.
fill
false
Boolean
Fills the area between lines.
fillAlpha
1
Double
Opacity of the filled area.
smoothLine
false
Boolean
Enables smooth renderer.
disableStack
false
Boolean
When true, series data is not included in a stacked chart.
LinearAxis
org.primefaces.model.chart.LinearAxis extends org.primefaces.model.chart.Axis
LinearAxis is the Axis implementation used to display numbers.
LineChartModel
org.primefaces.model.chart.LineChartModel extends
org.primefaces.model.chart.CartesianChartModel
Property
Default
Type
Description
stacked
null
List
Displays series in stacked format.
breakOnNull
HashMap Map 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 List of ranges to be drawn around the gauge.
ticks
0
List 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
Integer
Number of Pixels to offset the label up (-) or down (+)
from its default position.
-25
OhlcChartModel
org.primefaces.model.chart.OhlcChartModel extends org.primefaces.model.chart.ChartModel
Property
Default
Type
Description
data
null
List Data as a list of OhlChartSeries.
98
PrimeFaces User Guide
Property
Default
Type
Description
candleStick
false
Boolean
Displays series as candlestick.
OhlcChartSeries
org.primefaces.model.chart.OhlcChartSeries extends org.primefaces.model.chart.ChartSeries
Property
Default
Type
Description
value
null
List 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
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
String
null
String
Format string for data labels. If none, ‘%s’ is 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.
99
PrimeFaces User Guide
3.16 Checkbox
Checkbox is a helper component of SelectManyCheckbox to implement custom layouts.
Info
Tag
checkbox
Component Class
org.primefaces.component.checkbox.Checkbox
Component Type
org.primefaces.component.Checkbox
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.CheckboxRenderer
Renderer Class
org.primefaces.component.checkbox.CheckboxRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
disabled
false
Boolean
Disabled the component.
itemIndex
null
Integer
Index of the selectItem.
onchange
null
String
Client side callback to execute on state change.
for
null
String
Id of the selectManyCheckbox to attach to.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the container.
tabindex
null
String
Specifies the tab order of element in tab navigation.
Getting started with Checkbox
See custom layout part in SelectManyCheckbox section for more information.
100
PrimeFaces User Guide
3.17 Chips
Chips is used to enter multiple values on an inputfield.
Info
Tag
chips
Component Class
org.primefaces.component.chips.Chips
Component Type
org.primefaces.component.Chips
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ChipsRenderer
Renderer Class
org.primefaces.component.chips.ChipsRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
value
null
Object
Value of the component.
converter
null
Converter/Str An el expression or a literal text that defines a
ing
converter for the component. When it’s an EL
expression, it’s resolved to a converter instance. In
case it’s a static text, it must refer to a converter id
immediate
false
Boolean
When set true, process validations logic is
executed at apply request values phase for this
component.
required
false
Boolean
Marks component as required.
validator
null
MethodExpr
A method expression that refers to a method for
validation the input.
valueChangeListener
null
ValueChange
Listener
A method binding expression that refers to a
method for handling a valuchangeevent.
requiredMessage
null
String
Message to be displayed when required field
validation fails.
converterMessage
null
String
Message to be displayed when conversion fails.
validatorMessage
null
String
Message to be displayed when validation fields.
101
PrimeFaces User Guide
Name
Default
Type
Description
widgetVar
null
String
Name of the client side widget.
max
null
Integer
Maximum number of entries allowed.
Getting started with Chips
Value of the component should be a List where type of the elements it contains can be a string or a
custom one if a converter is defined.
public class ChipsView {
private List cities;
public List getCities() {
return this.cities;
}
public void setCities(List cities) {
this.cities = cities;
}
}
books;
public CreateBookBean() {
books = new ArrayList();
}
//getters and setters
}
addTo="#{bookBean.books}" />
105
PrimeFaces User Guide
3.20 Color Picker
ColorPicker is an input component with a color palette.
Info
Tag
colorPicker
Component Class
org.primefaces.component.colorpicker.ColorPicker
Component Type
org.primefaces.component.ColorPicker
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ColorPickerRenderer
Renderer Class
org.primefaces.component.colorpicker.ColorPickerRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
value
null
Object
Value of the component.
converter
null
Converter/Str An el expression or a literal text that defines a
ing
converter for the component. When it’s an EL
expression, it’s resolved to a converter instance. In
case it’s a static text, it must refer to a converter id
immediate
false
Boolean
When set true, process validations logic is
executed at apply request values phase for this
component.
required
false
Boolean
Marks component as required.
validator
null
MethodExpr
A method expression that refers to a method for
validation the input.
106
PrimeFaces User Guide
Name
Default
Type
Description
valueChangeListener
null
ValueChange
Listener
A method binding expression that refers to a
method for handling a valuchangeevent.
requiredMessage
null
String
Message to be displayed when required field
validation fails.
converterMessage
null
String
Message to be displayed when conversion fails.
validatorMessage
null
String
Message to be displayed when validation fields.
widgetVar
null
String
Name of the client side widget.
mode
popup
String
Display mode, valid values are “popup” and
“inline”.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
Getting started with ColorPicker
ColorPicker’s value should be a hex string.
public class Bean {
private String color;
public String getColor() {
return this.color;
}
public void setColor(String color) {
this.color = color;
}
}
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”.
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
Name
Default
Type
Description
header
null
String
Header of confirm dialog.
message
null
String
Message to display in confirm dialog.
icon
null
String
Icon to display next to message.
disabled
null
Boolean
Disables confirm behavior when true.
Getting started with Confirm
See global confirm dialog topic in next section for details.
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
Component Class
org.primefaces.component.confirmdialog.ConfirmDialog
Component Type
org.primefaces.component.ConfirmDialog
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ConfirmDialogRenderer
Renderer Class
org.primefaces.component.confirmdialog.ConfirmDialogRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget.
message
null
String
Text to be displayed in body.
header
null
String
Text for the header.
severity
null
String
Message severity for the displayed icon.
width
auto
Integer
Width of the dialog in pixels
height
auto
Integer
Width of the dialog in pixels
style
null
String
Inline style of the dialog container.
styleClass
null
String
Style class of the dialog container
125
PrimeFaces User Guide
Name
Default
Type
Description
closable
true
Boolean
Defines if close icon should be displayed or not
appendTo
null
String
Appends the dialog to the element defined by the given
search expression.
visible
false
Boolean
Whether to display confirm dialog on load.
showEffect
null
String
Effect to use on showing dialog.
hideEffect
null
String
Effect to use on hiding dialog.
closeOnEscape
false
Boolean
Defines if dialog should hide on escape key.
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.
Getting started with ConfirmDialog
ConfirmDialog has two modes; global and non-global. Non-Global mode is almost same as the
dialog component used with a simple client side api, show() and hide().
Message and Severity
Message can be defined in two ways, either via message option or message facet. Message facet is
useful if you need to place custom content instead of simple text. Note that header can also be
defined using the header attribute or the header facet. Severity defines the icon to display next to
the message, default severity is alert and the other option is info.
//content
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-confirmdialog-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.
Client Side API
Widget: PrimeFaces.widget.ConfirmDialog
Method
Params
Return Type
Description
show()
-
void
Displays dialog.
hide()
-
void
Closes dialog.
Skinning
ConfirmDialog resides in a main container element which style and styleClass options apply. As
skinning style classes are global, see the main theming section for more information. Following is
the list of structural style classes;
Style Class
Applies
.ui-dialog
Container element of dialog
.ui-dialog-titlebar
Title bar
.ui-dialog-title
Header text
.ui-dialog-titlebar-close
Close icon
.ui-dialog-content
Dialog body
.ui-dialog-buttonpane
Footer button panel
127
PrimeFaces User Guide
3.29 ContentFlow
ContentFlow is a horizontal content gallery component with a slide animation.
Info
Tag
contentFlow
Component Class
org.primefaces.component.contentflow.ContentFlow
Component Type
org.primefaces.component.ContentFlow
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ContentFlowRenderer
Renderer Class
org.primefaces.component.contentflow.ContentFlowRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
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.
widgetVar
null
String
Name of the client side widget.
value
null
String
Collection of items to display.
var
null
String
Name of the iterator to display an item.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
128
PrimeFaces User Guide
Getting Started with ContentFlow
ContentFlow requires content as children that can either be defined dynamically using iteration or
one by one. Each item must have the content style class applied as well.
Static Images
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;
Style Class
Applies
.ui-contentflow
Container element.
.flow
Container of item list
.item
Item container
.caption
Caption element
129
PrimeFaces User Guide
3.30 ContextMenu
ContextMenu provides an overlay menu displayed on mouse right-click event.
Info
Tag
contextMenu
Component Class
org.primefaces.component.contextmenu.ContextMenu
Component Type
org.primefaces.component.ContextMenu
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.ContextMenuRenderer
Renderer Class
org.primefaces.component.contextmenu.ContextMenuRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget.
for
null
String
Id of the component to attach to
style
null
String
Style of the main container element
styleClass
null
String
Style class of the main container element
model
null
MenuModel
Menu model instance to create menu programmatically.
nodeType
null
String
Specific type of tree nodes to attach to.
event
null
String
Event to bind contextMenu display, default is
contextmenu aka right click.
beforeShow
null
String
Client side callback to execute before showing.
selectionMode
multiple
String
Defines the selection behavior, e.g "single" or "multiple".
130
PrimeFaces User Guide
Name
targetFilter
Default
null
Type
String
Description
Selector to filter the elements to attach the menu.
Getting started with ContextMenu
ContextMenu is created with submenus and menuitems. Optional for attribute defines which
component the contextMenu is attached to. When for is not defined, contextMenu is attached to the
page meaning, right-click on anywhere on page will display the menu.
Now right-clicking anywhere on an image will display the contextMenu like;
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;
Style Class
Applies
.ui-contextmenu
Container element of menu
.ui-menu-list
List container
.ui-menuitem
Each menu item
.ui-menuitem-link
Anchor element in a link item
.ui-menuitem-text
Text element in an item
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
Component Class
org.primefaces.component.dashboard.Dashboard
Component Type
org.primefaces.component.Dashboard
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DashboardRenderer
Renderer Class
org.primefaces.component.dashboard.DashboardRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget
model
null
Dashboard
Model
Dashboard model instance representing the layout of
the UI.
disabled
false
Boolean
Disables reordering feature.
style
null
String
Inline style of the dashboard container
styleClass
null
String
Style class of the dashboard container
133
PrimeFaces User Guide
Getting started with Dashboard
Dashboard is backed by a DashboardModel and consists of panel components.
//Sports Content
//Finance Content
//more panels like lifestyle, weather, politics...
Dashboard model simply defines the number of columns and the widgets to be placed in each
column. See the end of this section for the detailed Dashboard API.
public class Bean {
private DashboardModel model;
public Bean() {
model = new DefaultDashboardModel();
DashboardColumn column1 = new DefaultDashboardColumn();
DashboardColumn column2 = new DefaultDashboardColumn();
DashboardColumn column3 = new DefaultDashboardColumn();
column1.addWidget("sports");
column1.addWidget("finance");
column2.addWidget("lifestyle");
column2.addWidget("weather");
column3.addWidget("politics");
model.addColumn(column1);
model.addColumn(column2);
model.addColumn(column3);
}
}
State
Dashboard is a stateful component, whenever a widget is reordered dashboard model will be
updated, by persisting the user changes so you can easily create a stateful dashboard.
Ajax Behavior Events
“reorder” is the one and only ajax behavior event provided by dashboard, this event is fired when
dashboard panels are reordered. A defined listener will be invoked by passing an
org.primefaces.event.DashboardReorderEvent instance containing information about reorder.
Following dashboard displays a message about the reorder event
134
PrimeFaces User Guide
//panels
Toggle, Close and Options Menu
Widgets presented in dashboard can be closable, toggleable and have options menu as well,
dashboard doesn’t implement these by itself as these features are already provided by the panel
component. See panel component section for more information.
//Sports Content
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
//panels
getColumns()
Returns all columns in dashboard
int getColumnCount()
Returns the number of columns in dashboard
DashboardColumn getColumn(int index)
Returns the dashboard column at given index
void transferWidget(DashboardColumn from,
DashboardColumn to, String widgetId, int index)
Relocates the widget identifed with widget id to the
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
void removeWidget(String widgetId)
Removes the widget with the given id
List getWidgets()
Returns the ids of widgets in column
int getWidgetCount()
Returns the count of widgets in column
String getWidget(int index)
Returns the widget id with the given index
void addWidget(String widgetId)
Adds a new widget with the given id
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
Tag Class
org.primefaces.component.export.DataExporterTag
ActionListener Class
org.primefaces.component.export.DataExporter
Attributes
Name
Default
Type
Description
type
null
String
Export type: "xls","pdf","csv", "xml"
target
null
String
Search expression to resolve one or multiple
datatables.
fileName
null
String
Filename of the generated export file, defaults to
datatable id.
pageOnly
0
String
Exports only current page instead of whole dataset
preProcessor
null
MethodExpr
PreProcessor for the exported document.
postProcessor
null
MethodExpr
PostProcessor for the exported document.
encoding
UTF-8
Boolean
Character encoding to use
selectionOnly
fale
Boolean
When enabled, only selection would be exported.
repeat
false
Boolean
Set to true if target is a datatable that is rendered
multiple times in a repeating component.
options
null
ExporterOptions
Options object to customize document.
Getting Started with DataExporter
DataExporter is nested in a UICommand component such as commandButton or commandLink. For
pdf exporting itext and for xls exporting poi libraries are required in the classpath. Target must
point to a PrimeFaces Datatable. Assume the table to be exported is defined as;
//columns
Excel export (type="xls | xlsx | xlsxstream")
138
PrimeFaces User Guide
PDF export (type="pdf")
CSV export (type="csv")
XML export (type="xml")
//...
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
Pre and Post Processors
Processors are handy to customize the exported document (e.g. add logo, caption ...). PreProcessors
are executed before the data is exported and PostProcessors are processed after data is included in
the document. Processors are simple java methods taking the document as a parameter.
Change Excel Table Header
First example of processors changes the background color of the exported excel’s headers.
public void postProcessXLS(Object document) {
HSSFWorkbook wb = (HSSFWorkbook) document;
HSSFSheet sheet = wb.getSheetAt(0);
HSSFRow header = sheet.getRow(0);
HSSFCellStyle cellStyle = wb.createCellStyle();
cellStyle.setFillForegroundColor(HSSFColor.GREEN.index);
cellStyle.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
for(int i=0; i < header.getPhysicalNumberOfCells();i++) {
header.getCell(i).setCellStyle(cellStyle);
}
}
Add Logo to PDF
This example adds a logo to the PDF before exporting begins.
public void preProcessPDF(Object document) throws IOException,
BadElementException, DocumentException {
Document pdf = (Document) document;
ServletContext servletContext = (ServletContext)
FacesContext.getCurrentInstance().getExternalContext().getContext();
String logo = servletContext.getRealPath("") + File.separator + "images" +
File.separator + "prime_logo.png";
pdf.add(Image.getInstance(logo));
}
Customization
Excel and PDF documents can be further customized using exporterOptions property that takes a
configuration object that implements ExporterOptions.
140
PrimeFaces User Guide
public class CustomizedDocumentsView implements Serializable {
private ExcelOptions excelOpt;
@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");
}
public ExcelOptions getExcelOpt() {
return excelOpt;
}
}
141
PrimeFaces User Guide
3.33 DataGrid
DataGrid displays a collection of data in a grid layout.
Info
Tag
dataGrid
Component Class
org.primefaces.component.datagrid.DataGrid
Component Type
org.primefaces.component.DataGrid
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DataGridRenderer
Renderer Class
org.primefaces.component.datagrid.DataGridRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
142
PrimeFaces User Guide
Name
Default
Type
Description
value
null
Object
Data to display.
var
null
String
Name of the request-scoped variable used to
refer each data.
rows
null
Integer
Number of rows to display per page.
first
0
Integer
Index of the first row to be displayed
widgetVar
null
String
Name of the client side widget.
columns
3
Integer
Number of columns in grid.
paginator
false
boolean
Enables pagination.
paginatorTemplate
null
String
Template of the paginator.
rowsPerPageTemplate
null
String
Template of the rowsPerPage dropdown.
currentPageReportTemplate
null
String
Template of the currentPageReport UI.
pageLinks
10
Integer
Maximum number of page links to display.
paginatorPosition
both
String
Position of the paginator.
paginatorAlwaysVisible
true
Boolean
Defines if paginator should be hidden if total
data count is less than number of rows per page.
style
null
String
Inline style of the datagrid.
styleClass
null
String
Style class of the datagrid.
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.
emptyMessage
No records
found.
String
Text to display when there is no data to display.
layout
tabular
String
Layout approach to use, valid values are
"tabular" and "grid" for responsive grid.
Getting started with the DataGrid
A list of cars will be used throughout the datagrid, datalist and datatable examples.
public class Car {
private
private
private
private
...
String model;
int year;
String manufacturer;
String color;
}
143
PrimeFaces User Guide
The code for CarBean that would be used to bind the datagrid to the car list.
public class CarBean {
private List cars;
public CarBean() {
cars = new ArrayList();
cars.add(new Car("myModel",2005,"ManufacturerX","blue"));
//add more cars
}
public List getCars() {
return cars;
}
}
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 it’s own template, options to display is provided via
rowsPerPageTemplate attribute (e.g. rowsPerPageTemplate="9,12,15").
Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option.
You can use {currentPage},{totalPages},{totalRecords},{startRecord},{endRecord} keyword
within currentPageReportTemplate. Default is {currentPage} of{totalPages}. Default UI is;
which corresponds to the following template.
"{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}"
Here are more examples based on different templates;
" {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink}
{LastPageLink} {RowsPerPageDropdown}"
" {PreviousPageLink} {CurrentPageReport} {NextPageLink}"
Paginator Position
Paginator can be positoned using paginatorPosition attribute in three different locations, "top",
"bottom" or "both" (default).
145
PrimeFaces User Guide
Custom Content in Paginator
Custom content can be placed inside a paginator using a facet name matching a token in the
template.
//Any content here
//...
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.
public class CarBean {
private List cars;
private Car selectedCar;
//getters and setters
}
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
Ajax Behavior Events
Event
Listener Parameter
page
Fired
org.primefaces.event.data.PageEvent
On pagination.
Client Side API
Widget: PrimeFaces.widget.DataGrid
Method
getPaginator()
Params
Return Type
-
Paginator
Description
Returns the paginator widget.
Skinning
DataGrid resides in a main div container which style and styleClass attributes apply. Following is
the list of structural style classes;
Class
Applies
.ui-datagrid
Main container element
.ui-datagrid-content
Content container.
.ui-datagrid-data
Table element containing data
.ui-datagrid-row
A row in grid
.ui-datagrid-column
A column in grid
As skinning style classes are global, see the main theming section for more information.
Tips
• DataGrid supports lazy loading data via LazyDataModel, see DataTable lazy loading section.
• DataGrid provides two facets named header and footer that you can use to provide custom content
at these locations.
148
PrimeFaces User Guide
3.34 DataList
DataList presents a collection of data in list layout with several display types.
Info
Tag
dataList
Component Class
org.primefaces.component.datalist.DataList
Component Type
org.primefaces.component.DataList
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DataListRenderer
Renderer Class
org.primefaces.component.datalist.DataListRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
value
null
Object
Data to display.
var
null
String
Name of the request-scoped variable used to
refer each data.
rows
null
Integer
Number of rows to display per page.
first
0
Integer
Index of the first row to be displayed
149
PrimeFaces User Guide
Name
Default
Type
Description
type
unordered
String
Type of the list, valid values are "unordered",
"ordered", "definition" and "none".
itemType
null
String
Specifies the list item type.
widgetVar
null
String
Name of the client side widget.
paginator
false
boolean
Enables pagination.
paginatorTemplate
null
String
Template of the paginator.
rowsPerPageTemplate
null
String
Template of the rowsPerPage dropdown.
currentPageReportTemplate
null
String
Template of the currentPageReport UI.
pageLinks
10
Integer
Maximum number of page links to display.
paginatorPosition
both
String
Position of the paginator.
paginatorAlwaysVisible
true
Boolean
Defines if paginator should be hidden if total
data count is less than number of rows per
page.
style
null
String
Inline style of the main container.
styleClass
Null
String
Style class of the main container.
rowIndexVar
null
String
Name of the iterator to refer each row index.
varStatus
null
String
Name of the exported request scoped variable
to represent state of the iteration same as in
ui:repeat varStatus.
lazy
false
Boolean
Defines if lazy loading is enabled for the data
component.
emptyMessage
No records
found.
String
Text to display when there is no data to
display.
itemStyleClass
null
String
Style class of an item in list.
Getting started with the DataList
Since DataList is a data iteration component, it renders it’s children for each data represented with
var option. See itemType section for more information about the possible values.
#{car.manufacturer}, #{car.year}
Ordered Lists
DataList displays the data in unordered format by default, if you’d like to use ordered display set
type option to "ordered".
150
PrimeFaces User Guide
#{car.manufacturer}, #{car.year}
Item Type
itemType defines the bullet type of each item. For ordered lists, in addition to commonly used
decimal type, following item types are available;
-A
-a
-i
And for unordered lists, available values are;
- disc
- circle
- square
Definition Lists
Third type of dataList is definition lists that display inline description for each item, to use
definition list set type option to "definition". Detail content is provided with the facet called
"description".
Model: #{car.model}, Year: #{car.year}
Ajax Pagination
DataList has a built-in paginator that is enabled by setting paginator option to true.
#{car.manufacturer}, #{car.year}
Pagination configuration and usage is same as dataGrid, see pagination section in dataGrid
documentation for more information and examples.
151
PrimeFaces User Guide
Ajax Behavior Events
Event
Listener Parameter
page
Fired
org.primefaces.event.data.PageEvent
On pagination.
Selecting Data
Data selection can be implemented same as in dataGrid, see selecting data section in dataGrid
documentation for more information and an example.
Client Side API
Widget: PrimeFaces.widget.DataList
Method
getPaginator()
Params
Return Type
-
Paginator
Description
Returns the paginator widget.
Skinning
DataList resides in a main div container which style and styleClass attributes apply. Following is the
list of structural style classes;
Class
Applies
.ui-datalist
Main container element
.ui-datalist-content
Content container
.ui-datalist-data
Data container
.ui-datalist-item
Each item in list
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
Component Class
org.primefaces.component.datascroller.DataScroller
Component Type
org.primefaces.component.DataScroller
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DataScrollerRenderer
Renderer Class
org.primefaces.component.datascroller.DataScrollerRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
153
PrimeFaces User Guide
Name
Default
Type
Description
value
null
Object
Data to display.
var
null
String
Name of the request-scoped variable used to
refer each data.
rows
null
Integer
Number of rows to display per page.
first
0
Integer
Index of the first row to be displayed
widgetVar
null
String
Name of the client side widget.
style
null
String
Inline style of the main container.
styleClass
Null
String
Style class of the main container.
chunkSize
0
int
Number of items to fetch in each load.
rowIndexVar
null
String
Name of iterator to refer each row index.
mode
document
String
Defines the target to listen for scroll event,
valid values are "document" (default) and
"inline".
scrollHeight
null
String
Defines pixel height of the viewport in inline
mode.
lazy
false
Boolean
Defines if lazy loading is enabled for the data
component.
buffer
10
Integer
Percentage height of the buffer between the
bottom of the page and the scroll position to
initiate the load for the new chunk. Value is
defined in integer and default is 10 meaning
load would happen after 90% of the viewport
is scrolled down.
Getting started with the DataScroller
DataScroller requires a collection of data to display, when the page is scrolled down, datascroller
will do a request with ajax to fetch the new chunk of data and append them at the bottom.
#{car.manufacturer}
//more content
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
#{car.manufacturer}
//more content
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.
#{car.manufacturer}
//more content
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.
#{car.manufacturer}
//more content
Header
Header of the component is defined using header facet.
Cars
#{car.manufacturer}
//more content
Client Side API
Widget: PrimeFaces.widget.DataScroller
Method
load()
Params
Return Type
-
void
155
Description
Loads the next chunk.
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
.ui-datascroller
Main container element
.ui-datascroller-inline
Main container element in inline mode
.ui-datalist-header
Header element
.ui-datalist-content
Content element
.ui-datascroller-list
List element container
.ui-datascroller-item
Container of each item in the list
.ui-datascroller-loader
Container of custom loader element.
.ui-datascroller-loading
Built-in load status indicator
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
Component Class
org.primefaces.component.datatable.DataTable
Component Type
org.primefaces.component.DataTable
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DataTableRenderer
Renderer Class
org.primefaces.component.datatable.DataTableRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
rendered
false
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
value
null
Object
Data to display.
var
null
String
Name of the request-scoped variable used to refer
each data.
rows
null
Integer
Number of rows to display per page.
first
0
Integer
Index of the first row to be displayed
157
PrimeFaces User Guide
Name
Default
Type
Description
widgetVar
null
String
Name of the client side widget.
paginator
false
Boolean
Enables pagination.
paginatorTemplate
null
String
Template of the paginator.
rowsPerPageTemplate
null
String
Template of the rowsPerPage dropdown.
rowsPerPageLabel
null
String
Label for the rowsPerPage dropdown.
currentPageReportTemplate
null
String
Template of the currentPageReport UI.
pageLinks
10
Integer
Maximum number of page links to display.
paginatorPosition
both
String
Position of the paginator.
paginatorAlwaysVisible
true
Boolean
Defines if paginator should be hidden if total data
count is less than number of rows per page.
scrollable
false
Boolean
Makes data scrollable with fixed header.
scrollHeight
null
Integer
Scroll viewport height.
scrollWidth
null
Integer
Scroll viewport width.
selectionMode
null
String
Enables row selection, valid values are “single”
and “multiple”.
selection
null
Object
Reference to the selection data.
rowIndexVar
null
String
Name of iterator to refer each row index.
emptyMessage
No
records
found.
String
Text to display when there is no data to display.
Alternative is emptyMessage facet.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
dblClickSelect
false
Boolean
Enables row selection on double click.
liveScroll
false
Boolean
Enables live scrolling.
rowStyleClass
null
String
Style class for each row.
onExpandStart
null
String
Client side callback to execute before expansion.
resizableColumns
false
Boolean
Enables column resizing.
sortBy
null
Object
Property to be used for default sorting.
sortOrder
ascending
String
“ascending” or “descending”.
scrollRows
0
Integer
Number of rows to load on live scroll.
rowKey
null
String
Unique identifier of a row.
tableStyle
null
String
Inline style of the table element.
158
PrimeFaces User Guide
Name
Default
Type
Description
tableStyleClass
null
String
Style class of the table element.
filterEvent
keyup
String
Event to invoke filtering for input filters.
filterDelay
300
Integer
Delay in milliseconds before sending an ajax
filter query.
draggableColumns
false
Boolean
Columns can be reordered with dragdrop when
enabled.
editable
false
Boolean
Controls incell editing.
lazy
false
Boolean
Controls lazy loading.
filteredValue
null
List
List to keep filtered data.
sortMode
single
String
Defines sorting mode, valid values are single and
multiple.
editMode
row
String
Defines edit mode, valid values are row and cell.
editingRow
false
Boolean
Defines if cell editors of row should be displayed
as editable or not.
cellSeparator
null
String
Separator text to use in output mode of editable
cells with multiple components.
summary
null
String
Summary attribute for WCAG.
frozenRows
null
Object
Collection to display as fixed in scrollable mode.
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.
stickyHeader
false
Boolean
Sticky header stays in window viewport during
scrolling.
expandedRow
false
Boolean
Defines if row should be rendered as expanded
by default.
disabledSelection
false
Boolean
Disables row selection when true.
rowSelectMode
new
String
Defines row selection mode for multiple
selection. Valid values are "new", "add" and
"checkbox".
rowExpandMode
new
String
Defines row expand mode, valid values are
"single" and "multiple" (default).
dataLocale
null
Object
Locale to be used in features such as filtering and
sorting, defaults to view locale.
nativeElements
false
Boolean
Uses native radio-checkbox elements for row
selection.
frozenColumns
0
Integer
Number of columns to freeze from start index 0.
159
PrimeFaces User Guide
Name
Default
Type
Description
draggableRows
false
Boolean
When enabled, rows can be reordered using
dragdrop.
caseSensitiveSort
false
Boolean
Case sensitivity for sorting, insensitive by
default.
skipChildren
false
Boolean
Ignores processing of children during lifecycle,
improves performance if table only has output
components.
disabledTextSelection
true
Boolean
Disables text selection on row click.
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.
initMode
load
String
Defines when the datatable is initiated at client
side, valid values are "load" (default) and
"immediate".
nullSortOrder
1
Integer
Defines where the null values are placed in
ascending sort order. Default value is "1"
meaning null values are placed at the end in
ascending mode and at beginning in descending
mode. Set to "-1" for the opposite behavior.
tabindex
null
String
Position of the element in the tabbing order.
reflow
false
Boolean
Reflow mode is a responsive mode to display
columns as stacked depending on screen size.
liveScrollBuffer
0
Integer
Percentage height of the buffer between the
bottom of the page and the scroll position to
initiate the load for the new chunk. Value is
defined in integer and default is 0.
rowHover
false
Boolean
Adds hover effect to rows, default is false. Hover
is always on when selection is enabled.
rowStatePreserved
false
Boolean
Keeps state of its children on a per-row basis.
Default is false.
resizeMode
fit
String
Defines the resize behavior, valid values are "fit"
(default) and expand.
ariaRowLabel
null
String
Label to read by screen readers on checkbox
selection.
saveOnCellBlur
true
Boolean
Saves the changes in cell editing on blur, when
set to false changes are discarded..
clientCache
false
Boolean
Caches the next page asynchronously, default is
false.
multiViewState
false
Boolean
Whether to keep table state across views, defaults
to false.
160
PrimeFaces User Guide
Name
Default
Type
Description
filterBy
false
List
List of FilterState objects to filter table by
default.
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".
expandableRowGroups
false
Boolean
Makes row groups toggleable, default is false.
virtualScroll
false
Boolean
Loads data on demand as the scrollbar gets close
to the bottom. Default is false.
Getting started with the DataTable
We will be using the same Car and CarBean classes described in DataGrid section.
//more columns
Header and Footer
Both datatable itself and columns can have custom content in their headers and footers using header
and footer facets respectively. Alternatively for columns there are headerText and footerText
shortcuts to display simple texts.
161
PrimeFaces User Guide
List of Cars
Model
#{car.model}
8 digit code
#{car.year}
//more columns
In total there are #{fn:length(carBean.cars)} cars.
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.
//columns
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.
...more columns
Instead of using the default sorting algorithm which uses a java comparator, you can plug-in your
own sort method as well.
public int sortByModel(Object car1, Object car2) {
//return -1, 0 , 1 if car1 is less than, equal to or greater than car2
}
162
PrimeFaces User Guide
...more columns
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.
//columns
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
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.
...more columns
Filtering is triggered with keyup event and filter inputs can be styled using filterStyle,
filterStyleClass attributes. If you’d like to use a dropdown instead of an input field to only allow
predefined filter values use filterOptions attribute and a collection/array of selectitems as value. In
addition, filterMatchMode defines the built-in matcher which is startsWith by default.
Following is a basic filtering datatable with these options demonstrated;
163
PrimeFaces User Guide
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;
- startsWith: Checks if column value starts with the filter value.
- endsWith: Checks if column value ends with the filter value.
- contains: Checks if column value contains the filter value.
- exact: Checks if string representations of column value and filter value are same.
- lt: Checks if column value is less than the filter value.
- lte: Checks if column value is less than or equals the filter value.
- gt: Checks if column value is greater than the filter value.
- gte: Checks if column value is greater than or equals the filter value.
- equals: Checks if column value equals the filter value.
- in: Checks if column value is in the collection of the filter value.
In case the built-in methods do not suffice, custom filtering can be implemented using
filterFunction approach.
filterFunction should be a method with three parameters; column value, filter value and locale.
Return value is a boolean, true accepts the value and false rejects it.
public boolean filterByPrice(Object value, Object filter, Locale locale) {
//return true or false
}
Locale is provided as optional in case you need to use a locale aware method like
toLowerCase(Locale locale). Note that String based filters like startsWith, endsWith uses
toLowerCase already and dataLocale attribute is used to provide the locale to use when filtering.
Row Selection
There are several ways to select row(s) from datatable. Let’s begin by adding a Car reference for
single selection and a Car array for multiple selection to the CarBean to hold the selected data.
public class CarBean {
private List cars;
private Car selectedCar;
private Car[] selectedCars;
public CarBean() {
cars = new ArrayList();
//populate cars
}
//getters and setters
}
Single Selection with a Command Component
This method is implemented with a command component such as commandLink or
commandButton. Selected row can be set to a server side instance by passing as a parameter if you
are using EL 2.2 or using f:setPropertyActionListener.
166
PrimeFaces User Guide
...columns
Single Selection with Row Click
Previous method works when the button is clicked, if you’d like to enable selection wherever the
row is clicked, use selectionMode option.
...columns
Multiple Selection with Row Click
Multiple row selection is similar to single selection but selection should reference an array or a list
of the domain object displayed and user needs to use press modifier key(e.g. ctrl) during selection *.
...columns
Single Selection with RadioButton
Selection a row with a radio button placed on each row is a common case, datatable has built-in
support for this method so that you don’t need to deal with h:selectOneRadios and low level bits. In
order to enable this feature, define a column with selectionMode set as single.
Multiple Selection with Checkboxes
Similar to how radio buttons are enabled, define a selection column with a multiple selectionMode.
DataTable will also provide a selectAll checkbox at column header.
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 can’t know how many columns to render. Columns
component is used to define the columns programmatically. It requires a collection as the value, two
iterator variables called var and columnIndexVar.
#{column.header}
168
PrimeFaces User Guide
public class CarBean {
private List columns = new ArrayList();
private List cars;
public CarBean() {
populateColumns();
cars = //populate cars;
}
public void populateColumns() {
String[] columnKeys = new String[]{"model","year","color"};
for(String columnKey : columnKeys) {
columns.add(new ColumnModel(columnKey.toUpperCase(), columnKey));
}
}
//getters and setters
static public class ColumnModel implements Serializable {
private String header;
private String property;
public ColumnModel(String header, String property) {
this.header = header;
this.property = property;
}
public String getHeader() {
return header;
}
public String getProperty() {
return property;
}
}
}
Column Grouping
Grouping is defined by ColumnGroup component used to combine datatable header and footers.
169
PrimeFaces User Guide
#{sale.manufacturer}
#{sale.lastYearProfit}%
#{sale.thisYearProfit}%
#{sale.lastYearSale}$
#{sale.thisYearSale}$
public class CarBean {
private List sales;
public CarBean() {
sales = //create a list of BrandSale objects
}
public List getSales() {
return this.sales;
}
}
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.
Optionally rows can be made toggleable using expandableRowGroups property.
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;
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.
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
Expandable Rows
RowToggler and RowExpansion facets are used to implement expandable rows.
Expand rows to see detailed information
//columns
//Detailed content of a car
p:rowToggler component places an expand/collapse icon, clicking on a collapsed row loads
expanded content with ajax. If you need to display a row as expanded by default, use expandedRow
attribute which is evaluated before rendering of each row so value expressions are supported.
Additionally, rowExpandMode attribute defines if multiple rows can be expanded at the same time
or not, valid values are "single" and "multiple" (default).
Editing
Incell editing provides an easy way to display editable data. p:cellEditor is used to define the cell
editor of a particular column. There are two types of editing, row and cell. Row editing is the
default mode and used by adding a p:rowEditor component as row controls.
173
PrimeFaces User Guide
In-Cell Editing
//more columns with cell editors
When pencil icon is clicked, row is displayed in editable mode meaning input facets are displayed
and output facets are hidden. Clicking tick icon only saves that particular row and cancel icon
reverts the changes, both options are implemented with ajax interaction.
Another option for incell editing is cell editing, in this mode a cell switches to edit mode when it is
clicked, losing focus triggers an ajax event to save the change value.
Lazy Loading
Lazy Loading is an approach to deal with huge datasets efficiently, regular ajax based pagination
works by rendering only a particular page but still requires all data to be loaded into memory. Lazy
loading datatable renders a particular page similarly but also only loads the page data into memory
not the whole dataset. In order to implement this, you’d 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
//columns
public class CarBean {
private LazyDataModel model;
public CarBean() {
model = new LazyDataModel() {
@Override
public void load(int first, int pageSize, String sortField,
SortOrder sortOrder, Map filters) {
//load physical data
}
};
int totalRowCount = //logical row count based on a count query
model.setRowCount(totalRowCount);
}
public LazyDataModel getModel() {
return model;
}
}
DataTable calls your load implementation whenever a paging, sorting or filtering occurs with
following parameters;
•
•
•
•
•
first: Offset of first data to start from
pageSize: Number of data to load
sortField: Name of sort field
sortOrder: SortOrder enum.
filter: Filter map with field name as key (e.g. "model" for filterBy="#{car.model}") and value.
In addition to load method, totalRowCount needs to be provided so that paginator can display itself
according to the logical number of rows to display.
It is suggested to use field attribute of column component to define the field names passed as
sortField and filterFields, otherwise these fields would be tried to get extracted from the value
expression which is not possible in cases like composite components.
Sticky Header
Sticky Header feature makes the datatable header visible on page scrolling.
//columns
175
PrimeFaces User Guide
Column Toggler
Visibility of columns can be toggled using the column toggler helper component.
176
PrimeFaces User Guide
List of Cars
#{car.model}
#{car.year}
#{car.manufacturer}
#{car.color}
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.
#{car.model}
//columns
public class TableBean {
//...
public void onRowReorder(ReorderEvent event) {
//int from = event.getFromIndex();
//int end = event.getEndIndex();
}
}
Reordering Columns
Columns of the table can be reordered using drag&drop as well. Set draggableColumns attribute to
true to enable this feature. Optional colReorder ajax behavior is provided to listen to reorder events
at server side.
#{car.model}
//columns
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
Ajax Behavior Events
Event
Listener Parameter
Fired
page
org.primefaces.event.data.PageEvent
On pagination.
sort
org.primefaces.event.data.SortEvent
When a column is sorted.
filter
org.primefaces.event.data.FilterEvent
On filtering.
rowSelect
org.primefaces.event.SelectEvent
When a row is being selected.
rowUnselect
org.primefaces.event.UnselectEvent
When a row is being unselected.
rowEdit
org.primefaces.event.RowEditEvent
When a row is edited.
rowEditInit
org.primefaces.event.RowEditEvent
When a row switches to edit mode
rowEditCancel
org.primefaces.event.RowEditEvent
When row edit is cancelled.
colResize
org.primefaces.event.ColumnResizeEvent
When a column is being selected.
toggleSelect
org.primefaces.event.ToggleSelectEvent
When header checkbox is toggled.
colReorder
-
When columns are reordered.
rowSelectRadio
org.primefaces.event.SelectEvent
Row selection with radio.
rowSelectCheckbox
org.primefaces.event.SelectEvent
Row selection with checkbox.
rowUnselectCheckbox
org.primefaces.event.UnselectEvent
Row unselection with checkbox.
rowDblselect
org.primefaces.event.SelectEvent
Row selection with double click.
rowToggle
org.primefaces.event.ToggleEvent
Row expand or collapse.
contextMenu
org.primefaces.event.SelectEvent
ContextMenu display.
cellEdit
org.primefaces.event.CellEditEvent
When a cell is edited.
cellEditInit
org.primefaces.event.CellEditEvent
When a cell edit begins.
cellEditCancel
org.primefaces.event.CellEditEvent
When a cell edit is cancelled e.g.
with escape key
rowReorder
org.primefaces.event.ReorderEvent
On row reorder.
For example, datatable below makes an ajax request when a row is selected with a click on row.
Moreover org.primefaces.event.data.PostSortEvent, org.primefaces.event.data.PostFilterEvent and
org.primefaces.event.data.PostPageEvent, are available to be used with f:event tag.
179
PrimeFaces User Guide
Client Side API
Widget: PrimeFaces.widget.DataTable
Method
Params
Return Type
getPaginator()
-
Paginator
clearFilters()
-
void
getSelectedRowsCount()
Number
Description
Returns the paginator insance.
Clears all column filters
Returns number of selected rows.
selectRow(r, silent)
r: number or tr
element as jQuery
object,
silent: flag to fire row
select ajax behavior
void
Selects the given row.
unselectRow(r, silent)
r: number or tr
element as jQuery
object,
silent: flag to fire row
select ajax behavior
void
Unselects the given row.
unselectAllRows()
-
void
Unselects all rows.
toggleCheckAll()
-
void
Toggles header checkbox state.
filter()
-
Void
Filters the data.
selectAllRows()
-
void
Select all rows.
selectAllRowsOnPage()
-
void
Select all rows on current page.
unselectAllRowsOnPage()
-
void
Unselect all rows on current page.
Skinning
DataTable resides in a main container element which style and styleClass options apply. As skinning
style classes are global, see the main theming section for more information. Following is the list of
structural style classes;
Class
Applies
.ui-datatable
Main container element
.ui-datatable-data
Table body
.ui-datatable-empty-message
Empty message row
.ui-datatable-header
Table header
.ui-datatable-footer
Table footer
.ui-sortable-column
Sortable columns
.ui-sortable-column-icon
Icon of a sortable icon
.ui-expanded-row-content
Content of an expanded row
180
PrimeFaces User Guide
Class
Applies
.ui-row-toggler
Row toggler for row expansion
.ui-editable-column
Columns with a cell editor
.ui-cell-editor
Container of input and output controls of an editable cell
.ui-cell-editor-input
Container of input control of an editable cell
.ui-cell-editor-output
Container of output control of an editable cell
.ui-datatable-even
Even numbered rows
.ui-datatable-odd
Odd numbered rows
.ui-datatable-scrollable
Main container element of a scrollable table.
.ui-datatable-scrollable-header
Header wrapper of a scrollable table.
.ui-datatable-scrollable-header-box
Header container of a scrollable table.
.ui-datatable-scrollable-body
Body container of a scrollable table.
.ui-datatable-scrollable-footer
Footer wrapper of a scrollable table.
.ui-datatable-scrollable-footer-box
Footer container of a scrollable table.
.ui-datatable-resizable
Main container element of a resizable table.
.ui-datatable-frozencolumn
Frozen columns.
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 doesn’t seem to be a standard
and even if a standard exists, IE probably will not care about it. There are some ugly workarounds
like placing a hidden button and writing javascript for every form in your app. DefaultCommand
solves this problem by normalizing the command(e.g. button or link) to submit the form with on
enter key press.
Info
Tag
defaultCommand
Component Class
org.primefaces.component.defaultcommand.DefaultCommand
Component Type
org.primefaces.component.DefaultCommand
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DefaultCommandRenderer
Renderer Class
org.primefaces.component.defaultcommand.DefaultCommandRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget
target
null
String
Identifier of the default command component.
scope
null
String
Identifier of the ancestor component to enable
multiple default commands in a form.
Getting Started with the DefaultCommand
DefaultCommand must be nested inside a form requires target option to reference a clickable
command. Example below triggers btn2 when enter key is pressed. Note that an input must have
focused due to browser nature.
182
PrimeFaces User Guide
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
Component Class
org.primefaces.component.diagram.Diagram
Component Type
org.primefaces.component.Diagram
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DiagramRenderer
Renderer Class
org.primefaces.component.diagram.DiagramRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget
value
null
String
Model of the diagram.
converter
null
Converter An el expression or a literal text that defines a converter
/String
for the component. When it’s an EL expression, it’s
resolved to a converter instance. In case it’s a static text,
it must refer to a converter id.
184
PrimeFaces User Guide
Name
Default
Type
Description
style
null
String
Inline style of the diagram.
styleClass
null
String
Style class of the diagram.
Getting started with the Diagram
Diagram requires a backend model to display.
Show and Hide
Showing and hiding the dialog is easy using the client side api.
//Content
//...
Position
By default dialog is positioned at center of the viewport and position option is used to change the
location of the dialog. Possible values are;
• Single string value like ‘center’, ‘left’, ‘right’, ‘top’, ‘bottom’ representing the position within
viewport.
• Comma separated x and y coordinate values like 200, 500
• Comma separated position values like ‘top’,‘right’. (Use single quotes when using a combination)
Some examples are described below;
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
Ajax Behavior Events
close event is one of the ajax behavior events provided by dialog that is fired when the dialog is
hidden. If there is a listener defined it’ll be executed by passing an instance of
org.primefaces.event.CloseEvent.
Example below adds a FacesMessage when dialog is closed and updates the messages component to
display the added message.
//Content
Client Side API
Widget: PrimeFaces.widget.Dialog
Method
Params
Return Type
Description
show()
-
void
Displays dialog.
hide()
-
void
Closes dialog.
isVisible()
-
void
Returns visibility as a boolean.
Skinning
Dialog resides in a main container element which styleClass option apply. Following is the list of
structural style classes;
191
PrimeFaces User Guide
Style Class
Applies
.ui-dialog
Container element of dialog
.ui-dialog-titlebar
Title bar
.ui-dialog-title-dialog
Header text
.ui-dialog-titlebar-close
Close icon
.ui-dialog-content
Dialog body
As skinning style classes are global, see the main theming section for more information.
Tips
• Use appendTo with care as the page definition and html dom would be different, for example if
dialog is inside an h:form component and appendToBody is enabled, on the browser dialog would
be outside of form and may cause unexpected results. In this case, nest a form inside a dialog.
• Do not place dialog inside tables, containers likes divs with relative positioning or with nonvisible overflow defined, in cases like these functionality might be broken. This is not a limitation
but a result of DOM model. For example dialog inside a layout unit, tabview, accordion are a
couple of examples. Same applies to confirmDialog as well.
• 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
Component Class
org.primefaces.component.dnd.Draggable
Component Type
org.primefaces.component.Draggable
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.DraggableRenderer
Renderer Class
org.primefaces.component.dnd.DraggableRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget
proxy
false
Boolean
Displays a proxy element instead of actual element.
dragOnly
false
Boolean
Specifies a draggable that can’t be dropped.
for
null
String
Id of the component to add draggable behavior
disabled
false
Boolean
Disables draggable behavior when true.
axis
null
String
Specifies drag axis, valid values are ‘x’ and ‘y’.
containment
null
String
Constraints dragging within the boundaries of
containment element
helper
null
String
Helper element to display when dragging
revert
false
Boolean
Reverts draggable to it’s original position when not
dropped onto a valid droppable
snap
false
Boolean
Draggable will snap to edge of near elements
snapMode
null
String
Specifies the snap mode. Valid values are ‘both’,
‘inner’ and ‘outer’.
193
PrimeFaces User Guide
Name
Default
Type
Description
snapTolerance
20
Integer
Distance from the snap element in pixels to trigger
snap.
zindex
null
Integer
ZIndex to apply during dragging.
handle
null
String
Specifies a handle for dragging.
opacity
1
Double
Defines the opacity of the helper during dragging.
stack
null
String
In stack mode, draggable overlap is controlled
automatically using the provided selector, dragged
item always overlays other draggables.
grid
null
String
Dragging happens in every x and y pixels.
scope
null
String
Scope key to match draggables and droppables.
cursor
crosshair
String
CSS cursor to display in dragging.
dashboard
null
String
Id of the dashboard to connect with.
appendTo
null
String
A search expression to define which element to
append the draggable helper to.
Getting started with Draggable
Any component can be enhanced with draggable behavior, basically this is achieved by defining the
id of component using the for attribute of draggable.
Handle
By default any point in dragged component can be used as handle, if you need a specific handle,
you can define it with handle option. Following panel is dragged using it’s header only.
Ajax Behavior Events
drop is the only and default ajax behavior event provided by droppable that is processed when a
valid draggable is dropped. In case you define a listener it’ll be executed by passing an
org.primefaces.event.DragDrop event instance parameter holding information about the dragged
and dropped components.
Following example shows how to enable draggable images to be dropped on droppables.
public void onDrop(DragDropEvent ddEvent) {
String draggedId = ddEvent.getDragId();
String droppedId = ddEvent.getDropId();
Object data = ddEvent.getData();
}
198
//Client id of dragged component
//Client id of dropped component
//Model object of a datasource
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.
availableCars;
private List droppedCars;
public TableBean() {
availableCars = //populate data
}
//getters and setters
public void onCarDrop(DragDropEvent event) {
Car car = ((Car) ddEvent.getData());
droppedCars.add(car);
availableCars.remove(car);
}
}
199
PrimeFaces User Guide
//fade out the dropped item
200
PrimeFaces User Guide
Tolerance
There are four different tolerance modes that define the way of accepting a draggable.
Mode
Description
fit
draggable should overlap the droppable entirely
intersect
draggable should overlap the droppable at least 50%
pointer
pointer of mouse should overlap the droppable
touch
droppable should overlap the droppable at any amount
Acceptance
You can limit which draggables can be dropped onto droppables using scope attribute which a
draggable also has. Following example has two images, only first image can be accepted by
droppable.
value="Home" icon="/images/dock/home.png" url="#" />
value="Music" icon="/images/dock/music.png" url="#" />
value="Video" icon="/images/dock/video.png" url="#"/>
value="Email" icon="/images/dock/email.png" url="#"/>
value="Link" icon="/images/dock/link.png" url="#"/>
value="RSS" icon="/images/dock/rss.png" url="#"/>
value="History" icon="/images/dock/history.png" url="#"/>
Position
Dock can be located in two locations, top or bottom (default). For a dock positioned at top set
position to top.
Dock Effect
When mouse is over the dock items, icons are zoomed in. The configuration of this effect is done
via the maxWidth and proximity attributes.
Dynamic Menus
Menus can be created programmatically as well, see the dynamic menus part in menu component
section for more information and an example.
Skinning
Following is the list of structural style classes, {positon} can be top or bottom.
Style Class
Applies
.ui-dock-{position}
Main container.
.ui-dock-container-{position}
Menu item container.
.ui-dock-item-{position}
Each menu item.
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
Component Class
org.primefaces.component.editor.Editor
Component Type
org.primefaces.component.Editor
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.EditorRenderer
Renderer Class
org.primefaces.component.editor.EditorRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
rendered
true
Boolean
Boolean value to specify the rendering of the
component.
binding
null
Object
An el expression that maps to a server side
UIComponent instance in a backing bean.
value
null
Object
Value of the component than can be either an EL
expression of a literal text.
converter
null
Converter/
String
An el expression or a literal text that defines a
converter for the component. When it’s an EL
expression, it’s resolved to a converter instance. In
case it’s a static text, it must refer to a converter id.
immediate
false
Boolean
When set true, process validations logic is executed at
apply request values phase for this component.
204
PrimeFaces User Guide
Name
Default
Type
Description
required
false
Boolean
Marks component as required.
validator
null
Method
Expr
A method expression that refers to a method
validationg the input.
valueChangeListener
null
Method
Expr
A method expression that refers to a method for
handling a valuchangeevent.
requiredMessage
null
String
Message to be displayed when required field
validation fails.
converterMessage
null
String
Message to be displayed when conversion fails.
validatorMessage
null
String
Message to be displayed when validation fails.
widgetVar
null
String
Name of the client side widget.
controls
null
String
List of controls to customize toolbar.
height
null
Integer
Height of the editor.
width
null
Integer
Width of the editor.
disabled
false
Boolean
Disables editor.
style
null
String
Inline style of the editor container.
styleClass
null
String
Style class of the editor container.
onchange
null
String
Client side callback to execute when editor data
changes.
maxlength
null
Integer
Maximum length of the raw input.
Getting started with the Editor
Rich Text entered using the Editor is passed to the server using value expression.
public class Bean {
private String text;
//getter and setter
}
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: It’s important for components that have the effect component as a child to have an
assigned id because some components do not render their clientId’s if you don’t give them an id
explicitly.
List of Effects
Following is the list of effects;
•
•
•
•
•
•
•
•
•
•
•
•
•
•
blind
clip
drop
explode
fold
puff
slide
scale
bounce
highlight
pulsate
shake
size
transfer
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.
It’s important to provide string options with single quotes.
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.
Something went wrong.
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
Component Class
org.primefaces.component.fieldset.Fieldset
Component Type
org.primefaces.component.Fieldset
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.FieldsetRenderer
Renderer Class
org.primefaces.component.fieldset.FieldsetRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget.
legend
null
String
Title text.
style
null
String
Inline style of the fieldset.
styleClass
null
String
Style class of the fieldset.
toggleable
false
Boolean
Makes content toggleable with animation.
toggleSpeed
500
Integer
Toggle duration in milliseconds.
collapsed
false
Boolean
Defines initial visibility state of content.
212
PrimeFaces User Guide
Getting started with Fieldset
Fieldset is used as a container component for its children.
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.
//content
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.
Ajax Behavior Events
toggle is the default and only ajax behavior event provided by fieldset that is processed when the
content is toggled. In case you have a listener defined, it will be invoked by passing an instance of
org.primefaces.event.ToggleEvent.
213
PrimeFaces User Guide
Here is an example that adds a facesmessage and updates growl component when fieldset is
toggled.
//content
public void onToggle(ToggleEvent event) {
Visibility visibility = event.getVisibility();
FacesMessage msg = new FacesMessage();
msg.setSummary("Fieldset " + event.getId() + " toggled");
msg.setDetail("Visibility: " + visibility);
FacesContext.getCurrentInstance().addMessage(null, msg);
}
Client Side API
Widget: PrimeFaces.widget.Fieldset
Method
Params
toggle()
-
Return Type
void
Description
Toggles fieldset content.
Skinning
style and styleClass options apply to the fieldset. Following is the list of structural style classes;
Style Class
Applies
.ui-fieldset
Main container
.ui-fieldset-toggleable
Main container when fieldset is toggleable
.ui-fieldset .ui-fieldset-legend
Legend of fieldset
.ui-fieldset-toggleable .ui-fieldset-legend
Legend of fieldset when fieldset is toggleable
.ui-fieldset .ui-fieldset-toggler
Toggle icon on fieldset
As skinning style classes are global, see the main theming section for more information.
Tips
• A collapsed fieldset will remain collapsed after a postback since fieldset keeps its toggle state
internally, you don’t need to manage this using toggleListener and collapsed option.
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
ActionListener Class
org.primefaces.component.filedownload.FileDownloadActionListener
Attributes
Name
Default
Type
Description
value
null
StreamedContent
A streamed content instance
contextDisposition
attachment
String
Specifies display mode.
monitorKey
null
String
Optional key to support monitoring
multiple filedownloads on same page.
Getting started with FileDownload
A user command action is required to trigger the filedownload process. FileDownload can be
attached to any command component like a commandButton or commandLink. The value of the
FileDownload must be an org.primefaces.model.StreamedContent instance. We suggest using the
built-in DefaultStreamedContent implementation. First parameter of the constructor is the binary
stream, second is the mimeType and the third parameter is the name of the file.
public class FileBean {
private StreamedContent file;
public FileDownloadController() {
InputStream stream = this.getClass().getResourceAsStream("yourfile.pdf");
file = new DefaultStreamedContent(stream, "application/pdf",
"downloaded_file.pdf");
}
public StreamedContent getFile() {
return this.file;
}
}
This streamed content should be bound to the value of the fileDownload.
215
PrimeFaces User Guide
Similarly a more graphical presentation would be to use a commandlink with an image.
If you’d 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.
216
PrimeFaces User Guide
Cookies must be enabled for monitoring.
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
Component Class
org.primefaces.component.fileupload.FileUpload
Component Type
org.primefaces.component.FileUpload
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.FileUploadRenderer
Renderer Class
org.primefaces.component.fileupload.FileUploadRenderer
Attributes
Name
Default
Description
id
null
String
Unique identifier of the component.
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.
218
PrimeFaces User Guide
Name
Default
Description
value
null
Object
Value of the component than can be either an EL
expression of a literal text.
converter
null
Converter
/String
An el expression or a literal text that defines a
converter for the component. When it’s an EL
expression, it’s resolved to a converter instance. In
case it’s a static text, it must refer to a converter id.
immediate
false
Boolean
When set true, process validations logic is executed
at apply request values phase for this component.
required
false
Boolean
Marks component as required.
validator
null
MethodExpr
A method expression that refers to a method
validationg the input.
valueChangeListener
null
MethodExpr
A method expression that refers to a method for
handling a valuchangeevent.
requiredMessage
null
String
Message to be displayed when required field
validation fails.
converterMessage
null
String
Message to be displayed when conversion fails.
validatorMessage
null
String
Message to be displayed when validation fails.
widgetVar
null
String
Name of the client side widget.
update
null
String
Component(s) to update after fileupload completes.
process
null
String
Component(s) to process in fileupload request.
fileUploadListener
null
MethodExpr
Method to invoke when a file is uploaded.
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.
label
Choose
String
Label of the browse button.
allowTypes
null
String
Regular expression for accepted file types,
e.g. /(\.|\/)(gif|jpe?g|png)$/
sizeLimit
null
Integer
Individual file size limit in bytes.
fileLimit
null
Integer
Maximum number of files allowed to upload.
style
null
String
Inline style of the component.
styleClass
null
String
Style class of the component.
mode
advanced
String
Mode of the fileupload, can be simple or advanced.
uploadLabel
Upload
String
Label of the upload button.
cancelLabel
Cancel
String
Label of the cancel button.
219
PrimeFaces User Guide
Name
Default
Description
invalidSizeMessage
null
String
Message to display when size limit exceeds.
invalidFileMessage
null
String
Message to display when file is not accepted.
fileLimitMessage
null
String
Message to display when file limit exceeds.
dragDropSupport
true
Boolean
Specifies dragdrop based file selection from
filesystem, default is true and works only on
supported browsers.
onstart
null
String
Client side callback to execute when upload begins.
onerror
null
String
Callback to execute if fileupload request fails.
oncomplete
null
String
Client side callback to execute when upload ends.
disabled
false
Boolean
Disables component when set true.
messageTemplate
{name}
{size}
String
Message template to use when displaying file
validation errors.
previewWidth
80
Integer
Width for image previews in pixels.
skinSimple
false
Boolean
Applies theming to simple uploader.
accept
null
String
Filters files in native file browser dialog.
sequential
false
Boolean
Uploads are concurrent by default, set this option to
true for sequential uploads.
Getting started with FileUpload
FileUpload engine on the server side can either be servlet 3.0 or commons fileupload. PrimeFaces
selects the most appropriate uploader engine by detection and it is possible to force one or the other
usign an optional configuration param.
primefaces.UPLOADER
auto|native|commons
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
PrimeFaces FileUpload Filter
org.primefaces.webapp.filter.FileUploadFilter
PrimeFaces FileUpload Filter
Faces Servlet
Note that the servlet-name should match the configured name of the JSF servlet which is Faces
Servlet in this case. Alternatively you can do a configuration based on url-pattern as well.
Simple File Upload
Simple file upload mode works in legacy mode with a file input whose value should be an
UploadedFile instance. Ajax uploads are not supported in simple upload.
import org.primefaces.model.UploadedFile;
public class FileBean {
private UploadedFile file;
//getter-setter
}
Enable skinSimple option to style the simple uploader to have a themed look that works the same
across different environments.
Advanced File Upload
FileUploadListener is the way to access the uploaded files in this mode, when a file is uploaded
defined fileUploadListener is processed with a FileUploadEvent as the parameter.
PrimeFaces FileUpload Filter
org.primefaces.webapp.filter.FileUploadFilter
thresholdSize
51200
uploadDirectory
/Users/primefaces/temp
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
Component Class
org.primefaces.component.focus.Focus
Component Type
org.primefaces.component.Focus.FocusTag
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.FocusRenderer
Renderer Class
org.primefaces.component.focus.FocusRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
for
null
String
Specifies the exact component to set focus
context
null
String
The root component to start first input search.
minSeverity
error
String
Minimum severity level to be used when finding
the first invalid component
Getting started with Focus
By default focus will find the first enabled and visible input component on page and apply focus.
Input component can be any element such as input, textarea and select.
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.
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
Component Class
org.primefaces.component.galleria.Galleria
Component Type
org.primefaces.component.Galleria
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.GalleriaRenderer
Renderer Class
org.primefaces.component.galleria.GalleriaRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
widgetVar
null
String
Name of the client side widget.
value
null
Collection
Collection of data to display.
var
null
String
Name of variable to access an item in collection.
style
null
String
Inline style of the container element.
styleClass
null
String
Style class of the container element.
effect
fade
String
Name of animation to use.
229
PrimeFaces User Guide
Name
Default
Type
Description
effectSpeed
700
Integer
Duration of animation in milliseconds.
panelWidth
600
Integer
Width of the viewport.
panelHeight
400
Integer
Height of the viewport.
frameWidth
60
Integer
Width of the frames.
frameHeight
40
Integer
Height of the frames.
showFilmstrip
true
Boolean
Defines visibility of filmstrip.
showCaption
false
Boolean
Defines visibility of captions.
transitionInterval
4000
Integer
Defines interval of slideshow.
autoPlay
true
Boolean
Images are displayed in a slideshow in autoPlay.
Getting Started with Galleria
Images to displayed are defined as children of galleria;
title="image1"
title="image1"
title="image1"
title="image1"
alt="image1 desc" />
alt=" image2 desc" />
alt=" image3 desc" />
alt=" image4 desc" />
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
//images
Skinning
Galleria resides in a main container element which style and styleClass options apply. As skinning
style classes are global, see the main theming section for more information. Following is the list of
structural style classes
Style Class
Applies
.ui-galleria
Container element for galleria.
.ui-galleria-panel-wrapper
Container of panels.
.ui-galleria-panel
Container of each image.
.ui-galleria-caption
Caption element.
.ui-galleria-nav-prev, .ui-galleria-nav-next
Navigators of filmstrip.
.ui-galleria-filmstrip-wrapper
Container of filmstrip.
.ui-galleria-filmstrip
Filmstrip element.
.ui-galleria-frame
Frame element in a filmstrip.
.ui-galleria-frame-content
Content of a frame.
.ui-galleria-frame-image
Thumbnail image.
231
PrimeFaces User Guide
3.51 GMap
GMap is a map component integrated with Google Maps API V3.
Info
Tag
gmap
Component Class
org.primefaces.component.gmap.GMap
Component Type
org.primefaces.component.Gmap
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.GmapRenderer
Renderer Class
org.primefaces.component.gmap.GmapRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component.
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.
widgetVar
null
String
Name of the client side widget.
model
null
MapModel
An org.primefaces.model.MapModel instance.
232
PrimeFaces User Guide
Name
Default
Type
Description
style
null
String
Inline style of the map container.
styleClass
null
String
Style class of the map container.
type
null
String
Type of the map.
center
null
String
Center point of the map.
zoom
8
Integer
Defines the initial zoom level.
streetView
false
Boolean
Controls street view support.
disableDefaultUI
false
Boolean
Disables default UI controls
navigationControl
true
Boolean
Defines visibility of navigation control.
mapTypeControl
true
Boolean
Defines visibility of map type control.
draggable
true
Boolean
Defines draggability of map.
disabledDoubleClickZoom
false
Boolean
Disables zooming on mouse double click.
onPointClick
null
String
Javascript callback to execute when a point on
map is clicked.
fitBounds
true
Boolean
Defines if center and zoom should be calculated
automatically to contain all markers on the
map.
scrollWheel
false
Boolean
Controls scrollwheel zooming on the map.
Getting started with GMap
First thing to do is placing V3 of the Google Maps API that the GMap is based on. Ideal location is
the head section of your page.
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.
results = event.getResults();
}
236
PrimeFaces User Guide
Ajax Behavior Events
GMap provides many custom ajax behavior events for you to hook-in to various features.
Event
Listener Parameter
Fired
overlaySelect
org.primefaces.event.map.OverlaySelectEvent
When an overlay is selected.
stateChange
org.primefaces.event.map.StateChangeEvent
When map state changes.
pointSelect
org.primefaces.event.map.PointSelectEvent
When an empty point is selected.
markerDrag
org.primefaces.event.map.MarkerDragEvent
When a marker is dragged.
Following example displays a FacesMessage about the selected marker with growl component.
public class MapBean {
private MapModel model;
public MapBean() {
model = new DefaultMapModel();
//add markers
}
public MapModel getModel() {
return model
}
public void onMarkerSelect(OverlaySelectEvent event) {
Marker selectedMarker = (Marker) event.getOverlay();
//add facesmessage
}
}
InfoWindow
A common use case is displaying an info window when a marker is selected. gmapInfoWindow is
used to implement this special use case. Following example, displays an info window that contains
an image of the selected marker data.
237
PrimeFaces User Guide
public class MapBean {
private MapModel model;
private Marker marker;
public MapBean() {
model = new DefaultMapModel();
//add markers
}
public MapModel getModel() { return model; }
public Marker getMarker() { return marker; }
public void onMarkerSelect(OverlaySelectEvent event) {
this.marker = (Marker) event.getOverlay();
}
}
Street View
StreeView is enabled simply by setting streetView option to true.
238
PrimeFaces User Guide
getMarkers()
Returns the list of markers
List getPolylines()
Returns the list of polylines
List getPolygons()
Returns the list of polygons
List getCircles()
Returns the list of circles
List getRectangles()
Returns the list of rectangles.
Overlay findOverlay(String id)
Finds an overlay by it’s unique id
org.primefaces.model.map.Overlay
Property
Default
Type
Description
id
null
String
Id of the overlay, generated and used internally
data
null
Object
Data represented in marker
zindex
null
Integer
Z-Index of the overlay
org.primefaces.model.map.Marker extends org.primefaces.model.map.Overlay
Property
Default
Type
Description
title
null
String
Text to display on rollover
latlng
null
LatLng
Location of the marker
icon
null
String
Icon of the foreground
shadow
null
String
Shadow image of the marker
cursor
pointer
String
Cursor to display on rollover
draggable
0
Boolean
Defines if marker can be dragged
clickable
1
Boolean
Defines if marker can be dragged
flat
0
Boolean
If enabled, shadow image is not displayed
visible
1
Boolean
Defines visibility of the marker
org.primefaces.model.map.Polyline extends org.primefaces.model.map.Overlay
240
PrimeFaces User Guide
Property
Default
Type
Description
paths
null
List
List of coordinates
strokeColor
null
String
Color of a line
strokeOpacity
1
Double
Opacity of a line
strokeWeight
1
Integer
Width of a line
org.primefaces.model.map.Polygon extends org.primefaces.model.map.Overlay
Property
Default
Type
Description
paths
null
List
List of coordinates
strokeColor
null
String
Color of a line
strokeOpacity
1
Double
Opacity of a line
strokeWeight
1
Integer
Weight of a line
fillColor
null
String
Background color of the polygon
fillOpacity
1
Double
Opacity of the polygon
org.primefaces.model.map.Circle extends org.primefaces.model.map.Overlay
Property
Default
Type
Description
center
null
LatLng
Center of the circle
radius
null
Double
Radius of the circle.
strokeColor
null
String
Stroke color of the circle.
strokeOpacity
1
Double
Stroke opacity of circle.
strokeWeight
1
Integer
Stroke weight of the circle.
fillColor
null
String
Background color of the circle.
fillOpacity
1
Double
Opacity of the circle.
org.primefaces.model.map.Rectangle extends org.primefaces.model.map.Overlay
Property
Default
Type
Description
bounds
null
LatLngBounds
Boundaries of the rectangle.
strokeColor
null
String
Stroke color of the rectangle.
strokeOpacity
1
Double
Stroke opacity of rectangle.
241
PrimeFaces User Guide
Property
Default
Type
Description
strokeWeight
1
Integer
Stroke weight of the rectangle.
fillColor
null
String
Background color of the rectangle.
fillOpacity
1
Double
Opacity of the rectangle.
org.primefaces.model.map.LatLng
Property
Default
Type
Description
lat
null
double
Latitude of the coordinate
lng
null
double
Longitude of the coordinate
org.primefaces.model.map.LatLngBounds
Property
Default
Type
Description
center
null
LatLng
Center coordinate of the boundary
northEast
null
LatLng
NorthEast coordinate of the boundary
southWest
null
LatLng
SouthWest coordinate of the boundary
org.primefaces.model.map.GeocodeResult
Property
Default
Type
Description
address
null
String
String representation of the address.
latLng
null
LatLng
Coordinates of the address.
GMap Event API
All classes in event api extends from javax.faces.event.FacesEvent.
org.primefaces.event.map.MarkerDragEvent
Property
marker
Default
null
Type
Marker
Description
Dragged marker instance
org.primefaces.event.map.OverlaySelectEvent
Property
overlay
Default
null
Type
Overlay
Description
Selected overlay instance
242
PrimeFaces User Guide
org.primefaces.event.map.PointSelectEvent
Property
latLng
Default
null
Type
LatLng
Description
Coordinates of the selected point
org.primefaces.event.map.StateChangeEvent
Property
Default
Type
Description
bounds
null
LatLngBounds
Boundaries of the map
zoomLevel
0
Integer
Zoom level of the map
org.primefaces.event.map.GeocodeEvent
Property
Default
Type
Description
query
null
String
Query of the geocode search.
results
null
List
List of results represented as GeocodeResult.
org.primefaces.event.map.ReverseGeocodeEvent
Property
Default
Type
Description
latlng
null
LatLng
Coordinates of the reverse geocode query.
addresses
null
List
List of results represented as strings.
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
Tag Class
org.primefaces.component.gmap.GMapInfoWindowTag
Component Class
org.primefaces.component.gmap.GMapInfoWindow
Component Type
org.primefaces.component.GMapInfoWindow
Component Family
org.primefaces.component
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
maxWidth
null
Integer
Maximum width of the info window
Getting started with GMapInfoWindow
See GMap section for more information about how gmapInfoWindow is used.
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
Component Class
org.primefaces.component.graphicimage.GraphicImage
Component Type
org.primefaces.component.GraphicImage
Component Family
org.primefaces.component
Renderer Type
org.primefaces.component.GraphicImageRenderer
Renderer Class
org.primefaces.component.graphicimage.GraphicImageRenderer
Attributes
Name
Default
Type
Description
id
null
String
Unique identifier of the component
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
value
null
Object
Binary data to stream or context relative path.
alt
null
String
Alternate text for the image
url
null
String
Alias to value attribute
width
null
String
Width of the image
height
null
String
Height of the image
title
null
String
Title of the image
dir
null
String
Direction of the text displayed
lang
null
String
Language code
ismap
false
Boolean
Specifies to use a server-side image map
usemap
null
String
Name of the client side map
style
null
String
Style of the image
styleClass
null
String
Style class of the image
245
PrimeFaces User Guide
Name
Default
Type
Description
onclick
null
String
onclick dom event handler
ondblclick
null
String
ondblclick dom event handler
onkeydown
null
String
onkeydown dom event handler
onkeypress
null
String
onkeypress dom event handler
onkeyup
null
String
onkeyup dom event handler
onmousedown
null
String
onmousedown dom event handler
onmousemove
null
String
onmousemove dom event handler
onmouseout
null
String
onmouseout dom event handler
onmouseover
null
String
onmouseover dom event handler
onmouseup
null
String
onmouseup dom event handler
cache
true
String
Enables/Disables browser from caching the image
name
null
String
Name of the image.
library
null
String
Library name of the image.
stream
true
Boolean
Defines if the image is streamed or rendered
directly as data uri / base64 with ViewScoped
support.
Getting started with GraphicImage
GraphicImage requires an org.primefaces.model.StreamedContent content as it’s value for dynamic
images. StreamedContent is an interface and PrimeFaces provides a built-in implementation called
DefaultStreamedContent. Following examples loads an image from the classpath.
Content
6
12
4
250
PrimeFaces User Guide
Solution is wrapping the internal divs inside a ui-g as well.
6
Content
6
12
4
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.
ui-md-6
ui-md-6
ui-md-6
ui-md-6
ui-lg-3">ui-g-12
ui-lg-3">ui-g-12
ui-lg-3">ui-g-12
ui-lg-3">ui-g-12
ui-md-6
ui-md-6
ui-md-6
ui-md-6
ui-lg-3
ui-lg-3
ui-lg-3 ui-g-12 ui-md-6 ui-lg-4
ui-g-12 ui-md-6 ui-lg-4
ui-g-12 ui-lg-4
tag which style and styleClass options apply. 471 PrimeFaces User Guide
StackTrace:
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.4 Linearized : No Creator : Writer Modify Date : 2017:04:18 11:40:13+03:00 Create Date : 2017:04:18 11:35:09+03:00 Producer : 䱩扲敏晦楣攠㔮㌻潤楦楥搠畳楮朠楔數琠㈮ㄮ㜠批‱吳塔 Author : Çağatay Çivici Language : en-US Page Count : 653EXIF Metadata provided by EXIF.tools