USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

This guide is dedicated to my wife Nurcan, without her support PrimeFaces wouldn’t even exist.

Çağatay Çivici

2

PrimeFaces Userʼs Guide

About the Author! 1. Introduction!
1.1 What is PrimeFaces?! 1.2 Prime Teknoloji!

11 12
12 12

2. Setup!
2.1 Download! 2.2 Dependencies! 2.3 Configuration! 2.4 Hello World!

13
13 14 14 14

3. Component Suite!
3.1 AccordionPanel! 3.2 AjaxBehavior! 3.3 AjaxStatus! 3.4 AutoComplete ! 3.5 BlockUI! 3.6 BreadCrumb! 3.7 Button! 3.8 Calendar! 3.9 Captcha ! 3.10 Carousel! 3.11 CellEditor! 3.12 Charts !
3.12.1 Pie Chart! 3.12.2 Line Chart! 3.12.3 Bar Chart!
3

15
15 19 21 24 33 36 38 41 52 55 61 62
62 65 68

PrimeFaces Userʼs Guide

3.12.4 Donut Chart! 3.12.5 Bubble Chart! 3.12.6 Ohlc Chart! 3.12.7 MeterGauge Chart! 3.12.8 Skinning Charts! 3.12.9 Ajax Behavior Events! 3.12.10 Charting Tips!

71 74 77 79 81 82 83

3.13 Collector! 3.14 Color Picker! 3.15 Column! 3.16 Columns! 3.17 ColumnGroup! 3.18 CommandButton! 3.19 CommandLink! 3.20 ConfirmDialog! 3.21 ContextMenu! 3.22 Dashboard! 3.23 DataExporter! 3.24 DataGrid! 3.25 DataList! 3.26 DataTable! 3.27 DefaultCommand! 3.28 Dialog! 3.29 Drag&Drop!
3.29.1 Draggable! 3.29.2 Droppable!
4

84 85 89 91 92 93 98 101 104 107 112 115 121 125 143 145 150
150 154

PrimeFaces Userʼs Guide

3.30 Dock! 3.31 Editor! 3.32 Effect! 3.33 FeedReader! 3.34 Fieldset! 3.35 FileDownload! 3.36 FileUpload! 3.37 Focus ! 3.38 Galleria ! 3.39 GMap! 3.40 GMapInfoWindow! 3.41 GraphicImage ! 3.42 Growl! 3.43 HotKey! 3.44 IdleMonitor! 3.45 ImageCompare! 3.46 ImageCropper! 3.47 ImageSwitch! 3.48 Inplace ! 3.49 InputMask! 3.50 InputText! 3.51 InputTextarea! 3.52 Keyboard! 3.53 Layout! 3.54 LayoutUnit!
5

159 161 165 168 169 173 176 182 184 187 198 199 204 207 210 212 214 218 221 225 229 232 235 240 245

PrimeFaces Userʼs Guide

3.55 LightBox! 3.56 Log! 3.57 Media! 3.58 MegaMenu! 3.59 Menu! 3.60 Menubar! 3.61 MenuButton! 3.62 MenuItem! 3.63 Message! 3.64 Messages! 3.65 NotificationBar! 3.66 OrderList! 3.67 OutputPanel! 3.68 OverlayPanel! 3.69 Panel! 3.70 PanelGrid! 3.71 Password! 3.72 PhotoCam! 3.73 PickList! 3.74 Poll! 3.75 Printer! 3.76 ProgressBar! 3.77 Push! 3.78 RadioButton! 3.79 Rating!
6

247 250 252 254 257 263 266 268 271 273 275 277 281 283 286 289 292 297 299 305 308 309 313 314 315

PrimeFaces Userʼs Guide

3.80 RemoteCommand! 3.81 Resizable! 3.82 Ring! 3.83 Row! 3.84 RowEditor! 3.85 RowExpansion! 3.86 RowToggler! 3.87 Schedule ! 3.88 ScrollPanel! 3.89 SelectBooleanButton! 3.90 SelectBooleanCheckbox! 3.91 SelectChecboxMenu! 3.92 SelectManyButton! 3.93 SelectManyCheckbox! 3.94 SelectManyMenu! 3.95 SelectOneButton! 3.96 SelectOneListbox! 3.97 SelectOneMenu! 3.98 SelectOneRadio ! 3.99 Separator! 3.100 Sheet! 3.101 Slider! 3.102 Spacer! 3.103 Spinner! 3.104 SplitButton!
7

318 320 324 327 328 329 330 331 339 341 343 345 347 349 351 353 355 357 361 364 366 369 374 375 380

PrimeFaces Userʼs Guide

3.105 Submenu! 3.106 Stack! 3.107 SubTable! 3.108 SummaryRow! 3.109 Tab! 3.110 TabView! 3.111 TagCloud! 3.112 Terminal! 3.113 ThemeSwitcher! 3.114 Toolbar! 3.115 ToolbarGroup! 3.116 Tooltip! 3.117 Tree! 3.118 TreeNode! 3.119 TreeTable ! 3.120 Watermark! 3.121 Wizard!

384 385 387 388 389 390 395 397 399 401 403 404 407 415 416 419 421

4. Partial Rendering and Processing!
4.1 Partial Rendering!
4.1.1 Infrastructure! 4.1.2 Using IDs! 4.1.3 Notifying Users! 4.1.4 Bits&Pieces!

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

5. PrimeFaces Mobile! 6. PrimeFaces Push!
6.1 Setup! 6.2 Push API! 6.3 Push Component! 6.4 Samples!
6.4.1 Counter! 6.4.2 Chat!

433 434
434 435 435 435
435 436

7. Javascript API!
7.1 PrimeFaces Namespace! 7.2 Ajax API!

438
438 439

8. Themes!
8.1 Applying a Theme ! 8.2 Creating a New Theme ! 8.3 How Themes Work! 8.4 Theming Tips!

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

Project Resources! 14. Integration with Java EE! 12.2 Eclipse! 455 456 456 457 13.PrimeFaces Userʼs Guide 11. IDE Support ! 12. FAQ! 458 459 10 .1 NetBeans! 12.

JSFSummit.About the Author Çağatay Çivici is a member of JavaServer Faces Expert Group. JSFDays. W-JAX. . Çağatay is also an author and technical reviewer of a couple books regarding web application development with Java and JSF. He’s a recognized speaker in international conferences including SpringOne. the company he cofounded in Turkey. Çağatay is currently working as a principal consultant for Prime Teknoloji. EJB 3. As an experienced trainer. the founder and project lead of PrimeFaces and PMC member of open source JSF implementation Apache MyFaces. Jazoon. Con-Fess and many local events such as JUGs. he has trained over 300 developers on Java EE technologies mainly JSF. Spring.x and JPA. JAX.

PrimeFaces Team members are full time engineers at Prime Teknoloji. • Large. Dialog. AutoComplete.Core Developer / QA&Test Mustafa Daşgın .Mentor 12 . • Built-in Ajax based on standard JSF 2.Architect and Lead Developer Levent Günay .2 Prime Teknoloji PrimeFaces is maintained by Prime Teknoloji. • Skinning Framework with 30 built-in themes and support for visual theme designer tool. zero-configuration and no required dependencies.1 What is PrimeFaces? PrimeFaces is an open source JSF component suite with various extensions. • • • • • Çağatay Çivici . vibrant and active user community. one jar.PrimeFaces Userʼs Guide 1. • Lightweight. • Mobile UI kit to create mobile web applications for handheld devices. • Developed with "passion" from application developers to application developers. • Ajax Push support via websockets. • Extensive documentation. a Turkish software development company specialized in Agile and Java EE consulting.Core Developer / QA&Test Cenk Çivici . Introduction 1. Charts and many more). • Rich set of components (HtmlEditor.Core Developer / QA&Test Yiğit Darçın . 1.0 Ajax APIs.

org/downloads. Bundle contains binary.0</version> </dependency> In addition to the configuration above you also need to add PrimeFaces maven repository to the repository list so that maven can download it.1 Download PrimeFaces has a single jar called primefaces-{version}.PrimeFaces Userʼs Guide 2. binary. sources and javadocs. There are two ways to download this jar. Setup 2. Download Manually Three different artifacts are available for each PrimeFaces version. sources and bundle. http://www. you can either download from PrimeFaces homepage or if you are a maven user you can define it as a dependency.primefaces. <dependency> <groupId>org.jar.html Download with Maven Group id of the dependency is org. <repository> <id>prime-repo</id> <name>Prime Repo</name> <url>http://repository.primefaces</groupId> <artifactId>primefaces</artifactId> <version>3.org</url> </repository> 13 .primefaces and artifact id is primefaces.primefaces.

7 3.w3c.4 Type Required Optional Optional Optional Optional Optional Description Apache MyFaces or Oracle Mojarra DataExporter (PDF).0 1.x implementation as mandatory dependencies. 2.1 1. 14 . FileUpload FileUpload * Listed versions are tested and known to be working with PrimeFaces. There’re some optional libraries for certain features.PrimeFaces Userʼs Guide 2. FeedReader.2 Dependencies PrimeFaces only requires a JAVA 5+ runtime and a JSF 2.1 2. <html xmlns="http://www.org/1999/xhtml" xmlns:h="http://java.1.7 1. you need to add the PrimeFaces namespace to your page to begin using the components.0 or 2.3 Configuration PrimeFaces does not require any mandatory configuration. Dependency JSF runtime itext apache poi rome commons-fileupload commons-io Version * 2.org/ui"> <h:head> </h:head> <h:body> <p:editor /> </h:body> </html> When you run this page.com/jsf/html" xmlns:p="http://primefaces. you should see a rich text editor.sun. DataExporter (Excel).4 Hello World Once you have added the downloaded jar to your classpath. 2. Here is a simple page. other versions of these dependencies may also work but not tested.2.

1 AccordionPanel AccordionPanel is a container component that displays content in stacked format.primefaces.component. An EL expression that maps to a server side UIComponent instance in a backing bean.component.primefaces.AccordionPanelRenderer org. 15 .accordionpanel.Accordionpanel org.PrimeFaces Userʼs Guide 3.AccordionPanel org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class accordionPanel org.component.primefaces.component org.primefaces. Component Suite 3.AccordionPanelRenderer Attributes Name id rendered binding Default null TRUE null Type String boolean Object Description Unique identifier of the component Boolean value to specify the rendering of the component.accordionpanel.component.

.More content for first tab </p:tab> <p:tab title="Second Tab Title"> <h:outputText value="Ipsum" /> </p:tab> //any number of tabs </p:accordionPanel> Dynamic Content Loading AccordionPanel supports lazy loading of tab content.List String Boolean String Description Index of the active tab or a comma separated string of indexes when multiple mode is on. Client side callback to invoke when an inactive tab is clicked. To control this behavior use cache option. Getting Started with Accordion Panel Accordion panel consists of one or more tabs and each tab can group any content. Name of iterator to use in a dynamic number of tabs. Defines the toggle mode. Inline style of the container element. when dynamic option is set true. Controls multiple selection. Titles can also be defined with “title” facet. 16 .PrimeFaces Userʼs Guide Name activeIndex style styleClass onTabChange onTabShow dynamic cache value var multiple widgetVar Default 0 null null null null FALSE TRUE null null FALSE null Type String String String String String Boolean Boolean java. By default activating a previously loaded dynamic tab does not initiate a request to load the contents again as tab is cached. This feature is useful to reduce bandwidth and speed up page loading time. List to iterate to display dynamic number of tabs. 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. <p:accordionPanel> <p:tab title="First Tab Title"> <h:outputText value= "Lorem"/> .util. Defines if activating a dynamic tab should load the contents from server again. Style class of the container element.. Name of the client side widget. Client side callback to invoke when a tab gets activated.

//..PrimeFaces Userʼs Guide <p:accordionPanel dynamic="true"> //. } Your listener(if defined) will be invoked with an org..tabs </p:accordionPanel> Client Side Callbacks onTabChange is called before a tab is shown and onTabShow is called after.tabs </p:accordionPanel> <script type="text/javascript"> function handleChange(panel) { //panel: new tab content container } </script> Ajax Behavior Events tabChange is the one and only ajax behavior event of accordion panel that is executed when a tab is toggled.More content </p:tab> </p:accordionPanel> 17 . Both receive container element of the tab to show as the parameter.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself. <p:accordionPanel value=”#{bean.onChange}” /> </p:accordionPanel> public void onChange(TabChangeEvent event) { //Tab activeTab = event.list}” var=”listItem”> <p:tab title="#{listItem...propertyB}"/> .event..primefaces. use the built-in iteration feature similar to ui:repeat. Dynamic Number of Tabs When the tabs to display are not static. <p:accordionPanel onTabChange="handleChange(panel)"> //. <p:accordionPanel> <p:ajax event=”tabChange” listener=”#{bean.propertyA}"> <h:outputText value= "#{listItem.getTab()..

enable multiple mode to activate multiple tabs. see the main Skinning section for more information.More content for first tab </p:tab> <p:tab title="Second Tab Title"> <h:outputText value="Ipsum" /> </p:tab> //any number of tabs </p:accordionPanel> Multiple Selection By default. 18 . Following is the list of structural style classes.PrimeFaces Userʼs Guide Disabled Tabs A tab can be disabled by setting disabled attribute to true.ui-accordion-header .widget. Class ..ui-accordion-content Main container element Tab header Tab content Applies As skinning style classes are global.AccordionPanel Method select(index) unselect(index) Params index: Index of tab to display index: Index of tab to hide Return Type void void Description Activates tab with given index. <p:accordionPanel multiple=”true”> //tabs </p:accordionPanel> Client Side API Widget: PrimeFaces. Skinning AccordionPanel resides in a main container element which style and styleClass options apply..ui-accordion . only one tab at a time can be active. <p:accordionPanel> <p:tab title="First Tab Title" disabled=”true”> <h:outputText value= "Lorem"/> . Deactivates tab with given index.

when false at invoke_application phase. Info Tag Behavior Id Behavior Class ajax org.component. Callback to execute when ajax request is completed.AjaxBehavior org. Component(s) to update with ajax. Global ajax requests are listened by ajaxStatus component. async process update onstart oncomplete onsuccess onerror global disabled event FALSE null null null null null null TRUE FALSE null Boolean String String String String String String Boolean Boolean String Getting Started with AjaxBehavior AjaxBehavior is attached to the component to ajaxify.2 AjaxBehavior AjaxBehavior is an extension to standard f:ajax. Boolean value that determines the phaseId.AjaxBehavior Attributes Name listener immediate Default null FALSE Type MethodExpr boolean Description Method to process in partial request.component. <h:inputText value="#{bean. Component(s) to process in partial request. Disables ajax behavior.text}"> <p:ajax update="out" /> </h:inputText> <h:outputText id="out" value="#{bean.PrimeFaces Userʼs Guide 3. Callback to execute when ajax request fails. setting global to false will not trigger ajaxStatus. Callback to execute when ajax request succeeds. Callback to execute before ajax request is begins.primefaces. ajax requests are not queued.primefaces.ajax. When set to true. Client side event to trigger ajax request. when true actions are processed at apply_request_values.behavior.text}" /> 19 .

an ajax request is sent to the server. When the response is received output text with id "out" is updated with value of the input.PrimeFaces Userʼs Guide In the example above. for input components it is onchange and for command components it is onclick. In order to override the dom event to trigger the ajax request use event option. public int getCount() { return count. ajax request is triggered when key is up on input field.text}"> <p:ajax update="out" event="keyup"/> </h:inputText> <h:outputText id="out" value="#{bean. <h:inputText id="firstname" value="#{bean. In following example. } public void setCount(int count) { this. each time the input changes. } Events Default client side events are defined by components that support client behaviors.text}" /> Partial Processing Partial processing is used with process option which defaults to @this.count}" /> public class CounterBean { } private int count. 20 . meaning the ajaxified component. define a listener. Listener In case you need to execute a method on a backing bean. <h:inputText id="counter"> <p:ajax update="out" listener="#{counterBean.increment}"/> </h:inputText> <h:outputText id="out" value="#{counterBean.count = count. See section 5 for detailed information on partial processing. } public void increment() { count++.

AjaxStatusRenderer org.ajaxstatus.PrimeFaces Userʼs Guide 3. 21 . Boolean value to specify the rendering of the component.AjaxStatus org.AjaxStatusRenderer Attributes Name id rendered binding onstart oncomplete onprestart onsuccess onerror style styleClass widgetVar Default null TRUE null null null null null null null null null String Boolean Object String String String String String String String String Type Description Unique identifier of the component.primefaces.component.primefaces. Style class of the component.component org.3 AjaxStatus AjaxStatus is a global notifier for ajax requests made by PrimeFaces components.component. Inline style of the component.primefaces. Client side callback to execute after ajax requests complete.AjaxStatus org. Client side callback to execute after ajax requests completed succesfully. Client side callback to execute when an ajax request fails.ajaxstatus. Name of the client side widget. Client side callback to execute before ajax requests start.component.primefaces.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ajaxStatus org. An el expression that maps to a server side UIComponent instance in a backing bean Client side callback to execute after ajax requests start.

• • • • • • default: Initially visible when page is loaded. success: When ajax response is received without error. error: When ajax response is received with error. start: After ajax request begins." /> </f:facet> <f:facet name="error"> <h:outputText value="Error" /> </f:facet> <f:facet name="success"> <h:outputText value="Success" /> </f:facet> <f:facet name="default"> <h:outputText value="Idle" /> </f:facet> <f:facet name="start"> <h:outputText value="Sending" /> </f:facet> <f:facet name="complete"> <h:outputText value="Done" /> </f:facet> </p:ajaxStatus> 22 .gif" /> </f:facet> <f:facet name="complete"> <h:outputText value="Done!" /> </f:facet> </p:ajaxStatus> Events Here is the full list of available event names. complete: When everything finishes. <p:ajaxStatus> <f:facet name="start"> <p:graphicImage value="ajaxloading. prestart: Before ajax request is sent.. Once the ajax response is received start facet becomes hidden and complete facet shows up.PrimeFaces Userʼs Guide Getting Started with AjaxStatus AjaxStatus uses facets to represent the request status. <p:ajaxStatus> <f:facet name="prestart"> <h:outputText value="Starting.. Start facet will be visible once ajax request begins and stay visible until it’s completed. Most common used facets are start and complete.

fn: function to bind Return Type void Description Binds a facet to an event bindCallback(eventName. facetId: Element id of facet container eventName: Name of status event.PrimeFaces Userʼs Guide Custom Events Facets are the declarative way to use. <p:ajaxStatus onstart="alert(‘Start’)" oncomplete="alert(‘End’)"/> A comman usage of programmatic approach is to implement a custom status dialog.show()" oncomplete="status.widget. Styling directly applies to a container element which contains the facets..hide()"/> <p:dialog widgetVar="status" modal="true" closable="false"> Please Wait </p:dialog> Client Side API Widget: PrimeFaces. Provide a fixed width/height to the ajaxStatus to prevent page layout from changing.. There is an ajax loading gif bundled with PrimeFaces which you can use. Components like commandButton has an attribute (global) to control triggering of AjaxStatus. <p:ajaxStatus onstart="status. <p:ajaxStatus style="width:32px.height:32px" . facetId) Params eventName: Name of status event. fn) void Binds a function to an event Skinning AjaxStatus is equipped with style and styleClass.AjaxStatus Method bindFacet(eventName. 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. /> Tips • • • • Avoid updating ajaxStatus itself to prevent duplicate facet/callback bindings. 23 .

primefaces.primefaces.AutoCompleteRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component. An el expression that maps to a server side UIComponent instance in a backing bean. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class autoComplete org.AutoComplete org.autocomplete. 24 . it’s resolved to a converter instance. it must refer to a converter id.PrimeFaces Userʼs Guide 3.component org.component.component.4 AutoComplete AutoComplete provides live suggestions while an input is being typed.autocomplete.primefaces.primefaces.primefaces. Boolean value to specify the rendering of the component. Value of the component than can be either an EL expression of a literal text.component.component.AutoCompleteRenderer org. An el expression or a literal text that defines a converter for the component. In case it’s a static text. When it’s an EL expression.AutoComplete org.

required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar completeMethod var itemLabel itemValue maxResults minQueryLength queryDelay forceSelection onstart oncomplete global scrollHeight effect effectDuration dropdown panelStyle FALSE null null null null null null null null null null unlimited 1 300 FALSE null null TRUE null null 400 FALSE null Boolean MethodExpr MethodExpr String String String String MethodExpr String String String Integer Integer Integer Boolean String String Boolean Integer String Integer Boolean String 25 . Maximum number of results to be displayed. When enabled. Method providing suggestions. autoComplete only accepts input from the selection list. Defines whether to trigger ajaxStatus or not. Inline style of the items container element. Label of the item. A method expression that refers to a method validationg the input. Message to be displayed when required field validation fails. A method expression that refers to a method for handling a valuchangeevent. Message to be displayed when conversion fails. Enables dropdown mode when set true. Defines the height of the items viewport. Client side callback to execute after ajax request to load suggestions completes. Name of the iterator used in pojo based suggestion. process validations logic is executed at apply request values phase for this component. Message to be displayed when validation fails. Delay to wait in milliseconds before sending each query to the server.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true. Value of the item. Number of characters to be typed before starting to query. Marks component as required. Client side callback to execute before ajax request to load suggestions begins. Effect to use when showing/hiding suggestions. Duration of effect in milliseconds. Name of the client side widget.

When true. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when a key is released over input element. Valid values are LTR and RTL. Maximum number of characters that may be entered in this field.PrimeFaces Userʼs Guide Name panelStyleClass multiple process accesskey alt autocomplete dir disabled label lang maxlength onblur onchange Default null null null null null null null FALSE null null null null null Type String Boolean String String String String String Boolean String String Integer String String Description Style class of the items container element. enables multiple selection. Client side callback to execute when input element loses focus. 26 onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout null null null null null null null null null String String String String String String String String String . Direction indication for text that does not inherit directionality. Disables input field A localized user presentable name. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when input element receives focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Access key that when pressed transfers focus to the input element. Client side callback to execute when a key is pressed down over input element. Controls browser autocomplete behavior. Component(s) to process on query request. Code describing the language used in the generated markup for this component. Alternate textual description of the input field. Client side callback to execute when input element is double clicked.

text}" completeMethod="#{bean. Since autoComplete is an input component. Position of the input element in the tabbing order. } //getter setter 27 . Flag indicating that this component will prevent changes by the user. Getting Started with AutoComplete Suggestions are loaded by calling a server side completeMethod that takes a single string parameter which is the text entered.PrimeFaces Userʼs Guide Name onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null FALSE null null null null null Type String String String Boolean Integer String String Integer String Description Client side callback to execute when a pointer button is moved onto input element. i++) results. return results. Style class of the input element. for (int i = 0. <p:autoComplete value="#{bean. Client side callback to execute when a pointer button is released over input element.complete}" /> public class Bean { } private String text. Inline style of the input element. it requires a value as usual. Number of characters used to determine the width of the input element. Advisory tooltip informaton. i < 10. public List<String> complete(String query) { List<String> results = new ArrayList<String>(). Client side callback to execute when text within input element is selected by user.add(query + i).

instead of simple strings you would need work with your domain objects. by default there is no limit. public List<Player> complete(String query) { List<Player> players = readPlayersFromDatasource(query). //getter setter Limiting the Results Number of results shown can be limited. Note that when working with pojos. you need to plug-in your own converter.text}" completeMethod="#{bean. } public class Player { } private String name.PrimeFaces Userʼs Guide Pojo Support Most of the time. itemLabel is the label displayed as a suggestion and itemValue is the submitted value. autoComplete supports this common use case with the use of a converter and data iterator.selectedPlayer}" completeMethod="#{playerBean. void setSelectedPlayer(Player selectedPlayer) { this. public } public } Player getSelectedPlayer() { return selectedPlayer. <p:autoComplete value="#{bean. <p:autoComplete value="#{playerBean.complete}" maxResults="5" /> 28 .selectedPlayer = selectedPlayer. return players.name}" itemValue="#{player}" converter="playerConverter"/> public class PlayerBean { } private Player selectedPlayer. Following example loads a list of players.completePlayer}" var="player" itemLabel="#{player.

completePlayer}" var="p" itemValue="#{p}" converter="player"> <p:column> <p:graphicImage value="/images/barca/#{p.complete}" queryDelay="1000" /> Custom Content AutoComplete can display custom content by nesting columns.complete}" dropdown="true" /> 29 .complete}" minQueryLength="3" /> With this setting.#{p. <p:autoComplete value="#{bean.photo}" width="40" height="50"/> </p:column> <p:column> #{p.number} </p:column> </p:autoComplete> Dropdown Mode When dropdown mode is enabled.text}" completeMethod="#{bean. <p:autoComplete value="#{bean. Query Delay AutoComplete is optimized using queryDelay option.name} . give a longer value. a dropdown button is displayed next to the input field.text}" completeMethod="#{bean. <p:autoComplete value="#{autoCompleteBean.selectedPlayer}" completeMethod="#{autoCompleteBean. if you’d like to tune the load balance. suggestions will start when user types the 3rd character at the input field. clicking this button will do a search with an empty query. <p:autoComplete value="#{bean. a regular completeMethod implementation should load all available items as a response. by default autoComplete waits for 300 milliseconds to query a suggestion request. Following autoComplete waits for 1 second after user types an input.text}" completeMethod="#{bean.PrimeFaces Userʼs Guide Minimum Query Length By default queries are sent to the server and completeMethod is called as soon as users starts typing at the input text. This behavior is tuned using the minQueryLength attribute.

Following example demonstrates multiple selection with custom content support.selectedPlayers}" completeMethod="#{autoCompleteBean. Example below demonstrates how to display a message about the selected item instantly.name} ..handleSelect" update="msg" /> </p:autoComplete> <p:messages id=”msg” /> 30 .text}" completeMethod="#{bean.number} </p:column> </p:autoComplete> public class AutoCompleteBean { } private List<Player> selectedPlayers.text-align:center"> <p:graphicImage value="/images/barca/#{p.completePlayer}" var="p" itemLabel="#{p. //.photo}"/> </p:column> <p:column style="width:80%"> #{p.PrimeFaces Userʼs Guide Multiple Selection AutoComplete supports multiple selection as well.complete}"> <p:ajax event="itemSelect" listener="bean. <p:autoComplete value="#{bean.#{p.. you can enable instant ajax selection by using the itemSelect ajax behavior. <p:autoComplete id="advanced" value="#{autoCompleteBean.name}" itemValue="#{p}" converter="player" multiple="true"> <p:column style="width:20%. to use this feature set multiple option to true and define a list as your backend model. Ajax Behavior Events Instead of waiting for user to submit the form manually to process the selected item.

text}" completeMethod="#{bean.complete}" onstart="handleStart(request)" oncomplete="handleComplete(response)" /> onstart callback gets a request parameter and oncomplete gets a response parameter. itemUnselect event is provided for multiple autocomplete when an item is removed by clicking the remove icon.event.primefaces. Client Side Callbacks onstart and oncomplete are used to execute custom javascript before and after an ajax request to load suggestions. focus. mouseover in addition to itemSelect.Unselect instance is passed to a listener if defined.Select instance that contains a reference to the selected item..widget. Client Side API Widget: PrimeFaces. these parameters contain useful information.event.. Similarly. In this case org. FacesMessage msg = new FacesMessage("Selected".PrimeFaces Userʼs Guide public class Bean { } public void handleSelect(SelectEvent event) { Object item = event. For example request is the query string and response is the xhr request sent under the hood.primefaces.getObject(). Note that autoComplete also supports events inherited from regular input text such as blur.AutoComplete Method search(value) close() disable() enable() deactivate() activate() Params value: keyword for search Return Type void void void void void void Description Initiates a search with given value Hides suggested items menu Disables the input field Enables the input field Deactivates search behavior Activates search behavior 31 . Your listener(if defined) will be invoked with an org. } . "Item:" + item). <p:autoComplete value="#{bean.

ui-autocomplete-input . Class . Input field. • Increase query delay to avoid unnecessary load to server as a result of user typing fast. • Enable forceSelection if you’d like to accept values only from suggested list.ui-autocomplete .ui-autocomplete-item .PrimeFaces Userʼs Guide Skinning Following is the list of structural style classes. Highlighted part in suggestions. 32 . Container of suggestions list. Applies As skinning style classes are global. see the main Skinning section for more information.ui-autocomplete-query Container element. List of items Each item in the list. Tips • Do not forget to use a converter when working with pojos.ui-autocomplete-items .ui-autocomplete-panel .

BlockUIRenderer Attributes Name id rendered binding widgetVar Default null TRUE null null Type String Boolean Object String Description Unique identifier of the component.primefaces.component org.blockui.component.primefaces.5 BlockUI BlockUI is used to block JSF components during ajax processing.primefaces.blockui. Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component.PrimeFaces Userʼs Guide 3.BlockUIRenderer org.component.component.BlockUI org.primefaces.BlockUI org. 33 .primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class blockUI org.

<p:blockUI block="pnl" trigger="saveBtn.gif"/> </p:blockUI> 34 . With the special ajax integration.cars}" paginator="true" rows="10"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car. Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received.model}" /> </p:column> //more columns </p:dataTable> <p:blockUI block="dataTable" trigger="dataTable"> LOADING<br /> <p:graphicImage value="/images/ajax-loader.deleteBtn.updateBtn" /> Custom Content In order to display custom content like a loading text and animation.PrimeFaces Userʼs Guide Name trigger block Default null null Type String String Description Identifier of the component(s) to bind. <p:dataTable id="dataTable" var="car" value="#{tableBean. Getting Started with BlockUI BlockUI requires trigger and block attributes to be defined. Identifier of the component to block. ajax requests whose source is trigger components will block the ui onstart and unblock oncomplete. <p:panel id="pnl" header="My Panel"> //content <p:commandButton id="saveBtn" value="Save" /> </p:panel> <p:blockUI block="pnl" trigger="saveBtn" /> Multiple triggers are defined as a comma separated list. place the content inside the blockUI.

Class . see the main Skinning section for more information. Tips • BlockUI does not support absolute and fixed positioned components at the moment.ui-blockui-content Container element.ui-blockui . e. 35 . dialog.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Applies As skinning style classes are global.widget. Container for custom content. Unblocks the UI Skinning Following is the list of structural style classes.BlockUI Method block() unblock() Params Return Type void void Description Blocks the UI.g.

component.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class breadCrumb org.primefaces.6 BreadCrumb Breadcrumb is a navigation component that provides contextual information about page hierarchy in the workflow.component.primefaces.breadcrumb.BreadCrumbRenderer org.primefaces. <p:breadCrumb> <p:menuitem label="Categories" url="#" /> <p:menuitem label="Sports" url="#" /> //more menuitems </p:breadCrumb> 36 .primefaces.PrimeFaces Userʼs Guide 3.breadcrumb.BreadCrumb org.component org.BreadCrumb org.primefaces. Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. MenuModel instance to create menus programmatically Style of main container element.BreadCrumbRenderer Attributes Name id rendered binding widgetVar model style styleClass Default null TRUE null null null null null Type String Boolean Object String MenuModel String String Description Unique identifier of the component. Style class of main container Getting Started with BreadCrumb Steps are defined as child menuitem components in breadcrumb.

Style Class . use model option instead of creating declarative p:menuitem components and bind your MenuModel representing the state of the flow. do not define the url option.ui-breadcrumb-chevron Applies Main breadcrumb container element. If you’d like to use menuitem to execute command with or without ajax. if it is defined. Following is the list of structural style classes. Skinning Breadcrumb resides in a container element that style and styleClass options apply. see the dynamic menus part in menu component section for more information and an example.ui-menu-item-link .ui-breadcrumb . 37 . it will work as a simple link. see the main Skinning section for more information. breadcrumb must be nested in a form.ui-breadcrumb .PrimeFaces Userʼs Guide Dynamic Menus Menus can be created programmatically as well. Each menuitem.ui-breadcrumb . • Breadcrumb can do ajax/non-ajax action requests as well since p:menuitem has this option. Tips • If there is a dynamic flow.ui-menu-item-text . • url option is the key for a menuitem. In this case. As skinning style classes are global. Each menuitem label. Seperator of menuitems.

Used to resolve a navigation case.7 Button Button is an extension to the standard h:button component with skinning capabilities.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class button org. Disables button.primefaces. Alternate textual description. (deprecated: use icon) 38 .primefaces. Style class for the button icon. Direction indication for text that does not inherit directionality. Value of the component than can be either an EL expression of a literal text.Button org.component. An el expression that maps to a server side UIComponent instance in a backing bean.button.component.ButtonRenderer org.ButtonRenderer Attributes Name id rendered binding widgetVar value outcome includeViewParams fragment disabled accesskey alt dir image Default null TRUE null null null null FALSE null FALSE null null null null Type String Boolean Object String Object String Boolean String Boolean String String String String Description Unique identifier of the component. Name of the client side widget.primefaces.component org.PrimeFaces Userʼs Guide 3.primefaces. Boolean value to specify the rendering of the component.Button org. Access key that when pressed transfers focus to button. Valid values are LTR and RTL. Whether to include page parameters in target URI Identifier of the target page which should be scrolled to.component.button.

Makes button read only. Client side callback to execute when button is double clicked. Position of the button icon. Client side callback to execute when button is clicked. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Client side callback to execute when a pointer button is released over button. Position in the tabbing order. Style class of the button. Client side callback to execute when button loses focus. Client side callback to execute when a key is pressed down over button. Resource to link directly to implement anchor behavior. Icon of the button. Advisory tooltip informaton. Client side callback to execute when a key is released over button. Client side callback to execute when a pointer button is moved within button Client side callback to execute when a pointer button is moved away from button.PrimeFaces Userʼs Guide Name lang onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup style styleClass readOnly tabindex title href icon iconPos Default null null null null null null null null null null null null null null null null FALSE null null null null left Type String String String String String String String String String String String String String String String String Boolean Integer String String String String Description Code describing the language used in the generated markup for this component. Client side callback to execute when a pointer button is pressed down over button. Inline style of the button. Client side callback to execute when a key is pressed and released over button. Client side callback to execute when button receives focus. 39 .

ui-button .xhtml. <p:button outcome="target" value="Navigate"/> Parameters Parameters in URI are defined with nested <f:param /> tags. an outcome is necessary to navigate using GET requests. Style Class .xhtml and need to navigate target.ui-button-text Button element Button element when icon is not used Label of button Applies As skinning style classes are global. You can also use icons from PrimeFaces themes. if you use title instead of value. Following is the list of structural style classes. Assume you are at source. 40 .png").star { background-image: url("images/star. <p:button outcome="target" icon="star" value="With Icon"/> <p:button outcome="target" icon="star" title="With Icon"/> . see the main Skinning section for more information.PrimeFaces Userʼs Guide Getting Started with Button p:button usage is same as standard h:button. } Skinning Button renders a button tag which style and styleClass applies. only icon will be displayed and title text will be displayed as tooltip on mouseover. <p:button outcome="target" value="Navigate"> <f:param name="id" value="10" /> </p:button> Icons Icons for button are defined via css and icon attribute.ui-button-text-only .

Calendar org.component. it must refer to a converter id When set true.primefaces. localization. it’s resolved to a converter instance.8 Calendar Calendar is an input component used to select a date featuring display modes.calendar.primefaces.primefaces. ajax selection and more. paging. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class calendar org. process validations logic is executed at apply request values phase for this component. In case it’s a static text.calendar.PrimeFaces Userʼs Guide 3.component org.util.Calendar org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component An el expression or a literal text that defines a converter for the component.component.CalendarRenderer org.primefaces.component. When it’s an EL expression.CalendarRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object java.Date Converter/ String Description Unique identifier of the component Boolean value to specify the rendering of the component. 41 immediate FALSE Boolean .component.primefaces.

Enables month/year navigator String or a java. popup icon is rendered without the button. Client side event that displays the popup calendar. Message to be displayed when validation fails. Message to be displayed when conversion fails. Duration of the effect. Effect to use when displaying and showing the popup calendar. Visibility of button panel containing today and done buttons. Defines how the calendar will be displayed. defaults to TimeZone.PrimeFaces Userʼs Guide Name required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar mindate maxdate pages disabled mode pattern locale popupIcon popupIconOnly navigator timeZone Default FALSE null null null null null null null null int FALSE popup MM/dd/ yyyy null null FALSE FALSE null Type Boolean MethodExpr MethodExpr String String String String Date or String Date or String 1 Boolean String String Locale/String String Boolean Boolean TimeZone Description Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Name of the client side widget. readOnlyInputText showButtonPanel effect effectDuration showOn FALSE FALSE null normal both Boolean Boolean String String String 42 .util. Sets calendar's minimum visible date Sets calendar's maximum visible date Enables multiple page rendering.TimeZone instance to specify the timezone used for date conversion. DateFormat pattern for localization Locale to be used for labels and conversion. Icon of the popup button When enabled.getDefault () Makes input text of a popup calendar readonly. Disables the calendar when set to true.

Enables selection of days belonging to other months. Maximum number of characters that may be entered in this field. Disables weekend columns. default "c-10:c +10" Shows only timepicker without date. Direction indication for text that does not inherit directionality. Maximum boundary for second selection. label lang maxlength onblur null null null null String String Integer String 43 . Alternate textual description of the input field. Minimum boundary for second selection.PrimeFaces Userʼs Guide Name showWeek disabledWeekends showOtherMonths selectOtherMonths yearRange timeOnly stepHour stepMinute stepSecond minHour maxHour minMinute maxMinute minSecond maxSecond pagedate accesskey alt autocomplete dir Default FALSE FALSE FALSE FALSE null FALSE 1 1 1 0 23 0 59 0 59 null null null null null Type Boolean Boolean Boolean Boolean String Boolean Integer Integer Integer Integer Integer Integer Integer Integer Integer Object String String String String Description Displays the week number next to each week. Second steps. Minute steps. Displays days belonging to other months. Maximum boundary for hour selection. Controls browser autocomplete behavior. Maximum boundary for hour selection. Hour steps. Valid values are LTR and RTL. Initial date to display if value is null. Minimum boundary for minute selection. Year range for the navigator. Minimum boundary for hour selection. Code describing the language used in the generated markup for this component. A localized user presentable name. Client side callback to execute when input element loses focus. Access key that when pressed transfers focus to the input element.

Client side callback to execute when a key is pressed down over input element.PrimeFaces Userʼs Guide Name onchange Default null Type String Description Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when a pointer button is released over input element. Client side callback to execute before displaying a date. Client side callback to execute when a key is released over input element. used to customize date display. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when input element receives focus. Flag indicating that this component will prevent changes by the user. Client side callback to execute when input element is double clicked. Client side callback to execute when text within input element is selected by user. Advisory tooltip informaton. Client side callback to execute when a pointer button is moved onto input element. Position of the input element in the tabbing order. onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown null null null null null null null String String String String String String String onmousemove null String onmouseout null String onmouseover onmouseup onselect readonly size tabindex title beforeShowDay null null null FALSE null null null null String String String Boolean Integer Integer String String 44 . Client side callback to execute when input element is clicked. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Number of characters used to determine the width of the input element.

<p:calendar value="#{dateBean.Date.date}"/> public class DateBean { } private Date date.PrimeFaces Userʼs Guide Getting Started with Calendar Value of the calendar should be a java. Inline <p:calendar value="#{dateBean.util.date}" mode="popup" /> 45 . //Getter and Setter Display Modes Calendar has two main display modes.date}" mode="inline" /> Popup <p:calendar value="#{dateBean. popup (default) and inline.

date}" mode="popup" showOn="button" /> Popup Icon Only <p:calendar value="#{dateBean.date}" mode="popup" showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month.PrimeFaces Userʼs Guide showOn option defines the client side event to display the calendar. • focus: When input field receives focus • button: When popup button is clicked • both: Both focus and button cases Popup Button <p:calendar value="#{dateBean. <p:calendar value="#{dateController. This feature is tuned with the pages attribute.date}" pages="3"/> 46 . Valid values are.

primefaces. we suggest adding the code to a javascript file and include in your application.util.MM. PrimeFaces Wiki Page for PrimeFacesLocales is a community driven page where you may find the translations you need.yyyy"/> <p:calendar value="#{dateController.date2}" pattern="yy.js” /> <p:calendar value="#{dateController.date3}" pattern="EEE.PrimeFaces Userʼs Guide Localization By default locale information is retrieved from the view’s locale and can be overridden by the locale attribute. Locale attribute can take a locale key as a String or a java. Default language of labels are English and you need to add the necessary translations to your page manually as PrimeFaces does not include language translations. dd MMM. <h:outputScript name=”path_to_your_translations.org/display/Components/PrimeFaces+Locales Translation is a simple javascript object. M. use the pattern option. d"/> <p:calendar value="#{dateController. <p:calendar value="#{dateController.date}" locale="tr" navigator="true" showButtonPanel="true"/> To override calculated pattern from locale. http://wiki.Locale instance. Following is a Turkish calendar.date1}" pattern="dd. yyyy"/> 47 . Please contribute to this wiki with your own translations.

//Add facesmessage } In popup mode.event. If you define a method as a listener. options are. selectable dates can be restricted.date}" mode="inline" mindate="07/10/2010" maxdate="07/15/2010"/> 48 . <p:calendar value="#{dateBean.Date. calendar also supports regular ajax behavior events like blur. • • • • • • • • • show slideDown fadeIn blind bounce clip drop fold slide Ajax Behavior Events Calendar provides a dateSelect ajax behavior event to execute an instant ajax selection whenever a date is selected.date}"> <p:ajax event=”dateSelect” listener=”#{bean. <p:calendar value="#{calendarBean. it will be invoked by passing an org. keyup and more.getDate(). Values for these attributes can either be a string or a java.PrimeFaces Userʼs Guide Effects Various effects can be used when showing and hiding the popup calendar.primefaces.util. Date Ranges Using mindate and maxdate options.DateSelectEvent instance.handleDateSelect}” update=”msg” /> </p:calendar> <p:messages id="msg" /> public void handleDateSelect(DateSelectEvent event) { Date date = event.

first one is flag to indicate if date would be displayed as enabled and second parameter is the optional style class to add to date cell. <p:calendar value="#{dateBean.PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly. <p:calendar value="#{dateBean. The function returns an array with two values.date}" mode="inline" navigator="true" /> TimePicker TimePicker functionality is enabled by adding time format to your pattern. Following example disabled tuesdays and fridays.date}" pattern=”MM/dd/yyyy HH:mm” /> Advanced Customization Use beforeShowDay javascript callback to customize the look of each date. 49 .

ui-datepicker-month . Style Class .ui-datepicker-table .PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.ui-datepicker td .ui-datepicker-other-month .ui-datepicker-title . Following is the list of structural style classes.ui-datepicker-week-end .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.Calendar Method getDate() setDate(date) disable() enable() Params date: Date to display Return Type Date void void void Description Return selected date Sets display date Disables calendar Enables calendar Skinning Calendar resides in a container element which style and styleClass options apply.ui-datepicker-header .ui-datepicker-prev .widget.ui-datepicker-buttonpane Main container Header container Previous month navigator Next month navigator Title Month display Date table Label of weekends Dates belonging to other months Each cell date Button panel 50 Applies .ui-datepicker-next .getDay().ui-datepicker . ''] } Client Side API Widget: PrimeFaces.   return [(day != 2 && day != 5).

51 .ui-datepicker-current .ui-datepicker-close Today button Close button Applies As skinning style classes are global.PrimeFaces Userʼs Guide Style Class . see the main Skinning section for more information.

Marks component as required. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class captcha org. Boolean value to specify the rendering of the component. 52 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required FALSE Boolean .captcha.component.captcha.Captcha org. An el expression or a literal text that defines a converter for the component.Captcha org.CaptchaRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. An el expression that maps to a server side UIComponent instance in a backing bean.component org.primefaces. it’s resolved to a converter instance.primefaces.component. When it’s an EL expression.primefaces.9 Captcha Captcha is a form validation component based on Recaptcha API. When set true.component. it must refer to a converter id.primefaces.PrimeFaces Userʼs Guide 3. Value of the component than can be either an EL expression of a literal text.component. In case it’s a static text.CaptchaRenderer org.primefaces. process validations logic is executed at apply request values phase for this component.

<p:captcha /> 53 . Position of the input element in the tabbing order. Public recaptcha key for a specific domain (deprecated) Theme of the captcha.PRIVATE_CAPTCHA_KEY</param-name> <param-value>YOUR_PRIVATE_KEY</param-value> </context-param> <context-param> <param-name>primefaces. Message to be displayed when validation fields. add them to web. User presentable field name. <context-param> <param-name>primefaces.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage publicKey theme language tabindex label secure Default null null null null null null red en null null FALSE Type MethodExpr ValueChange Listener String String String String String String Integer String Boolean Description A method binding expression that refers to a method validationg the input. Enables https support Getting Started with Captcha Catpcha is implemented as an input component with a built-in validator that is integrated with reCaptcha.PUBLIC_CAPTCHA_KEY</param-name> <param-value>YOUR_PUBLIC_KEY</param-value> </context-param> That is it. Once you have the keys for your domain. now you can use captcha as follows. Message to be displayed when required field validation fails.xml as follows. First thing to do is to sign up to reCaptcha to get public&private keys. A method binding expression that refers to a method for handling a valuchangeevent. Key of the supported languages. Message to be displayed when conversion fails.

• Enable secure option to support https otherwise browsers will give warnings.INVALID_detail Tips • Use label option to provide readable error messages in case validation fails. Below is a captcha with Turkish text.captcha. Summary Detail primefaces. • • • • red (default) white blackglass clean Themes are applied via the theme attribute. <p:captcha theme="white"/> Languages Text instructions displayed on captcha is customized with the language attribute.google.captcha.INVALID primefaces. <p:captcha language="tr"/> Overriding Validation Messages By default captcha displays it’s own validation messages.com/recaptcha/learnmore to learn more about how reCaptcha works.PrimeFaces Userʼs Guide Themes Captcha features following built-in themes for look and feel customization. 54 . • See http://www. this can be easily overridden by the JSF message bundle mechanism. Corresponding keys are.

CarouselRenderer org.component. An el expression that maps to a server side UIComponent instance in a backing bean A value expression that refers to a collection Name of the request scoped iterator Number of visible items per page Index of the first element to be displayed Name of the client side widget.component.component. when set to false component will not be rendered.primefaces.CarouselRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.carousel.primefaces.Carousel org.component.10 Carousel Carousel is a multi purpose component to display a set of data or general content with slide effects.primefaces. Sets continuous scrolling Sets vertical scrolling binding value var rows first widgetVar circular vertical null null null 3 0 null FALSE FALSE Object Object String Integer Integer String Boolean Boolean 55 .component org.primefaces.carousel.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class carousel org.Carousel org.

String model. String manufacturer. public class Car { } private private private private . public } CarListController() { cars = new ArrayList<Car>(). Getting Started with Carousel Calendar has two main use-cases. Label for footer. //add more cars //getter setter 56 . String color. data and general content display.. Template string for dropdown of paginator. could be “fade” or “slide”.. "blue")). int year.. Inline style of the component. Style class of each item. "ManufacturerX".add(new Car("myModel". Name of the easing animation.PrimeFaces Userʼs Guide Name autoPlayInterval pageLinks effect easing effectDuration dropdownTemplate.. To begin with data iteration let’s use a list of cars to display with carousel. Label for header. Duration of the animation in milliseconds. public class CarBean { } private List<Car> cars. 2005. style styleClass itemStyle itemStyleClass headerText footerText Default 0 3 slide easeInO utCirc 500 {page} null null null null null null Type Integer Integer String String Integer String String String String String String String Description Sets the time in milliseconds to have Carousel start scrolling automatically after being initialized Defines the number of page links of paginator. Name of the animation. cars. Style class of the component. Inline style of each item.

cars}" var="car" rows="1" itemStyle=”width:200px” > .color}" /> </p:carousel> Carousel iterates through the cars collection and renders it’s children for each car..PrimeFaces Userʼs Guide <p:carousel value="#{carBean. Limiting Visible Items Bu default carousel lists it’s items in pages with size 3. <p:carousel value="#{carBean. This is customizable with the rows attribute. • • • • • • • • • • • • • • • • backBoth backIn backOut bounceBoth bounceIn bounceOut easeBoth easeBothStrong easeIn easeInStrong easeNone easeOut easeOutStrong elasticBoth elasticIn elasticOut 57 . </p:carousel> Effects Paging happens with a slider effect by default and following easing options are supported. note that you also need to define a width for each item.model}" /> <h:outputText value="Year: #{car.manufacturer}.year}" /> <h:outputText value="Color: #{car..cars}" var="car" itemStyle=”width:200px”> <p:graphicImage value="/images/cars/#{car.jpg"/> <h:outputText value="Model: #{car.

Following carousel displays a collection of images as a slideshow..jpg"/> <p:graphicImage value="/images/nature3. <p:carousel rows="1" itemStyle="height:200px.PrimeFaces Userʼs Guide Note: Easing names are case sensitive and incorrect usage may result in javascript errors SlideShow Carousel can display the contents in a slideshow.jpg"/> </p:carousel> Content Display Another use case of carousel is tab based content display.jpg"/> <p:graphicImage value="/images/nature2. <p:carousel autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” > <p:graphicImage value="/images/nature1.jpg" /> <h:outputText value="After a break of ..width:600px.jpg"/> <p:graphicImage value="/images/nature4."/> </h:panelGrid> </p:tab> <p:tab title="Godfather Part III"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather3.." /> </h:panelGrid> </p:tab> </p:carousel> 58 .jpg" /> <h:outputText value="The story begins as Don Vito .jpg" /> <h:outputText value="Francis Ford Coppola's . for this purpose autoPlayInterval and circular attributes are used."> <p:tab title="Godfather Part I"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather1...." /> </h:panelGrid> </p:tab> <p:tab title="Godfather Part II"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather2.

selected}" /> </p:commandLink> </p:column> </p:carousel> <p:dialog widgetVar="dlg"> <h:outputText id="detail" value="#{carBean.jpg"/> <p:commandLink update=":form:detail" oncomplete="dlg. Following is the list of structural style classes.PrimeFaces Userʼs Guide Item Selection When selecting an item from a carousel with a command component.model}" /> <f:setPropertyActionListener value="#{car}" target="#{carBean.ui-carousel-header . Skinning Carousel resides in a container element which style and styleClass options apply. Style Class . //getters and setters Header and Footer Header and Footer of carousel can be defined in two ways either. Following example displays selected car contents within a dialog.cars}" var="car" itemStyle=”width:200px” > <p:column> <p:graphicImage value="/images/cars/#{car.selected}" /> </p:dialog> </h:form> public class CarBean { } private List<Car> cars. <h:form id=”form"> <p:carousel value="#{carBean.ui-carousel-header-title Main container Header container Header content 59 Applies . p:column is necessary to process selection properly.manufacturer}. using headerText and footerText options that take simple strings as labels or by header and footer facets that can take any custom content. itemStyle and itemStyleClass attributes apply to each item displayed by carousel.ui-carousel . private Car selected.show()"> <h:outputText value="Model: #{car.

60 .ui-carousel-item Content container Navigation buttons Applies Next navigation button of paginator Prev navigation button of paginator Page links of paginator. Each page link of paginator.ui-carousel-page-links .ui-carousel-prev-button . As skinning style classes are global. Each item.ui-carousel-viewport .ui-carousel-button . see the main Skinning section for more information.ui-carousel-next-button .ui-carousel-page-link .PrimeFaces Userʼs Guide Style Class . Tips • Carousel is a NamingContainer. make sure you reference components outside of carousel properly following conventions.

when set to false component will not be rendered.component org.component.primefaces.celleditor.component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with CellEditor See inline editing section in datatable documentation for more information about usage.11 CellEditor CellEditor is a helper component of datatable used for incell editing.primefaces.CellEditor org.CellEditorRenderer org.celleditor. 61 .CellEditorRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.primefaces.component.PrimeFaces Userʼs Guide 3.CellEditor org.

1 Pie Chart Pie chart displays category-data pairs in a pie graphic. Title of the chart. 62 binding widgetVar value style styleClass title legendPosition seriesColors diameter sliceMargin fill null null null null null null null null null 0 TRUE Object String ChartModel String String String String String Integer Integer Boolean .chart.component org. auto computed by default.primefaces. Position of the legend.component. There’re various chart types like pie.primefaces.chart.primefaces.component.chart.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pieChart org. Render solid slices.12. Gap between slices.PrimeFaces Userʼs Guide 3. Comma separated list of colors in hex format.PieChartRenderer org.PieChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.pie. bar.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.12 Charts Charts are used to display graphical data.PieChart org.pie. when set to false component will not be rendered. Diameter of the pie.component. Style class of the chart.component.primefaces. 3. line and more.PieChart org.

702). public class Bean { } private PieChartModel model. Displays data on each slice. public PieChartModel getModel() { return model.model}" legendPosition=”w” /> 63 .primefaces. model. 540).set("Brand 1".set("Brand 2". 421). Specifies interactive legend. model. } <p:pieChart value="#{bean.PieChartModel instance. Getting started with PieChart PieChart is created with an org. model. 325). model.set("Brand 3".model.set("Brand 4". Format of data labels. public } Bean() { model = new PieChartModel().chart.PrimeFaces Userʼs Guide Name shadow showDataLabels enhancedLegend dataFormat Default TRUE FALSE TRUE percent Type Boolean Boolean Boolean String Description Shows shadow or not.

sliceMargin and diameter.PrimeFaces Userʼs Guide Customization PieChart can be customized using various options such as fill.model}" legendPosition=”e” sliceMargin=”5” diameter=”150” fill=”false”/> 64 . <p:pieChart value="#{bean. here is an example.

line. Comma separated list of colors in hex format.2 Line Chart Line chart visualizes one or more series of data in a line graph.LineChartRenderer org. Maximum Y axis value.line.component.primefaces. Position of the legend.12. Maximum X axis value.chart. binding value widgetVar style styleClass title legendPosition minY maxY minX maxX breakOnNull seriesColors null null null null null null null null null null null FALSE null Object ChartModel String String String String String Double Double Double Double Boolean String 65 .primefaces.component.component. An el expression that maps to a server side UIComponent instance in a backing bean Datasource to be displayed on the chart Name of the client side widget Inline style of the chart.chart. when set to false component will not be rendered. fall will join point on either side of line. Minimum X axis value.primefaces.PrimeFaces Userʼs Guide 3.component org.chart. Whether line segments should be broken at null value.primefaces.LineChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.LineChart org.component.chart. Title of the chart.LineChart org. Style class of the chart.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lineChart org. Minimum Y axis value.

} public } ChartBean() { model = new CartesianChartModel(). Whether to fill under lines. Label of the x-axis. 60).setLabel("Boys"). boys. girls.CartesianChartModel instance. //. Displays markers at data points. ChartSeries girls = new ChartSeries(). Angle of the y-axis ticks. 52). public CartesianChartModel getModel() { return model. public class Bean { private CartesianChartModel model.PrimeFaces Userʼs Guide Name shadow fill stacked showMarkers fillToZero xaxisLabel yaxisLabel xaxisAngle yaxisAngle enhancedLegend Default TRUE FALSE FALSE TRUE FALSE null null null null TRUE Type Boolean Boolean Boolean Boolean Boolean String String Integer Integer Boolean Description Shows shadow or not. True will force filled series to fill toward zero.chart. //.. Specifies interactive legend. Getting started with LineChart LineChart is created with an org.addSeries(boys). 120).primefaces.set("2004". girls.. model.model. Whether to stack series..set("2005".set("2005". girls. Label of the y-axis..setLabel("Girls"). Angle of the x-axis ticks. boys. ChartSeries boys = new ChartSeries(). boys.addSeries(girs).set("2004". } 66 . model. 100).

model}" legendPosition="e" /> AreaChart AreaCharts is implemented by enabling stacked and fill options.PrimeFaces Userʼs Guide <p:lineChart value="#{chartBean.model}" legendPosition="ne" fill=”true” stacked=”true”/> 67 . <p:lineChart value="#{bean.

Style class of the chart.component.primefaces.bar. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org.component org.primefaces.3 Bar Chart Bar chart visualizes one or more series of data using bars.BarChart org.primefaces.chart. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. valid values are “vertical” and “horizontal”. Margin of bars. Orientation of bars.component.BarChart org.component.chart.primefaces.BarChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Position of the legend.bar. Title of the chart.chart. Enables stacked display of bars. Minimum boundary value.PrimeFaces Userʼs Guide 3.chart.BarChartRenderer org.12. binding widgetVar value style styleClass title legendPosition barPadding barMargin orientation stacked min max null null null null null null null 8 10 vertical FALSE null null Object String ChartModel String String String String Integer Integer String Boolean Double Double 68 .component. Maximum boundary value.primefaces. Padding of bars.

<p:barChart value="#{bean.primefaces. Reusing the same model sample from lineChart section.model}" legendPosition="ne" /> Orientation Bars can be displayed horizontally using the orientation attribute. <p:barChart value="#{bean.CartesianChartModel instance. Getting Started with Bar Chart BarChart is created with an org. Specifies interactive legend. Comma separated list of colors in hex format. Angle of the x-axis ticks.model}" legendPosition="ne" orientation=”horizontal” /> 69 . Label of the y-axis. Angle of the y-axis ticks.PrimeFaces Userʼs Guide Name breakOnNull seriesColors shadow enhancedLegend xaxisLabel yaxisLabel xaxisAngle yaxisAngle Default FALSE null TRUE TRUE null null null null Type Boolean String Boolean Boolean String String Integer Integer Description Whether line segments should be broken at null value. fall will join point on either side of line.chart.model. Shows shadow or not. Label of the x-axis.

. <p:barChart value="#{bean.model}" legendPosition="se" stacked=”true” /> 70 .PrimeFaces Userʼs Guide Stacked BarChart Enabling stacked option displays bars in stacked format.

component.component.primefaces. Title of the chart. Comma separated list of colors in hex format. Specifies interactive legend.component.component.DonutChartRenderer org.4 Donut Chart DonutChart is a combination of pie charts. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class donutChart org. Style class of the chart. Render solid slices. Gap between slices. Shows shadow or not.primefaces.donut.DonutChart org.chart.primefaces.DonutChart org. Format of data labels.12.chart. 71 binding widgetVar value style styleClass title legendPosition seriesColors sliceMargin fill shadow showDataLabels dataFormat enhancedLegend null null null null null null null null 0 TRUE TRUE FALSE percent TRUE Object String ChartModel String String String String String Integer Boolean Boolean Boolean String Boolean . Displays data on each slice.component org.PrimeFaces Userʼs Guide 3.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.chart.primefaces. Position of the legend.chart.donut. when set to false component will not be rendered.DonutChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

circle2.addCircle(circle2). circle2. 10). 540). 325). Number> circle3 = new LinkedHashMap<String.put("Brand 3". circle3.put("Brand 3". 125). circle3.put("Brand 3".put("Brand 1". Number>().put("Brand 1".put("Brand 2".addCircle(circle1). 402).DonutChartModel instance. circle1. 150). circle1. Number>().put("Brand 4".put("Brand 2".model}" legendPosition=”w” /> 72 . 702). Number> circle1 = new LinkedHashMap<String. Map<String. public class Bean { private DonutChart model. circle1.model. circle2.primefaces. donutModel. circle1. 421). donutModel. Number> circle2 = new LinkedHashMap<String. 400).put("Brand 2".put("Brand 4". } } public DonutChart getModel() { return model.put("Brand 4". circle3. 200).put("Brand 1". circle2. Number>().PrimeFaces Userʼs Guide Getting started with DonutChart PieChart is created with an org. } Map<String.chart. <p:donutChart value="#{bean. Map<String. 40). public Bean() { model = new DonutChart().addCircle(circle3). 421). donutModel. circle3.

PrimeFaces Userʼs Guide Customization DonutChart can be customized using various options.model}" legendPosition=”e” sliceMargin=”5” showDataLabels=”true” dataFormat=”value” shadow=”false”/> 73 . <p:donutChart model="#{bean.

component.primefaces. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. Shows shadow or not.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.primefaces.chart.component.component.chart. Enables gradient fills instead of flat colors.primefaces.primefaces.PrimeFaces Userʼs Guide 3.BubbleChart org.chart. Comma separated list of colors in hex format. Label of the x-axis. Title of the chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org. Displays labels on buttons.primefaces.bubble. Alpha transparency of a bubble. 74 binding widgetVar value style styleClass title legendPosition shadow seriesColors enhancedLegend bubbleGradients bubbleAlpha showLabels xaxisLabel null null null null null null null TRUE null TRUE FALSE 70 TRUE null Object String ChartModel String String String String Boolean String Boolean Boolean Integer Boolean String .BubbleChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org.12. Specifies interactive legend.BubbleChart org.chart.bubble.component. Style class of the chart.BubbleChartRenderer org. Position of the legend.

50. 15. public class Bean { private BubbleChartModel model. 24. 104. <p:bubbleChart value="#{bean. 45. } BubbleChartSeries("Acura". 183. Description Angle of the x-axis ticks. BubbleChartSeries("Bugatti". 70.55)). bubbleModel. BubbleChartSeries("AM General".PrimeFaces Userʼs Guide Name yaxisLabel xaxisAngle yaxisAngle Default null null null Type String Integer Integer Label of the y-axis. 48)).primefaces. 123. 40)). BubbleChartSeries("BMW". 36)). 40.model}" xaxisLabel=”Price” yaxisLabel=”Sales” title=”Sample Bubble Chart”/> 75 . 180. 80)). 25)). 60)).chart.addBubble(new bubbleModel. public Bean() { bubbleModel = new BubbleChartModel().addBubble(new } } public BubbleChartModel getModel() { return model. 92. Angle of the y-axis ticks.addBubble(new bubbleModel.addBubble(new bubbleModel. BubbleChartSeries("Alfa Romeo". 70. 70. BubbleChartSeries("AstonMartin". Getting started with BubbleChart PieChart is created with an org.model. BubbleChartSeries("Audi".addBubble(new bubbleModel.addBubble(new bubbleModel.BubbleChartModel instance. 89.addBubble(new bubbleModel.

model}" bubbleGradients=”true” shadow=”false” title=”Custom Bubble Chart” showLabels=”false” bubbleAlpha=”100” xaxisAngle=”-50” yaxisAngle=”50” /> 76 . <p:bubbleChart value="#{bean.PrimeFaces Userʼs Guide Customization BubbleChart can be customized using various options.

OhlcChart org. Style class of the chart.component. Specifies interactive legend.primefaces. Title of the chart.PrimeFaces Userʼs Guide 3. Angle of the x-axis ticks.component.primefaces. 77 binding widgetVar value style styleClass title legendPosition seriesColors enhancedLegend candleStick xaxisLabel yaxisLabel xaxisAngle yaxisAngle null null null null null null null null TRUE FALSE null null null null Object String ChartModel String String String String String Boolean Boolean String String Integer Integer .chart. Comma separated list of colors in hex format. Angle of the y-axis ticks.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.ohlc.chart. Label of the x-axis.12.chart.OhlcChartRenderer org.primefaces.OhlcChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org. Position of the legend.6 Ohlc Chart An open-high-low-close chart is a type of graph typically used to visualize movements in the price of a financial instrument over time. Enables candle stick display mode.primefaces.ohlc.component.component.chart. Label of the y-axis. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.OhlcChart org.

135.01.81)).143.addRecord(new ohlcModel.139. <p:ohlcChart value="#{bean.46.addRecord(new ohlcModel.139.135.123.139.142.addRecord(new ohlcModel.124.addRecord(new } //getter } OhlcChartSeries(2007.140.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .143.121.7.73.31.144.02)).04.68.66.135.OhlcChartModel instance.5.44)). OhlcChartSeries(2011.chart.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.53.124.4)).56.82. public Bean() { model = new OhlcChartModel().136.132.9. OhlcChartSeries(2012.143.primefaces.57.55.addRecord(new ohlcModel.144.136.56.139. OhlcChartSeries(2009.5)).88.122. OhlcChartSeries(2010.135. OhlcChartSeries(2012.67. <p:ohlcChart value="#{bean.48)). ohlcModel.140. OhlcChartSeries(2008.129.18.134.model.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.138.79.76.136.addRecord(new ohlcModel. public class Bean { private OhlcChartModel model.addRecord(new ohlcModel.97)).

MeterGaugeChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.component org.chart.primefaces. Number of pixels to offset the label up and down.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. binding widgetVar value style styleClass title legendPosition seriesColors enhancedLegend showTickLabels labelHeightAdjust intervalOuterRadius null null null null null null null null TRUE TRUE -25 85 Object String ChartModel String String String String String Boolean Boolean Integer Integer 79 . Title of the chart.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered. Position of the legend. Radius of the outer circle of the internal ring.MeterGaugeChartRenderer org.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class meterGaugeChart org.MeterGauge org.component.chart. Specifies interactive legend.MeterGaugeChart org.7 MeterGauge Chart MeterGauge chart visualizes data on a meter gauge display. Displays ticks around gauge.component.12.chart. Comma separated list of colors in hex format.chart.metergauge. Style class of the chart.metergauge.primefaces.component.

add(50).PrimeFaces Userʼs Guide Getting started with MeterGaugeChart PieChart is created with an org. <p:meterGaugeChart value="#{bean. 140. add(220). } } public MeterGaugeChartModel getModel() { return model. cc6666" /> 80 . <p:meterGaugeChart value="#{bean. intervals). public Bean() { List<Number> intervals = new ArrayList<Number>(){{ add(20).model}" showTickLabels=”false” labelHeightAdjust=”110” intervalOuterRadius=”110” seriesColors="66cc66. 93b75f. } model = new MeterGaugeChartModel("km/h".MeterGaugeChartModel instance. }}.chart.model}" /> Customization MeterGaugeChart can be customized using various options.model.primefaces. public class Bean { private MeterGaugeChartModel model. E7E658. add(120).

x-axis.jqplot-highlighter-tooltip div.jqplot-x2axis. <p:pieChart value="#{bean. Following is the list of style classes.jqplot-y2axis.jqplot-axis . .jqplot-y2axis-tick table. Axis ticks. Axes. Legend table.. Primary x-axis..8 Skinning Charts Charts are built on top of jqlot javascript library that uses a canvas tag and can be styled using regular css.model}" seriesColors="66cc66.jqplot-x3axis . E7E658. Primary x-axis ticks.jqplot-y3axis .jqplot-table-legend . Secondary x-axis ticks. Primary y-axis-ticks. Style Class ..jqplot-axis-tick . .jqplot-xaxis .jqplot-yaxis-tick . Applies Additionally style and styleClass options of charts apply to the container element of charts..12. use the seriesColors options. 93b75f. <p:pieChart value="#{bean.jqplot-table-legend-swatch Plot target container. 3rd .jqplot-xaxis-tick . use these attribute to specify the dimensions of a chart..jqplot-x2axis-tick . cc6666" /> 81 .jqplot-title . 2nd. . Primary y-axis. Cursor tooltip. Seconday y-axis-ticks. 3rd .jqplot-target . Title of the chart.jqplot-yaxis .. Highlighter tooltip.model}" style=”width:320px.jqplot-cursor-tooltip ..height:200px” /> In case you’d like to change the colors of series.PrimeFaces Userʼs Guide 3. . y-axis.. Colors swatch of the legend. 2nd.

ItemSelectEvent instance. In case you have a listener defined.addMessage(null.getItemIndex()). Example above demonstrates how to display a message about selected series in chart.getCurrentInstance().setSummary("Item Index: " + event. msg.event. msg). it’ll be executed by passing an org.9 Ajax Behavior Events itemSelect is one and only ajax behavior event of charts. <p:pieChart value="#{bean. FacesContext.12.model}"> <p:ajax event=”itemSelect” listener=”#{bean.itemSelect}” update=”msg” /> </p:pieChart> <p:growl id=”msg” /> public class Bean implements Serializable { //Data creation omitted } public } void itemSelect(ItemSelectEvent event) { FacesMessage msg = new FacesMessage().setDetail("Series Index:" + event. msg.PrimeFaces Userʼs Guide 3. 82 .getSeriesIndex()). this event is triggered when a series of a chart is clicked.primefaces.

PrimeFaces Userʼs Guide 3. jFreeChart If you like to use static image charts instead of canvas based charts. see the JFreeChart integration example at graphicImage section.12. Note that static images charts are not rich as PrimeFaces chart components and you need to know about jFreeChart apis to create the charts. 83 .10 Charting Tips jqPlot Charts components use jqPlot as the underlying charting engine which uses a canvas element under the hood with support for IE.

Collection Type Description Value to be used in collection operation Reference to the Collection instance Reference to the Collection instance Getting started with Collector Collector requires a collection and a value to work with. public class BookBean { private Book book = new Book().Collector Attributes Name value addTo removeFrom Default null null null Object java.books}" /> </p:commandLink> 84 .PrimeFaces Userʼs Guide 3.book}" addTo="#{bookBean. Info Tag ActionListener Class collector org.books}" /> </p:commandButton> <p:commandLink value="Remove"> <p value="#{book}" removeFrom="#{createBookBean.createNew}"> <p:collector value="#{bookBean. private List<Book> books.collector. It’s important to override equals and hashCode methods of the value object to make collector work. } } //getters and setters <p:commandButton value="Add" action="#{bookBean. } public String createNew() { book = new Book().Collection java. public CreateBookBean() { books = new ArrayList<Book>().primefaces.component. //reset form return null.util.13 Collector Collector is a simple utility to manage collections declaratively.util.

ColorPicker org.primefaces.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component. it’s resolved to a converter instance.component.primefaces.primefaces.component.ColorPickerRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. When it’s an EL expression.colorpicker.primefaces. In case it’s a static text. An el expression or a literal text that defines a converter for the component.component.ColorPicker org. when set to false component will not be rendered.colorpicker. it must refer to a converter id When set true.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class colorPicker org. binding value converter null null null Object Object Converter/ String immediate FALSE Boolean 85 . process validations logic is executed at apply request values phase for this component.component org.14 Color Picker ColorPicker is an input component with a color palette.ColorPickerRenderer org.component.

public String getColor() { return this. A method binding expression that refers to a method for handling a valuchangeevent.color. Getting started with ColorPicker ColorPicker’s value should be a hex string. default mode is popup and other available option is inline.PrimeFaces Userʼs Guide Name required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar mode style styleClass Default FALSE null null null null null null popup null null Type Boolean MethodExpr ValueChange Listener String String String String String String String Description Marks component as required. A method expression that refers to a method for validation the input.color}" mode="inline"/> 86 . Inline style of the component. <p:colorPicker value="#{bean. Display mode.color}" /> Display Mode ColorPicker has two modes. Message to be displayed when validation fields. valid values are “popup” and “inline”.color = color. Message to be displayed when required field validation fails. } <p:colorPicker value="#{bean. public class Bean { } private String color. Style class of the component. Name of the client side widget. Message to be displayed when conversion fails. } public void setColor(String color) { this.

Background of gradient. Hex input. Current color display.ui-colorpicker-rgb-b .ui-colorpicker_hue .ui-colorpicker_current_color . Greed input. New color display. <p:colorPicker value="#{bean. Saturation input.ui-colorpicker-rgb-h .ui-colorpicker-rgb-hex Container element. Red input. Following is the list of structural style classes.ui-colorpicker-rgb-b .color}" styleClass=”silver” /> 87 .ui-colorpicker-rgb-s .ui-colorpicker-rgb-r . Hue input.ui-colorpicker-rgb-g .ui-colorpicker_color .ui-colorpicker .PrimeFaces Userʼs Guide Skinning ColorPicker resides in a container element which style and styleClass options apply. Style Class . Hue element. Blue input. Applies Example below changes the skin of color picker to a silver look and feel. Brightness input.ui-colorpicker_new_color .

ui-colorpicker_hsb_h { background-image: url(silver_hsb_h.PrimeFaces Userʼs Guide .png). } .silver . } .png). } .silver .ui-colorpicker_hsb_b { background-image: url(silver_hsb_b.silver .png).png). } .png).png). } .ui-colorpicker-container { background-image: url(silver_background.ui-colorpicker_rgb_b { background-image: url(silver_rgb_b.silver .png).ui-colorpicker_hsb_s { background-image: url(silver_hsb_s. } . } .silver .ui-colorpicker_submit { background-image: url(silver_submit.silver .png).png).ui-colorpicker_rgb_g { background-image: url(silver_rgb_g. } 88 .silver .silver .ui-colorpicker_rgb_r { background-image: url(silver_rgb_r.silver .ui-colorpicker_hex { background-image: url(silver_hex. } .

Column org.component. Shortcut for footer facet. Match mode for filtering.15 Column Column is an extended version of the standard column used by various PrimeFaces components like datatable. Enables selection mode. treetable and more. Info Tag Component Class Component Type Component Family column org.primefaces.PrimeFaces Userʼs Guide 3.primefaces. Shortcut for header facet. Defines the number of rows the column spans. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the column. Defines the number of columns the column spans. Style class of the column. when set to false component will not be rendered.primefaces. Property to be used for sorting. 89 binding style styleClass sortBy sortFunction filterBy filterStyle filterStyleClass filterOptions filterMatchMode rowspan colspan headerText footerText selectionMode null null null null null null null null null startsWith 1 1 null null null Object String String ValueExpr String/MethodExpr ValueExpr String String Object String Integer Integer String String String .column.component.Column org. Custom pluggable sortFunction. Inline style of the filter element Style class of the filter element A collection of selectitems for filter dropdown. Property to be used for filtering.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.

Datatable's resizableColumns must be enabled to use this option. 90 . for example filterBy is only used by datatable whereas sortBy is used by datatable and sheet.PrimeFaces Userʼs Guide Name disabledSelection filterMaxLength resizable Default FALSE null TRUE Type Boolean Integer Boolean Description Disables row selection. see documentation of components that use a column. Getting Started with Column As column is a reused component. Note As column is a reused component. not all attributes of column are implemented by the components that use column. Specifies resizable feature at column level. Maximum number of characters for an input filter.

Info Tag Component Class Component Type Component Family columns org.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Style class of the column.column. 91 .component.PrimeFaces Userʼs Guide 3.Columns org.primefaces. binding value var columnIndexVar style styleClass null null null null null null Object Object String String String String Getting Started with Columns See dynamic columns section in datatable documentation for detailed information.16 Columns Columns is used by datatable to create columns programmatically. when set to false component will not be rendered.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Data to represent columns. Inline style of the column. Name of iterator to access a column index.primefaces. Name of iterator to access a column.Columns org.

component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. ColumnGroup org.component. binding type null null Object String Getting Started with ColumnGroup See grouping section in datatable documentation for detailed information. Info Tag Component Class Component Type Component Family columnGroup org.primefaces.primefaces.ColumnGroup org.columngroup. valid values are “header” and “footer”.component. when set to false component will not be rendered. 92 . An el expression that maps to a server side UIComponent instance in a backing bean Type of group.17 ColumnGroup ColumnGroup is used by datatable for column grouping.PrimeFaces Userʼs Guide 3.primefaces.

component.component org.PrimeFaces Userʼs Guide 3.CommandButton org.commandbutton.primefaces. When set to true. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class commandButton org.commandbutton. ajax requests are not queued.component. Specifies the submit mode.CommandButtonRenderer Attributes Name id rendered binding value action actionListener immediate Default null TRUE null null null null FALSE Type String Boolean Object String MethodExpr/ String MethodExpr Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces. Component(s) to process partially instead of whole view. Boolean value that determines the phaseId. Component(s) to be updated with ajax. Sets the behavior of the button. when set to true(default). 93 type ajax async process update submit TRUE FALSE null null String Boolean Boolean String String .component.component. when true actions are processed at apply_request_values.CommandButton org.primefaces. when false at invoke_application phase.primefaces.CommandButtonRenderer org. An actionlistener that’d be processed when button is clicked. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Label for the button A method expression or a String outcome that’d be processed when button is clicked.18 CommandButton CommandButton is an extended version of standard commandButton with ajax and theming. submit would be made with Ajax.

Inline style of the button element. Access key that when pressed transfers focus to the button. Client side callback to execute when button loses focus. Client side callback to execute when a key is pressed down over button. Client side callback to execute when ajax request is completed. Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when text within button is selected by user. Client side callback to execute when ajax request succeeds. Client side callback to execute when button is double clicked. Client side callback to execute when button receives focus. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Client side callback to execute when a pointer button is pressed down over button. Client side callback to execute when ajax request fails. Client side callback to execute when button is clicked.PrimeFaces Userʼs Guide Name onstart oncomplete onsuccess onerror global style styleClass onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect accesskey Default null null null null TRUE null null null null null null null null null null null null null null null null null Type String String String String Boolean String String String String String String String String String String String String String String String String String Description Client side callback to execute before ajax request is begins. Defines whether to trigger ajaxStatus or not. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when a pointer button is moved within button. Client side callback to execute when a key is released over button. Client side callback to execute when a key is pressed and released over button. StyleClass of the button element. 94 . Client side callback to execute when a pointer button is released over button.

Name of the client side widget. Getting started with CommandButton CommandButton usage is similar to standard commandButton. by default commandButton submits its enclosing form with ajax. Direction indication for text that does not inherit directionality. <p:commandButton value="Save" actionListener="#{bookBean. Position of the button element in the tabbing order.saveBook}" /> public class BookBean { public void saveBook() { //Save book } } Reset Buttons Reset buttons do not submit the form. Flag indicating that this component will prevent changes by the user.PrimeFaces Userʼs Guide Name alt dir disabled image label lang tabindex title readonly icon iconPos inline widgetVar Default null null FALSE null null null null null FALSE null left FALSE null Type String String Boolean String String String Integer String Boolean String String String String Description Alternate textual description of the button. <p:commandButton type="reset" value="Reset" /> 95 . just resets the form contents. Disables the button. Style class for the button icon. Advisory tooltip information. Valid values are LTR and RTL. (deprecated: use icon) A localized user presentable name. Code describing the language used in the generated markup for this component. Used by PrimeFaces mobile only. Icon of the button as a css class. Position of the icon.

text}" /> <p:commandButton value="Submit" update="display"/> <h:outputText value="#{bean. not just PrimeFaces components should be updated with the Ajax response. <p:commandButton type="button" value="Alert" onclick="alert(‘Prime’)" /> AJAX and Non-AJAX CommandButton has built-in ajax capabilities. <p:commandButton value="With Icon" icon="disk"/> <p:commandButton icon="disk"/> . ajax submit is enabled by default and configured using ajax attribute. } You can also use the pre-defined icons from ThemeRoller like ui-icon-search.disk is a simple css class with a background property.disk { background-image: url(‘disk. Icons An icon on a button is provided using icon option. Update attribute takes a comma or white-space separated list of JSF component ids to be updated. To create a push button set type as "button". iconPos is used to define the position of the button which can be “left” or “right”. 96 . form is submitted with ajax and display outputText is updated with the ajax response.text}" id="display" /> </h:form> Tip: You can use the ajaxStatus component to notify users about the ajax request. Basically any JSF component. The update attribute is used to partially update other component(s) after the ajax response is received. When ajax attribute is set to false.PrimeFaces Userʼs Guide Push Buttons Push buttons are used to execute custom javascript without causing an ajax/non-ajax request. . In the following example. <h:form> <h:inputText value="#{bean. form is submitted with a regular full page refresh.png’) !important.

PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Following is the list of structural style classes.ui-button . Style Class . see the main Skinning section for more information.ui-button-text-only .CommandButton Method disable() enable() Params Return Type void void Description Disables button Enables button Skinning CommandButton renders a button tag which style and styleClass applies.ui-button-text Button element Button element when icon is not used Label of button Applies As skinning style classes are global.widget. 97 .

CommandLink org.CommandLinkRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. when false at invoke_application phase. when set to false component will not be rendered.component. A method expression or a String outcome that’d be processed when link is clicked. when true actions are processed at apply_request_values. when set to true (default). 98 binding value action actionListener immediate null null null null FALSE Object String MethodExpr/String MethodExpr Boolean async process ajax update onstart FALSE null TRUE null null Boolean String Boolean String String . An el expression that maps to a server side UIComponent instance in a backing bean Href value of the rendered anchor.primefaces. submit would be made with Ajax.19 CommandLink CommandLink extends standard JSF commandLink with Ajax capabilities.component org. An actionlistener that’d be processed when link is clicked.primefaces. Client side callback to execute before ajax request is begins.primefaces.CommandLinkRenderer org. When set to true.primefaces. Component(s) to process partially instead of whole view.commandlink. Boolean value that determines the phaseId. ajax requests are not queued.component.primefaces.component.component. Specifies the submit mode. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class commandLink org.PrimeFaces Userʼs Guide 3.CommandLink org. Component(s) to be updated with ajax. commandlink.

Client side callback to execute when ajax request succeeds. Client side callback to execute when ajax request fails. Client side callback to execute when a key is released over link.PrimeFaces Userʼs Guide Name oncomplete onsuccess onerror global style styleClass onblur onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup accesskey charset coords Default null null null TRUE null null null null null null null null null null null null null null null null null String String String Type Description Client side callback to execute when ajax request is completed. Defines whether to trigger ajaxStatus or not. Client side callback to execute when a pointer button is moved away from link. Access key that when pressed transfers focus to the link. Client side callback to execute when a pointer button is pressed down over link. 99 Boolean String String String String String String String String String String String String String String String String String . Client side callback to execute when a pointer button is moved onto link. Style to be applied on the anchor element StyleClass to be applied on the anchor element Client side callback to execute when link loses focus. Client side callback to execute when a key is pressed and released over link. Client side callback to execute when link receives focus. Client side callback to execute when link is clicked. Client side callback to execute when a pointer button is released over link. Client side callback to execute when a key is pressed down over link. Client side callback to execute when link is double clicked. Position and shape of the hot spot on the screen for client use in image maps. Client side callback to execute when a pointer button is moved within link. Character encoding of the resource designated by this hyperlink.

public class BookBean { public void saveBook() { //Save book } } <p:commandLink actionListener="#{bookBean. 100 . Shape of hot spot on the screen. circle and poly. Boolean String String rev null String shape tabindex target title type null null null null null String Integer String String String Getting Started with CommandLink CommandLink is used just like the standard h:commandLink.saveBook}"> <h:outputText value="Save" /> </p:commandLink> Skinning CommandLink renders an html anchor element that style and styleClass attributes apply. values are provided by a space-separated list of link types. Position of the button element in the tabbing order. Relationship from the current document to the anchor specified by the link. Advisory tooltip information. Type of resource referenced by the link. Valid values are LTR and RTL.PrimeFaces Userʼs Guide Name dir disabled hreflang rel Default null null null null String Type Description Direction indication for text that does not inherit directionality. valid values are default. A reverse link from the anchor specified by this link to the current document. Disables the link Languae code of the resource designated by the link. difference is form is submitted with ajax by default. rect. values are provided by a space-separated list of link types. Name of a frame where the resource targeted by this link will be displayed.

ConfirmDialog org. Skinning. Text to be displayed in body.ConfirmDialogRenderer org.primefaces.primefaces.component. 101 binding widgetVar message header severity width height style null null null null null auto auto null Object String String String String Integer Integer String .component.PrimeFaces Userʼs Guide 3. Text for the header.primefaces. when set to false component will not be rendered.primefaces.20 ConfirmDialog ConfirmDialog is a replacement to the legacy javascript confirmation box. Width of the dialog in pixels Width of the dialog in pixels Inline style of the dialog container.component org.confirmdialog.ConfirmDialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.confirmdialog. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. customization and avoiding popup blockers are notable advantages over classic javascript confirmation.component.primefaces.component.ConfirmDialog org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class confirmDialog org. Message severity for the displayed icon.

either via message option or message facet." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways. </p:confirmDialog> Severity Severity defines the icon to display next to the message. default severity is alert and the other option is info. You can call these functions to display a confirmation from any component like commandButton. menuitem and more. Message facet is useful if you need to place custom content instead of simple text. Whether to display confirm dialog on load. Getting started with ConfirmDialog ConfirmDialog has a simple client side api. show() and hide() functions are used to display and close the dialog respectively.show()" /> <p:confirmDialog message="Are you sure about destroying the world?" header="Initiating destroy process" severity="alert" widgetVar="cd"> <p:commandButton value="Yes Sure" actionListener="#{buttonBean. <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //..hide()"/> <p:commandButton value="Not Yet" onclick="confirmation.hide(). <h:form> <p:commandButton type="button" onclick="cd. commandLink. 102 . Note that header can also be defined using the header attribute or the header facet.destroyWorld}" update="messages" oncomplete="confirmation.PrimeFaces Userʼs Guide Name styleClass closable appendToBody visible Default null TRUE FALSE FALSE Type String Boolean Boolean Boolean Description Style class of the dialog container Defines if close icon should be displayed or not Appends dialog as a child of document body..

widget.ui-dialog-titlebar-close . Style Class .ConfirmDialog Method show() hide() Params Return Type void void Description Displays dialog.ui-dialog-content .ui-dialog-title . 103 . see the main Skinning section for more information. Following is the list of structural style classes.ui-dialog .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-dialog-buttonpane Applies Container element of dialog Title bar Header text Close icon Dialog body Footer button panel As skinning style classes are global.ui-dialog-titlebar . Skinning ConfirmDialog resides in a main container element which style and styleClass options apply. Closes dialog.

PrimeFaces Userʼs Guide 3. Optional for attribute defines which component the contextMenu is attached to. contextMenu is attached to the page meaning.ContextMenuRenderer Attributes Name id rendered binding widgetVar for style styleClass model Default null TRUE null null null null null null Type String Boolean Object String String String String MenuModel Description Unique identifier of the component Boolean value to specify the rendering of the component.21 ContextMenu ContextMenu provides an overlay menu displayed on mouse right-click event.primefaces. When for is not defined.primefaces.primefaces.contextmenu.component.ContextMenuRenderer org. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class contextMenu org.primefaces.component. Id of the component to attach to Style of the main container element Style class of the main container element Menu model instance to create menu programmatically.contextmenu. 104 . Getting started with ContextMenu ContextMenu is created with menuitems. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component.component. right-click on anywhere on page will display the menu.ContextMenu org.component org.primefaces.ContextMenu org.

105 .previous()" /> <p:menuitem value="Next" url="#" onclick="gallery. Following example demonstrates an integration between contextMenu and imageSwitcher.jpg" /> <p:graphicImage value="/images/nature4. see the documentation of these component for more information. second one triggers a non-ajax action and third one is used for navigation.jpg" /> <p:graphicImage value="/images/nature3. contextMenu here is used to navigate between images. tree and treeTable has special integration with context menu.PrimeFaces Userʼs Guide <p:contextMenu> <p:menuitem value="Save" actionListener="#{bean. First menuitem triggers an ajax action.delete}" ajax="false"/> <p:menuitem value="Go Home" url="www.next()" /> </p:contextMenu> Now right-clicking anywhere on an image will display the contextMenu like. this means right clicking on the attached component will display the contextMenu.jpg" /> <p:graphicImage value="/images/nature2.primefaces. <p:imageSwitch id="images" widgetVar="gallery" slideshowAuto="false"> <p:graphicImage value="/images/nature1.org" target="_blank"/> </p:contextMenu ContextMenu example above is attached to the whole page and consists of three different menuitems with different use cases.jpg" /> </p:imageSwitch> <p:contextMenu for="images"> <p:menuitem value="Previous" url="#" onclick="gallery. Data Components Data components like datatable. Attachment ContextMenu can be attached to any JSF component.save}" update="msg"/> <p:menuitem value="Delete" actionListener="#{bean.

ui-menu-list . see the main Skinning section for more information. see the dynamic menus part in menu component section for more information and an example. Style Class .ui-menuitem .PrimeFaces Userʼs Guide Dynamic Menus ContextMenus can be created programmatically as well. Following is the list of structural style classes. 106 .ui-menuitem-link .ui-menuitem-text Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global.ui-contextmenu . Skinning ContextMenu resides in a main container which style and styleClass attributes apply.

DashboardRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. 107 .dashboard.Dashboard org.primefaces.PrimeFaces Userʼs Guide 3.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities.primefaces.component. when set to false component will not be rendered.Dashboard org.component.primefaces. Inline style of the dashboard container Style class of the dashboard container binding widgetVar model disabled style styleClass null null null FALSE null null Object String Dashboard Model Boolean String String Getting started with Dashboard Dashboard is backed by a DashboardModel and consists of panel components. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Dashboard model instance representing the layout of the UI.dashboard.DashboardRenderer org.component org.component.primefaces.component.primefaces. Disables reordering feature. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.

column2.addWidget("politics"). politics.addWidget("lifestyle"). See the end of this section for the detailed Dashboard API. DashboardColumn column3 = new DefaultDashboardColumn(). DashboardColumn column1 = new DefaultDashboardColumn(). model. model. column1.. public class Bean { private DashboardModel model.. DashboardColumn column2 = new DefaultDashboardColumn(). by persisting the user changes so you can easily create a stateful dashboard. </p:dashboard> Dashboard model simply defines the number of columns and the widgets to be placed in each column.addWidget("finance"). this event is fired when dashboard panels are reordered.addColumn(column1).addColumn(column3).PrimeFaces Userʼs Guide <p:dashboard model="#{bean.event. A defined listener will be invoked by passing an org. column3.primefaces. model. column2.model}"> <p:panel id="sports"> //Sports Content </p:panel> <p:panel id="finance"> //Finance Content </p:panel> //more panels like lifestyle. State Dashboard is a stateful component. column1.addColumn(column2). whenever a widget is reordered dashboard model will be updated.addWidget("weather"). } public } Bean() { model = new DefaultDashboardModel(). Ajax Behavior Events “reorder” is the one and only ajax behavior event provided by dashboard. Following dashboard displays a message about the reorder event 108 . weather.DashboardReorderEvent instance containing information about reorder.addWidget("sports").

senderColumnIndex will be null. Also when the listener is invoked.getItemIndex().getColumnIndex(). <p:dashboard model="#{dashboardBean. int columnIndex = event.model}"> <p:panel id="sports" closable="true" toggleable="true"> //Sports Content </p:panel> </p:dashboard> 109 . //Add facesmessage If a widget is reordered in the same column. dashboard has already updated it’s model.PrimeFaces Userʼs Guide <p:dashboard model="#{bean. int widgetIndex = event. dashboard doesn’t implement these by itself as these features are already provided by the panel component. See panel component section for more information. Close and Options Menu Widgets presented in dashboard can be closable... <p:dashboard disabled="true" .handleReorder}” /> //panels </p:dashboard> <p:growl id="messages" /> public class Bean { } . int senderColumnIndex = event.getWidgetId(). This field is populated only when a widget is transferred to a column from another column. set disabled option to true. toggleable and have options menu as well. public } void handleReorder(DashboardReorderEvent event) { String widgetId = event...getSenderColumnIndex().> //panels </p:dashboard> Toggle.model}"> <p:ajax event=”reorder” update=”messages” listener=”#{bean. Disabling Dashboard If you’d like to disable reordering feature.

ui-state-hover Applies Container element of dashboard Each column in dashboard Placeholder As skinning style classes are global. <p:dashboard model="#{dashboardBean. 110 . Style Class .PrimeFaces Userʼs Guide New Widgets Draggable component is used to add new widgets to the dashboard. Here is an example based on a different theme.model}" id="board"> //panels </p:dashboard> <p:panel id="newwidget" /> <p:draggable for="newwidget" helper="clone" dashboard="board" /> Skinning Dashboard resides in a container element which style and styleClass options apply. Following is the list of structural style classes. Tips • Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets. This way you can add new panels from outside of the dashboard. see the main Skinning section for more information.ui-dashboard-column div.ui-dashboard .

map. int index) Description Adds a column to the dashboard Returns all columns in dashboard Returns the number of columns in dashboard Returns the dashboard column at given index Relocates the widget identifed with widget id to the given index of the new column from old column.primefaces.PrimeFaces Userʼs Guide Dashboard Model API org.model. String widgetId) Description Removes the widget with the given id Returns the ids of widgets in column Returns the count of widgets in column Returns the widget id with the given index Adds a new widget with the given id Adds a new widget at given index Updates the index of widget in column 111 .primefaces.primefaces.DefaultDashboardModel is the default implementation) Method void addColumn(DashboardColumn column) List<DashboardColumn> getColumns() int getColumnCount() DashboardColumn getColumn(int index) void transferWidget(DashboardColumn from. DashboardColumn to. String widgetId) void reorderWidget(int index.DashboardModel (org.model.model.map.model. String widgetId.DefaultDashboardModel is the default implementation) Method void removeWidget(String widgetId) List<String> getWidgets() int getWidgetCount() String getWidget(int index) void addWidget(String widgetId) void addWidget(int index.DashboardColumn (org.primefaces. org.

PrimeFaces Userʼs Guide 3. csv and xml.export..component. Filename of the generated export file.> //columns </p:dataTable> 112 . only selection would be exported. <p:dataTable id="tableId" ."csv". Target must point to a PrimeFaces Datatable..23 DataExporter DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel."pdf".export.DataExporterTag org. PostProcessor for the exported 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.component.primefaces. Assume the table to be exported is defined as. Info Tag Tag Class ActionListener Class dataExporter org. defaults to datatable id. Character encoding to use When enabled.DataExporter Attributes Name type target fileName pageOnly excludeColumns preProcessor postProcessor encoding selectionOnly Default null null null FALSE null null null UTF-8 FALSE Type String String String String String MethodExpr MethodExpr Boolean Boolean Description Export type: "xls". Exports only current page instead of whole dataset Comma separated list(if more than one) of column indexes to be excluded from export PreProcessor for the exported document. pdf. "xml" Id of the datatable whose data to export.primefaces.

to exclude more than one column define the indexes as a comma separated string (excludeColumns="0. <p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/> Excluding Columns In case you need one or more columns to be ignored use exludeColumns option. <p:dataExporter type="pdf" target="tableId" excludeColumns="0"/> 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.PrimeFaces Userʼs Guide Excel export <p:commandButton value="Export as Excel" ajax="false"> <p:dataExporter type="xls" target="tableId" fileName="cars"/> </p:commandButton> PDF export <p:commandButton value="Export as PDF" ajax="false" > <p:dataExporter type="pdf" target="tableId" fileName="cars"/> </p:commandButton> CSV export <p:commandButton value="Export as CSV" ajax="false" > <p:dataExporter type="csv" target="tableId" fileName="cars"/> </p:commandButton> XML export <p:commandButton value="Export as XML" ajax="false" > <p:dataExporter type="xml" target="tableId" fileName="cars"/> </p:commandLink> PageOnly By default dataExporter works on whole dataset.6"). set pageOnly to true. if you’d like export only the data displayed on current page.2. Same solution applies to data export as well. Exporter below ignores first column. 113 .

<h:commandButton value="Export as XLS"> <p:dataExporter type="xls" target="tableId" fileName="cars" postProcessor="#{bean. HSSFRow header = sheet.getInstance(logo)). cellStyle. i < header.getExternalContext(). <h:commandButton value="Export as PDF"> <p:dataExporter type="xls" target="tableId" fileName="cars" preProcessor="#{bean.separator + "images" + File.preProcessPDF}"/> </h:commandButton> public void preProcessPDF(Object document) throws IOException.png".getContext().getRow(0). String logo = servletContext. } } Add Logo to PDF This example adds a logo to the PDF before exporting begins.getCurrentInstance(). BadElementException.postProcessXLS}"/> </h:commandButton> public void postProcessXLS(Object document) { HSSFWorkbook wb = (HSSFWorkbook) document.index).g. Processors are simple java methods taking the document as a parameter.)..getSheetAt(0). pdf.createCellStyle(). add logo.setCellStyle(cellStyle).SOLID_FOREGROUND). DocumentException { Document pdf = (Document) document.setFillPattern(HSSFCellStyle. HSSFCellStyle cellStyle = wb. Change Excel Table Header First example of processors changes the background color of the exported excel’s headers. HSSFSheet sheet = wb. } 114 .add(Image. ServletContext servletContext = (ServletContext) FacesContext. PreProcessors are executed before the data is exported and PostProcessors are processed after data is included in the document. cellStyle. caption .GREEN..getRealPath("") + File.PrimeFaces Userʼs Guide Pre and Post Processors Processors are handy to customize the exported document (e.getCell(i).setFillForegroundColor(HSSFColor.i++) { header. for(int i=0.separator + "prime_logo.getPhysicalNumberOfCells().

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataGrid org.DataGridRenderer org.DataGridRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.PrimeFaces Userʼs Guide 3.component. when set to false component will not be rendered.primefaces.primefaces.component.datagrid. 115 .DataGrid org.24 DataGrid DataGrid displays a collection of data in a grid layout.DataGrid org.primefaces.component org.primefaces.component.datagrid.

Template of the rowsPerPage dropdown. Template of the paginator. public class Car { } private private private private .. Name of the request-scoped variable used to refer each data. 116 . String manufacturer. int year. Style class of the datagrid. Defines if paginator should be hidden if total data count is less than number of rows per page. Index of the first row to be displayed Name of the client side widget.PrimeFaces Userʼs Guide Name binding value var rows first widgetVar columns paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible Default null null null null 0 null 3 FALSE null null null 10 both TRUE Type Object Object String Integer Integer String Integer boolean String String String Integer String Boolean Description An el expression that maps to a server side UIComponent instance in a backing bean Data to display. Position of the paginator. Name of the iterator to refer each row index. Template of the currentPageReport UI. Inline style of the datagrid. String model. Enables pagination. String color. datalist and datatable examples. Number of rows to display per page.. style styleClass rowIndexVar null null null String String String Getting started with the DataGrid A list of cars will be used throughout the datagrid. Maximum number of page links to display. Number of columns in grid.

PrimeFaces Userʼs Guide The code for CarBean that would be used to bind the datagrid to the car list. cars.model}"> <h:panelGrid columns="1"> <p:graphicImage value="/images/cars/#{car.year}" /> </h:panelGrid> </p:panel> </p:column> </p:dataGrid> This datagrid has 3 columns and 12 rows.jpg"/> <h:outputText value="#{car. public class CarBean { } private List<Car> cars. public } CarBean() { cars = new ArrayList<Car>()."blue"))."ManufacturerX". 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. 117 .cars}" columns="3" rows="12"> <p:column> <p:panel header="#{car.2005. As datagrid extends from standard UIData.add(new Car("myModel". As a result datagrid is displayed as. //add more cars public List<Car> getCars() { return cars.manufacturer}. } <p:dataGrid var="car" value="#{carBean.

"{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}" Here are more examples based on different templates. Default UI is.PrimeFaces Userʼs Guide Ajax Pagination DataGrid has a built-in paginator that is enabled by setting paginator option to true.{endRecord} keyword within currentPageReportTemplate. rowsPerPageTemplate="9..cars}" columns="3" rows="12" paginator="true"> . " {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropDown}" " {PreviousPageLink} {CurrentPageReport} {NextPageLink}" 118 . which corresponds to the following template. options to display is provided via rowsPerPageTemplate attribute (e. Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option. Note that this section applies to dataGrid.g. dataList and dataTable.{totalRecords}.15"). </p:dataGrid> Paginator Template Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls.{startRecord}. <p:dataGrid var="car" value="#{carBean.{totalPages}.12. • • • • • • • FirstPageLink LastPageLink PreviousPageLink NextPageLink PageLinks CurrentPageReport RowsPerPageDropDown Note that {RowsPerPageDropDown} has it’s own template.. Default is {currentPage} of{totalPages}. You can use {currentPage}.

selectedCar. "top". //getters and setters 119 . <h:form id="carForm"> <p:dataGrid var="car" value="#{carBean.show()"> <f:setPropertyActionListener value="#{car}" target="#{carBean.PrimeFaces Userʼs Guide Paginator Position Paginator can be positoned using paginatorPosition attribute in three different locations.jpg"/> </f:facet> <h:outputText value="Model:" /> <h:outputText value="#{carBean. Selecting Data Selection of data displayed in datagrid is very similar to row selection in datatable. Here is an example to demonstrate how to select data from datagrid and display within a dialog with ajax.model}" /> </p:commandLink> </p:panel> </p:column> </p:dataGrid> <p:dialog modal="true" widgetVar="dlg"> <h:panelGrid id="display" columns="2"> <f:facet name="header"> <p:graphicImage value="/images/cars/#{car.selectedCar}" <h:outputText value="#{car.manufacturer}.year}" /> //more selectedCar properties </h:panelGrid> </p:dialog> </h:form> public class CarBean { } private List<Car> cars. Important point is to place datagrid contents in a p:column which is a child of datagrid. you can access the current data using the var reference.model}"> <p:commandLink update="carForm:display" oncomplete="dlg. private Car selectedCar.cars}" columns="3" rows="12"> <p:column> <p:panel header="#{car. "bottom" or "both" (default).

ui-datagrid-data .ui-datagrid . see the main Skinning section for more information.DataGrid Method getPaginator() Params Return Type Paginator Description Returns the paginator widget. see DataTable lazy loading section.widget. Class . Skinning DataGrid resides in a main div container which style and styleClass attributes apply.ui-datagrid-column Main container element Content container. Table element containing data A row in grid A column in grid Applies As skinning style classes are global.ui-datagrid-content .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Following is the list of structural style classes. 120 . Tips • DataGrid supports lazy loading data via LazyDataModel.ui-datagrid-row .

Index of the first row to be displayed binding value var rows first null null null null 0 Object Object String Integer Integer 121 .PrimeFaces Userʼs Guide 3.datalist. Name of the request-scoped variable used to refer each data.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Data to display.component.DataListRenderer org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataList org.DataList.primefaces.25 DataList DataList presents a collection of data in list layout with several display types.component.primefaces. Number of rows to display per page.component org.DataListTag org.primefaces. when set to false component will not be rendered.datalist.DataListRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.DataList org.

year} </p:dataList> 122 . "ordered". Name of the exported request scoped variable to represent state of the iteration same as in ui:repeat varStatus. Enables pagination. Position of the paginator. See itemType section for more information about the possible values. Name of the iterator to refer each row index. Template of the rowsPerPage dropdown.manufacturer}.cars}" var="car" type="ordered"> #{car. Defines if paginator should be hidden if total data count is less than number of rows per page. Template of the currentPageReport UI. #{car. Inline style of the main container. Maximum number of page links to display. Name of the client side widget. <p:dataList value="#{carBean. it renders it’s children for each data represented with var option.PrimeFaces Userʼs Guide Name type itemType widgetVar paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible Default unordered null null FALSE null null null 10 both TRUE Type String String String boolean String String String Integer String Boolean Description Type of the list.manufacturer}. if you’d like to use ordered display set type option to "ordered". Specifies the list item type.cars}" var="car" itemType="disc"> #{car. Style class of the main container. "definition" and "none". valid values are "unordered". <p:dataList value="#{carBean.year} </p:dataList> Ordered Lists DataList displays the data in unordered format by default. #{car. style styleClass rowIndexVar varStatus null Null null null String String String String Getting started with the DataList Since DataList is a data iteration component. Template of the paginator.

<p:dataList value="#{carBean.PrimeFaces Userʼs Guide Item Type itemType defines the bullet type of each item. following item types are available. to use definition list set type option to "definition". Year: #{car.cars}" var="car" type="definition"> Model: #{car.manufacturer}. A a i And for unordered lists. Detail content is provided with the facet called "description".year} <f:facet name="description"> <p:graphicImage value="/images/cars/#{car. For ordered lists. disc circle square Definition Lists Third type of dataList is definition lists that display inline description for each item. available values are.jpg"/> </f:facet> </p:dataList> 123 .model}.

cars}" var="car" paginator="true" rows="10"> #{car. Skinning DataList resides in a main div container which style and styleClass attributes apply.widget. 124 . With this setting. see DataTable lazy loading section.year} </p:dataList> Pagination configuration and usage is same as dataGrid.ui-datalist-content . • If you need full control over list type markup. <p:dataList value="#{carBean. datalist does not render item tags like li.ui-datalist .manufacturer}. #{car.ui-datalist-data .ui-datalist-item Main container element Content container Data container Each item in list Applies As skinning style classes are global.DataList Method getPaginator() Params Return Type Paginator Description Returns the paginator widget. see selecting data section in dataGrid documentation for more information and examples. Client Side API Widget: PrimeFaces. Tips • DataList supports lazy loading data via LazyDataModel. Class . see pagination section in dataGrid documentation for more information and examples.PrimeFaces Userʼs Guide Ajax Pagination DataList has a built-in paginator that is enabled by setting paginator option to true. Selecting Data Data selection can be implemented same as in dataGrid. Following is the list of structural style classes. set type to “none”. see the main Skinning section for more information.

primefaces. when set to false component will not be rendered.component.26 DataTable DataTable is an enhanced version of the standard Datatable that provides built-in solutions to many commons use cases like paging. filtering and more.PrimeFaces Userʼs Guide 3.primefaces. lazy loading. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataTable org. Name of the request-scoped variable used to refer each data. selection.component org.primefaces. Index of the first row to be displayed Name of the client side widget.datatable.primefaces. binding value var rows first widgetVar null null null null 0 null Object Object String Integer Integer String 125 .component.datatable.component.DataTable org.DataTable org.DataTableRenderer org.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Data to display. sorting. Number of rows to display per page.DataTableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

Position of the paginator. Style class of the component. valid values are “single” and “multiple”. Unique identifier of a row. Style class for each row. scrollable scrollHeight scrollWidth selectionMode selection rowIndexVar emptyMessage style styleClass dblClickSelect liveScroll rowStyleClass onExpandStart resizableColumns sortBy sortOrder scrollRows rowKey tableStyle tableStyleClass filterEvent FALSE null null null null null No records found. Text to display when there is no data to display. Makes data scrollable with fixed header. Enables column resizing. Template of the paginator.PrimeFaces Userʼs Guide Name paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible Default FALSE null null null 10 both TRUE Type boolean String String String Integer String Boolean Description Enables pagination. null null FALSE FALSE null null FALSE null ascending 0 null null null keyup Boolean Integer Integer String Object String String String String Boolean Boolean String String Boolean Object String Integer String String String String 126 . Template of the currentPageReport UI. Inline style of the component. Name of iterator to refer each row index. Maximum number of page links to display. Property to be used for default sorting. Enables live scrolling. Inline style of the table element. Scroll viewport width. Client side callback to execute before expansion. Enables row selection on double click. Enables row selection. Defines if paginator should be hidden if total data count is less than number of rows per page. Number of rows to load on live scroll. Style class of the table element. Event to invoke filtering for input filters. Template of the rowsPerPage dropdown. Reference to the selection data. Scroll viewport height. “ascending” or “descending”.

Getting started with the DataTable We will be using the same Car and CarBean classes described in DataGrid section.year}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Manufacturer" /> </f:facet> <h:outputText value="#{car.color}" /> </p:column> </p:dataTable> Header and Footer Both datatable itself and columns can have headers and footers.model}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Year" /> </f:facet> <h:outputText value="#{car.manufacturer}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Color" /> </f:facet> <h:outputText value="#{car. 127 . Controls incell editing.cars}"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car. <p:dataTable var="car" value="#{carBean.PrimeFaces Userʼs Guide Name draggableColumns editable Default FALSE FALSE Type Boolean Boolean Description Columns can be reordered with dragdrop when enabled.

model} <f:facet name="footer"> 8 digit code </f:facet> </p:column> <p:column headerText="Year" footerText="1960-2010"> #{car.cars}"> <f:facet name="header"> List of Cars </f:facet> <p:column> <f:facet name="header"> Model </f:facet> #{car.year} </p:column> //more columns <f:facet name="header"> In total there are #{fn:length(carBean.cars}"> <p:column sortBy="#{car. <p:dataTable var="car" value="#{carBean. </f:facet> </p:dataTable> headerText and footerText attributes on column are handy shortcuts for header and footer facets that just display plain texts.model}" headerText=”Model”> <h:outputText value="#{car.PrimeFaces Userʼs Guide <p:dataTable var="car" value="#{carBean.cars)} cars.cars}" paginator="true" rows="10"> //columns </p:dataTable> Sorting Defining sortBy attribute enables ajax based sorting on that particular column.model}" /> </p:column> . <p:dataTable var="car" value="#{carBean.more columns </p:dataTable> 128 . see pagination section in dataGrid documentation for more information about customization... Pagination DataTable has a built-in ajax based paginator that is enabled by setting paginator option to true.

.model}" /> </p:column> .. to implement this use the sortBy option of datatable and optional sortOrder.sortByModel}" headerText=”Model”> <h:outputText value="#{car.more columns </p:dataTable> 129 . <p:dataTable var="car" value="#{carBean.model}" /> </p:column> . <p:dataTable var="car" value="#{carBean. equal to or greater than car2 } DataTable can display data sorted by default. 0 .model}" sortFunction="#{carBean.cars}"> <p:column filterBy="#{car. ajax based filtering is enabled at column level by setting filterBy option. 1 if car1 is less than.model}" /> </p:column> .more columns </p:dataTable> public int sortByModel(Car car1..cars}" sortBy=”#{car.model}”> <p:column sortBy="#{car.model}"> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car.sortByModel}" headerText=”Model”> <h:outputText value="#{car. <p:dataTable var="car" value="#{carBean..model}" sortFunction="#{carBean. Car car2) { //return -1.. you can plug-in your own sort method..PrimeFaces Userʼs Guide Instead of using the default sorting algorithm which uses a java comparator. Table below would be initially displayed as sorted by model.cars}" dynamic="true"> <p:column sortBy="#{car.more columns </p:dataTable> Data Filtering Similar to sorting.

130 .color}" headerText="Color" filterMatchMode="endsWith"> <h:outputText value="#{car.filter()" /> </p:outputPanel> </f:facet> <p:column filterBy="#{car.PrimeFaces Userʼs Guide Filtering is triggered with keyup event and filter inputs can be styled using filterStyle . In addition. important part is to specify the id of the input text as globalFilter which is a reserved identifier for datatable. this is implemented by calling client side api method called filter(). Following is an advanced filtering datatable with these options demonstrated. filterMatchMode defines the built-in matcher which is startsWith by default.year}" /> </p:column> <p:column filterBy="#{car.year}" headerText="Year" footerText="startsWith"> <h:outputText value="#{car.model}" /> </p:column> <p:column filterBy="#{car. <p:dataTable var="car" value="#{carBean.manufacturerOptions}" filterMatchMode="exact"> <h:outputText value="#{car.model}" headerText="Model" filterMatchMode="contains"> <h:outputText value="#{car.manufacturer}" /> </p:column> <p:column filterBy="#{car. filterStyleClass attributes.cars}" widgetVar="carsTable"> <f:facet name="header"> <p:outputPanel> <h:outputText value="Search all fields:" /> <h:inputText id="globalFilter" onkeyup="carsTable. 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.manufacturer}" headerText="Manufacturer" filterOptions="#{carBean.color}" /> </p:column> </p:dataTable> Filter located at header is a global one applying on all fields.

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.. //add more cars //getters and setters Single Selection with a Command Component This method is implemented with a command component such as commandLink or commandButton.2005."blue"))."ManufacturerX". use selectionMode option. cars.columns </p:dataTable> 131 . <p:dataTable var="car" value="#{carBean. private Car selectedCar.2 or using f:setPropertyActionListener. Selected row can be set to a server side instance by passing as a parameter if you are using EL 2. <p:dataTable var="car" value="#{carBean. public class CarBean { } private List<Car> cars.cars}"> <p:column> <p:commandButton value="Select"> <f:setPropertyActionListener value="#{car}" target="#{carBean.PrimeFaces Userʼs Guide Row Selection There are several ways to select row(s) from datatable. private Car[] selectedCars. public } CarBean() { cars = new ArrayList<Car>()..id}"> .columns </p:dataTable> Single Selection with Row Click Previous method works when the button is clicked.selectedCar}" /> </p:commandButton> </p:column> ..cars}" selectionMode="single" selection="#{carBean.selectedCar}" rowKey="#{car.add(new Car("myModel". if you’d like to enable selection wherever the row is clicked..

<p:dataTable var="car" value="#{carBean.SelectableDataModel. DataTable will also provide a selectAll checkbox at column header.id}"> <p:column selectionMode="single"/> .selecedCars}" rowKey="#{car.columns </p:dataTable> RowKey RowKey should a unique identifier from your data model and used by datatable to find the selected rows.columns </p:dataTable> Selection on Double Click By default.PrimeFaces Userʼs Guide Multiple Selection with Row Click Multiple row selection is similar to single selection but selection should reference an array of the domain object displayed and user needs to use press modifier key(e.model. <p:dataTable var="car" value="#{carBean.selectedCars}" rowKey="#{car. In order to enable this feature. ctrl) during selection. <p:dataTable var="car" value="#{carBean.id}" > .cars}" selection="#{carBean. Single Selection with RadioButton Selection a row with a radio button placed on each row is a common case. You can either define this key by using the rowKey attribute or by binding a data model which implements org..cars}" selection="#{carBean.id}" > <p:column selectionMode="multiple"/> . enable dblClickSelect so that clicking double on a row does the selection.primefaces. row based selection is enabled by click event..columns </p:dataTable> Multiple Selection with Checkboxes Similar to how radio buttons are enabled..cars}" selectionMode="multiple" selection="#{carBean.. datatable has built-in support for this method so that you don’t need to deal with h:selectOneRadio’s and low level bits.. define a selection column with a multiple selectionMode.selecedCar}" rowKey="#{car.. 132 .g. define a column with selectionMode set as single.

color}"/> </p:columns> </p:dataTable> public class CarBean { } private List<String> columns. public CarBean() { populateColumns(). i < 3. for(int i=0. Columns component is used to define the columns programmatically. } } for(int j = 0. It requires a collection as the value. <p:dataTable var="cars" value="#{tableBean. populateCars().dynamicCars}" id="carsTable"> <p:columns value="#{tableBean.add(cars). } public void populateCars() { dynamicCars = new ArrayList<Car[]>(). private List<Car[]> dynamicCars.year}" /> <br /> <h:outputText value="#{cars[colIndex]. } 133 .add("Brand:" + i). Features like sortBy and filterBy are supported however advanced features like editing is not. } public void populateColumns() { columns = new ArrayList().size()].model}" /> <br /> <h:outputText value="#{cars[colIndex]. i < 9.columns}" var="column" columnIndexVar="colIndex"> <f:facet name="header"> #{column} </f:facet> <h:outputText value="#{cars[colIndex]. for(int i = 0.size(). i++) { columns. j < columns. two iterator variables called var and columnIndexVar. j++) { cars[j] = //Create car object } dynamicCars. i++) { Car[] cars = new Car[columns.PrimeFaces Userʼs Guide Dynamic Columns Dynamic columns is handy in case you can’t know how many columns to render.

thisYearTotal}$" /> </p:row> </p:columnGroup> </p:dataTable> 134 .thisYearProfit}% </p:column> <p:column> #{sale. <p:dataTable var="sale" value="#{carBean.thisYearSale}$ </p:column> <p:columnGroup type="footer"> <p:row> <p:column colspan="3" style="text-align:right" footerText="Totals:"/> <p:column footerText="#{tableBean.sales}"> <p:columnGroup type="header"> <p:row> <p:column rowspan="3" headerText="Manufacturer" /> <p:column colspan="4" headerText="Sales" /> </p:row> <p:row> <p:column colspan="2" headerText="Sales Count" /> <p:column colspan="2" headerText="Profit" /> </p:row> <p:row> <p:column headerText="Last Year" /> <p:column headerText="This Year" /> <p:column headerText="Last Year" /> <p:column headerText="This Year" /> </p:row> </p:columnGroup> <p:column> #{sale.manufacturer} </p:column> <p:column> #{sale.lastYearTotal}$" /> <p:column footerText="#{tableBean.PrimeFaces Userʼs Guide Grouping Grouping is defined by ColumnGroup component used to combine datatable header and footers.lastYearProfit}% </p:column> <p:column> #{sale.lastYearSale}$ </p:column> <p:column> #{sale.

cars}" scrollable="true" scrollHeight="150"> <p:column style="width:100px" .sales. public CarBean() { sales = //create a list of BrandSale objects } public List<ManufacturerSale> getSales() { return this.PrimeFaces Userʼs Guide public class CarBean { } private List<Manufacturer> sales. <p:dataTable var="car" value="#{carBean. in order to enable simple scrolling set scrollable option to true.. define a fixed height in pixels and set a fixed width to each column. //columns </p:dataTable> 135 . } Scrolling Scrolling is a way to display data with fixed headers..

Set liveScroll to enable this option..cars}" scrollable="true" height="150" liveScroll="true"> <p:column style="width:100px" . clicking on a collapsed row loads expanded content with ajax. in this case data is fetched whenever the scrollbar reaches bottom. //columns </p:dataTable> Scrolling has 3 modes. <p:dataTable var="car" value="#{carBean. x. Expandable Rows RowToggler and RowExpansion facet are used to implement expandable rows.PrimeFaces Userʼs Guide Simple scrolling renders all data to client and places a scrollbar.. 136 .cars}"> <f:facet name="header"> Expand rows to see detailed information </f:facet> <p:column> <p:rowToggler /> </p:column> //columns <p:rowExpansion> //Detailed content of a car </p:rowExpansion> </p:dataTable> p:rowToggler component places an expand/collapse icon. <p:dataTable var="car" value="#{carBean. live scrolling is necessary to deal with huge data. y and x-y scrolling that are defined by scrollHeight and scrollWidth.

row is displayed in editable mode meaning input facets are displayed and output facets are hidden. <p:dataTable var="car" value="#{carBean. See ajax behavior events section for more information about cell edit event.PrimeFaces Userʼs Guide Incell Editing Incell editing provides an easy way to display editable data. Clicking tick icon only saves that particular row and cancel icon reverts the changes. both options are implemented with ajax.model}" /> </f:facet> <f:facet name="input"> <h:inputText value="#{car. p:cellEditor is used to define the cell editor of a particular column and p:rowEditor is used to toggle edit/view displays of a row. 137 .model}"/> </f:facet> </p:cellEditor> </p:column> //more columns with cell editors <p:column> <p:rowEditor /> </p:column> </p:dataTable> When pencil icon is clicked.cars}"> <f:facet name="header"> In-Cell Editing </f:facet> <p:column headerText="Model"> <p:cellEditor> <f:facet name="output"> <h:outputText value="#{car.

you’d need to bind a org. Also you must implement getRowData and getRowKey if you have selection enabled.LazyDataModel as the value and implement load method.model}") and value. "model" for filterBy="#{car. public LazyDataModel getModel() { return model. "model" for sortBy="#{car.model}" paginator="true" rows="10"> //columns </p:dataTable> public class CarBean { private LazyDataModel model. String sortField. filter: Filter map with field name as key (e. 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 (e. In order to implement this. Map<String. int pageSize. } public CarBean() { model = new LazyDataModel() { } }.model.String> filters) { } //load physical data int totalRowCount = //logical row count based on a count query model. } DataTable calls your load implementation whenever a paging.setRowCount(totalRowCount).g.model}") sortOrder: SortOrder enum. @Override public void load(int first. regular ajax based pagination works by rendering only a particular page but still requires all data to be loaded into memory.g. In addition to load method. Lazy loading datatable renders a particular page similarly but also only loads the page data into memory not the whole dataset.PrimeFaces Userʼs Guide Lazy Loading Lazy Loading is a built-in feature of datatable to deal with huge datasets efficiently. <p:dataTable var="car" value="#{carBean. SortOrder sortOrder. totalRowCount needs to be provided so that paginator can display itself according to the logical number of rows to display. 138 .primefaces.

year} </p:column> <p:column headerText="Manufacturer" sortBy="#{car.model}"> #{car.manufacturer}"> #{car.manufacturer}" sortOrder="descending"> <p:column headerText="Model" sortBy="#{car.year}"> #{car.color}"> #{car.cars}" sortBy="#{car.manufacturer} </p:column> <p:column headerText="Color" sortBy="#{car.randomPrice}$ </p:column> </p:summaryRow> </p:dataTable> 139 .color} </p:column> <p:summaryRow> <p:column colspan="3" style="text-align:right"> Total: </p:column> <p:column> #{tableBean.PrimeFaces Userʼs Guide SummaryRow Summary is a helper component to display a summary for the grouping which is defined by the sortBy option.model} </p:column> <p:column headerText="Year" sortBy="#{car. <p:dataTable var="car" value="#{tableBean.

<p:dataTable var="player" value="#{tableBean.allAssists}" /> </p:row> </p:columnGroup> </p:subTable> </p:dataTable> 140 .goals} </p:column> <p:column> #{stats.stats}"> <f:facet name="header"> #{player.players}"> <f:facet name="header"> FCB Statistics </f:facet> <p:columnGroup type="header"> <p:row> <p:column rowspan="2" headerText="Player" sortBy="#{player.PrimeFaces Userʼs Guide SubTable SubTable is a helper component to display nested collections.season} </p:column> <p:column> #{stats.assists} </p:column> <p:columnGroup type="footer"> <p:row> <p:column footerText="Totals: " style="text-align:right"/> <p:column footerText="#{player.name}"/> <p:column colspan="2" headerText="Stats" /> </p:row> <p:row> <p:column headerText="Goals" /> <p:column headerText="Assists" /> </p:row> </p:columnGroup> <p:subTable var="stats" value="#{player. Example below displays a collection of players and a subtable for the stats collection of each player.name} </f:facet> <p:column> #{stats.allGoals}" /> <p:column footerText="#{player.

When a row is being selected.data. When header checkbox is toggled. On filtering. Event page sort filter rowSelect rowUnselect rowEdit colResize toggleSelect colReorder Listener Parameter org.event.event.RowEditEvent org.UnselectEvent org.primefaces. When a row is being unselected.primefaces. When columns are reordered.SortEvent org.primefaces.data.primefaces.event.model}"> <p:ajax event=”rowSelect” update=”another_component” /> //columns </p:dataTable> 141 .primefaces.event.ColumnResizeEvent On pagination. When a column is being selected. <p:dataTable var="car" value="#{carBean.data.FilterEvent org.primefaces. Fired For example. When a column is sorted. When a row is edited. datatable below makes an ajax request when a row is selected.event.event.SelectEvent org.primefaces.event.PageEvent org.PrimeFaces Userʼs Guide Ajax Behavior Events DataTable provides many custom ajax behavior events for you to hook-in to various features.

Following is the list of structural style classes.ui-cell-editor-input .ui-datatable-odd Main container element Table body Table body when there is no data Table header Table footer Sortable columns Icon of a sortable icon Content of an expanded row Row toggler for row expansion Columns with a cell editor Container of input and output controls of an editable cell Container of input control of an editable cell Container of output control of an editable cell Even numbered rows Odd numbered rows Applies As skinning style classes are global. 142 .ui-sortable-column-icon .ui-datatable-header .ui-row-toggler .widget.ui-cell-editor .DataTable Method getPaginator() clearFilters() Params Return Type Paginator void Description Returns the paginator insance.ui-datatable-data .ui-datatable .ui-cell-editor-output . Clears all column filters Skinning DataTable resides in a main container element which style and styleClass options apply. Class .ui-datatable-even .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. see the main Skinning section for more information.ui-datatable-data-empty .ui-datatable-footer .ui-editable-column .ui-expanded-row-content .ui-sortable-column .

DefaultCommandRenderer org.27 DefaultCommand Which command to submit the form with when enter key is pressed a common problem in web apps not just specific to JSF.primefaces.primefaces.DefaultCommand org.component.DefaultCommand org.primefaces.primefaces.component org. Browsers tend to behave differently as there doesn’t seem to be a standard and even if a standard exists.component. binding widgetVar header target null null null null Object String String String Getting Started with the DefaultCommand DefaultCommand must be nested inside a form requires target option to reference a clickable command. button or link) to submit the form with on enter key press. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class defaultCommand org. when set to false component will not be rendered.g. IE probably will not care about it.PrimeFaces Userʼs Guide 3.component. Note that an input must have focused due to browser nature.component.defaultcommand. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Text of the header Identifier of the default command component.DefaultCommandRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.defaultcommand. 143 . DefaultCommand solves this problem by normalizing the command(e. Example below triggers btn2 when enter key is pressed. There are some ugly workarounds like placing a hidden button and writing javascript for every form in your app.primefaces.

text}" id="display" /> </h:panelGrid> <p:commandButton value="Button1" id="btn1" actionListener="#{bean.submit2}" /> <h:commandButton value="Button3" id="btn3" actionListener="#{bean.text}" /> <h:outputText value="#{defaultCommandBean.PrimeFaces Userʼs Guide <h:form id="form"> <h:panelGrid columns="3" cellpadding="5"> <h:outputLabel for="name" value="Name:" style="font-weight:bold"/> <p:inputText id="name" value="#{defaultCommandBean.submit3}" /> <p:defaultCommand target="bt2" /> </h:form> 144 .submit1}" ajax="false"/> <p:commandButton value="Button2" id="btn2" actionListener="#{bean.

dialog.primefaces.DialogRenderer org.component.Dialog org.component.component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Text of the header Specifies draggability Specifies resizability Enables modality. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org. 145 binding widgetVar header draggable resizable modal visible width height minWidth null null null TRUE TRUE FALSE FALSE auto auto 150 Object String String Boolean Boolean Boolean Boolean Integer Integer Integer .Dialog org.primefaces.primefaces.DialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Width of the dialog Height of the dialog Minimum width of a resizable dialog.28 Dialog Dialog is a panel component that can overlay other elements on page.dialog. When enabled.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.primefaces.component.component org. dialog is visible by default.

PrimeFaces Userʼs Guide Name minHeight style styleClass showEffect hideEffect position closable onShow onHide appendToBody showHeader footer dynamic minimizable maximizable Default 0 null null null null null TRUE null null FALSE TRUE null FALSE FALSE FALSE Type Integer String String String String String Boolean String String Boolean Boolean String Boolean Boolean Boolean Description Minimum height of a resizable dialog. Whether a dialog is maximizable or not. note that by default dialog is not visible. Defines visibility of the header content. Client side callback to execute when dialog is hidden. Appends dialog as a child of document body. Text of the footer. <p:dialog> <h:outputText value="Resistance to PrimeFaces is Futile!" /> //Other content </p:dialog> Show and Hide Showing and hiding the dialog is easy using the client side api. Inline style of the dialog. Style class of the dialog Effect to use when showing the dialog Effect to use when hiding the dialog Defines where the dialog should be displayed Defines if close icon should be displayed or not Client side callback to execute when dialog is displayed. Whether a dialog is minimizable or not. Getting started with the Dialog Dialog is a panel component containing other components. Enables lazy loading of the content with ajax. <p:dialog header="Header Text" widgetVar="dlg"> //Content </p:dialog> <p:commandButton value="Show" type="button" onclick="dlg.hide()" /> 146 .show()" /> <p:commandButton value="Hide" type="button" onclick="dlg.

500 • Comma separated position values like ‘top’. • • • • • • • • • • • • • • • blind bounce clip drop explode fade fold highlight puff pulsate scale shake size slide transfer <p:dialog showEffect="fade" hideEffect="explode" ..> <p:dialog position="left.PrimeFaces Userʼs Guide Effects There are various effect options to be used when displaying and closing the dialog..> 147 .> <p:dialog position="200. • Comma separated x and y coordinate values like 200... ‘left’. Use showEffect and hideEffect options to apply these effects. Possible values are. </p:dialog> Position By default dialog is positioned at center of the viewport and position option is used to change the location of the dialog. ‘right’.50" . ‘top’. ‘bottom’ representing the position within viewport. • Single string value like ‘center’.top" .> //....‘right’. (Use single quotes when using a combination) Some examples are described below... <p:dialog position="top" ..

Closes dialog. Following is the list of structural style classes.Dialog Method show() hide() Params Return Type void void Description Displays dialog.handleClose}" update="msg" /> //Content </p:dialog> <p:messages id="msg" /> public class DialogBean { } public void handleClose(CloseEvent event) { //Add facesmessage } Client Side Callbacks Similar to close listener. 148 . Example below adds a FacesMessage when dialog is closed and updates the messages component to display the added message. <p:dialog> <p:ajax event="close" listener="#{dialogBean. Skinning Dialog resides in a main container element which styleClass option apply.event.widget.PrimeFaces Userʼs Guide Ajax Behavior Events close event is the one and only ajax behavior event provided by dialog that is fired when the dialog is hidden.primefaces. If there is a listener defined it’ll be executed by passing an instace of org. onShow and onHide are handy callbacks for client side in case you need to execute custom javascript. <p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)"> //Content </p:dialog> Client Side API Widget: PrimeFaces.CloseEvent.

tabview. • Do not place dialog inside tables.ui-dialog-content Applies Container element of dialog Title bar Header text Close icon Dialog body As skinning style classes are global.ui-dialog-title-dialog . Same applies to confirmDialog as well. For example dialog inside a layout unit. Tips • Use appendToBody with care as the page definition and html dom would be different. accordion are a couple of examples. see the main Skinning section for more information.ui-dialog-titlebar . in cases like these functionality might be broken. In this case.PrimeFaces Userʼs Guide Style Class . on the browser dialog would be outside of form and may cause unexpected results. This is not a limitation but a result of DOM model. nest a form inside a dialog. 149 . containers likes divs with relative positioning or with nonvisible overflow defined.ui-dialog .ui-dialog-titlebar-close . for example if dialog is inside an h:form component and appendToBody is enabled.

primefaces. when set to false component will not be rendered. valid values are ‘x’ and ‘y’. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Displays a proxy element instead of actual element.Draggable org.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org. Id of the component to add draggable behavior Disables draggable behavior when true.component. Specifies drag axis. Specifies a draggable that can’t be dropped.dnd. 3.component.primefaces.dnd.primefaces.PrimeFaces Userʼs Guide 3.component org. Draggable and Droppable.primefaces. Constraints dragging within the boundaries of containment element Helper element to display when dragging Reverts draggable to it’s original position when not dropped onto a valid droppable Draggable will snap to edge of near elements binding widgetVar proxy dragOnly for disabled axis containment helper revert snap null null FALSE FALSE null FALSE null null null FALSE FALSE Object String Boolean Boolean String Boolean String String String Boolean Boolean 150 .component.DraggableRenderer org.component.Draggable org.29.primefaces.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.DraggableRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

ZIndex to apply during dragging. Distance from the snap element in pixels to trigger snap. In stack mode. CSS cursor to display in dragging. parent component will be selected as the draggable target. you can define it with handle option. Valid values are ‘both’. 151 . Scope key to match draggables and droppables. Id of the dashboard to connect with. if you need a specific handle. Following panel is dragged using it’s header only. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="This is actually a regular panel" /> </p:panel> <p:draggable for="pnl"/> If you omit the for attribute. Specifies a handle for dragging. ‘inner’ and ‘outer’. <h:graphicImage id="campnou" value="/images/campnou. Dragging happens in every x and y pixels. draggable overlap is controlled automatically using the provided selector. basically this is achieved by defining the id of component using the for attribute of draggable. grid scope cursor dashboard null null crosshair null String String String String Getting started with Draggable Any component can be enhanced with draggable behavior.PrimeFaces Userʼs Guide Name snapMode snapTolerance zindex handle opacity stack Default null 20 null null 1 null Type String Integer Integer String Double String Description Specifies the snap mode. dragged item always overlays other draggables.jpg"> <p:draggable /> </h:graphicImage> Handle By default any point in dragged component can be used as handle. Defines the opacity of the helper during dragging.

if you need to keep the component at it’s original location. use a clone helper. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am dragged on an axis only" /> </p:panel> <p:draggable for="pnl" axis="x or y"/> Clone By default. revert option enables the component to move back to it’s original position with an animation.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically.PrimeFaces Userʼs Guide <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I can only be dragged using my header" /> </p:panel> <p:draggable for="pnl" handle="div. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I will be reverted back to my original position" /> </p:panel> <p:draggable for="pnl" revert="true"/> Opacity During dragging. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am cloned" /> </p:panel> <p:draggable for="pnl" helper="clone"/> Revert When a draggable is not dropped onto a matching droppable. 152 . opacity option can be used to give visual feedback. helper of following panel’s opacity is reduced in dragging. actual component is used as the drag indicator.

5"/> Grid Defining a grid enables dragging in specific pixels. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am dragged in grid mode" /> </p:panel> <p:draggable for="pnl" grid="20. <p:outputPanel layout="block" style="width:400px."> <p:panel id="conpnl" header="Restricted"> <h:outputText value="I am restricted to my parent's boundaries" /> </p:panel> </p:outputPanel> <p:draggable for="conpnl" containment="parent" /> 153 . following draggable cannot go outside of it’s parent.height:200px.40"/> Containment A draggable can be restricted to a certain section on page.PrimeFaces Userʼs Guide <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="My opacity is lower during dragging" /> </p:panel> <p:draggable for="pnl" opacity="0.y format. This value takes a comma separated dimensions in x.

PrimeFaces Userʼs Guide 3.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Droppable org. Specifies the intersection mode to accept a draggable.primefaces.primefaces.component. when set to false component will not be rendered.Droppable org. Scope key to match draggables and droppables. Selector to define the accepted draggables. An el expression that maps to a server side UIComponent instance in a backing bean Variable name of the client side widget Id of the component to add droppable behavior Disables of enables droppable behavior Style class to apply when an acceptable draggable is dragged over. Client side callback to execute when a draggable is dropped.dnd.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org.component.component.primefaces. Style class to apply when an acceptable draggable is being dragged.component org. binding widgetVar for disabled hoverStyleClass activeStyleClass onDrop accept scope tolerance datasource null null null FALSE null null null null null null null Object String String Boolean String String String String String String String 154 .primefaces.primefaces.29.component.DroppableRenderer org.dnd. Id of a UIData component to connect with.

DragDrop event instance parameter holding information about the dragged and dropped components.slot { background:#FF9900. height:96px. } </style> If for attribute is omitted.PrimeFaces Userʼs Guide Getting Started with Droppable Usage of droppable is very similar to draggable. display:block. droppable behavior can be added to any component specified with the for attribute. <style type="text/css"> .jpg" /> <p:draggable for="messi"/> <p:outputPanel id="zone" styleClass="slot" /> <p:droppable for="zone"> <p:ajax listener="#{ddController. <p:graphicImage id="messi" value="barca/messi_thumb. width:64px. Following example shows how to enable draggable images to be dropped on droppables. In case you define a listener it’ll be executed by passing an org.event. <p:outputPanel id="slot" styleClass="slot"> <p:droppable /> </p:outputPanel> Ajax Behavior Events drop is the only and default ajax behavior event provided by droppable that is processed when a valid draggable is dropped.primefaces. parent component becomes droppable. <p:outputPanel id="slot" styleClass="slot" /> <p:droppable for="slot" /> slot styleClass represents a small rectangle.onDrop}" /> </p:droppable> 155 .

getDropId(). <p:outputPanel id="zone" styleClass="slot" /> <p:droppable for="zone" onDrop="handleDrop"/> function handleDrop(event. datagrid).getData()). } //draggable element.draggable. } public TableBean() { availableCars = //populate data } //getters and setters public } void onCarDrop(DragDropEvent event) { Car car = ((Car) ddEvent.getData(). ui) { var draggable = ui.getDragId(). a jQuery object //position of draggable helper //absolute position of draggable helper DataSource Droppable has special care for data elements that extend from UIData(e.add(car). offset = ui. } //Client id of dragged component //Client id of dropped component //Model object of a datasource onDrop onDrop is a client side callback that is invoked when a draggable is dropped. Example below show how to drag data from datagrid and drop onto a droppable to implement a dragdrop based selection.helper. it gets two parameters event and ui object holding information about the drag drop event. droppedCars. private List<Car> droppedCars. in order to connect a droppable to accept data from a data component define datasource option as the id of the data component. helper = ui.PrimeFaces Userʼs Guide public void onDrop(DragDropEvent ddEvent) { String draggedId = ddEvent. a jQuery object //helper element of draggable. 156 . String droppedId = ddEvent.g. datatable. Object data = ddEvent. public class TableBean { private List<Car> availableCars.offset.remove(car). Dropped cars are displayed with a datatable. availableCars.position. position = ui.

} </script> //fade out the dropped item 157 .onCarDrop}" update="dropArea availableCars" /> </p:droppable> </h:form> <script type="text/javascript"> function handleDrop(event.manufacturer}" /> </p:column> <p:column headerText="Color"> <h:outputText value="#{car. ui) { ui.droppedCars}" style="font-size:24px.fadeOut(‘fast’).PrimeFaces Userʼs Guide <h:form id="carForm"> <p:fieldset legend="AvailableCars"> <p:dataGrid id="availableCars" var="car" value="#{tableBean.droppedCars}" rendered="#{not empty tableBean.model}" /> </p:column> <p:column headerText="Year"> <h:outputText value="#{car.availableCars}" columns="3"> <p:column> <p:panel id="pnl" header="#{car." /> <p:dataTable var="car" value="#{tableBean.droppedCars}"> <p:column headerText="Model"> <h:outputText value="#{car.draggable.year}" /> </p:column> <p:column headerText="Manufacturer"> <h:outputText value="#{car.manufacturer}.ui-panel-titlebar" stack=".jpg" /> </p:panel> <p:draggable for="pnl" revert="true" h andle=".model}" style="text-align:center"> <p:graphicImage value="/images/cars/#{car.color}" /> </p:column> </p:dataTable> </p:outputPanel> </p:fieldset> <p:droppable for="selectedCars" tolerance="touch" activeStyleClass="ui-state-highlight" datasource="availableCars" onDrop="handleDrop"/> <p:ajax listener="#{tableBean.ui-panel"/> </p:column> </p:dataGrid> </p:fieldset> <p:fieldset id="selectedCars" legend="Selected Cars" style="margin-top:20px"> <p:outputPanel id="dropArea"> <h:outputText value="!!!Drop here!!!" rendered="#{empty tableBean.

jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. <p:graphicImage id="messi" value="barca/messi_thumb. Mode fit intersect pointer touch Description draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount Acceptance You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has. 158 . only first image can be accepted by droppable. Following example has two images.PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb.

component.30 Dock Dock component mimics the well known dock interface of Mac OS X.PrimeFaces Userʼs Guide 3.Dock org.component.primefaces.primefaces.dock. Distance to enlarge. Maximum width of items. An el expression that maps to a server side UIComponent instance in a backing bean MenuModel instance to create menus programmatically Position of the dock. binding model position itemWidth maxWidth proximity halign widgetVar null null bottom 40 50 90 center null Object MenuModel String Integer Integer Integer String String 159 . bottom or top. Horizontal alignment. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.primefaces.primefaces. Initial width of items.dock.DockRenderer org.component.DockRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.Dock org. when set to false component will not be rendered. Name of the client side widget.primefaces.component.component org.

ui-dock-container-{position} .png" url="#" /> value="Video" icon="/images/dock/video. see the main Skinning section for more information. Each menu item.png" url="#"/> value="Link" icon="/images/dock/link. 160 . Dynamic Menus Menus can be created programmatically as well.ui-dock-{position} .png" url="#"/> Position Dock can be located in two locations.png" url="#"/> value="Email" icon="/images/dock/email. Style Class . For a dock positioned at top set position to top. Applies As skinning style classes are global. {positon} can be top or bottom.PrimeFaces Userʼs Guide Getting started with the Dock A dock is composed of menuitems. Dock Effect When mouse is over the dock items. <p:dock> <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem </p:dock> value="Home" icon="/images/dock/home. The configuration of this effect is done via the maxWidth and proximity attributes. Menu item container. top or bottom (default).png" url="#"/> value="History" icon="/images/dock/history.png" url="#"/> value="RSS" icon="/images/dock/rss. icons are zoomed in.ui-dock-item-{position} Main container.png" url="#" /> value="Music" icon="/images/dock/music. Skinning Following is the list of structural style classes. see the dynamic menus part in menu component section for more information and an example.

PrimeFaces Userʼs Guide 3. it’s resolved to a converter instance.Editor org.editor.editor. Value of the component than can be either an EL expression of a literal text.component.component.primefaces.primefaces.EditorRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component. In case it’s a static text.31 Editor Editor is an input component with rich text editing capabilities. 161 .component. When it’s an EL expression. An el expression that maps to a server side UIComponent instance in a backing bean.EditorRenderer org. Boolean value to specify the rendering of the component.primefaces.Editor org.component. An el expression or a literal text that defines a converter for the component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class editor org.component org.primefaces. it must refer to a converter id.

List of controls to customize toolbar. Height of the editor. Disables editor. Message to be displayed when validation fails. A method expression that refers to a method for handling a valuchangeevent. A method expression that refers to a method validationg the input. Inline style of the editor container. Style class of the editor container. Client side callback to execute when editor data changes. Message to be displayed when conversion fails. process validations logic is executed at apply request values phase for this component. Message to be displayed when required field validation fails. Marks component as required. required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar controls height width disabled style styleClass onchange FALSE null null null null null null null null null FALSE null null null Boolean MethodExpr MethodExpr String String String String String Integer Integer Boolean String String String Getting started with the Editor Rich Text entered using the Editor is passed to the server using value expression. Width of the editor. //getter and setter <p:editor value="#{bean.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true. public class Bean { private String text. Name of the client side widget.text}" /> 162 .

PrimeFaces Userʼs Guide Custom Toolbar Toolbar of editor is easy to customize using controls option. • • • • • • • • • • • • • • • • bold italic underline strikethrough subscript superscript font size style color highlight bullets numbering alignleft center alignright • • • • • • • • • • • • • • • • justify undo redo rule image link unlink cut copy paste pastetext print source outdent indent removeFormat Client Side API Widget: PrimeFaces. Clears the text in editor.text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls. Saves html text in iframe back to the textarea.Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor. <p:editor value="#{bean.widget. subsequent calls do not reinit the editor. .

Skinning Following is the list of structural style classes. Disabled editor controls.ui-editor-color .ui-editor-prompt . Color picker.PrimeFaces Userʼs Guide Method enable() disable() focus() selectAll() getSelectedHTML() getSelectedText() Params - Return Type void void void void String String Enables editing. Returns selected text as HTML. Disables editing. Applies Editor is not integrated with ThemeRoller as there is only one icon set for the controls. Overlays to provide input.ui-editor-list . Dropdown lists. Toolbar of editor.ui-editor-message Main container.ui-editor-toolbar . Selects all text in editor. Overlays displaying a message. Button groups.ui-editor . Style Class . Description Adds cursor focus to edit area.ui-editor-group . Popup overlays. 164 . Divider to separate buttons.ui-editor-popup .ui-editor-divider . Each button.ui-editor-button . Returns selected text in plain format.ui-editor-disabled .

PrimeFaces Userʼs Guide 3.effect. binding effect event type for speed delay null null null null null 1000 null Object String String String String Integer Integer Getting started with Effect Effect component needs a trigger and target which is effect’s parent by default. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Dom event to attach the event that executes the animation Specifies the name of the animation Component that is animated Speed of the animation in ms Time to wait until running the effect. when set to false component will not be rendered.component. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.Effect org. Info Tag Tag Class Component Class Component Type Component Family Renderer Type Renderer Class effect org.primefaces. 165 .component.primefaces.EffectRenderer org.component.component org.EffectTag org.primefaces.32 Effect Effect component is based on the jQuery UI effects library.effect.primefaces.EffectRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.effect.primefaces.Effect org.component.component.primefaces.

jpg" style="display:none"/> With this setting. outputLink becomes the trigger for the effect on graphicImage. <h:outputLink id="lnk" value="#"> <h:outputText value="Show the Barca Temple" /> <p:effect type="appear" event="click" for="img" /> </h:outputLink> <p:graphicImage id="img" value="/ui/barca/campnou.value}"> <p:effect type="pulsate" event="click" /> </h:outputText> Effect Target There may be cases where you want to display an effect on another target on the same page while keeping the parent as the trigger.PrimeFaces Userʼs Guide <h:outputText value="#{bean. List of Effects Following is the list of effects supported by PrimeFaces. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 . When the link is clicked. Use for option to specify a target. 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. initially hidden graphicImage comes up with a fade effect.

duration and more. <p:messages id="messages"> <p:effect type="pulsate" event="load" delay=”500”> <f:param name="mode" value="'show'" /> </p:effect> </p:messages> <p:commandButton value="Save" actionListener="#{bean. Following example animates messages with pulsate effect after ajax request completes. please see the jquery documentation.PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors. http://docs. In order to change the configuration of the animation.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. <h:outputText value="#{bean.value}"> <p:effect type="scale" event="mouseover"> <f:param name="percent" value="90"/> </p:effect> </h:outputText> It’s important to provide string options with single quotes.action}" update="messages"/> 167 . <h:outputText value="#{bean.value}"> <p:effect type="blind" event="click"> <f:param name="direction" value="'horizontal'" /> </p:effect> </h:outputText> For the full list of configuration parameters for each effect. provide these parameters with the f:param tag.jquery.

primefaces.news.PrimeFaces Userʼs Guide 3.value}" escape="false"/> <p:separator /> <f:facet name="error"> Something went wrong.FeedReaderRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.component. </f:facet> </p:feedReader> Note that you need the ROME library in your classpath to make feedreader work. Iterator to refer each item in feed. <p:feedReader value="http://rss. 168 .FeedReader org.FeedReaderRenderer org.title}" style="font-weight: bold"/> <h:outputText value="#{feed. binding value var size null null null Unlimited Object String String Integer Getting started with FeedReader FeedReader requires a feed url to display and renders it’s content for each feed item.com/rss/sports" var="feed"> <h:outputText value="#{feed. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class feedReader org.33 FeedReader FeedReader is used to display content from a feed.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean URL of the feed.yahoo.primefaces. Number of items to display.component org. when set to false component will not be rendered.component.feedreader.description.feedreader.primefaces.component.FeedReader org.

primefaces.primefaces.component.FieldsetRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org. 169 binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null null null null null FALSE 500 FALSE Object String String String String Boolean Integer Boolean .component. Inline style of the fieldset. Style class of the fieldset. Makes content toggleable with animation.fieldset.fieldset. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.FieldsetRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Title text.primefaces.component.Fieldset org.component.component org.Fieldset org. Defines initial visibility state of content. Toggle duration in milliseconds.primefaces.34 Fieldset Fieldset is a grouping component as an extension to html fieldset.

Use facet way if you need to place custom html other than simple text.. Toggleable Content Clicking on fieldset legend can toggle contents. Set toggleable to true to enable this feature. with legend attribute as in example above or using legend facet.jpg" /> <h:outputText value="The story begins as Don Vito Corleone .PrimeFaces Userʼs Guide Getting started with Fieldset Fieldset is used as a container component for its children." /> </h:panelGrid> </p:fieldset> 170 .jpg" /> <h:outputText value="Francis Ford Coppolas’ legendary . <p:fieldset> <f:facet name="legend"> </f:facet> //content </p:fieldset> When both legend attribute and legend facet are present... <p:fieldset legend="Toggleable Fieldset" toggleable="true"> <h:panelGrid column="2"> <p:graphicImage value="/images/godfather/2.." /> </h:panelGrid> </p:fieldset> Legend Legend can be defined in two ways. this is handy to use space efficiently in a layout. <p:fieldset legend="Simple Fieldset"> <h:panelGrid column="2"> <p:graphicImage value="/images/godfather/1. facet is chosen.

msg.ui-fieldset-toggleable .widget.getVisibility(). Here is an example that adds a facesmessage and updates growl component when fieldset is toggled. In case you have a listener defined.ui-fieldset .ui-fieldset .ToggleEvent.primefaces. Skinning style and styleClass options apply to the fieldset.onToggle}" update="messages"> //content </p:fieldset> public void onToggle(ToggleEvent event) { Visibility visibility = event.PrimeFaces Userʼs Guide Ajax Behavior Events toggle is the default and only ajax behavior event provided by fieldset that is processed when the content is toggled.ui-fieldset-legend Main container Main container when fieldset is toggleable Legend of fieldset 171 Applies .Fieldset Method toggle() Params Return Type void Description Toggles fieldset content. FacesMessage msg = new FacesMessage(). msg).getId() + " toggled"). <p:growld id="messages" /> <p:fieldset legend="Toggleable Fieldset" toggleable="true" <p:ajax listener="#{bean. Style Class . it will be invoked by passing an instance of org. msg. } FacesContext.event.setDetail("Visibility: " + visibility).addMessage(null.setSummary("Fieldset " + event. Following is the list of structural style classes. Client Side API Widget: PrimeFaces.getCurrentInstance().

ui-fieldset-toggleable . Tips • A collapsed fieldset will remain collapsed after a postback since fieldset keeps its toggle state internally.ui-fieldset-toggler Applies Legend of fieldset when fieldset is toggleable Toggle icon on fieldset As skinning style classes are global.ui-fieldset .PrimeFaces Userʼs Guide Style Class .ui-fieldset-legend . 172 . you don’t need to manage this using toggleListener and collapsed option. see the main Skinning section for more information.

} } This streamed content should be bound to the value of the fileDownload.FileDownloadActionListener Attributes Name value contextDisposition Default null attachment Type StreamedContent String Description A streamed content instance Specifies display mode. "downloaded_file.StreamedContent instance.component. public FileDownloadController() { InputStream stream = this.35 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 can be attached to any command component like a commandButton or commandLink.primefaces. Getting started with FileDownload A user command action is required to trigger the filedownload process.PrimeFaces Userʼs Guide 3. second is the mimeType and the third parameter is the name of the file. } public StreamedContent getFile() { return this. FileDownload presents an easier way to do the same.getClass(). 173 . "application/pdf". We suggest using the built-in DefaultStreamedContent implementation.pdf"). The value of the FileDownload must be an org.file.model. file = new DefaultStreamedContent(stream. Info Tag ActionListener Class fileDownload org.filedownload. First parameter of the constructor is the binary stream. public class FileBean { private StreamedContent file.pdf").getResourceAsStream("yourfile.primefaces.

show().file}"/> <h:graphicImage value="pdficon. in this case browser will try to open the file internally without a prompt. ajaxStatus cannot apply. <script type="text/javascript"> function showStatus() { statusDialog. Example below displays a modal dialog when dowload begins and hides it on complete. another alternative is the inline mode.file}" /> </p:commandButton> <p:commandLink value="Download" ajax="false"> <p:fileDownload value="#{fileBean.hide(). endFunction) method.gif" /> </h:commandLink> If you’d like to use PrimeFaces commandButton and commandLink. } function hideStatus() { statusDialog. disable ajax option as fileDownload requires a full page refresh to present the file. content is displayed as an attachment with a download dialog box. Still PrimeFaces provides a feature to monitor file downloads via client side monitorDownload(startFunction. } </script> 174 . Note that content disposition is not part of the http standard although it is widely implemented. <p:commandButton value="Download" ajax="false"> <p:fileDownload value="#{fileBean. <h:commandLink value="Download"> <p:fileDownload value="#{fileBean.PrimeFaces Userʼs Guide <h:commandButton value="Download"> <p:fileDownload value="#{fileBean.gif" /> </p:commandLink> ContentDisposition By default.file}" /> </h:commandButton> Similarly a more graphical presentation would be to use a commandlink with an image. Monitor Status As fileDownload process is non-ajax.file}"/> <h:graphicImage value="pdficon.

gif" /> </p:dialog> <p:commandButton value="Download" ajax="false" onclick="PrimeFaces.monitorDownload(showStatus.file}"/> </p:commandButton> </h:form> 175 .PrimeFaces Userʼs Guide <h:form> <p:dialog modal="true" widgetVar="statusDialog" header="Status" draggable="false" closable="false"> <p:graphicImage value="/design/ajaxloadingbar. hideStatus)"> <p:fileDownload value="#{fileDownloadController.

When set true.component.36 FileUpload FileUpload goes beyond the browser input type="file" functionality and features an html5 powered rich solution with graceful degradation for legacy browsers.primefaces.fileupload. Marks component as required.FileUpload org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fileUpload org. When it’s an EL expression.component org. when set to false component will not be rendered.FileUploadRenderer org. In case it’s a static text.component. Boolean value to specify the rendering of the component. it’s resolved to a converter instance.FileUpload org.FileUploadRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component. Value of the component than can be either an EL expression of a literal text.primefaces. process validations logic is executed at apply request values phase for this component.fileupload. A method expression that refers to a method validationg the input. it must refer to a converter id.component.primefaces.component.PrimeFaces Userʼs Guide 3. 176 binding value converter null null null Object Object Converter/ String immediate required validator FALSE FALSE null Boolean Boolean MethodExpr . An el expression or a literal text that defines a converter for the component.primefaces.

Method to invoke when a file is uploaded. Whether or not to enable dragdrop from filesystem. Message to display when size limit exceeds. Name of the client side widget. can be simple or advanced. Message to display when file is not accepted. Label of the cancel button. Message to display when file limit exceeds. Component(s) to process in fileupload request. Label of the upload button. Maximum number of files allowed to upload. Label of the browse button. Allows multi file selection when true. 177 . Visibility of upload and cancel buttons in button bar. Enables auto file uploads. Maximium file size limit in bytes. Component(s) to update after fileupload completes. Message to be displayed when validation fails. Client side callback to execute when upload ends.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar update process fileUploadListener multiple auto label allowTypes sizeLimit fileLimit showButtons style styleClass mode uploadLabel cancelLabel invalidSizeMessage invalidFileMessage fileLimitMessage dragDropSupport onstart oncomplete disabled Default null null null null null null null null FALSE FALSE Choose null null null TRUE null null advanced Upload Cancel null null null TRUE null null FALSE Type MethodExpr String String String String String String MethodExpr Boolean Boolean String String Integer Integer Boolean String String String String String String String String Boolean String String Boolean Description A method expression that refers to a method for handling a valuchangeevent. Message to be displayed when conversion fails. Mode of the fileupload. Disables component when set true. Message to be displayed when required field validation fails. Style class of the component. Client side callback to execute when upload begins. Inline style of the component. Regular expression to restrict uploadable files.

<p:fileUpload fileUploadListener="#{fileBean. <filter> <filter-name>PrimeFaces FileUpload Filter</filter-name> <filter-class> org.model.handleFileUpload}" /> 178 . FileUpload filter should map to Faces Servlet.filter. //getter-setter Advanced File Upload Default mode of fileupload is advanced that provides a richer UI.file}" mode="simple" /> <p:commandButton value="Submit" ajax="false"/> </h:form> import org.UploadedFile. <h:form enctype="multipart/form-data"> <p:fileUpload value="#{fileBean. when a file is uploaded defined fileUploadListener is processed with a FileUploadEvent as the parameter.PrimeFaces Userʼs Guide Getting started with FileUpload First thing to do is to configure the fileupload filter which parses the multipart request. public class FileBean { } private UploadedFile file.primefaces.FileUploadFilter </filter-class> </filter> <filter-mapping> <filter-name>PrimeFaces FileUpload Filter</filter-name> <servlet-name>Faces Servlet</servlet-name> </filter-mapping> Simple File Upload Simple file upload mode works in legacy mode with a file input whose value should be an UploadedFile instance.webapp. FileUploadListener is the way to access the uploaded files.primefaces. In this case.

<p:fileUpload fileUploadListener="#{fileBean. Following example displays a "File Uploaded" message using the growl component after file upload.handleFileUpload}" update="msg" /> <p:growl id="msg" /> public class FileBean { } public void handleFileUpload(FileUploadEvent event) { //add facesmessage to display with growl //application code } 179 .getFile().handleFileUpload}" multiple="true" /> Auto Upload Default behavior requires users to trigger the upload process. <p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" auto="true" /> Partial Page Update After the fileUpload process completes you can use the PrimeFaces PPR to update any component on the page. you can change this way by setting auto to true. Auto uploads are triggered as soon as files are selected from the dialog. <p:fileUpload fileUploadListener="#{fileBean. This way multiple files can be selected and uploaded together. FileUpload is equipped with the update attribute for this purpose.PrimeFaces Userʼs Guide public class FileBean { } public void handleFileUpload(FileUploadEvent event) { UploadedFile file = event. //application code } Multiple Uploads Multiple uploads can be enabled using the multiple attribute.

fileinput-button . Filter Configuration FileUpload filter’s default settings can be configured with init parameters. Following is the list of structural style classes. Class . this is as simple as setting the sizeLimit configuration. multi uploads. Content container. Upload button. see the main Skinning section for more information. Following fileUpload limits the size to 1000 bytes for each file.ui-fileupload . <p:fileUpload fileUploadListener="#{fileBean. example below demonstrates how to accept images only. <p:fileUpload fileUploadListener="#{fileBean. Cancel button. threshold size and temporary file upload location. Applies As skinning style classes are global. Two configuration options exist. It is also suggested to offer simple upload mode to the users of your application as a fallback.|\/)(gif|jpe?g|png)$/" description="Select Images"/> Size Limit Most of the time you might need to restrict the file upload size. progress tracking requires browsers that implement HTML5 features so advanced mode might behave differently across browsers and gracefully degrade for legacy browsers like IE.handleFileUpload}" sizeLimit="1000" /> Skinning FileUpload FileUpload resides in a container element which style and styleClass options apply. Browse button.ui-fileupload start . Browser Compatibility Rich upload functionality like dragdrop from filesystem.ui-fileupload cancel fileupload-content Main container element Button bar.fileupload-buttonbar .PrimeFaces Userʼs Guide File Filters Users can be restricted to only select the file types you’ve configured. 180 .handleFileUpload}" allowTypes="/(\.

By default it is System. 181 .filter.io. Tips • Multiple advanced uploaders in same form is not supported at the moment.PrimeFaces Userʼs Guide Parameter Name thresholdSize uploadDirectory Description Maximum file size in bytes to keep uploaded files in memory. it’ll be temporarily written to disk.tmpdir") An example configuration below defined thresholdSize to be 50kb and uploads to user’s temporary folder.getProperty("java.FileUploadFilter </filter-class> <init-param> <param-name>thresholdSize</param-name> <param-value>51200</param-value> </init-param> <init-param> <param-name>uploadDirectory</param-name> <param-value>/Users/primefaces/temp</param-value> </init-param> </filter> Note that uploadDirectory is used internally. you should implement the logic to save the file contents yourself in your backing bean. Disk repository path to keep temporary files that exceeds the threshold size. If a file exceeds this limit. <filter> <filter-name>PrimeFaces FileUpload Filter</filter-name> <filter-class> org.primefaces.webapp.

Input component can be any element such as input.primefaces. when set to false component will not be rendered.37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org. <p:focus /> <p:inputText .FocusRenderer org. Minimum severity level to be used when finding the first invalid component binding for context minSeverity null null null error Object String String String Getting started with Focus By default focus will find the first enabled and visible input component on page and apply focus.. /> 182 .component.component.primefaces.component.PrimeFaces Userʼs Guide 3.. An el expression that maps to a server side UIComponent instance in a backing bean Specifies the exact component to set focus The root component to start first input search..Focus.primefaces.focus. /> <h:selectOneMenu .Focus org.focus.component.primefaces.FocusRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org... /> <h:inputText ..FocusTag org. textarea and select.

firstname}" required="true" label="Firstname" /> <p:message for="firstname" /> <h:outputLabel for="surname" value="Surname: *" /> <h:inputText id="surname" value="#{pprBean.savePerson}" /> </p:panel> </h:form> When this page initially opens. <h:form> <p:panel id="panel" header="Register"> <p:focus /> <p:messages /> <h:panelGrid columns="3"> <h:outputLabel for="firstname" value="Firstname: *" /> <h:inputText id="firstname" value="#{pprBean. in this case focus will be set on surname field implicitly.surname}" required="true" label="Surname"/> <p:message for="surname" /> </h:panelGrid> <p:commandButton value="Submit" update="panel" actionListener="#{pprBean.PrimeFaces Userʼs Guide Following is a simple example. a validation error will be raised for surname. So in previous example if firstname field is valid but surname field has no input. Validation Aware Another useful feature of focus is that when validations fail. Explicit Focus Additionally. you need to update p:focus component as well. using for attribute focus can be set explicitly on an input component which is useful when using a dialog. first invalid component will receive a focus. <p:focus for="text"/> <h:inputText id="text" value="{bean.value}" /> 183 . input text with id "firstname" will receive focus as it is the first input component. Note that for this feature to work on ajax requests.

Style class of the container element.GalleriaRenderer org.component org.PrimeFaces Userʼs Guide 3.component.Galleria org. Collection of data to display.38 Galleria Galleria is used to display a set of images.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.galleria.GalleriaRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. when set to false component will not be rendered.galleria.Galleria org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class galleria org. 184 binding widgetVar value var style styleClass null null null null null null Object String Collection String String String . Inline style of the container element.component.primefaces.primefaces. Name of variable to access an item in collection.component.primefaces.

jpg" title="image1" <p:graphicImage value="/images/image2.jpg" title="image1" </p:galleria> 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. Defines interval of slideshow. Duration of animation in milliseconds. <p:galleria value="#{galleriaBean.path}" title="#{image. <p:galleria effect="slide" effectDuration="1000"> <p:graphicImage value="/images/image1.images}" var="image" > <p:graphicImage value="#{image.description}" /> </p:galleria> 185 . 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. Defines visibility of filmstrip. Height of the viewport. Width of the viewport. Getting Started with Galleria Images to displayed are defined as children of galleria. you would need to display a dynamic set of images rather than defining each image declaratively. Style of the filmstrip. Defines visibility of captions.jpg" title="image1" <p:graphicImage value="/images/image4.title}" alt="#{image. Dynamic Collection Most of the time.jpg" title="image1" <p:graphicImage value="/images/image3. Defines visibility of overlays. Position of the filmstrip. For this you can use built-in data iteration feature. Height of the frames.PrimeFaces Userʼs Guide Name effect effectSpeed panelWidth panelHeight frameWidth frameHeight filmstripStyle filmstripPosition showFilmstrip showCaptions showOverlays transitionInterval Default fade 700 600 400 60 40 null null TRUE FALSE FALSE 4000 Type String Integer Integer Integer Integer Integer String String Boolean Boolean Boolean Integer Description Name of animation to use. Width of the frames.

• • • • fade (default) flash pulse slide By default animation takes 700 milliseconds.ui-galleria-image .ui-galleria-description . 186 .ui-galleria-counter .ui-galleria-thumbnails-container .ui-galleria-image-thumb-nav-right Applies Container element for galleria.ui-galleria-image-thumb-nav-left . use effectDuration option to tune this. Container displaying thumbnail images.ui-galleria-thumbnails . Style Class .jpg" title="image1" <p:graphicImage value="/images/image2. Container displaying actual images. <p:galleria effect="slide" effectDuration="1000"> <p:graphicImage value="/images/image1.ui-galleria-stage .jpg" title="image1" </p:galleria> alt="image1 desc" /> alt=" image2 desc" /> alt=" image3 desc" /> alt=" image4 desc" /> Skinning Galleria resides in a main container element which style and styleClass options apply.jpg" title="image1" <p:graphicImage value="/images/image4. Thumbnail images list Each thumbnail in list Text showing image index/total Info overlay container Text in info overlay.jpg" title="image1" <p:graphicImage value="/images/image3.ui-galleria-info .PrimeFaces Userʼs Guide Effects There are four different options for the animation to display when switching images.ui-galleria-container . Following is the list of structural style classes. see the main Skinning section for more information. Info title Info description Left thumbnail navigator Right thumbnail navigator As skinning style classes are global.ui-galleria-title .ui-galleria-text .ui-galleria-thumbnails-list .

Gmap org.component.primefaces.GmapRenderer org.gmap.GMap org. when set to false component will not be rendered. Boolean value to specify the rendering of the component.GmapRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.PrimeFaces Userʼs Guide 3. Name of the client side widget.39 GMap GMap is a map component integrated with Google Maps API V3.gmap.component.primefaces.component org. binding widgetVar null null Object String 187 .component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class gmap org.primefaces.

Defines draggability of map.381542.google. <p:gmap center="41. lng format zoom: Zoom level of the map 188 . Getting started with GMap First thing to do is placing V3 of the Google Maps API that the GMap is based on. Disables default UI controls Defines visibility of navigation control. Controls street view support.com/maps/api/js?sensor=true|false" type="text/javascript"></script> As Google Maps api states. zoom. these are center. Disables zooming on mouse double click. Javascript callback to execute when a point on map is clicked. type and style. Style class of the map container.height:400px" /> center: Center of the map in lat. Defines if center and zoom should be calculated automatically to contain all markers on the map.PrimeFaces Userʼs Guide Name model style styleClass type center zoom streetView disableDefaultUI navigationControl mapTypeControl draggable disabledDoubleClickZoom onPointClick fitBounds Default null null null null null 8 FALSE FALSE TRUE TRUE TRUE FALSE null TRUE Type MapModel String String String String Integer Boolean Boolean Boolean Boolean Boolean Boolean String Boolean Description An org. mandatory sensor parameter is used to specify if your application requires a sensor like GPS locator.primefaces. 2. Ideal location is the head section of your page. Defines visibility of map type control. Defines the initial zoom level. Four options are required to place a gmap on a page. <script src="http://maps.122893" zoom="15" type="hybrid" style="width:600px.MapModel instance. Type of the map. Inline style of the map container. Center point of the map.model.

primefaces.height:400px" model="#{mapBean. MapModel GMap is backed by an org.model. "hybrid" and "terrain". PrimeFaces provides org.model. } } Polylines A polyline is represented by org. "satellite".primefaces.model}"/> public class MapBean { private MapModel model = new DefaultMapModel().model. <p:gmap center="41.map.height:400px" model="#{mapBean. 2.Polyline.primefaces.122893" zoom="15" type="hybrid" style="width:600px.model.addOverlay(new Marker(new LatLng(36.map. //more overlays } public MapModel getModel() { return this. style: Dimensions of the map.PrimeFaces Userʼs Guide type: Type of map.MapModel instance. public MapBean() { model. valid values are. "hybrid".Marker.map. Markers A marker is represented by org.667648).map.381542.879466. 30.model}"/> 189 . "M1")). <p:gmap center="41.model. 2.primefaces. API Docs of all GMap related model classes are available at the end of GMap section and also at javadocs of PrimeFaces.122893" zoom="15" type="hybrid" style="width:600px.381542.DefaultMapModel as the default implementation.

getPaths(). model. public MapBean() { model = new DefaultMapModel().model.addOverlay(polyline). polyline.706707)). polyline. 30. polyline. } public MapModel getModel() { return this. public MapBean() { model = new DefaultMapModel(). polyline.getPaths().primefaces.702323)). } public MapModel getModel() { return this. model.Circle. polyline. 2.getPaths().map.add(new LatLng(36. Polyline polyline = new Polyline().885233.height:400px" model="#{mapBean.381542.height:400px" model="#{mapBean.879466.add(new LatLng(36.add(new LatLng(36. } } 30.122893" zoom="15" type="hybrid" style="width:600px.primefaces. 37.122893" zoom="15" type="hybrid" style="width:600px.879703. 2. Polygons A polygon is represented by org.879703. polyline.883707.add(new LatLng(36.add(new LatLng(36.getPaths().667648)). 30.getPaths().addOverlay(polygon).PrimeFaces Userʼs Guide public class MapBean { private MapModel model.model}"/> 190 .model.map.667648)).689216)). <p:gmap center="41.381542.883707.706707)). polyline.model. Polygon polygon = new Polygon().getPaths().add(new LatLng(36.879466.add(new LatLng(36.model. <p:gmap center="41.model}"/> public class MapBean { private MapModel model.689216)).getPaths(). 30. } } Circles A circle is represented by org.Polygon. 30. 30.

model. .122893" zoom="15" type="hybrid" style="width:600px. When map state changes. 30. Rectangle rectangle = new Rectangle(coord1.primefaces.381542. } } Ajax Behavior Events GMap provides many custom ajax behavior events for you to hook-in to various features.event. public MapBean() { model = new DefaultMapModel(). } } Rectangles A circle is represented by org. LatLng coord2 = new LatLng(36.883707.map.height:400px" model="#{mapBean.StateChangeEvent org.879466.primefaces.event.map.OverlaySelectEvent org.primefaces.PointSelectEvent org.879466. <p:gmap center="41. When a marker is dragged.addOverlay(circle). Event overlaySelect stateChange pointSelect markerDrag Listener Parameter org.event.map. When an empty point is selected. } public MapModel getModel() { return this. LatLng coord1 = new LatLng(36. model. model.model.model. coord2).Rectangle.map.primefaces.map. } public MapModel getModel() { return this. 500).event. 30. public MapBean() { model = new DefaultMapModel().primefaces.MarkerDragEvent 191 Fired When an overlay is selected. 2.PrimeFaces Userʼs Guide public class MapBean { private MapModel model.667648).addOverlay(circle). 30.689216).667648). Circle circle = new Circle(new LatLng(36.model}"/> public class MapBean { private MapModel model.

onMarkerSelect}" /> <p:gmapInfoWindow> <p:graphicImage value="/images/#{mapBean. 2. //add facesmessage } } InfoWindow A common use case is displaying an info window when a marker is selected.data. displays an info window that contains an image of the selected marker data. Following example.381542.onMarkerSelect}" update="growl" /> </p:gmap> </h:form> public class MapBean { private MapModel model.title}" /> </p:gmapInfoWindow> </p:gmap> </h:form> 192 . //add markers } public MapModel getModel() { return model } public void onMarkerSelect(OverlaySelectEvent event) { Marker selectedMarker = (Marker) event.marker.PrimeFaces Userʼs Guide Following example displays a FacesMessage about the selected marker with growl component.122893" zoom="15" type="hybrid" style="width:600px.image}" /> <h:outputText value="#{mapBean. 2. gmapInfoWindow is used to implement this special use case. <h:form> <p:growl id="growl" /> <p:gmap center="41.height:400px" model="#{mapBean.height:400px" model="#{mapBean.381542. <h:form> <p:gmap center="41.model}"> <p:ajax event="overlaySelect" listener="#{mapBean.marker.122893" zoom="15" type="hybrid" style="width:600px. public MapBean() { model = new DefaultMapModel().getOverlay().data.model}"> <p:ajax event="overlaySelect" listener="#{mapBean.

} } Street View StreeView is enabled simply by setting streetView option to true.122893" zoom="15" type="hybrid" style="width:600px.PrimeFaces Userʼs Guide public class MapBean { private MapModel model. <p:gmap center="41. } public void onMarkerSelect(OverlaySelectEvent event) { this.381542. //add markers } public MapModel getModel() { return model. 2. private Marker marker. public MapBean() { model = new DefaultMapModel(). } public Marker getMarker() { return marker.height:400px" streetView="true" /> 193 .getOverlay().marker = (Marker) event.

google.PrimeFaces Userʼs Guide Map Controls Controls on map can be customized via attributes like navigationControl and mapTypeControl.122893" zoom="15" type="terrain" style="width:600px.DefaultMapModel is the default implementation) Method addOverlay(Overlay overlay) List<Marker> getMarkers() List<Polyline> getPolylines() List<Polygon> getPolygons() List<Circle> getCircles() List<Rectangle> getRectangles() Overlay findOverlay(String id) Adds an overlay to map Returns the list of markers Returns the list of polylines Returns the list of polygons Returns the list of circles Returns the list of rectangles. //gmap is a google.Map instance Full map api is provided at.map. <p:gmap center="41.html GMap API org.381542.MapModel (org.getMap().primefaces. 2.height:400px" Native Google Maps API In case you need to access native google maps api with javascript.com/apis/maps/documentation/javascript/reference.primefaces.model. Alternatively setting disableDefaultUI to true will remove all controls at once. use provided getMap() method.model. Finds an overlay by it’s unique id 194 Description . var gmap = yourWidgetVar.maps. http://code.map.

Overlay Property paths strokeColor Default null null List String Type List of coordinates Color of a line 195 Description .model.map.Marker extends org.model. shadow image is not displayed Defines visibility of the marker org.Polyline extends org.map.Polygon extends org.Overlay Property title latlng icon shadow cursor draggable clickable flat visible Default null null null null pointer FALSE TRUE FALSE TRUE Type String LatLng String String String Boolean Boolean Boolean Boolean Description Text to display on rollover Location of the marker Icon of the foreground Shadow image of the marker Cursor to display on rollover Defines if marker can be dragged Defines if marker can be dragged If enabled.model.map.model.primefaces.primefaces.model.PrimeFaces Userʼs Guide org.map.primefaces.primefaces.Overlay Property paths strokeColor strokeOpacity strokeWeight Default null null 1 1 List String Double Integer Type List of coordinates Color of a line Opacity of a line Width of a line Description org.map.map.Overlay Property id data zindex Default null null null Type String Object Integer Description Id of the overlay.primefaces.map. generated and used internally Data represented in marker Z-Index of the overlay org.model.primefaces.primefaces.model.

map.Overlay Property bounds strokeColor strokeOpacity strokeWeight fillColor fillOpacity Default null null 1 1 null 1 Type LatLngBounds String Double Integer String Double Description Boundaries of the rectangle.model. Stroke color of the rectangle.map.Rectangle extends org.primefaces.Circle extends org.primefaces.primefaces.primefaces.model. Background color of the circle.model. Background color of the rectangle.LatLng Property lat lng Default null null Type double double Description Latitude of the coordinate Longitude of the coordinate 196 .map. Stroke weight of the rectangle. org.model. Stroke opacity of circle. Description org. Opacity of the rectangle. Stroke color of the circle. Opacity of the circle.map.model. Stroke weight of the circle.map.Overlay Property center radius strokeColor strokeOpacity strokeWeight fillColor fillOpacity Default null null null 1 1 null 1 Type LatLng Double String Double Integer String Double Center of the circle Radius of the circle.primefaces.PrimeFaces Userʼs Guide Property strokeOpacity strokeWeight fillColor fillOpacity 1 1 Default Type Double Integer String Double Opacity of a line Weight of a line Description null 1 Background color of the polygon Opacity of the polygon org. Stroke opacity of rectangle.

StateChangeEvent Property bounds zoomLevel Default null 0 Type LatLngBounds Integer Description Boundaries of the map Zoom level of the map 197 .event.model.primefaces.primefaces.OverlaySelectEvent Property overlay Default null Type Overlay Description Selected overlay instance org.primefaces.primefaces.PrimeFaces Userʼs Guide org. org.map.event.primefaces.map.faces.FacesEvent.map.PointSelectEvent Property latLng Default null Type LatLng Description Coordinates of the selected point org.MarkerDragEvent Property marker Default null Type Marker Description Dragged marker instance org.event.event.LatLngBounds Property center northEast southWest Default null null null Type LatLng LatLng LatLng Description Center coordinate of the boundary NorthEast coordinate of the boundary SouthWest coordinate of the boundary GMap Event API All classes in event api extends from javax.map.map.event.

component.primefaces.GMapInfoWindowTag org.primefaces. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.GMapInfoWindow org.gmap.40 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Maximum width of the info window binding maxWidth null null Object Integer Getting started with GMapInfoWindow See GMap section for more information about how gmapInfoWindow is used. 198 .primefaces.component.gmap.GMapInfoWindow org.component. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

An el expression that maps to a server side UIComponent instance in a backing bean Binary data to stream or context relative path.component.component.GraphicImage org. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier.GraphicImage org.graphicimage.GraphicImageRenderer org. Legacy way to do this is to come up with a Servlet that does the streaming.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class graphicImage org.component org. when set to false component will not be rendered.primefaces.GraphicImageRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.41 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream.component.primefaces.primefaces. Alternate text for the image Alias to value attribute Width of the image Height of the image Title of the image Direction of the text displayed Language code Specifies to use a server-side image map Name of the client side map Style of the image 199 binding value alt url width height title dir lang ismap usemap style null null null null null null null null null FALSE null null Object Object String String String String String String String Boolean String String .graphicimage. GraphicImage does all the hard work without the need of a Servlet.PrimeFaces Userʼs Guide 3.primefaces.component.

200 . } public StreamedContent getImage() { return this. "image/jpeg"). public DynamicImageController() { InputStream stream = this.PrimeFaces Userʼs Guide Name styleClass onclick ondblclick onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup cache Default null null null null null null null null null null null TRUE Type String String String String String String String String String String String String Description Style class of the image onclick dom event handler ondblclick dom event handler onkeydown dom event handler onkeypress dom event handler onkeyup dom event handler onmousedown dom event handler onmousemove dom event handler onmouseout dom event handler onmouseover dom event handler onmouseup dom event handler Enables/Disables browser from caching the image Getting started with GraphicImage GraphicImage requires an org. image = new DefaultStreamedContent(stream. <p:graphicImage value="#{imageBean.getResourceAsStream("barcalogo.image}" /> public class ImageBean { } private StreamedContent image. } DefaultStreamedContent gets an inputstream as the first parameter and mime type as the second.image.getClass().jpg").StreamedContent content as it’s value. StreamedContent is an interface and PrimeFaces provides a built-in implementation called DefaultStreamedContent.primefaces. Following examples loads an image from the classpath.model.

} return dataset.0)). 375. 300). true. <p:graphicImage value="#{chartBean.saveChartAsPNG(chartFile. } catch (Exception e) { e.g.chart}" /> public class ChartBean { } private StreamedContent chart.8)). new Double(45. public StreamedContent getChart() { return this. ChartUtilities. "image/png"). chart = new DefaultStreamedContent( new FileInputStream(chartFile). public BackingBean() { try { JFreeChart jfreechart = ChartFactory.setValue("Izmir". JSF ChartCreator project which we’ve created in the past) to take full advantage of JFreechart API. new Double(25.0)).setValue("Antalya". dataset. } } private PieDataset createDataset() { DefaultPieDataset dataset = new DefaultPieDataset().setValue("Ankara". Here’s an example that generates a chart with JFreeChart and displays it with p:graphicImage. new Double(14.printStackTrace(). you can create the inputstream after reading the image from the database.ResultsSet API has the getBinaryStream() method to read blob files stored in database. new Double(15. dataset. Displaying Charts with JFreeChart StreamedContent is a powerful API that can display images created on-the-fly as well. dataset.chart. dataset.sql. File chartFile = new File("dynamichart"). createDataset().PrimeFaces Userʼs Guide In a real life application. jfreechart. } Basically p:graphicImage makes any JSF chart component using JFreechart obsolete and lets you to avoid wrappers(e.createPieChart( "Turkish Cities".2)). false). For example java. 201 .setValue("Istanbul". true.

} catch (Exception e) { e.createCode128("PRIMEFACES"). } 202 . barcode = new DefaultStreamedContent( new FileInputStream(barcodeFile). "image/jpeg").printStackTrace().barcode}" /> public class BarcodeBean { } private StreamedContent barcode. } } public BarcodeBean getBarcode() { return this. BarcodeImageHandler.barcode. barcodeFile). a barcode can be generated as well.saveJPEG( BarcodeFactory.PrimeFaces Userʼs Guide Displaying a Barcode Similar to the chart example. <p:graphicImage value="#{backingBean. public BackingBean() { try { File barcodeFile = new File("dynamicbarcode"). This sample uses barbecue project for the barcode API.

PrimeFaces Userʼs Guide Displaying Regular Images As GraphicImage extends standard graphicImage component. This is extremely handy to display dynamic images if your image is in a data iteration component like datatable or ui:repeat. as a result the actual request rendering the image can have access to these values. first browser will make a request to load the page and then another one to the dynamic image url that points to JSF resource handler. <p:graphicImage value="barcalogo. • Unique session key is appended to the image url that points to JSF resource handler. Please note that you cannot use viewscope beans as viewscoped bean is not available in resource loading request. As a result there will be 2 requests to display an image.jpg" /> How It Works Dynamic image display works as follows. Passing Parameters and Data Iteration You can pass request parameters to the graphicImage via f:param tags. evaluates it to get the instance of StreamedContent from bean and streams contents to client. 203 . • Custom PrimeFaces ResourceHandler get the key from the url. • Dynamic image puts its value expression string to the http session with a unique key. retrieves the expression string like #{bean.streamedContentValue}. it can also display regular non dynamic images.

component.primefaces.component. 204 binding sticky showSummary showDetail globalOnly life autoUpdate null FALSE TRUE FALSE FALSE 6000 FALSE Object Boolean Boolean Boolean Boolean Integer Boolean .GrowlRenderer org.component.component.component org.primefaces. when set to false component will not be rendered.growl. When true.42 Growl Growl is based on the Mac’s growl notification widget and used to display FacesMessages in an overlay. Specifies if the detail of message should be displayed.growl. Specifies auto update mode.PrimeFaces Userʼs Guide 3.Growl org. An el expression that maps to a server side UIComponent instance in a backing bean Specifies if the message should stay instead of hidden automatically.primefaces.Growl org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class growl org.primefaces.GrowlRenderer Attributes Name id rendered null TRUE Default Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. only facesmessages without clientids are displayed.primefaces. Specifies if the summary of message should be displayed. Duration in milliseconds to display non-sticky messages.

<p:growl /> Lifetime of messages By default each message will be displayed for 6000 ms and then hidden. <p:growl id="messages"/> <p:commandButton value="Submit" update="messages" /> Positioning Growl is positioned at top right corner by default. position can be controlled with a CSS selector called ui-growl. growl will be updated automatically with each ajax request anyway. it’s also possible to tune the duration of displaying messages. With the below setting growl will be located at top left corner.PrimeFaces Userʼs Guide Name redisplay Default TRUE Type Boolean Description Defines if already rendered messaged should be displayed. Simply place growl anywhere on your page. the location of growl in JSF page does not matter. since messages are displayed as an overlay. Following growl will display the messages for 5 seconds and then fade-out. Getting Started with Growl Growl usage is similar to standard h:messages component.ui-growl { left:20px. A message can be made sticky meaning it’ll never be hidden automatically. . <p:growl sticky="true" /> If growl is not working in sticky mode. Note that if you enable autoUpdate. <p:growl life="5000" /> Growl with Ajax Updates If you need to display messages with growl after an ajax request you just need to update it. } 205 .

ui-growl-image-error .ui-growl-image-fatal Applies Main container element of growl Container of messages Container of a message Text message container Summary of the message Detail of the message Severity icon Info severity icon Warning severity icon Error severity icon Fatal severity icon As skinning style classes are global.ui-growl-image .ui-growl-message . 206 .ui-growl-title .ui-growl-image-info . see the main Skinning section for more information.ui-growl-message p . Style Class .ui-growl .ui-growl-item .ui-growl-image-warn .ui-growl-item-container .PrimeFaces Userʼs Guide Skinning Following is the list of structural style classes.

43 HotKey HotKey is a generic key binding component that can bind any formation of keys to javascript event handlers or ajax calls. An actionlistener that’d be processed in the partial request caused by uiajax. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class hotkey org. Javascript event handler to be executed when the key binding is pressed. Client side id of the component(s) to be updated after async partial submit request.HotKeyRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.component. when set to false component will not be rendered.HotKey org.HotKeyRenderer org.primefaces.primefaces. When set to true. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3. when false at invoke_application phase.hotkey. Boolean value that determines the phaseId.HotKey org. binding bind handler action actionListener immediate null null null null null FALSE Object String String MethodExpr MethodExpr Boolean async process update FALSE null null Boolean String String 207 .component.hotkey.component.primefaces.primefaces. A method expression that’d be processed in the partial request caused by uiajax. ajax requests are not queued.primefaces.component org. Component id(s) to process partially instead of whole view. An el expression that maps to a server side UIComponent instance in a backing bean The Key binding.component. when true actions are processed at apply_request_values.

" /> When this hotkey is on page." /> <p:hotkey bind="right" handler="switcher. either on client side with the event handler or with ajax support. Javascript handler to execute when ajax request fails.PrimeFaces Userʼs Guide Name onstart oncomplete onsuccess onerror global Default null null null null TRUE String String String String Type Description Javascript handler to execute before ajax request is begins." /> <p:imageSwitch widgetVar="switcher"> //content </p:imageSwitch> 208 . setting global to false will not trigger ajaxStatus." /> <p:hotkey bind="ctrl+shift+s" handler="alert(‘Pressed ctrl+shift+s’)" /> Integration Here’s an example demonstrating how to integrate hotkeys with a client side api.previous(). Javascript handler to execute when ajax request is completed. Using left and right keys will switch the images displayed via the p:imageSwitch component. <p:hotkey bind="left" handler="switcher. pressing the a key will alert the ‘Pressed key a’ text. Javascript handler to execute when ajax request succeeds. <p:hotkey bind="ctrl+s" handler="alert(‘Pressed ctrl+s’). Simplest example would be. Boolean Getting Started with HotKey HotKey is used in two ways. <p:hotkey bind="a" handler="alert(‘Pressed a’). Key combinations Most of the time you’d need key combinations rather than a single key. Global ajax requests are listened by ajaxStatus component.next().

<h:form> <p:hotkey bind="ctrl+shift+s" update="display" /> <h:panelGrid columns="2"> <h:outputLabel for="name" value="Name:" /> <h:inputText id="name" value="#{bean.firstname}" /> </h:form> Note that hotkey will not be triggered if there is a focused input on page. 209 .name}" /> </h:panelGrid> <h:outputText id="dsplay" value="Hello: #{bean.PrimeFaces Userʼs Guide Ajax Support Ajax is a built-in feature of hotKeys meaning you can do ajax calls with key combinations. Following form can be submitted with the ctrl+shift+s combination.

Client side callback to execute when user goes idle.idlemonitor. <p:idleMonitor onidle="idleDialog.primefaces. Example below toggles visibility of a dialog to respond these events.primefaces. when set to false component will not be rendered.primefaces.primefaces. are you there?" /> </p:dialog> 210 .IdleMonitor org.primefaces.idlemonitor.IdleMonitor Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.IdleMonitor org. you can hook-in to client side events that are called when a user goes idle or becomes active again.component.show(). Name of the client side widget.PrimeFaces Userʼs Guide 3.hide()." onactive="idleDialog.44 IdleMonitor IdleMonitor watches user actions on a page and notify callbacks in case they go idle or active again. An el expression that maps to a server side UIComponent instance in a backing bean Time to wait in milliseconds until deciding if the user is idle.component."/> <p:dialog header="What's happening?" widgetVar="idleDialog" modal="true"> <h:outputText value="Dude.component org.IdleMonitorRenderer org.component. binding timeout onidle onactive widgetVar null 300000 null null null Object Integer String String String Getting Started with IdleMonitor To begin with. Client side callback to execute when user goes idle.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class idleMonitor org. Default is 5 minutes.

You can customize this duration with the timeout attribute. Example below displays messages for each event.activeListener}" update="msg" /> </p:idleMonitor> <p:growl id=”msg” /> public class Bean { public void idleListener() { //Add facesmessage } } public void idle() { //Add facesmessage } 211 . <p:idleMonitor timeout="5000" update="messages"> <p:ajax event="idle" listener="#{bean. idleMonitor waits for 5 minutes (300000 ms) until triggering the onidle event. Ajax Behavior Events IdleMonitor provides two ajax behavior events which are idle and active that are fired according to user status changes.idleListener}" update="msg" /> <p:ajax event="active" listener="#{bean.PrimeFaces Userʼs Guide Controlling Timeout By default.

PrimeFaces Userʼs Guide

3.45 ImageCompare
ImageCompare provides a rich user interface to compare two images.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCompare org.primefaces.component.imagecompare.ImageCompare org.primefaces.component.ImageCompare org.primefaces.component org.primefaces.component.ImageCompareRenderer org.primefaces.component.imagecompare.ImageCompareRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

Description Name of the client side widget. Source of the image placed on the left side Source of the image placed on the right side Width of the images Height of the images Inline style of the container element Style class of the container element

Getting started with ImageCompare ImageCompare is created with two images with same height and width. It is required to set width and height of the images as well.
<p:imageCompare leftImage="xbox.png" rightImage="ps3.png" width="438" height="246"/>

Skinning Both images are placed inside a div container element, style and styleClass attributes apply to this element.

213

PrimeFaces Userʼs Guide

3.46 ImageCropper
ImageCropper allows cropping a certain region of an image. A new image is created containing the cropped area and assigned to a CroppedImage instanced on the server side.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCropper org.primefaces.component. imagecropper.ImageCropper org.primefaces.component.ImageCropper org.primefaces.component org.primefaces.component.ImageCropperRenderer org.primefaces.component.imagecropper.ImageCropperRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

Description When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Context relative path to the image. Alternate text of the image. Aspect ratio of the cropper area. Minimum size of the cropper area. Maximum size of the cropper area. Background color of the container. Background opacity of the container Initial coordinates of the cropper area.

required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar image alt aspectRatio minSize maxSize backgroundColor backgroundOpacity initialCoords

FALSE null null null null null null null null null null null null 0,6 null

Boolean MethodExpr ValueChange Listener String String String String String String Double String String String Double String

Getting started with the ImageCropper ImageCropper is an input component and image to be cropped is provided via the image attribute. The cropped area of the original image is used to create a new image, this new image can be accessed on the backing bean by setting the value attribute of the image cropper. Assuming the image is at %WEBAPP_ROOT%/campnou.jpg
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" />

public class Cropper { private CroppedImage croppedImage; //getter and setter }

215

PrimeFaces Userʼs Guide

org.primefaces.model.CroppedImage belongs a PrimeFaces API and contains handy information about the crop process. Following table describes CroppedImage properties.
Property originalFileName bytes left right width height Type String byte[] int int int int Description Name of the original file that’s cropped Contents of the cropped area as a byte array Left coordinate Right coordinate Width of the cropped image Height of the cropped image

External Images ImageCropper has the ability to crop external images as well.
<p:imageCropper value="#{cropper.croppedImage}" image="http://primefaces.prime.com.tr/en/images/schema.png"> </p:imageCropper>

Context Relative Path For local images, ImageCropper always requires the image path to be context relative. So to accomplish this simply just add slash ("/path/to/image.png") and imagecropper will recognize it at %WEBAPP_ROOT%/path/to/image.png. Action url relative local images are not supported. Initial Coordinates By default, user action is necessary to initiate the cropper area on an image, you can specify an initial area to display on page load using initialCoords option in x,y,w,h format.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" initialCoords="225,75,300,125"/>

Boundaries minSize and maxSize attributes are control to limit the size of the area to crop.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" minSize="50,100" maxSize="150,200"/>

216

PrimeFaces Userʼs Guide

Saving Images Below is an example to save the cropped image to file system.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" /> <p:commandButton value="Crop" actionListener="#{myBean.crop}" />

public class Cropper { private CroppedImage croppedImage; //getter and setter public String crop() { ServletContext servletContext = (ServletContext) FacesContext.getCurrentInstance().getExternalContext().getContext(); String newFileName = servletContext.getRealPath("") + File.separator + "ui" + File.separator + "barca" + File.separator+ croppedImage.getOriginalFileName() + "cropped.jpg"; FileImageOutputStream imageOutput; try { imageOutput = new FileImageOutputStream(new File(newFileName)); imageOutput.write(croppedImage.getBytes(), 0, croppedImage.getBytes().length); imageOutput.close(); } catch (Exception e) { e.printStackTrace(); } return null; } }

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageSwitch org.primefaces.component.imageswitch.ImageSwitch org.primefaces.component.ImageSwitch org.primefaces.component org.primefaces.component.ImageSwitchRenderer org.primefaces.component.imageswitch.ImageSwitchRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Name of the effect for transition. Speed of the effect in milliseconds. Slideshow speed in milliseconds. Starts slideshow automatically on page load. Style of the main container. Style class of the main container.
218

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

Getting Started with ImageSwitch ImageSwitch component needs a set of images to display. Provide the image collection as a set of children components.
<p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> <p:graphicImage value="/images/nature1.jpg" /> <p:graphicImage value="/images/nature2.jpg" /> <p:graphicImage value="/images/nature3.jpg" /> <p:graphicImage value="/images/nature4.jpg" /> </p:imageSwitch>

Most of the time, images could be dynamic, ui:repeat is supported to implement this case.
<p:imageSwitch widgetVar="imageswitch"> <ui:repeat value="#{bean.images}" var="image"> <p:graphicImage value="#{image}" /> </ui:repeat> </p:imageSwitch>

Slideshow or Manual ImageSwitch is in slideShow mode by default, if you’d like manual transitions disable slideshow and use client side api to create controls.
<p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> //images </p:imageSwitch> <span onclick="imageswitch.previous();">Previous</span> <span onclick="imageswitch.next();">Next</span>

Client Side API
Method void previous() void next() void startSlideshow() void stopSlideshow() voud pauseSlideshow(); void toggleSlideShow() Description Switches to previous image. Switches to next image. Starts slideshow mode. Stops slideshow mode. Pauses slideshow mode. Toggles slideshow mode.

219

PrimeFaces Userʼs Guide

Effect Speed The speed is considered in terms of milliseconds and specified via the speed attribute.
<p:imageSwitch effect="FlipOut" speed="150" widgetVar="imageswitch" > //set of images </p:imageSwitch>

List of Effects ImageSwitch supports a wide range of transition effects. Following is the full list, note that values are case sensitive. • • • • • • • • • • • • • • • • • • • • • • • • • • • blindX blindY blindZ cover curtainX curtainY fade fadeZoom growX growY none scrollUp scrollDown scrollLeft scrollRight scrollVert shuffle slideX slideY toss turnUp turnDown turnLeft turnRight uncover wipe zoom

220

Label to be shown in display mode.component.Inplace org. Inline style of the main container element.inplace. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Specifies the editor mode.component. Label to be shown in display mode when value is empty.PrimeFaces Userʼs Guide 3. Prevents hidden content to be shown. Speed of the effect.InplaceRenderer org.Inplace org.component. Inplace consists of two members. 221 binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor null null null null fade normal FALSE null null FALSE Object String String String String String Boolean String String Boolean .inplace.primefaces.48 Inplace Inplace provides easy inplace editing and inline content display.InplaceRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inplace org.primefaces. display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.component org. when set to false component will not be rendered.primefaces.primefaces. Style class of the main container element.primefaces. Effect to be used when toggling.component.

normal and fast. <p:inplace label="Show Image" effect="slide" effectSpeed="fast"> <p:graphicImage value="/images/nature1. also effect speed can be tuned with values slow. Name of the client side event to display inline content.PrimeFaces Userʼs Guide Name saveLabel cancelLabel event toggleable Default Save Cancel click TRUE Type String String String Boolean Description Tooltip text of save buttin in editor mode. <h:outputText value="Select One:" /> <p:inplace label="Cities"> <h:selectOneMenu> <f:selectItem itemLabel="Istanbul" itemValue="Istanbul" /> <f:selectItem itemLabel="Ankara" itemValue="Ankara" /> </h:selectOneMenu> </p:inplace> Effects Default effect is fade and other possible effect is slide. Tooltip text of cancel buttin in editor mode. you can customize it via the label attribute. Getting Started with Inplace The inline component needs to be a child of inplace.jpg" /> </p:inplace> 222 . Defines if inplace is toggleable or not. <p:inplace> <h:inputText value="Edit me" /> </p:inplace> Custom Labels By default inplace displays it’s first child’s value as the label.

223 . //getter-setter } <p:inplace editor="true"> <h:inputText value="#{inplaceBean. public class InplaceBean { private String text. } public void handleSave() { //add faces message with update text value } //getter-setter <p:inplace editor="true"> <p:ajax event="save" listener="#{inplaceBean.text}" /> </p:inplace> save and cancel are two provided ajax behaviors events you can use to hook-in the editing process.widget.Inplace Method show() hide() Params Return Type void void Description Shows content and hides display element.handleSave}" update="msgs" /> <h:inputText value="#{inplaceBean. public class InplaceBean { private String text. Shows display element and hides content.PrimeFaces Userʼs Guide Ajax Behavior Events Inplace editing is enabled via editor option.text}" /> </p:inplace> <p:growl id="msgs" /> Client Side API Widget: PrimeFaces.

ui-inplace-cancel Applies Main container element.ui-inplace-editor . Triggers an ajax request to process inplace input. Triggers an ajax request to revert inplace input. Skinning Inplace resides in a main container element which style and styleClass options apply.PrimeFaces Userʼs Guide Method toggle() save() cancel() Params - Return Type void void void Description Toggles visibility of between content and display element. Editor controls container. Inline content. see the main Skinning section for more information.ui-inplace-content . Main container element when disabled. Style Class . Cancel button. Following is the list of structural style classes. Save button.ui-inplace-display .ui-inplace-save .ui-inplace .ui-inplace-disabled . Display element. As skinning style classes are global. 224 .

PrimeFaces Userʼs Guide

3.49 InputMask
InputMask forces an input to fit in a defined mask template.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputMask org.primefaces.component.inputmask.InputMask org.primefaces.component.InputMask org.primefaces.component org.primefaces.component.InputMaskRenderer org.primefaces.component.inputmask.InputMaskRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Mask template PlaceHolder in mask template. Value of the component than can be either an EL expression of a literal text

binding mask placeHolder value

null null null null

Object Integer String Object

225

PrimeFaces Userʼs Guide

Name converter

Default null

Type Converter/ String

Description An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked.

immediate required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange

FALSE FALSE null null null null null null null null null null FALSE null null null null null

Boolean Boolean MethodExpr MethodExpr String String String String String String String String Boolean String String Integer String String

onclick ondblclick

null null

String String

226

PrimeFaces Userʼs Guide

Name onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title

Default null null null null null null null null null null FALSE null null null null null

Type String String String String String String String String String String Boolean Integer String String Integer String

Description Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton.

Getting Started with InputMask InputMask below enforces input to be in 99/99/9999 date format.
<p:inputMask value="#{bean.field}" mask="99/99/9999" />

Mask Samples Here are more samples based on different masks;
227

PrimeFaces Userʼs Guide
<h:outputText value="Phone: " /> <p:inputMask value="#{bean.phone}" mask="(999) 999-9999"/> <h:outputText value="Phone with Ext: " /> <p:inputMask value="#{bean.phoneExt}" mask="(999) 999-9999? x99999"/> <h:outputText value="SSN: " /> <p:inputMask value="#{bean.ssn}" mask="999-99-9999"/> <h:outputText value="Product Key: " /> <p:inputMask value="#{bean.productKey}" mask="a*-999-a999"/>

Skinning style and styleClass options apply to the displayed input element. As skinning style classes are global, see the main Skinning section for more information.

228

PrimeFaces Userʼs Guide

3.50 InputText
InputText is an extension to standard inputText with skinning capabilities.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputText org.primefaces.component.inputtext.InputText org.primefaces.component.InputText org.primefaces.component org.primefaces.component.InputTextRenderer org.primefaces.component.inputtext.InputTextRender

Attributes
Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails.
229

immediate required validator valueChangeListener requiredMessage

FALSE FALSE null null null

Boolean Boolean Method Expr Method Expr String

PrimeFaces Userʼs Guide

Name converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout

Default null null null null null null null FALSE null null null null null null null null null null null null null null

Type String String String String String String String Boolean String String Integer String String String String String String String String String String String

Description Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element.

230

PrimeFaces Userʼs Guide

Name onmouseover onmouseup onselect readonly size style styleClass tabindex title type

Default null null null FALSE null null null null null text

Type String String String Boolean Integer String String Integer String String

Description Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton. Input field type.

Getting Started with InputText InputText usage is same as standard inputText;
<p:inputText value="#{bean.propertyName}" />

public class Bean { private String propertyName; } //getter and setter

Skinning style and styleClass options apply to the input element. As skinning style classes are global, see the main Skinning section for more information.

231

PrimeFaces Userʼs Guide

3.51 InputTextarea
InputTextarea is an extension to standard inputTextara with skinning capabilities and auto growing.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputTextarea org.primefaces.component.inputtextarea.InputTextarea org.primefaces.component.InputTextarea org.primefaces.component org.primefaces.component.InputTextareaRenderer org.primefaces.component.inputtextarea.InputTextareaRender

Attributes
Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input
232

immediate required validator

FALSE FALSE null

Boolean Boolean Method Expr

PrimeFaces Userʼs Guide

Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar autoResize accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup

Default null null null null null TRUE null null null null FALSE null null null null null null null null null null null

Type Method Expr String String String String Boolean String String String String Boolean String String Integer String String String String String String String String

Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Specifies auto growing when being typed. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element.

233

Position of the input element in the tabbing order. if content height exceeds the allocated space. <p:inputTextarea value="#{bean. Client side callback to execute when a pointer button is released over input element. Inline style of the input element. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Client side callback to execute when a pointer button is moved away from input element. Getting Started with InputTextarea InputTextarea usage is same as standard inputTextarea. see the main Skinning section for more information. As skinning style classes are global. Client side callback to execute when text within input element is selected by user. textarea can grow automatically.propertyName}" /> AutoResize When textarea is being typed. Skinning style and styleClass options apply to the textarea element. Client side callback to execute when a pointer button is moved onto input element. Use autoResize option to turn on/off this feature. 234 .PrimeFaces Userʼs Guide Name onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null null null null FALSE null null null null null Type String String String String String String Boolean Integer String String Integer String Description Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Style class of the input element. Advisory tooltip informaton.

component. Notable features are the customizable layouts and skinning capabilities. When it’s an EL expression.PrimeFaces Userʼs Guide 3.primefaces. when set to false component will not be rendered. In case it’s a static text. it must refer to a converter id When set true. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class keyboard org.Keyboard org. 235 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean .primefaces.Keyboard org.component.primefaces.KeyboardRenderer org.component.primefaces.component.52 Keyboard Keyboard is an input component that uses a virtual keyboard to provide the input.component org.keyboard. it’s resolved to a converter instance.primefaces.KeyboardRenderer Attributes Name id rendered Default Assigned by JSF TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. process validations logic is executed at apply request values phase for this component.keyboard.

PrimeFaces Userʼs Guide

Name required validator valueChangeListener requiredMessage converterMessage validatorMessage password showMode buttonImage buttonImageOnly effect effectDuration layout layoutTemplate keypadOnly promptLabel closeLabel clearLabel backspaceLabel accesskey alt autocomplete dir disabled label lang

Default FALSE null null null null null FALSE focus null FALSE fadeIn null qwerty null focus null null null null null null null null FALSE null null

Type Boolean MethodExpr MethodExpr String String String Boolean String String boolean String String String String Boolean String String String String String String String String Boolean String String

Description Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Makes the input a password field. Specifies the showMode, ‘focus’, ‘button’, ‘both’ Image for the button. When set to true only image of the button would be displayed. Effect of the display animation. Length of the display animation. Built-in layout of the keyboard. Template of the custom layout. Specifies displaying a keypad instead of a keyboard. Label of the prompt text. Label of the close key. Label of the clear key. Label of the backspace key. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component.

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

Description Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton.
237

onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title

null null null null null null null null null null null null FALSE null null null null null

String String String String String String String String String String String String Boolean Integer String String Integer String

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

Getting Started with Keyboard Keyboard is used just like a simple inputText, by default when the input gets the focus a keyboard is displayed.
<p:keyboard value="#{bean.value}" />

Built-in Layouts There’re a couple of built-in keyboard layouts these are ‘qwerty’, ‘qwertyBasic’ and ‘alphabetic’. For example keyboard below has the alphabetic layout.
<p:keyboard value="#{bean.value}" layout="alphabetic"/>

Custom Layouts Keyboard has a very flexible layout mechanism allowing you to come up with your own layout.
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="prime-back,faces-clear,rocks-close"/>

Another example;

238

PrimeFaces Userʼs Guide
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="create-space-your-close,owntemplate-shift,easily-spacespacebar"/>

A layout template basically consists of built-in keys and your own keys. Following is the list of all built-in keys. • • • • • • • back clear close shift spacebar space halfspace

All other text in a layout is realized as seperate keys so "prime" would create 5 keys as "p" "r" "i" "m" "e". Use dash to seperate each member in layout and use commas to create a new row. Keypad By default keyboard displays whole keys, if you only need the numbers use the keypad mode.
<p:keyboard value="#{bean.value}" keypadOnly="true"/>

ShowMode There’re a couple of different ways to display the keyboard, by default keyboard is shown once input field receives the focus. This is customized using the showMode feature which accept values ‘focus’, ‘button’, ‘both’. Keyboard below displays a button next to the input field, when the button is clicked the keyboard is shown.
<p:keyboard value="#{bean.value}" showMode="button"/>

Button can also be customized using the buttonImage and buttonImageOnly attributes.
239

PrimeFaces Userʼs Guide

3.53 Layout
Layout component features a highly customizable borderLayout model making it very easy to create complex layouts even if you’re not familiar with web design.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class layout org.primefaces.component.layout.Layout org.primefaces.component.Layout org.primefaces.component org.primefaces.component.LayoutRenderer org.primefaces.component.layout.LayoutRenderer

Attributes
Name id rendered binding widgetVar fullPage Default null TRUE null null FALSE Type String Boolean Object String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Specifies whether layout should span all page or not.

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

Description Style to apply to container element, this is only applicable to element based layouts. Style class to apply to container element, this is only applicable to element based layouts. Client side callback to execute when a layout unit is resized. Client side callback to execute when a layout unit is closed. Client side callback to execute when a layout unit is toggled. Title label of the resize button. Title label of the collapse button. Title label of the expand button. Title label of the close button.

Getting started with Layout Layout is based on a borderLayout model that consists of 5 different layout units which are top, left, center, right and bottom. This model is visualized in the schema below;

Full Page Layout Layout has two modes, you can either use it for a full page layout or for a specific region in your page. This setting is controlled with the fullPage attribute which is false by default. The regions in a layout are defined by layoutUnits, following is a simple full page layout with all possible units. Note that you can place any content in each layout unit.

241

PrimeFaces Userʼs Guide
<p:layout fullPage="true"> <p:layoutUnit position="north" size="50"> <h:outputText value="Top content." /> </p:layoutUnit> <p:layoutUnit position="south" size="100"> <h:outputText value="Bottom content." /> </p:layoutUnit> <p:layoutUnit position="west" size="300"> <h:outputText value="Left content" /> </p:layoutUnit> <p:layoutUnit position="east" size="200"> <h:outputText value="Right Content" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Center Content" /> </p:layoutUnit> </p:layout>

Forms in Full Page Layout When working with forms and full page layout, avoid using a form that contains layoutunits as generated dom may not be the same. So following is invalid.
<p:layout fullPage="true"> <h:form> <p:layoutUnit position="west" size="100"> h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> </h:form>

</p:layout>

A layout unit must have it’s own form instead, also avoid trying to update layout units because of same reason, update it’s content instead. Dimensions Except center layoutUnit, other layout units must have dimensions defined via size option. Element based layout Another use case of layout is the element based layout. This is the default case actually so just ignore fullPage attribute or set it to false. Layout example below demonstrates creating a split panel implementation.
242

PrimeFaces Userʼs Guide

<p:layout style="width:400px;height:200px"> <p:layoutUnit position="west" size="100"> <h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> //more layout units

</p:layout>

Ajax Behavior Events Layout provides custom ajax behavior events for each layout state change.
Event toggle close resize Listener Parameter org.primefaces.event.ToggleEvent org.primefaces.event.CloseEvent org.primefaces.event.ResizeEvent Fired When a unit is expanded or collapsed. When a unit is closed. When a unit is resized.

Stateful Layout Making layout stateful would be easy, once you create your data to store the user preference, you can update this data using ajax event listeners provided by layout. For example if a layout unit is collapsed, you can save and persist this information. By binding this persisted information to the collapsed attribute of the layout unit layout will be rendered as the user left it last time. Client Side API Widget: PrimeFaces.widget.Layout
Method toggle(position) show(position) hide(unit) Params position position position Return Type void void void Toggles layout unit. Shows layout unit. Hides layout unit. Description

243

PrimeFaces Userʼs Guide

Skinning Following is the list of structural style classes;
Style Class .ui-layout .ui-layout-doc .ui-layout-unit .ui-layout-{position} .ui-layout-unit-header .ui-layout-unit-content Applies Main wrapper container element Layout container Each layout unit container Position based layout unit Layout unit header Layout unit body

As skinning style classes are global, see the main Skinning section for more information.

244

Text of header. Style class of the component.primefaces. Text of footer.component. Specifies default visibility Specifies toggle status of unit Size of the unit when collapsed Inline style of the component. when set to false component will not be rendered. Minimum dimension for resize. Gutter size of layout unit. Makes the unit closable. Makes the unit resizable.primefaces.54 LayoutUnit LayoutUnit represents a region in the border layout model of the Layout component.primefaces. Info Tag Component Class Component Type Component Family layoutUnit org. 245 binding position size resizable closable collapsible header footer minSize maxSize gutter visible collapsed collapseSize style styleClass null null null FALSE FALSE FALSE null null null null 4px TRUE FALSE null null null Object String String Boolean Boolean Boolean String String Integer Integer String Boolean Boolean Integer String String . An el expression that maps to a server side UIComponent instance in a backing bean Position of the unit. Maximum dimension for resize.layout. Size of the unit.LayoutUnit org.component.PrimeFaces Userʼs Guide 3.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Makes the unit collapsible.LayoutUnit org.

PrimeFaces Userʼs Guide Name effect effectSpeed Default null null Type String String Description Effect name of the layout transition. Getting started with LayoutUnit See layout component documentation for more information regarding the usage of layoutUnits. 246 . Effect speed of the layout transition.

component lightbox. Style class of the container element not the overlay element. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lightBox org.component org. when set to false component will not be rendered.LightBoxRenderer Attributes Name id rendered binding widgetVar style styleClass Default null TRUE null null null null Type String Boolean Object String String String Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.PrimeFaces Userʼs Guide 3.component. multimedia content.LightBox org.component.primefaces.primefaces. other JSF components and external urls. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component. 247 .LightBox org.LightBoxRenderer org.primefaces. Style of the container element not the overlay element.55 LightBox Lightbox features a powerful overlay that can display images.primefaces.lightbox.

Client side callback to execute when lightbox is displayed. you can display other JSF content on the page using the lightbox overlay. following lightbox displays the PrimeFaces homepage when the link inside is clicked. 248 . Simply place your overlay content in the "inline" facet.org" title="PrimeFaces HomePage"> <h:outputText value="PrimeFaces HomePage"/> </h:outputLink> </p:lightBox> Clicking the outputLink will display PrimeFaces homepage within an iframe. Inline Mode Inline mode acts like a modal dialog. Images The images displayed in the lightBox need to be nested as child outputLink components.PrimeFaces Userʼs Guide Name width heigth iframe visible onHide onShow Default null null FALSE FALSE null null Type String String Boolean Boolean String String Description Width of the overlay in iframe mode.jpg" title="Sopranos 1"> <h:graphicImage value="sopranos/sopranos1_small. <p:lightBox iframe="true"> <h:outputLink value="http://www. Client side callback to execute when lightbox is hidden. Clicking the link in the example below will display the panelGrid contents in overlay. Specifies an iframe to display an external url in overlay.primefaces. Displays lightbox without requiring any user interaction by default. Height of the overlay in iframe mode. <p:lightBox> <h:outputLink value="sopranos/sopranos1.jpg/> </h:outputLink> //more </p:lightBox> IFrame Mode LightBox also has the ability to display iframes inside the page overlay. Following lightBox is displayed when any of the links are clicked.

PrimeFaces Userʼs Guide <p:lightBox> <h:outputLink value="#" title="Leo Messi" > <h:outputText value="The Messiah"/> </h:outputLink> <f:facet name="inline"> //content here </f:facet> </p:lightBox> Inline Mode Inline mode acts like a modal dialog. Previous image navigator. see the main Skinning section for more information. Client Side API Widget: PrimeFaces. you can display other JSF content on the page using the lightbox overlay. Description Skinning Lightbox resides in a main container element which style and styleClass options apply.ui-lightbox-nav-right . Simply place your overlay content in the "inline" facet. As skinning style classes are global.ui-lightbox-loading . Style Class . Clicking the link in the example below will display the panelGrid contents in overlay.ui-lightbox-nav-left .ui-lightbox . Following is the list of structural style classes.LightBox Method show() hide() Params Return Type void void Displays lightbox. Hides lightbox.ui-lightbox-content-wrapper .widget. Content wrapper element. Caption element.ui-lightbox-caption Applies Main container element. 249 .ui-lightbox-content . Next image navigator. Loading image. Content container.

Log org.LogRenderer org.Log org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.component.component. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting started with Log Log component is used simply as adding the component to the page.component.56 Log Log component is a visual console to display logs on JSF pages.PrimeFaces Userʼs Guide 3.component.log.component org. 250 .primefaces.primefaces.log.primefaces.primefaces.primefaces.LogRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.

PrimeFaces.debug(‘Debug message’). <script type=”text/javascript”> PrimeFaces. for example you can use log component to see details of an ajax request.warn(‘Warning message’).error(‘Error message’). PrimeFaces.PrimeFaces Userʼs Guide <p:log /> Log API PrimeFaces uses client side log apis internally.info(‘Info message’). </script> 251 . PrimeFaces. Log API is also available via global PrimeFaces object in case you’d like to use the log component to display your logs.

primefaces.primefaces.MediaRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component. Type of the player. when set to false component will not be rendered.primefaces.Media org.media.component.component. Media renders <object /> or <embed /> html tags depending on the user client."windows".media. StyleClass of the player.primefaces.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean.57 Media Media component is used for embedding multimedia content such as videos and music to JSF views.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class media org. Boolean value to specify the rendering of the component.component org. Media source to play. Width of the player.Media org. <p:media value="/media/ria_with_primefaces.mov" /> 252 . binding value player width height style styleClass null null null null null null null Object String String String String String String Getting started with Media In it’s simplest form media component requires a source to play.component."real".MediaRenderer org."flash". Style of the player. Height of the player. possible values are "quicktime". this is defined using the value attribute.

com/v/ABCDEFGH" player="flash"/> Following is the supported players and file types. au. aac. rv.youtube. 3g2. rpm. midi. qt. <p:media value="/media/ria_with_primefaces. wmv aif. mid. mpeg. public MediaController() { InputStream stream = //Create binary stream from database media = new DefaultStreamedContent(stream. In order to implement this.mov"> <f:param name="param1" value="value1" /> <f:param name="param2" value="value2" /> </p:media> StreamedContent Support Media component can also play binary media content. You can customize which player to use with the player attribute. <p:media value="#{mediaBean. mov. ram. these can be specified using f:param tags. snd. mpg. 3pg flv. } } 253 . example for this use case is storing media files in datatabase using binary format. gsm. players are identified using the value extension so for instance mov files will be played by quicktime player. bmp. rm. qif. } public StreamedContent getMedia() { return media. qtif. wma. asf. bind a StreamedContent. qti. psd. smil Types Parameters Different proprietary players might have different configuration parameters. avi. <p:media value="http://www. mp4.media}" width="250" height="225" player="quicktime"/> public class MediaBean { private StreamedContent media. m4a. smi.PrimeFaces Userʼs Guide Player Types By default. mp3. aiff. Player windows quicktime flash real asx. tiff. tif. wav. "video/quicktime"). swf ra.

58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together.MegaMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.megamenu.primefaces.primefaces.component. Name of the client side widget MenuModel instance to create menus programmatically binding widgetVar model null null null Object String MenuModel 254 .primefaces.component.primefaces. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.megamenu. when set to false component will not be rendered.primefaces.MegaMenu org.component.component.component org. An el expression that maps to a server side UIComponent instance in a backing bean.MegaMenu org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class megaMenu org.MegaMenuRenderer org.

1.6.3" </p:submenu> <p:submenu label="TV.4.2.3.1"> <p:menuitem value="TV.2" </p:submenu> <p:submenu label="TV.1" <p:menuitem value="TV.6"> <p:menuitem value="TV.2" <p:menuitem value="TV.5.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.3.4.3" </p:submenu> <p:submenu label="TV.1" <p:menuitem value="TV.5. Style class of the component.1.5. Getting Started with MegaMenu Layout of MegaMenu is grid based and root items require columns as children to define each section in a grid.2" <p:menuitem value="TV.1" <p:menuitem value="TV.2" <p:menuitem value="TV.3"> <p:menuitem value="TV.2"> <p:menuitem value="TV.6. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.2.4"> <p:menuitem value="TV.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.2" </p:submenu> <p:submenu label="TV.6.1" <p:menuitem value="TV.1" <p:menuitem value="TV.3" </p:submenu> </p:column> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> </p:submenu> //more root items </p:megaMenu> 255 .5"> <p:menuitem value="TV.2.1" <p:menuitem value="TV.

Style Class . <p:megaMenu> //submenus <p:menuitem label="Logout" action="#{bean.ui-menuitem .ui-menuitem-text Applies Container element of menubar.logout}"/> </p:megaMenu> Dynamic Menus Menus can be created programmatically as well. see the dynamic menus part in menu component section for more information and an example. see the main Skinning section for more information.ui-menu-list . <p:column> <strong>Sopranos</strong> <p:graphicImage value="/images/sopranos/sopranos1. Skinning MegaMenu resides in a main container which style and styleClass attributes apply. 256 . Following example allows a root menubar item to execute an action to logout the user.ui-menuitem-link . Following is the list of structural style classes. List container Each menu item Anchor element in a link item Text element in an item As skinning style classes are global.ui-megamenu .jpg" width="200"/> </p:column> Root Menuitem MegaMenu supports menuitem as root menu options as well.PrimeFaces Userʼs Guide Custom Content Any content can be placed inside columns.

Boolean value to specify the rendering of the component.primefaces.component. A menu model instance to create menu programmatically.Menu org.MenuRenderer Attributes Name id rendered binding widgetVar model trigger my Default null TRUE null null null null null Type String Boolean Object String MenuModel String String Description Unique identifier of the component. Id of component whose click event will show the dynamic positioned menu. ipod style sliding and overlays. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menu org.MenuRenderer org.59 Menu Menu is a navigation component with various customized modes like multi tiers. when set to false component will not be rendered.primefaces.Menu org.menu. 257 . An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.primefaces.primefaces.PrimeFaces Userʼs Guide 3.menu.component org.component.component.component. Name of the client side widget. Corner of menu to align with trigger element.

com" /> value="Hotmail" url="http://www.com" /> value="Yahoo Mail" url="http://mail. Easing type. Defines positioning type of menu.com" /> value="Metacafe" url="http://www. valid values are plain.metacafe.com" /> value="MySpace" url="http://www.facebook.com" /> value="Facebook" url="http://www. Getting started with the Menu A menu is composed of submenus and menuitems.PrimeFaces Userʼs Guide Name at position type style styleClass backLabel triggerEvent easing Default null static plain null null Back click null Type String String String String String String String String Description Corner of trigger to align with menu element. Style class of the main container element. Type of menu. Inline style of the main container element.com" /> 258 . Text for back link.break.com" /> value="Youtube" url="http://www.yahoo.google. <p:menu> <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem </p:menu> value="Gmail" url="http://www.youtube. Event to show the dynamic positioned menu.hotmail. either static or dynamic. tiered and sliding.myspace. only applies to sliding menus.com" /> value="Break" url="http://www.

com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www. <p:menu> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www. "static" and "dynamic". In contrast dynamic menus is not on the normal flow of the page allowing them to overlay other elements.com" /> <p:menuitem value="Break" url="http://www.com" /> <p:menuitem value="Hotmail" url="http://www.PrimeFaces Userʼs Guide Submenus are used to group menuitems.youtube. A dynamic menu is created by setting position option to dynamic and defining a trigger to show the menu.com" /> </p:submenu> <p:submenu label="Social Networks"> <p:menuitem value="Facebook" url="http://www.com" /> <p:menuitem value="MySpace" url="http://www.com" /> <p:menuitem value="Metacafe" url="http://www.google.metacafe.facebook.com" /> <p:menuitem value="Yahoo Mail" url="http://mail.yahoo. • • • • left right bottom top 259 . Location of menu on page will be relative to the trigger and defined by my and at options that take combination of four values.myspace. By default it’s static meaning the menu is in normal page flow.com" /> </p:submenu> </p:menu> Overlay Menu Menu can be positioned on a page in two ways.hotmail.break.

submenus and menuitems </p:menu> Plain Tiered Sliding (iPod) Ajax and Non-Ajax Actions As menu uses menuitems.submenus and menuitems </p:menu> <p:commandButton id="btn" value="Show Menu" type="button"/> Menu Types Menu has three different types...primefaces.PrimeFaces Userʼs Guide For example. tiered and sliding. plain..save}" update="comp"/> <p:menuitem value="Update" actionListener="#{bean.org"/> </p:submenu> </p:menu> 260 .update}" ajax="false"/> <p:menuitem value="Navigate" url="http://www. clicking the button below will display the menu whose top left corner is aligned with bottom left corner of button. See menuitem documentation for more information about the capabilities. <p:menu type="plain|tiered|sliding"> . <p:menu> <p:submenu label="Options"> <p:menuitem value="Save" actionListener="#{bean. <p:menu position="dynamic" trigger="btn" my="left top" at="bottom left"> .. it is easy to invoke actions with or without ajax as well as navigation.

public MenuModel getModel() { return model.getChildren().getChildren().setUrl("#").add(item).primefaces. item. <p:menu model="#{menuBean. For further customization you can also create and bind your own MenuModel implementation.setLabel("Dynamic Submenu 2"). Menu metadata is defined using an org. this is more flexible compared to the declarative approach.setValue("Dynamic Menuitem 1.PrimeFaces Userʼs Guide Dynamic Menus Menus can be created programmatically as well. submenu.1"). submenu.2").getChildren(). submenu.add(item). item. } Skinning Menu resides in a main container element which style and styleClass attributes apply.setValue("Dynamic Menuitem 2.addSubmenu(submenu). //Second submenu submenu = new Submenu().setUrl("#"). item = new MenuItem(). //First submenu Submenu submenu = new Submenu().add(item).setLabel("Dynamic Submenu 1").setValue("Dynamic Menuitem 2.MenuModel instance. item = new MenuItem(). submenu.model}" /> public class MenuBean { } private MenuModel model. item.model. model.model. item.addSubmenu(submenu). Following is the list of structural style classes.1").DefaultMenuModel implementation.setUrl("#"). item. 261 . submenu. public } MenuBean() { model = new DefaultMenuModel(). PrimeFaces provides the built-in org. MenuItem item = new MenuItem(). item. model.primefaces.

262 .ui-menu-list .PrimeFaces Userʼs Guide Style Class . see the main Skinning section for more information.ui-menuitem .ui-menuitem-link .ui-menuitem-text .ui-menu-sliding Container element of menu List container Each menu item Applies Anchor element in a link item Text element in an item Container of ipod like sliding menu As skinning style classes are global.ui-menu .

PrimeFaces Userʼs Guide 3.menubar.primefaces.menubar.primefaces.component. click event is required to display.Menubar org.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menubar org.component.MenubarRenderer org.MenubarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean.Menubar org. When set to false. Boolean value to specify the rendering of the component. Name of the client side widget MenuModel instance to create menus programmatically Inline style of menubar Style class of menubar Defines whether the first level of submenus will be displayed on mouseover or not.component.60 Menubar Menubar is a horizontal navigation component.primefaces.primefaces. when set to false component will not be rendered. binding widgetVar model style styleClass autoDisplay null null null null null FALSE Object String MenuModel String String Boolean 263 .

com" /> <p:menuitem value="Yahoo Mail" url="http://mail. <p:menubar> <p:menuitem label="Logout" action="#{bean. <p:menubar> <p:submenu label="File"> <p:submenu label="New"> <p:menuitem value="Project" url="#"/> <p:menuitem value="Other" url="#"/> </p:submenu> <p:menuitem value="Open" url="#"></p:menuitem> <p:menuitem value="Quit" url="#"></p:menuitem> </p:submenu> <p:submenu label="Edit"> <p:menuitem value="Undo" url="#"></p:menuitem> <p:menuitem value="Redo" url="#"></p:menuitem> </p:submenu> <p:submenu label="Help"> <p:menuitem label="Contents" url="#" /> <p:submenu label="Search"> <p:submenu label="Text"> <p:menuitem value="Workspace" url="#" /> </p:submenu> <p:menuitem value="File" url="#" /> </p:submenu> </p:submenu> </p:menubar> Root Menuitem Menubar supports menuitem as root menu options as well.com" /> <p:menuitem value="Hotmail" url="http://www.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.logout}"/> </p:menubar> 264 .google. <p:menubar> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www.break.com" /> </p:submenu> </p:menubar> Nested Menus To create a menubar with a higher depth. nest submenus in parent submenus.PrimeFaces Userʼs Guide Getting started with Menubar Submenus and menuitems as child components are required to compose the menubar.com" /> <p:menuitem value="Break" url="http://www.hotmail.yahoo.youtube.

Style Class . see the main Skinning section for more information. it is easy to invoke actions with or without ajax as well as navigation.ui-menuitem . See menuitem documentation for more information about the capabilities.primefaces.save}" update="comp"/> <p:menuitem value="Update" actionListener="#{bean. <p:menubar> <p:submenu label="Options"> <p:menuitem value="Save" actionListener="#{bean. List container Each menu item Anchor element in a link item Text element in an item As skinning style classes are global. see the dynamic menus part in menu component section for more information and an example.update}" ajax="false"/> <p:menuitem value="Navigate" url="http://www.ui-menuitem-text Applies Container element of menubar. Skinning Menubar resides in a main container which style and styleClass attributes apply.ui-menubar . 265 .ui-menu-list .org"/> </p:submenu> </p:menubar> Dynamic Menus Menus can be created programmatically as well. Following is the list of structural style classes.PrimeFaces Userʼs Guide Ajax and Non-Ajax Actions As menu uses menuitems.ui-menuitem-link .

PrimeFaces Userʼs Guide 3.component.component.61 MenuButton MenuButton displays different commands in a popup menu.primefaces.primefaces.primefaces.primefaces.MenuButtonRenderer org.component.MenuButton org. Boolean value to specify the rendering of the component.menubutton.menubutton. binding value style styleClass widgetVar model disabled null null null null null null FALSE Object String String String String MenuModel Boolean 266 . when set to false component will not be rendered.component org. Label of the button Style of the main container element Style class of the main container element Name of the client side widget MenuModel instance to create menus programmatically Disables or enables the button.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menuButton org.component.MenuButton org.MenuButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. An el expression that maps to a server side UIComponent instance in a backing bean.

Skinning MenuButton resides in a main container which style and styleClass attributes apply. second one does the similar but without ajax and third one is used for redirect purposes. Following menubutton example has three menuitems.ui-menuitem-text .ui-button-text Applies Container element of menu. first one is used triggers an action with ajax.ui-menu . see the main Skinning section for more information.jsf" /> </p:menuButton> Dynamic Menus Menus can be created programmatically as well. <p:menuButton value="Options"> <p:menuitem value="Save" actionListener="#{bean.save}" update="comp" /> <p:menuitem value="Update" actionListener="#{bean. List container Each menu item Anchor element in a link item Text element in an item Button element Label of button 267 .update}" ajax="false" /> <p:menuitem value="Go Home" url="/home.ui-menuitem-link .PrimeFaces Userʼs Guide Getting started with the MenuButton MenuButton consists of one ore more menuitems. Following is the list of structural style classes. see the dynamic menus part in menu component section for more information and an example. As skinning style classes are global.ui-menu-list .ui-button .ui-menuitem . Style Class .

action of this menuitem is processed after apply request phase.MenuItem org. Label of the menuitem Action listener to be invoked when menuitem is clicked.MenuItem org.primefaces. binding value actionListener action immediate url target style styleClass onclick async process null null null null FALSE null null null null null FALSE null Object String javax. Component id(s) to process partially instead of whole view.PrimeFaces Userʼs Guide 3.menuitem.primefaces.MethodE xpression Boolean String String String String String Boolean String 268 .component.primefaces.component.MenuItemTag org.62 MenuItem MenuItem is used by various menu components of PrimeFaces. when set to false component will not be rendered. ajax requests are not queued. Info Tag Tag Class Component Class Component Type Component Family menuItem org.menuitem.MethodE xpression javax. When true.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component. Action to be invoked when menuitem is clicked. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces. Boolean value to specify the rendering of the component.el.el.component. Url to be navigated when menuitem is clicked Target type of url navigation Style of the menuitem label StyleClass of the menuitem label Javascript event handler for click event When set to true.

• • • • • • Menu MenuBar Breadcrumb Dock Stack MenuButton Note that some attributes of menuitem might not be supported by these menu components. if not parent form is posted. Boolean String String String String Boolean ajax icon TRUE null Boolean String Getting started with MenuItem MenuItem is a generic component used by the following PrimeFaces components. Disables the menuitem. you can either use bundled icons within PrimeFaces or provide your own via css. directly navigating to a url with GET and doing a POST do execute an action which you can still do navigation with JSF navigation rules. Navigation vs Action Menuitem has two use cases. Icons There are two ways to specify an icon of a menuitem.PrimeFaces Userʼs Guide Name update disabled onstart oncomplete onsuccess onerror global Default null FALSE null null null null TRUE String Type Description Client side id of the component(s) to be updated after async partial submit request. 269 . This is decided by url attribute. Javascript handler to execute when ajax request is completed. Javascript handler to execute when ajax request fails. Path of the menuitem image. setting global to false will not trigger ajaxStatus. Javascript handler to execute when ajax request succeeds. Refer to the specific component documentation for more information. Javascript handler to execute before ajax request is begins. Global ajax requests are listened by ajaxStatus component. if it is present menuitem does a GET request. Specifies submit mode.

. width:16px. height:16px. /> Custom Icons <p:menuitem icon="barca" ...png) no-repeat.. } 270 .barca { background: url(barca_logo.PrimeFaces Userʼs Guide ThemeRoller Icons <p:menuitem icon="ui-icon ui-icon-disk" . /> .

MessageRenderer Attributes Name id rendered binding showSummary showDetail for redisplay display Default null TRUE null FALSE TRUE null TRUE both Type String Boolean Object Boolean Boolean String Boolean String Description Unique identifier of the component.component.message. <h:inputText id="txt" value="#{bean.text}" /> <p:message for="txt" /> 271 .primefaces. Boolean value to specify the rendering of the component.primefaces.Message org.message. An el expression that maps to a server side UIComponent instance in a backing bean.component.primefaces.PrimeFaces Userʼs Guide 3.component. Specifies if the detail of the FacesMessage should be displayed.component org. Getting started with Message Message usage is exactly same as standard message. when set to false component will not be rendered.MessageRenderer org. Specifies if the summary of the FacesMessage should be displayed.component.primefaces. Defines if already rendered messages should be displayed Defines the display mode.Message org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class message org.primefaces.63 Message Message is a pre-skinned extended version of the standard JSF message component. Id of the component whose messages to display.

‘warn’ and error. 272 . • text : Only message text is displayed. Skinning Message Full list of CSS selectors of message is as follows. ‘error’. Style Class ui-message-{severity} ui-message-{severity}-summary ui-message-{severity}-info Applies Container element of the message Summary text Detail text {severity} can be ‘info’.PrimeFaces Userʼs Guide Display Mode Message component has three different display modes. • both (default) : Both icon and text are displayed. • icon : Only message severity is displayed and message text is visible as a tooltip.

primefaces.Messages org. when set to false component will not be rendered.component org. only facesmessages with no clientIds are displayed.component.primefaces.MessagesRenderer org.messages. 273 binding showSummary showDetail globalOnly null FALSE TRUE FALSE Object Boolean Boolean String .Messages org.primefaces. Specifies if the summary of the FacesMessages should be displayed.PrimeFaces Userʼs Guide 3.messages. Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean.component.64 Messages Messages is a pre-skinned extended version of the standard JSF messages component. When true. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class messages org.primefaces.primefaces.component. Specifies if the detail of the FacesMessages should be displayed.component.MessagesRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.

274 . ‘error’.PrimeFaces Userʼs Guide Name redisplay autoUpdate Default TRUE FALSE Type Boolean Boolean Description Defines if already rendered messages should be displayed Enables auto update mode if set true. {severity} can be ‘info’. messages component is updated with each ajax request automatically. <p:messages /> AutoUpdate When auto update is enabled. Getting started with Messages Message usage is exactly same as standard messages. ‘warn’ and error. Skinning Message Full list of CSS selectors of message is as follows. Style Class ui-messages-{severity} ui-messages-{severity}-summary ui-messages-{severity}-detail ui-messages-{severity}-icon Applies Container element of the message Summary text Detail text Icon of the message.

NotificationBar org.component.NotificationBarRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. any content can be placed inside.notificationbar. "normal" or "fast". "fade".NotificationBarRenderer org. When true. "top" or "bottom". <p:notificationBar widgetVar="topBar"> //Content </p:notificationBar> 275 .primefaces. panel is displayed on page load.component. An el expression that maps to a server side UIComponent instance in a backing bean Style of the container element StyleClass of the container element Position of the bar.component. Speed of the effect.component org.PrimeFaces Userʼs Guide 3. "slow". binding style styleClass position effect effectSpeed autoDisplay null null null top fade normal FALSE Object String String String String String Boolean Getting started with NotificationBar As notificationBar is a panel component.65 NotificationBar NotificationBar displays a multipurpose fixed positioned panel for notification.primefaces.NotificatonBar org.component.notificationbar.primefaces.primefaces. "slide" or "none". when set to false component will not be rendered. Name of the effect. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class notificationBar org.primefaces.

In addition duration of the animation is controlled via effectSpeed attribute that can take "normal". another possible effect is "slide". "slow" or "fast" as it’s value.show()">Show</h:outputLink> Note that notificationBar has a default built-in close icon to hide the content. Additionally there are two predefined css selectors used to customize the look and feel. notificationBar provides an easy to use client side api that can be accessed through the widgetVar. other possibility is placing the bar at the bottom of the page.ui-notificationbar . set effect name to "none". bar will not scroll. <p:notificationBar widgetVar="topBar" position="bottom"> //Content </p:notificationBar> Skinning style and styleClass attributes apply to the main container element.ui-notificationbar-close Main container element Close icon element 276 Applies .show()">Show</h:outputLink> <h:outputLink value="#" onclick="topBar. Position Default position of bar is "top". Selector .PrimeFaces Userʼs Guide Showing and Hiding To show and hide the content. <p:notificationBar widgetVar="topBar"> //Content </p:notificationBar> <h:outputLink value="#" onclick="topBar. isVisible() and toggle() are additional client side api methods. Effects Default effect to be used when displaying and hiding the bar is "fade". Note that bar positioning is fixed so even page is scrolled. <p:notificationBar widgetVar="topBar" effect="slide"> //Content </p:notificationBar> If you’d like to turn off animation. show() displays the bar and hide() hides it.

component.OrderList org.OrderList org.PrimeFaces Userʼs Guide 3.orderlist.component.orderlist.component org.component.primefaces. when set to false component will not be rendered.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class orderList org.primefaces.primefaces.OrderListRenderer org.OrderListRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. binding value null null Object Object 277 .component. transition effects and pojo support.

Location of the reorder buttons. When it’s an EL expression. Name of the iterator. Inline style of container element. Label of move top button. it’s resolved to a converter instance. Label of move up button. Style class of container element. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails.PrimeFaces Userʼs Guide Name converter Default null Type Converter/String Description An el expression or a literal text that defines a converter for the component. Message to be displayed when validation fields. Message to be displayed when conversion fails. Name of animation to display. “right” and “none”. Value of an item. process validations logic is executed at apply request values phase for this component. Label of move bottom button. Disables the component. it must refer to a converter id When set true. Label of an item. Label of move down button. immediate FALSE Boolean required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar var itemLabel itemValue style styleClass disabled effect moveUpLabel moveTopLabel moveDownLabel moveBottomLabel controlsLocation FALSE null null null null null null null null null null null FALSE fade Move Up Move Top Move Down Move Bottom left Boolean MethodExpr MethodExpr String String String String String String String String String Boolean String String String String String String 278 . valid values are “left”. Name of the client side widget. In case it’s a static text.

In addition. public class OrderListBean { private List<String> cities.add("Antalya").PrimeFaces Userʼs Guide Getting started with OrderList A list is required to use OrderList component.jpg")). orderList will update the cities list according to the changes on client side. 10. } } //getter&setter for cities <p:orderList value="#{orderListBean.add("Izmir"). pojos are supported if a converter is defined. cities. "villa. 6. 8.add("Bursa").add(new Player("Messi".add("Ankara"). "messi. "xavi. cities.add(new Player("Iniesta". } } //getter&setter for players 279 . cities.add("Istanbul").jpg")). public OrderListBean() { players = new ArrayList<Player>(). players.cities}" var="city" itemLabel="#{city}" itemValue="#{city}""/> When the form is submitted. "iniesta. Advanced OrderList OrderList supports displaying custom content instead of simple labels by using columns. players. players. 7.add(new Player("Xavi". public class OrderListBean { private List<Player> players. public OrderListBean() { cities = new ArrayList<String>().jpg")). cities.jpg")).add(new Player("Villa". cities. players.

PrimeFaces Userʼs Guide <p:orderList value="#{orderListBean.photo}" /> </p:column> <p:column style="width:75%.#{player. Each item in the list. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide Skinning OrderList resides in a main container which style and styleClass attributes apply.ui-orderlist . Following is the list of structural style classes. Effects An animation is executed during reordering."> #{player.number} </p:column> </p:orderList> Header A facet called “caption” is provided to display a header content for the orderlist. default effect is fade and following options are available for effect attribute.ui-orderlist-list . 280 Applies . Container of items.name} . As skinning style classes are global.players}" var="player" itemValue="#{player}" converter="player"> <p:column style="width:25%"> <p:graphicImage value="/images/barca/#{player.ui-orderlist-item .ui-orderlist-caption Main container element. Style Class . see the main Skinning section for more information. Caption of the list.

PrimeFaces Userʼs Guide 3. When a JSF component is not rendered. 281 .OutputPanelRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.OutputPanel org.67 OutputPanel OutputPanel is a panel component with the ability to auto update.primefaces. when set to false component will not be rendered.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Style of the html container element StyleClass of the html container element Layout of the panel.outputpanel.primefaces. the markup on page cannot be updated since it doesn’t exist.component org. OutputPanel is useful in this case. valid values are inline(span) or block(div).component. no markup is rendered so for components with conditional rendering regular PPR mechanism may not work since the markup to update on page does not exist.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org.output.OutputPanelRenderer org. it is much simpler to update an existing element on page rather than inserting a new element to the dom.component.primefaces. Enables auto update mode if set true. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax. Suppose the rendered condition on bean is false when page if loaded initially and search method on bean sets the condition to be true meaning datatable will be rendered after a page submit. The problem is although partial output is generated.component.primefaces.OutputPanel org.

> //columns </p:dataTable> </p:outputPanel> <p:commandButton update="out" actionListener="#{bean. outputPanel component is updated with each ajax request automatically.condition}" . 282 .. in this case parent form will be updated partially implicitly making an outputPanel use obselete..list}" /> Note that you won’t need an outputPanel if commandButton has no update attribute specified... • inline (default): Renders a span • block: Renders a div AutoUpdate When auto update is enabled.PrimeFaces Userʼs Guide <p:dataTable id="tbl" rendered="#{bean. Layout OutputPanel has two layout modes.search}" /> Solution is to use the outputPanel as a placeHolder. Skinning OutputPanel style and styleClass attributes are used to skin the outputPanel.> //columns </p:dataTable> <p:commandButton update="tbl" actionListener="#{bean.condition}" . <p:outputPanel id="out"> <p:dataTable id="tbl" rendered="#{bean.

primefaces. Identifier of the target component to attach the panel. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class overlayPanel org.primefaces.component org.component. when set to false component will not be rendered. binding widgetVar style styleClass for null null null null null Object String String String String 283 .component.component. Style class of the panel.primefaces.OverlayPanel org.PrimeFaces Userʼs Guide 3.68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content.OverlayPanelRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.OverlayPanelRenderer org.component.overlaypanel.OverlayPanelRenderer org.primefaces.primefaces. Inline style of the panel.overlaypanel.

Defines content loading mode.pieModel}" legendPosition="w" title="Sample Pie Chart" style="width:400px. Example below demonstrates an overlayPanel attached to a button to show a chart in a popup. slide are available values for showEffect and hideEffect options if you’d like display animations. Client side callback to execute when panel is shown. puff. fold.PrimeFaces Userʼs Guide Name showEvent hideEvent showEffect hideEffect appendToBody onShow onHide my at dynamic Default mousedown mousedown null null FALSE null null left top left bottom FALSE Type String String String String Boolean String String String String Boolean Description Event on target to show the panel.height:300px" /> </p:overlayPanel> Events Default event on target to show and hide the panel is mousedown. size. drop. <p:commandButton id="chartBtn" value="Basic" type="button" /> <p:overlayPanel showEvent="mouseover" hideEvent="mousedown"> //content </p:overlayPanel> Effects blind. Position of the target relative to the panel. highlight. panel is appended to document body. <p:commandButton id="chartBtn" value="Basic" type="button" /> <p:overlayPanel for="chartBtn"> <p:pieChart value="#{chartBean. Event on target to hide the panel. bounce. clip. explode. 284 . shake. Position of the panel relative to the target. Animation to display when hiding the panel. Client side callback to execute when panel is hidden. pulsate. Animation to display when showing the panel. Getting started with OverlayPanel OverlayPanel needs a component as a target in addition to the content to display. These are customized using showEvent and hideEvent options. When true. scale.

“right bottom”. Also content is cached so consecutive displays do not load the content again. Skinning Panel Panel resides in a main container which style and styleClass attributes apply. see the main Skinning section for more information. in this mode content of the panel is not rendered on page load and loaded just before panel is shown. Following is the list of structural style classes.. Tips • Enable appendToBody when overlayPanel is in other panel components like layout.g. right.. Dynamic Mode Dynamic mode enables lazy loading of the content. left top corner of panel is aligned to left bottom corner of the target if there is enough space in window viewport.PrimeFaces Userʼs Guide Positioning By default. bottom and top e. In order to customize the position use my and at options that takes combinations of left.ui-overlaypanel Applies Main container element of panel As skinning style classes are global. Style Class . if not the position is flipped on the fly to find the best location to display. dialog . This feature is useful to reduce the page size and reduce page load time. 285 .

panel.69 Panel Panel is a grouping component with content toggle. Speed of toggling in milliseconds Renders a toggleable panel as collapsed.PanelRenderer org. close and menu integration.panel. An el expression that maps to a server side UIComponent instance in a backing bean Header text Footer text Makes panel toggleable.PanelRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.Panel org.component org.primefaces.component. Style of the panel Style class of the panel 286 binding header footer toggleable toggleSpeed collapsed style styleClass null null null FALSE 1000 FALSE null null Object String String Boolean Integer Boolean String String .primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.component.component. when set to false component will not be rendered.Panel org.primefaces.PrimeFaces Userʼs Guide 3.

PrimeFaces Userʼs Guide Name closable closeSpeed visible closeTitle toggleTitle menuTitle widgetVar Default FALSE 1000 TRUE null null null null Type Boolean Integer Boolean String String String String Description Make panel closable.. Event toggle close Listener Parameter org.primefaces. <p:panel header="Header Text"> <f:facet name="footer"> <h:outputText value="Footer Text" /> </f:facet> //Child components here.. facet will be used. Name of the client side widget Getting started with Panel Panel encapsulates other components.primefaces.event.event. When same attribute and facet name are used. Tooltip for the toggle button. Tooltip for the menu button. </p:panel> Header and Footer Header and Footer texts can be provided by header and footer attributes or the corresponding facets.. When panel is closed. Speed of closing effect in milliseconds Renders panel as visible.ToggleEvent org. Tooltip for the close button.. </p:panel> Ajax Behavior Events Panel provides custom ajax behavior events for toggling and closing features.CloseEvent Fired When panel is expanded or collapsed. 287 . <p:panel> //Child components here.

<f:facet name="options"> <p:menu> //Menuitems </p:menu> </f:facet> </p:panel> Skinning Panel Panel resides in a main container which style and styleClass attributes apply. Style Class . 288 .. see the main Skinning section for more information.ui-panel-title .ui-panel . This feature is enabled by defining a menu component and defining it as the options facet.ui-panel-titlebar .ui-panel-footer Applies Main container element of panel Header container Header text Option icon in header Panel content Panel footer As skinning style classes are global. <p:panel closable="true"> //Child components here. Following is the list of structural style classes.ui-panel-titlebar-icon . an icon to display the menu is placed at top-right corner.ui-panel-content .PrimeFaces Userʼs Guide Popup Menu Panel has built-in support to display a fully customizable popup menu..

panelgrid.PrimeFaces Userʼs Guide 3.component.primefaces.component.primefaces.PanelGridRenderer org.primefaces.PanelGridRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org.component.70 PanelGrid PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.component org.primefaces.PanelGrid org.panelgrid.component. An el expression that maps to a server side UIComponent instance in a backing bean 289 binding null Object .primefaces. when set to false component will not be rendered.PanelGridRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

Style class of the panel. <p:panelGrid columns="2"> <h:outputLabel for="firstname" value="Firstname:" /> <p:inputText id="firstname" value="#{bean. <p:panelGrid columns="2"> <f:facet name="header"> Basic PanelGrid </f:facet> <h:outputLabel for="firstname" value="Firstname: *" /> <p:inputText id="firstname" value="#{bean. null null null Getting started with PanelGrid Basic usage of panelGrid is same as the standard one.PrimeFaces Userʼs Guide Name columns style styleClass columnClasses 0 Default Type Integer String String String Description Number of columns in grid. Inline style of the panel.surname}" label="Surname"/> <f:facet name="footer"> <p:commandButton type="button" value="Save" icon="ui-icon-check" /> </f:facet> </p:panelGrid> 290 . Comma separated list of column style classes.firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname:" /> <p:inputText id="surname" value="#{bean.firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname: *" /> <p:inputText id="surname" value="#{bean.surname}" label="Surname"/> </p:panelGrid> Header and Footer PanelGrid provides facets for header and footer content.

Following is the list of structural style classes. As skinning style classes are global. in this case row and column markup should be defined manually. Style Class .ui-panelgrid-footer Applies Main container element of panelGrid. Footer. Header. 291 .ui-panelgrid .ui-panelgrid-header . see the main Skinning section for more information.PrimeFaces Userʼs Guide Rowspan and Colspan PanelGrid supports rowspan and colspan options as well. <p:panelGrid> <p:row> <p:column rowspan="3">AAA</p:column> <p:column colspan="4">BBB</p:column> </p:row> <p:row> <p:column colspan="2">CCC</p:column> <p:column colspan="2">DDD</p:column> </p:row> <p:row> <p:column>EEE</p:column> <p:column>FFF</p:column> <p:column>GGG</p:column> <p:column>HHH</p:column> </p:row> </p:panelGrid> Skinning PanelGrid PanelGrid resides in a main container which style and styleClass attributes apply.

primefaces.component org. In case it’s a static text.component. when set to false component will not be rendered.password.primefaces.PrimeFaces Userʼs Guide 3.password.Password org.primefaces. it must refer to a converter id When set true.Password org.primefaces.71 Password Password component is an extended version of standard inputSecret component with theme integration and strength indicator. it’s resolved to a converter instance.component. Marks component as required 292 binding value converter null null null Object Object Converter/ String immediate required FALSE FALSE Boolean boolean .PasswordRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. When it’s an EL expression.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class password org.PasswordRenderer org.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces. process validations logic is executed at apply request values phase for this component.

Id of another password component to match value against. Message to be displayed when validation fields. Maximum number of characters that may be entered in this field. Message to be displayed when conversion fails. Displays feedback inline rather than using a popup. Label of good password. Whether or not to display previous value. Enables strength indicator.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage feedback inline promptLabel Default null null null null null FALSE FALSE Please enter a password 1 Weak Good Strong FALSE null null null null null null FALSE null null null null Type MethodExpr MethodExpr String String String Boolean boolean String Description A method expression that refers to a method validationg the input. 293 . Client side callback to execute when input element loses focus. Name of the client side widget. Alternate textual description of the input field. Controls browser autocomplete behavior. Code describing the language used in the generated markup for this component. Label of prompt. Access key that when pressed transfers focus to the input element. Disables input field A localized user presentable name. level weakLabel goodLabel strongLabel redisplay match widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur Integer String String String Boolean String String String String String String Boolean String String Integer String Level of security. Valid values are LTR and RTL. A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Label of strong password. Direction indication for text that does not inherit directionality. Label of weak password.

Client side callback to execute when input element receives focus. Number of characters used to determine the width of the input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Position of the input element in the tabbing order. Advisory tooltip informaton. Flag indicating that this component will prevent changes by the user. Client side callback to execute when input element is double clicked. Client side callback to execute when a pointer button is moved away from input element. Style class of the input element. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when input element is clicked. Client side callback to execute when a pointer button is released over input element. Inline style of the input element.PrimeFaces Userʼs Guide Name onchange Default null Type String Description Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when a key is pressed and released over input element. onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title null null null null null null null null null null null null FALSE null null null null null String String String String String String String String String String String String Boolean Integer String String Integer String 294 .

<p:password value="#{mybean. <p:password value="#{bean. Following password gives feedback in Turkish.password6}" feedback="false" label="Password 2" required="true"/> 295 .PrimeFaces Userʼs Guide Getting Started with Password Password is an input component and used just like a standard input text. } public void setPassword(String password) { this. <p:password value="#{bean.password}" feedback="true|false" /> public class Bean { } private String password. <p:password id="pwd1" value="#{passwordBean. When feedback option is enabled a password strength indicator is displayed. The other password component’s id should be used to define the match option. if you prefer an inline indicator just enable inline mode.password}" promptLabel="Lütfen şifre giriniz" weakLabel="Zayıf" goodLabel="Orta seviye" strongLabel="Güçlü" feedback= "true"/> Inline Strength Indicator By default strength indicator is shown in an overlay.password6}" feedback="false" match="pwd2" label="Password 1" required="true"/> <p:password id="pwd2" value="#{passwordBean. you can provide custom labels as well.password}" inline="true" feedback= "true"/> Confirmation Password confirmation is a common case and password provides an easy way to implement.password = password. public String getPassword() { return password.} I18N Although all labels are in English by default.

PrimeFaces Userʼs Guide Skinning Structural selectors for password is as follows.ui-password-info Input element.ui-password . Applies As skinning style classes are global.ui-password-panel . Strength meter. Overlay panel of strength indicator. see the main Skinning section for more information.ui-password-meter . Name . 296 . Strength label.

Message to be displayed when conversion fails. when set to false component will not be rendered. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails.primefaces.component.PrimeFaces Userʼs Guide 3. In case it’s a static text.photocam.component. process validations logic is executed at apply request values phase for this component.photocam.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.PhotoCam org.PhotoCamRenderer org.component org.component. When it’s an EL expression.PhotoCamRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PhotoCam org. it’s resolved to a converter instance. 297 binding value converter null null null Object Object Converter/ String immediate required validator valueChangeListener requiredMessage converterMessage validatorMessage FALSE FALSE null null null null null Boolean boolean MethodBind ing MethodExpr String String String . it must refer to a converter id When set true.72 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org. Message to be displayed when validation fields.component.primefaces.primefaces.

getData(). data. Also a method expression is necessary to invoke when an image is captured.length). Sample below captures an image and saves it to a directory. ServletContext servletContext = (ServletContext) FacesContext.close(). FileImageOutputStream imageOutput.separator + "captured. Identifiers of components to update during capture. imageOutput.write(data. imageOutput.getExternalContext(). Method expression to listen to capture events. 0. • It is not supported in IE at the moment and this will be worked on in future versions. Getting started with PhotoCam Capture is triggered via client side api’s capture method. Inline style of the component.png". String newFileName = servletContext.oncapture}"update="photos"/> <p:commandButton type="button" value="Capture" onclick="pc.getRealPath("") + File. } catch(Exception e) { throw new FacesException("Error in writing captured image. 298 .getCurrentInstance(). Style class of the component. canvas and javascript solution.").PrimeFaces Userʼs Guide Name widgetVar style styleClass process update listener Default null null null null null null Type String String String String String MethodExpr Description Name of the client side widget. Identifiers of components to process during capture. try { imageOutput = new FileImageOutputStream(new File(newFileName)). <h:form> <p:photoCam widgetVar="pc" listener="#{photoCamBean.separator + "photocam" + File. } } } Notes • PhotoCam is a flash.capture()"/> </h:form> public class PhotoCamBean { public void oncapture(CaptureEvent captureEvent) { byte[] data = captureEvent.getContext().

PrimeFaces Userʼs Guide 3. it’s resolved to a converter instance. process validations logic is executed at apply request values phase for this component.PickList org. it must refer to a converter id When set true.primefaces.picklist. when set to false component will not be rendered. Marks component as required binding value converter null null null Object Object Convert er/String immediate FALSE Boolean required FALSE Boolean 299 .PickListRenderer org.primefaces. When it’s an EL expression.primefaces.PickListRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Panel org.component.primefaces.primefaces.component. In case it’s a static text.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pickList org.73 PickList PickList is used for transferring data between two different collections.component org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.picklist.

Name of the iterator. Name of the client side widget. Label of an item. Title of move top button. Style class of the main container. Message to be displayed when validation fields. Message to be displayed when conversion fails. Speed of the animation. Specifies visibility of reorder buttons of target list. Title of move down button. Disables the component. Style of the main container. Title of add all button. Value of an item. Name of the animation to display. . Title of remove button. Client side callback to execute when an item is transferred from one list to another. A localized user presentable name. Title of add button.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage var itemLabel itemValue style styleClass widgetVar disabled effect effectSpeed addLabel addAllLabel removeLabel removeAllLabel moveUpLabel moveTopLabel moveDownLabel moveButtomLabel showSourceControls showTargetControls onTransfer label itemDisabled Default null null null null null null null null null null null FALSE null null Add Add All Remove Remove All Move Up Move Top Move Down Move Buttom FALSE FALSE null null FALSE Type Method Expr Method Expr String String String String String Object String String String Boolean String String String String String String String String String String String String String String Boolean 300 Description A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Title of move up button. Title of remove all button. Specified if an item can be picked or not. Title of move bottom button. Specifies visibility of reorder buttons of source list.

//more cities cities = new DualListModel<String>(citiesSource.add("Izmir").model.DualListModel to use PickList. This use case is no different except the addition of a converter. } public } PickListBean() { List<String> source = new ArrayList<String>(). List<String> target = new ArrayList<String>(). As the name suggests it consists of two lists. one is the source list and the other is the target.primefaces. citiesSource.cities}" var="city" itemLabel="#{city}" itemValue="#{city}"> When the enclosed form is submitted.add("Bursa").add("Istanbul"). POJOs Most of the time you would deal with complex pojos rather than simple types like String. citiesSource. age . As the first example we’ll create a DualListModel that contains basic Strings. } public void setCities(DualListModel<String> cities) { this.cities = cities.getTarget() api.. citiesTarget).getSource() and DualListModel. 301 . citiesSource.. <p:pickList value="#{pickListBean. Following pickList displays a list of players(name.). } And bind the cities dual list to the picklist. citiesSource. public DualListModel<String> getCities() { return cities.PrimeFaces Userʼs Guide Getting started with PickList You need to create custom model called org. public class PickListBean { private DualListModel<String> cities.add("Ankara"). citiesSource.add("Antalya"). the dual list reference is populated with the new values and you can access these values with DualListModel.

name} . <p:pickList value="#{pickListBean.players}" var="player" itemLabel="#{player. 302 . boolean as well. 10)).photo}"/> </p:column> <p:column style="width:75%".> #{player. //more players players = new DualListModel<Player>(source. target).players}" var="player" iconOnly="true" effect="bounce" itemValue="#{player}" converter="player" showSourceControls="true" showTargetControls="true"> <p:column style="width:25%"> <p:graphicImage value="/images/barca/#{player. DualListModel<Player> getPlayers() { return players.players = players. List<Player> target = new ArrayList<Player>(). these are enabled by showSourceControls and showTargetControls options.#{player. integer. source. void setPlayers(DualListModel<Player> players) { this.number} </p:column> </p:pickList> Reordering PickList support reordering of source and target lists.add(new Player("Messi". public } public } public } PickListBean() { //Players List<Player> source = new ArrayList<Player>(). <p:pickList value="#{pickListBean. Custom content instead of simple strings can be displayed by using columns.Converter contract and implement getAsString. getAsObject methods.faces.PrimeFaces Userʼs Guide public class PickListBean { } private DualListModel<Player> players.convert. Note that a converter is always necessary for primitive types like long.name}" itemValue="#{player}" converter="player"> PlayerConverter in this case should implement javax.

<p:pickList value="#{pickListBean. onTransfer If you’d like to execute custom javascript when an item is transferred bind your javascript function to onTransfer attribute.toList //type = e.PrimeFaces Userʼs Guide Effects An animation is displayed when transferring when item to another or reordering a list. dblclick or dragdrop) } </script> Captions Caption texts for lists are defined with facets named sourceCaption and targetCaption.from //toList = e. <p:pickList value="#{pickListBean.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" onTransfer="handleTransfer(e)"> <script type="text/javascript"> function handleTransfer(e) { //item = e. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide effectSpeed attribute is used to customize the animation speed. normal and fast.type (type of transfer.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" onTransfer="handleTransfer(e)"> <f:facet name="sourceCaption">Available</facet> <f:facet name="targetCaption">Selected</facet> </p:picklList> 303 . valid values are slow. command.item //fromList = e. default effect is fade and following options are available to be applied using effect attribute.

Style Class . see the main Skinning section for more information. Following is the list of structural style classes. 304 .ui-picklist-list-source .ui-picklist-button-add Applies Main container element(table) of picklist Lists of a picklist Source list Target list Container element of source list reordering controls Container element of target list reordering controls Buttons of a picklist Move up button Move top button Move down button Move bottom button Add button Add all button Remove all button Add button As skinning style classes are global.ui-picklist-button .ui-picklist-button-add-all .ui-picklist-button-move-bottom .ui-picklist-list .ui-picklist-target-controls .PrimeFaces Userʼs Guide Skinning PickList resides in a main container which style and styleClass attributes apply.ui-picklist .ui-picklist-source-controls .ui-picklist-list-target .ui-picklist-button-move-top .ui-picklist-button-move-down .ui-picklist-button-move-up .ui-picklist-button-remove-all .ui-picklist-button-add .

PollRenderer Attributes Name id rendered binding widgetVar interval update listener immediate Default null TRUE null null 2 null null FALSE Type String Boolean Object String Integer String MethodExpr Boolean Description Unique identifier of the component. Javascript handler to execute before ajax request is begins.component.component. Component id(s) to process partially instead of whole view.PollRenderer org.primefaces.poll. A method expression to invoke by polling. When set to true. Interval in seconds to do periodic ajax requests.PrimeFaces Userʼs Guide 3. 305 async process onstart oncomplete onsuccess onerror FALSE null null null null null Boolean String String String String String . Name of the client side widget. when false at invoke_application phase. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class poll org.74 Poll Poll is an ajax component that has the ability to send periodical ajax requests.Poll org. Javascript handler to execute when ajax request is completed.component.primefaces.component.primefaces.primefaces. Boolean value that determines the phaseId.Poll org. Component(s) to be updated with ajax. Boolean value to specify the rendering of the component. Javascript handler to execute when ajax request fails.primefaces.component org. Javascript handler to execute when ajax request succeeds. An el expression that maps to a server side UIComponent instance in a backing bean. when set to false component will not be rendered. when true actions are processed at apply_request_values.poll. ajax requests are not queued.

setting global to false will not trigger ajaxStatus. Following poll works every 5 seconds. In autoStart mode. } Tuning timing By default the periodic interval is 2 seconds.count = count. } public int getCount() { return this. Note that poll must be nested inside a form. <h:outputText id="txt_count" value="#{counterBean.PrimeFaces Userʼs Guide Name global Default TRUE Type Boolean Description Global ajax requests are listened by ajaxStatus component. to start polling on demand set to false. public void increment() { count++. this is changed with the interval attribute.count. autoStart stop TRUE FALSE Boolean Boolean Getting started with Poll Poll below invokes increment method on CounterBean every 2 seconds and txt_count is updated with the new value of the count variable. polling starts automatically on page load.count}" /> <p:poll listener="#{counterBean. Stops polling when true.increment}" update="txt_count" interval="5" /> 306 .count}" /> <p:poll listener="#{counterBean. } public void setCount(int count) { this. <h:outputText id="txt_count" value="#{counterBean.increment}" update="txt_count" /> public class CounterBean { } private int count.

start(). 307 .stop().">Start</a> <a href="#" onclick="myPoll.">Stop</a> </h:form> Or bind a boolean variable to the stop attribute and set it to false at any arbitrary time.PrimeFaces Userʼs Guide Start and Stop Poll can be started and stopped using client side api.increment}" update="txt_count" widgetVar="myPoll" autoStart="false" /> <a href="#" onclick="myPoll.count}" /> <p:poll interval="5" actionListener="#{counterBean. <h:form> <h:outputText id="txt_count" value="#{counterBean.

75 Printer Printer allows sending a specific JSF component to the printer. binding target null null Object String Getting started with the Printer Printer is attached to any command component like a button or a link.Printer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Behavior Class printer org.component. when set to false component will not be rendered. <h:commandButton id="btn" value="Print"> <p:printer target="output" /> </h:commandButton> <h:outputText id="output" value="PrimeFaces Rocks!" /> <h:outputLink id="lnk" value="#"> <p:printer target="image" /> <h:outputText value="Print Image" /> </h:outputLink> <p:graphicImage id="image" value="/images/nature1.behavior.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Id of the component to print. Examples below demonstrates how to print a simple output text or a particular image on page. not the whole page.PrimeFaces Userʼs Guide 3.jpg" /> 308 .

primefaces.ProgressBar org.primefaces. Interval in seconds to do periodic requests in ajax mode.progressbar.progressbar.component. when set to false component will not be rendered. 309 binding widgetVar value disabled ajax interval null null 0 FALSE FALSE 3000 Object String Integer Boolean Boolean Integer .Progressbar org.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class propressBar org.ProgressBarRenderer org. in ajax mode progress value is retrieved from a backing bean.primefaces.ProgressBarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Value of the progress bar Disables or enables the progressbar Specifies the mode of progressBar.component.component org.primefaces.primefaces.76 ProgressBar ProgressBar is a process status indicator that can either work purely on client side or interact with server side using ajax.component.component.

getValue() + 10). <p:progressBar widgetVar="pb" /> <p:commandButton value="Start" type="button" onclick="start()" /> <p:commandButton value="Cancel" type="button" onclick="cancel()" /> <script type="text/javascript"> function start() { this. Style class of the main container element.progress}" /> public class ProgressBean { } private int progress.setValue(0).progressInterval = setInterval(function(){ pb. "client"(default) or "ajax". } </script> Ajax Progress Ajax mode is enabled by setting ajax attribute to true.progressInterval). Following is a pure client side progressBar. }.PrimeFaces Userʼs Guide Name style styleClass labelTemplate Default null null {value} Type String String String Description Inline style of the main container element. //getter and setter 310 . Template of the progress label. pb. in this case the value defined on a managed bean is retrieved periodically and used to update the progress. Getting started with the ProgressBar ProgressBar has two modes.setValue(pbClient. } function cancel() { clearInterval(this. <p:progressBar ajax="true" value="#{progressBean. 2000).

ProgressBar Method getValue() setValue(value) start() cancel() Params value: Value to display Return Type Number void void void Description Returns current value Sets current value Starts ajax progress bar Stops ajax progress bar 311 .widget. use the interval attribute. Example below demonstrates how to use this event.handleComplete}" update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces. In order to set a different value. <p:progressBar interval="5000" /> Ajax Behavior Events ProgressBar provides complete as the default and only ajax behavior event that is fired when the progress is completed.PrimeFaces Userʼs Guide Interval ProgressBar is based on polling and 3000 milliseconds is the default interval for ajax progress bar meaning every 3 seconds progress value will be recalculated. public class ProgressBean { } private int progress.progress}" ajax="true"> <p:ajax event="complete" listener="#{progressBean. public void handleComplete() { //Add a faces message } //getter-setter <p:progressBar value="#{progressBean.

312 .PrimeFaces Userʼs Guide Skinning ProgressBar resides in a main container which style and styleClass attributes apply. Applies As skinning style classes are global. Style Class .ui-progressbar .ui-progressbar-value . Value of the progressbar Progress label. Following is the list of structural style classes. see the main Skinning section for more information.ui-progressbar-label Main container.

Connects to the channel.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class push org.component org. Client side callback to execute when data is pushed. Getting Started with the Push See chapter 6.widget.primefaces.PushRenderer org.Push org.PrimeFaces Userʼs Guide 3.77 Push Push component is an agent that creates a channel between the server and the client. 313 .component.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Unique channel name of the connection between subscriber and the server.component.primefaces.PushRenderer Attributes Name id rendered binding channel onmessage onclose autoConnect Default null TRUE null null null null TRUE Type String Boolean Object Object String String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeWebSocket Method void send(data) void connect() void close() Description Sends data in json format to push server.push. Disconnects from channel.push. when set to false component will not be rendered. Client side callback to execute when connection is closed. "PrimeFaces Push" for detailed information.primefaces.Push org.component. Connects to channel on page load when enabled. Client Side API of PrimeFaces.

radiobutton.78 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts.component. An el expression that maps to a server side UIComponent instance in a backing bean Disabled the component.PrimeFaces Userʼs Guide 3.RadioButton org. Inline style of the component.radiobutton.component. when set to false component will not be rendered.primefaces. Index of the selectItem of selectOneRadio. Style class of the container.RadioButton org. Id of the selectOneRadio to attach to.RadioButtonRenderer org.primefaces.RadioButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces.component org. 314 .primefaces. Client side callback to execute on state change. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.component. binding disabled itemIndex onchange for style styleClass null FALSE null null null null null Object Boolean Integer String String String String Getting started with RadioButton See custom layout part in SelectOneRadio section for more information.component.

when true the events will be fired at "apply request values".primefaces.RatingRenderer org.component. valueChange Events are fired in "process validations" phase Marks component as required A method binding expression that refers to a method validationg the input binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 315 .79 Rating Rating component features a star based rating system. when set to false component will not be rendered.primefaces.RatingRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rating org.primefaces.component. if immediate is set to false.Rating org.component.component org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces. In case it’s a static text.Rating org. When it’s an EL expression.primefaces. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed.rating. it’s resolved to a converter instance.rating.PrimeFaces Userʼs Guide 3.component.

316 . if you need less or more stars use the stars attribute.rating}" stars="10"/> Display Value Only In cases where you only want to use the rating component to display the rating value and disallow user interaction.rating}" /> When the enclosing form is submitted value of the rating will be assigned to the rating variable. Getting Started with Rating Rating is an input component that takes a double variable as it’s value. Number of Stars Default number of stars is 5. Following rating consists of 10 stars. Message to be displayed when validation fields. <p:rating value="#{ratingBean. set disabled to true.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stars disabled onRate Default null null null null null 5 FALSE null Type MethodExpr String String String String Integer Boolean String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. //getter-setter <p:rating value="#{ratingBean. Name of the client side widget. Message to be displayed when conversion fails. Number of stars to display Disabled user interaction Client side callback to execute when rate happens. public class RatingBean { } private double rating.

public void handleRate(RateEvent rateEvent) { int rating = (int) rateEvent.primefaces.event.RateEvent as a parameter. Disables component.rating}"> <p:ajax event="rate" listener="#{ratingBean.widget.PrimeFaces Userʼs Guide Ajax Behavior Events Rating provides default and only rate event as an ajax behavior.star-rating . A defined listener will be executed by passing an org. Enables component.getRating().Rating Method getValue() setValue(value) disable() enable() Params value: Value to set Return Type Number void void void Description Returns the current value Updates rating value with provided one. <p:rating value="#{ratingBean. //Add facesmessage } //getter-setter Client Side API Widget: PrimeFaces.star-rating-on . Skinning Following is the list of css classes for star rating. Style Class .rating-cancel .star-rating-hover Applies Main container element of progressbar Value of the progressbar Default star Active star Hover star 317 .star-rating-control .handleRate}" update="msgs" /> </p:rating> <p:messages id="msgs" /> public class RatingBean { } private double rating.

Boolean value to specify the rendering of the component.RemoteCommand org. ajax requests are not queued. when true actions are processed at apply_request_values.primefaces. 318 name async process update onstart oncomplete onsuccess onerror null FALSE null null null null null null String Boolean String String String String String String . Component(s) to update with ajax.RemoteCommandRenderer org.PrimeFaces Userʼs Guide 3. Javascript handler to execute when ajax request succeeds. Boolean value that determines the phaseId.component.primefaces. Javascript handler to execute before ajax request is begins.remotecommand.primefaces. when false at invoke_application phase.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class remoteCommand org. An actionlistener that’d be processed in the partial request caused by uiajax.RemoteCommand org.remotecommand. Name of the command When set to true. when set to false component will not be rendered.RemoteCommandRenderer Attributes Name id rendered binding action actionListener immediate Default null TRUE null null null FALSE Type String Boolea Object MethodExpr MethodExpr Boolean Description Unique identifier of the component.80 RemoteCommand RemoteCommand provides a way to execute JSF backing bean methods directly from javascript.component. Javascript handler to execute when ajax request fails.component org. Javascript handler to execute when ajax request is completed. An el expression that maps to a server side UIComponent instance in a backing bean A method expression that’d be processed in the partial request caused by uiajax.component.primefaces. Component(s) to process partially instead of whole view.

Passing Parameters Remote command can send dynamic parameters in the following way. //makes a remote call That’s it whenever you execute your custom javascript function(eg customfunction()). When enabled command is executed on page load. setting global to false will not trigger ajaxStatus. <p:remoteCommand name="increment" actionListener="#{counter.increment}" out="count" /> <h:outputText id="count" value="#{counter. Run on Load If you’d like to run the command on page load. a remote call will be made. param2:’val2’}). Getting started with RemoteCommand RemoteCommand is used by invoking the command from your javascript code.PrimeFaces Userʼs Guide Name global autoRun Default TRUE FALSE Type Boolean Boolean Description Global ajax requests are listened by ajaxStatus component. actionListener is processed and output text is updated.count}" /> <script type="text/javascript"> function customfunction() { //your custom code } </script> increment(). 319 . increment({param1:’val1’. set autoRun to true. Note that remoteCommand must be nested inside a form.

component. Identifier of the target component to make resizable. In ghost mode. 320 . Specifies the resize handles. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org. resize helper is displayed as the original element with less opacity. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Maximum height boundary in pixels.ResizableRenderer org. Enables animation.resizable.component.Resizable org.Resizable org.PrimeFaces Userʼs Guide 3. Defines if aspectRatio should be kept or not.81 Resizable Resizable component is used to make another JSF component resizable.primefaces.primefaces.component.primefaces. Maximum height boundary in pixels.primefaces.component org.component.resizable. Effect duration of animation.primefaces. Effect to use in animation. Minimum width boundary in pixels. when set to false component will not be rendered.ResizableRenderer Attributes Name id rendered binding widgetVar for aspectRatio proxy handles ghost animate effect effectDuration maxWidth maxHeight minWidth minHeight Default null TRUE null null null FALSE FALSE null FALSE FALSE swing normal null null 10 10 Type String Boolean Object String String Boolean Boolean String Boolean Boolean String String Integer Integer Integer Integer Description Unique identifier of the component Boolean value to specify the rendering of the component. Maximum width boundary in pixels. Displays proxy element instead of actual element.

ne. Snaps resizing to grid structure.jpg" /> <p:resizable for="img" /> Another example is the input fields. if users need more space for a textarea. Getting started with Resizable Resizable is used by setting for option as the identifier of the target.w.PrimeFaces Userʼs Guide Name containment grid onStart onResize onStop Default FALSE 1 null null null Type Boolean Integer String String String Description Sets resizable boundaries as the parents size.nw"/> 321 . The valid values for these attributes are numbers in terms of pixels.sw. Client side callback to execute when resizing begins. minHeight and maxHeight. Client side callback to execute during resizing. There’re 4 attributes for this minWidth. se". sw and nw as the value. maxWidth. Client side callback to execute after resizing end. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" /> Boundaries To prevent overlapping with other elements on page. Default value is "e. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" minWidth="20" minHeight="40" maxWidth="50" maxHeight="100"/> Handles Resize handles to display are customize using handles attribute with a combination of n.ne. w. se.n. <p:graphicImage id="img" value="campnou. boundaries need to be specified. e.se. s. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" handles="e. s. make it resizable by.

ui-resizable-proxy { border: 2px dotted #00F.ui-resizable-proxy which you can override to customize. • • • • • • • swing easeInQuad easeOutQuad easeInOutQuad easeInCubic easeOutCubic easeInOutCubic • • • • • • • easeInQuart easeOutQuart easeInOutQuart easeInQuint easeOutQuint easeInOutQuint easeInSine • • • • • • • easeOutSine easeInExpo easeOutExpo easeInOutExpo easeInCirc easeOutCirc easeInOutCirc • • • • • • easeInElastic easeOutElastic easeInOutElastic easeInBack easeOutBack easeInOutBack • easeInBounce • easeOutBounce • easeInOutBounce Ajax Behavior Events Resizable provides default and only resize event that is called on resize end. "normal" and "fast" as valid values. Enabling ghost option displays the element itself with a lower opacity. Animation speed is customized using effectDuration option "slow". By default actual element itself is the helper and two options are available to customize the way feedback is provided.primefaces.handleResize}"> </p:resizable> 322 . } Effects Resizing can be animated using animate option and setting an effect name.ResizeEvent instance as a parameter. In case you have a listener defined. it will be called by passing an org. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area"> <p:ajax listener="#{resizeBean.event. in addition enabling proxy option adds a css class called . <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" animate="true" effect="swing" effectDuration="normal" /> Following is the list of available effect names.PrimeFaces Userʼs Guide Visual Feedback Resize helper is the element used to provide visual feedback during resizing. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" proxy="true" /> .

getHeight(). ui)" /> function handleStop(event. All of these callbacks receive two parameters that provide various information about resize event.originalSize = width.ui-resizable-handle-{handlekey} . onStart.ui-resizable . } Client Side Callbacks Resizable has three client side callbacks you can use to hook-in your javascript.ui-resizable-handle . ui) { //ui. height before resizing //ui.positon = top. left position before resizing //ui. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" onStop="handleStop(event. onResize and onStop. s.getWidth().ui-resizable-proxy Element that is resizable Handle element Particular handle element identified by handlekey like e. int height = event.PrimeFaces Userʼs Guide public class ResizeBean { } public void handleResize(ResizeEvent event) { int width = event. left after resizing //ui. ne Proxy helper element for visual feedback Applies 323 .originalPosition = top.helper = helper element as a jQuery object //ui.size = width height of current size } Skinning Style Class .

component.primefaces. Type of easing to use in animation. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ring org.component org.ring.PrimeFaces Userʼs Guide 3.RingRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.82 Ring Ring is a data display component with a circular animation.primefaces. when set to false component will not be rendered.primefaces.primefaces. Name of the data iterator.component. Inline style of the container element.primefaces.ring.Ring org. Style class of the container element.component.component.Ring org.RingRenderer org. binding widgetVar value var style styleClass easing null null null null null null swing Object String Object String String String String 324 . An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Collection to display.

jpg".add(new players.players}" var="player"> <p:column> //UI to select an item e.players}" var="player”> <p:graphicImage value="/images/barca/#{player. 6. public RingBean() { players = new ArrayList<Player>(). "xavi. 7. Player("Puyol". "puyol. 5. Player("Xavi". "villa. "CM")). commandLink </p:column> </p:ring> Easing Following is the list of available options for easing animation.jpg".jpg". //getter&setter for players <p:ring value="#{ringBean. "iniesta. "CM")). 8. Player("Iniesta".g. } } players.add(new players.add(new players. public class RingBean { private List<Player> players. 10.add(new Player("Messi". • • • • • • • swing easeInQuad easeOutQuad easeInOutQuad easeInCubic easeOutCubic easeInOutCubic • • • • • • • easeInQuart easeOutQuart easeInOutQuart easeInQuint easeOutQuint easeInOutQuint easeInSine • • • • • • • easeOutSine easeInExpo easeOutExpo easeInOutExpo easeInCirc easeOutCirc easeInOutCirc • • • • • • easeInElastic easeOutElastic easeInOutElastic easeInBack easeOutBack easeInOutBack • easeInBounce • easeOutBounce • easeInOutBounce 325 . "CF")). <p:ring value="#{ringBean.PrimeFaces Userʼs Guide Getting started with Ring A collection is required to use the Ring component.jpg".jpg".add(new players. "CB")). Player("Villa". "messi.photo}"/> </p:ring> Item Selection A column is required to process item selection from ring properly. "CF")).

Following is the list of structural style classes. Style Class .PrimeFaces Userʼs Guide Skinning Ring resides in a main container which style and styleClass attributes apply. Applies 326 .ui-ring-item Main container element.ui-ring . Each item in the list.

83 Row Row is a helper component for datatable.component.Row org.Row org.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family row org.component.primefaces. when set to false component will not be rendered.primefaces.row.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See datatable grouping section for more information about how row is used.PrimeFaces Userʼs Guide 3. 327 .

component.RowEditor org. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with RowEditor See inline editing section in datatable documentation for more information about usage.primefaces.component. 328 .roweditor. when set to false component will not be rendered.primefaces.RowEditorRenderer org.component org.primefaces.PrimeFaces Userʼs Guide 3.primefaces.84 RowEditor RowEditor is a helper component for datatable.component.roweditor.RowEditor org.RowEditorRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowEditor org.component.

329 .RowExpansion org.PrimeFaces Userʼs Guide 3.component.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.primefaces.component.rowexpansion.primefaces. Info Tag Component Class Component Type Component Family rowExpansion org. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with RowExpansion See datatable expandable rows section for more information about how rowExpansion is used.RowExpansion org. when set to false component will not be rendered.primefaces.

primefaces.primefaces.rowtoggler.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.RowTogglerRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.86 RowToggler RowToggler is a helper component for datatable.component.RowToggler org.RowToggler org.primefaces.RowTogglerRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See expandable rows section in datatable documentation for more information about usage. when set to false component will not be rendered. 330 .rowtoggler.primefaces.component org.PrimeFaces Userʼs Guide 3.

component.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class schedule org. iCal like JSF component to manage events.primefaces.model.87 Schedule Schedule provides an Outlook Calendar. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.ScheduleModel instance representing the backed model Locale for localization.component.primefaces.Locale instance binding widgetVar value locale null null null null Object String Object Object 331 .Schedule org.util. can be String or a java.component.ScheduleRenderer org.Schedule org.primefaces.ScheduleRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces org.schedule.schedule. An org.PrimeFaces Userʼs Guide 3.component. when set to false component will not be rendered.

Minimum time to display in a day view.TimeZone instance to specify the timezone used for date conversion. the schedule starts on the current date Specifies inclusion Saturday/Sunday columns in any of the views Style of the main container element of schedule Style class of the main container element of schedule When true. events are resizable. 'agendaWeek'. possible values are 'month'. 'basicWeek'. agendaDay TRUE 30 6 null null null Boolean String String Boolean Boolean Boolean String String String allDaySlot slotMinutes firstHour minTime maxTime axisFormat Boolean Integer Integer String String String Determines if all-day slot will be displayed in agendaWeek or agendaDay views Interval in minutes in an hour to create a slot. higher the value shorter the height is The view type to use. events are draggable. If ommitted. Determines the time-text that will be displayed on the vertical axis of the agenda views. When true. First hour to display in day view. timeFormat timeZone null null String Object 332 . Content of right side of header. initialDate null Object showWeekends style styleClass draggable resizable showHeader leftHeaderTemplate centerHeaderTemplate rightHeaderTemplate TRUE null null TRUE TRUE TRUE prev. Content of center of header. next today title month. agendaWeek. Maximum time to display in a day view. Content of left side of header. Determines the time-text that will be displayed on each event.util. 'basicDay' The initial date that is used when schedule loads.PrimeFaces Userʼs Guide Name aspectRatio view Default null month Type Float String Description Ratio of calendar width to height. String or a java. 'agendaDay'. Specifies visibility of header content.

Mandatory properties required to create a new event are the title.ScheduleEntrySelectEvent 333 Fired When a date is selected. public ScheduleBean() { eventModel = new ScheduleModel<ScheduleEvent>().addEvent(new DefaultScheduleEvent("title". new Date(). auto generated.primefaces. Event dateSelect eventSelect Listener Parameter org.model.ScheduleEvent instances.event.PrimeFaces Userʼs Guide Getting started with Schedule Schedule needs to be backed by an org. End date of type java. } DefaultScheduleEvent is the default implementation of ScheduleEvent interface.model.event. new Date())). When an event is selected.primefaces. start date and end date. Title of the event.primefaces.Date. Property id title startDate endDate allDay styleClass data editable Description Used internally by PrimeFaces. a schedule model consists of org. .ScheduleModel instance.util. } public ScheduleModel getModel() { return model.DateSelectEvent org. Other properties such as allDay get sensible default values. Visual style class to enable multi resource display. Start date of type java. eventModel.model}" /> public class ScheduleBean { } private ScheduleModel model. Optional data you can set to be represented by Event.Date.util. Whether the event is editable or not. Flag indicating event is all day. Ajax Behavior Events Schedule provides various ajax behavior events to respond user actions. Table below describes each property in detail.primefaces. <p:schedule value="#{scheduleBean.

title}" required="true"/> <h:outputLabel for="from" value="From:" /> <p:inputMask id="from" value="#{bean.allDay}" /> <p:commandButton type="reset" value="Reset" /> <p:commandButton value="Save" actionListener="#{bean.onDateSelect}" update="eventDetails" oncomplete="eventDialog.event. Editable Schedule Let’s put it altogether to come up a fully editable and complex schedule.Schedule widget to save bandwidth and increase page load performance.event.primefaces.onEventSelect}" </p:schedule> <p:dialog widgetVar="eventDialog" header="Event Details"> <h:panelGrid id="eventDetails" columns="2"> <h:outputLabel for="title" value="Title:" /> <h:inputText id="title" value="#{bean."/> </h:panelGrid> </p:dialog> </h:form> 334 . you may notice a UI lag as the DOM will be regenerated and replaced.ScheduleEntryMoveEvent org. schedule will query it’s server side ScheduleModel instance to check for updates. save button is calling myschedule. As a result when you try to update schedule like with a regular PrimeFacess PPR. Whenever you call update. Instead.PrimeFaces Userʼs Guide Event eventMove eventResize Listener Parameter org.widget.update() at oncomplete event handler.startDate}" mask="99/99/9999"> <f:convertDateTime pattern="dd/MM/yyyy" /> </p:inputMask> <h:outputLabel for="to" value="To:" /> <p:inputMask id="to" value="#{bean.ScheduleEntryResizeEvent Fired When an event is moved.eventDialog.event. Schedule provides a simple client side api and the update method.event. as a result this approach is much more effective then updating with regular PPR. When an event is resized.eventModel}" editable="true" widgetVar="myschedule"> <p:ajax event="dateSelect" listener="#{bean. An example of this is demonstrated at editable schedule example. transport method used to load events dynamically is JSON.primefaces.update().hide().show()" /> <p:ajax event="eventSelect" listener="#{bean.event. Ajax Updates Schedule has a quite complex UI which is generated on-the-fly by the client side PrimeFaces.event.addEvent}" oncomplete="myschedule.endDate}" mask="99/99/9999"> <f:convertDateTime pattern="dd/MM/yyyy" /> </p:inputMask> <h:outputLabel for="allDay" value="All Day:" /> <h:selectBooleanCheckbox id="allDay" value="#{bean. <h:form> <p:schedule value="#{bean.

LazyScheduleModel and implement the loadEvents methods. <p:schedule value="#{scheduleBean. } public void onDateSelect(DateSelectEvent e) { event = new DefaultScheduleEvent("".lazyModel}" /> To enable lazy loading of Schedule events.primefaces. } public ScheduleModel<ScheduleEvent> getModel() { return model. 335 . you just need to provide an instance of org.getDate(). } public ScheduleEventImpl getEvent() { return event. lazy loading features would help to improve performance.addEvent(event).getId() == null) eventModel. e. else eventModel.event = event.getDate()).updateEvent(event).PrimeFaces Userʼs Guide public class ScheduleBean { } private ScheduleModel<ScheduleEvent> model. private ScheduleEventImpl event = new DefaultScheduleEvent(). } Lazy Loading Schedule assumes whole set of events are eagerly provided in ScheduleModel. event = new DefaultScheduleEvent(). loadEvents method is called with new boundaries every time displayed timeframe is changed.model. public ScheduleBean() { eventModel = new ScheduleModel<ScheduleEvent>(). only the events that belong to the displayed time frame are fetched whereas in default eager more all events need to be loaded. if you have a huge data set of events.getScheduleEvent(). } //reset dialog form public void onEventSelect(ScheduleEntrySelectEvent e) { event = e. In lazy loading mode. } public void setEvent(ScheduleEventImpl event) { this. e. } public void addEvent() { if(event.

} Customizing Header Header controls of Schedule can be customized based on templates.. <p:schedule value="#{scheduleBean. @Override public void loadEvents(Date start. public ScheduleBean() { } public ScheduleModel getLazyModel() { return lazyModel.model}" leftHeaderTemplate"today" rightHeaderTemplate="prev. agendaDay" </p:schedule> 336 . Date end) { //addEvent(. These controls can be placed at three locations on header which are defined with leftHeaderTemplate. //addEvent(. } lazyModel = new LazyScheduleModel() { }.)... prevYear: Button to move calendar back one year nextYear: Button to move calendar forward one year today: Button to move calendar to current month/week/day.).PrimeFaces Userʼs Guide public class ScheduleBean { } private ScheduleModel lazyModel.next" centerTemplate="month. viewName: Button to change the view type based on the view type. agendaWeek. next: Button to move calendar forward one month/week/day. valid values of template options are.. • • • • • • • title: Text of current month/week/day information prev: Button to move calendar back one month/week/day. rightHeaderTemplate and centerTemplate attributes.

"agendaDay". "agendaWeek".model}" view="agendaDay"/> basicWeek <p:schedule value="#{scheduleBean.model}" view="agendaWeek"/> agendaDay <p:schedule value="#{scheduleBean. "basicWeek" and "basicDay". agendaWeek <p:schedule value="#{scheduleBean.PrimeFaces Userʼs Guide Views 5 different views are supported. these are "month".model}" view="basicWeek"/> 337 .

model}" view="basicDay"/> Locale Support By default locale information is retrieved from the view’s locale and can be overridden by the locale attribute. PrimeFaces Wiki Page for PrimeFacesLocales is a community driven page where you may find the translations you need.primefaces. Please contribute to this wiki with your own translations. see the main skinning section for more information.util. 338 . As skinning style classes are global. http://wiki. Following is a Turkish calendar. we suggest adding the code to a javascript file and include in your application.Locale instance. Default language of labels are English and you need to add the necessary translations to your page manually as PrimeFaces does not include language translations. <p:schedule value="#{scheduleBean.PrimeFaces Userʼs Guide basicDay <p:schedule value="#{scheduleBean. Locale attribute can take a locale key as a String or a java.org/display/Components/PrimeFaces+Locales Translation is a simple javascript object.model}" locale="tr"/> Skinning Schedule resides in a main container which style and styleClass attributes apply.

ScrollPanelRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.primefaces.primefaces. valid values are default and native.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class scrollPanel org.ScrollPanel org.component. Scrollbar display mode.88 ScrollPanel ScrollPanel is used to display overflowed content with theme aware scrollbars instead of native browsers scrollbars.component. Style class of the container element.ScrollPanelRenderer org.primefaces.component. binding style styleClass mode null null null default Object String String String 339 .component.scrollpanel.component org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the container element.scrollpanel.primefaces.ScrollPanel org.

Horizontal scrollbar. <p:scrollPanel style="width:250px. Handle of a scrollbar Applies 340 . scrollPanel displays theme aware scrollbars. Following is the list of structural style classes.ui-scrollpanel-handle Main container element. <p:scrollPanel style="width:250px.ui-scrollpanel . see the main Skinning section for more information. Style Class . As skinning style classes are global.ui-scrollpanel-vbar .ui-scrollpanel-hbar . width and height must be defined.ui-scrollpanel-container .height:200px"> //any content </p:scrollPanel> Native ScrollBars By default.height:200px" mode="native"> //any content </p:scrollPanel> Skinning ScrollPanel resides in a main container which style and styleClass attributes apply. setting mode option to native displays browser scrollbars.PrimeFaces Userʼs Guide Getting started with ScrollPanel ScrollPanel is used a container component. Vertical scrollbar. Overflow container.

component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectBooleanButton org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.SelectBooleanButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces.SelectBooleanButton org. it must refer to a converter id When set true. process validations logic is executed at apply request values phase for this component. when set to false component will not be rendered.primefaces. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate required validator valueChangeListener FALSE FALSE null null Boolean Boolean MethodExpr MethodExpr 341 .89 SelectBooleanButton SelectBooleanButton is used to select a binary decision with a toggle button.selectbooleanbutton. In case it’s a static text.PrimeFaces Userʼs Guide 3.component. When it’s an EL expression. it’s resolved to a converter instance.component org.selectbooleanbutton.component.SelectBooleanButton org. An el expression or a literal text that defines a converter for the component.component.primefaces.primefaces.SelectBooleanButtonRenderer org.

Inline style of the component. Icon to display when button is selected. //getter and setter } Skinning SelectBooleanButton resides in a main container which style and styleClass attributes apply. see the main Skinning section for more information. User presentable name. Message to be displayed when validation fields. Style class of the container. Following is the list of structural style classes. Disables the component. Getting started with SelectBooleanButton SelectBooleanButton usage is similar to selectBooleanCheckbox. <p:selectBooleanButton id="value2" value="#{bean. Callback to execute on value change. As skinning style classes are global. Label to display when button is unselected. Message to be displayed when conversion fails.value}" onLabel="Yes" offLabel="No" onIcon="ui-icon-check" offIcon="ui-icon-close" /> public class Bean { private boolean value.PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass onLabel offLabel onIcon offIcon Default null null null null FALSE null null null null null null null null Type String String String String Boolean String String String String String String String String Description Message to be displayed when required field validation fails. Name of the client side widget. Label to display when button is selected. Style Class . Icon to display when button is unselected.ui-selectbooleanbutton Main container element. 342 Applies .

component. An el expression or a literal text that defines a converter for the component.component.selectbooleancheckbox. when set to false component will not be rendered.primefaces.component org.selectbooleancheckbox. 343 binding value converter null null null Object Object Converter/ String immediate required validator valueChangeListener requiredMessage FALSE FALSE null null null Boolean Boolean MethodExpr MethodExpr String . In case it’s a static text.SelectBooleanCheckbox org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectBooleanCheckbox org.primefaces. When it’s an EL expression. it’s resolved to a converter instance.component. process validations logic is executed at apply request values phase for this component.SelectBooleanCheckbox Renderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces. it must refer to a converter id When set true.component.SelectBooleanCheckbox org.PrimeFaces Userʼs Guide 3.90 SelectBooleanCheckbox SelectBooleanCheckbox is an extended version of the standard checkbox with theme integration.primefaces. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails.primefaces.SelectBooleanCheckboxRenderer org.

SelectBooleanCheckbox Method check() uncheck() toggle() Params Return Type void void void Description Checks the checkbox. Style Class .ui-chkbox . Client Side API Widget: PrimeFaces. Callback to execute on value change. Label displayed next to checkbox. User presentable name. see the main Skinning section for more information.PrimeFaces Userʼs Guide Name converterMessage validatorMessage widgetVar disabled label onchange style styleClass itemLabel Default null null null FALSE null null null null null Type String String String Boolean String String String String String Description Message to be displayed when conversion fails. Inline style of the component. Toggles check state.ui-chkbox-box . Disables the component. Container of checkbox icon. Unchecks the checkbox. Getting started with SelectBooleanCheckbox SelectBooleanCheckbox usage is same as the standard one.widget. Checkbox label. Following is the list of structural style classes. Name of the client side widget. Message to be displayed when validation fields. Skinning SelectBooleanCheckbox resides in a main container which style and styleClass attributes apply. Style class of the container.ui-chkbox-icon Main container element. Applies 344 . As skinning style classes are global.ui-chkbox-icon . Checkbox icon.

selectcheckboxmenu.primefaces. In case it’s a static text.component org. it must refer to a converter id When set true.SelectCheckboxMenuRenderer org. process validations logic is executed at apply request values phase for this component.selectcheckboxmenu.primefaces. An el expression or a literal text that defines a converter for the component. When it’s an EL expression.SelectCheckboxMenu org.component.component.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.SelectCheckboxMenu org.primefaces.91 SelectChecboxMenu SelectCheckboxMenu is a multi select component that displays options in an overlay. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectCheckboxMenu org.component.primefaces.primefaces. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 345 .SelectCheckboxMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. it’s resolved to a converter instance.PrimeFaces Userʼs Guide 3.

ui-chkbox . Label. Checkbox icon. As skinning style classes are global. Overlay panel. Name of the client side widget. 346 Applies .ui-selectcheckboxmenu-items .ui-selectcheckboxmenu-trigger . Following is the list of structural style classes. Style class of the container.ui-selectcheckboxmenu-label . Style Class . Message to be displayed when validation fields. Container of a checkbox. Label container. Container of checkbox icon. Skinning SelectCheckboxMenu resides in a main container which style and styleClass attributes apply. see the main Skinning section for more information.ui-selectcheckboxmenu-label-container . User presentable name.ui-selectcheckboxmenu . Each options in the collection.ui-selectcheckboxmenu-panel . Callback to execute on value change. Option list container. Disables the component.ui-chkbox-box . Dropdown icon.PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass height Default null null null null FALSE null null null null null Type String String String String Boolean String String String String Integer Description Message to be displayed when required field validation fails.ui-selectcheckboxmenu-item . Getting started with SelectCheckboxMenu SelectCheckboxMenu usage is same as the standard selectManyCheckbox or PrimeFaces selectCheckboxMenu components. Inline style of the component. Height of the overlay. Message to be displayed when conversion fails.ui-chkbox-icon Main container element.

it must refer to a converter id When set true.primefaces. When it’s an EL expression.component.primefaces.primefaces.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyButton org.SelectManyButton Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. process validations logic is executed at apply request values phase for this component. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 347 . it’s resolved to a converter instance.SelectManyButton org.component.selectmanybutton.component. An el expression or a literal text that defines a converter for the component.primefaces.92 SelectManyButton SelectManyButton is a multi select component using button UI.component org. when set to false component will not be rendered.SelectManyButton org.component.selectmanybutton. In case it’s a static text. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.SelectManyButton org.primefaces.

see the main Skinning section for more information. Getting started with SelectManyButton SelectManyButton usage is same as selectManyCheckbox. Applies 348 . Disables the component. User presentable name. As skinning style classes are global. Callback to execute on value change. Inline style of the component. Style Class .PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass Default null null null null FALSE null null null null Type String String String String Boolean String String String String Description Message to be displayed when required field validation fails. Message to be displayed when validation fields. buttons just replace checkboxes. Name of the client side widget. Style class of the container. Message to be displayed when conversion fails. Skinning SelectManyButton resides in a main container which style and styleClass attributes apply.ui-selectmanybutton Main container element. Following is the list of structural style classes.

An el expression or a literal text that defines a converter for the component.primefaces.component org.component.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyCheckbox org. it’s resolved to a converter instance. process validations logic is executed at apply request values phase for this component.component.primefaces. In case it’s a static text.primefaces.selectmanycheckbox. When it’s an EL expression.SelectManyCheckbox org.component.selectmanycheckbox. when set to false component will not be rendered.93 SelectManyCheckbox SelectManyCheckbox is an extended version of the standard SelectManyCheckbox with theme integration.primefaces. it must refer to a converter id When set true.primefaces.SelectManyCheckboxRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.SelectManyCheckbox org. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 349 .SelectManyCheckboxRenderer org.component.

Layout of the checkboxes. User presentable name. Container of a checkbox. Applies 350 .PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label layout Default null null null null FALSE null lineDirection Type String String String String Boolean String String Description Message to be displayed when required field validation fails. onchange style styleClass null null null String String String Getting started with SelectManyCheckbox SelectManyCheckbox usage is same as the standard one. Message to be displayed when conversion fails. see the main Skinning section for more information. Following is the list of structural style classes.ui-chkbox-box .ui-chkbox . Container of checkbox icon.ui-chkbox-icon Main container element. Style class of the container.ui-selectmanycheckbox . Inline style of the component. Message to be displayed when validation fields. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Disables the component. Checkbox icon. As skinning style classes are global. Callback to execute on value change. Style Class . Name of the client side widget. Skinning SelectManyCheckbox resides in a main container which style and styleClass attributes apply.

selectmanymenu. When it’s an EL expression. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces. it must refer to a converter id When set true.primefaces.SelectManyMenu org.94 SelectManyMenu SelectManyMenu is an extended version of the standard SelectManyMenu with theme integration. Marks component as required A method expression that refers to a method validationg the input binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 351 .primefaces.primefaces.selectmanymenu. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyMenu org.component.PrimeFaces Userʼs Guide 3. An el expression or a literal text that defines a converter for the component. In case it’s a static text. process validations logic is executed at apply request values phase for this component.SelectManyMenu org.component.SelectManyMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. when set to false component will not be rendered.component. it’s resolved to a converter instance.SelectManyMenuRenderer org.component.component org.

Message to be displayed when conversion fails. Style Class . Message to be displayed when validation fields.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass Default null null null null null FALSE null null null null Type MethodExpr String String String String Boolean String String String String Description A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. see the main Skinning section for more information. Name of the client side widget. Style class of the container.ui-selectmanymenu . User presentable name. Getting started with SelectManyMenu SelectManyMenu usage is same as the standard one. Skinning SelectManyMenu resides in a container that style and styleClass attributes apply. Callback to execute on value change. As skinning style classes are global. Following is the list of structural style classes. Inline style of the component. Disables the component. Each item in list.ui-selectlistbox-item Main container element. Applies 352 .

primefaces. When it’s an EL expression.component.SelectOneButton org.95 SelectOneButton SelectOneButton is an input component to do a single select.primefaces.selectonebutton.primefaces.selectonebutton.SelectOneButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. process validations logic is executed at apply request values phase for this component.SelectOneButton org. An el expression or a literal text that defines a converter for the component. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneButton org. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 353 . it’s resolved to a converter instance. it must refer to a converter id When set true. In case it’s a static text.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces.SelectOneButtonRenderer org.primefaces.component.component.component org.

Getting started with SelectOneButton SelectOneButton usage is same as selectOneRadio component.PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass Default null null null null FALSE null null null null Type String String String String Boolean String String String String Description Message to be displayed when required field validation fails. see the main Skinning section for more information. Callback to execute on value change. Style Class . User presentable name. buttons just replace the radios.ui-selectonebutton Main container element. Applies 354 . Message to be displayed when conversion fails. Inline style of the component. Name of the client side widget. Disables the component. Style class of the container. As skinning style classes are global. Skinning SelectOneButton resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes. Message to be displayed when validation fields.

primefaces.component.component.96 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox with theme integration. An el expression or a literal text that defines a converter for the component. When it’s an EL expression.selectonelistbox.component.SelectOneListboxRenderer org.primefaces.primefaces.component org.selectonelistbox.PrimeFaces Userʼs Guide 3. it’s resolved to a converter instance.SelectOneListbox org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. Marks component as required A method expression that refers to a method validationg the input binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 355 .SelectOneListbox org. process validations logic is executed at apply request values phase for this component.primefaces. it must refer to a converter id When set true. In case it’s a static text.primefaces.SelectOneListBoxRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. when set to false component will not be rendered.

Following is the list of structural style classes. Inline style of the component.ui-selectonelistbox . Skinning SelectOneListbox resides in a main container which style and styleClass attributes apply.ui-selectlistbox-item Main container element. Getting started with SelectOneListbox SelectOneListbox usage is same as the standard one. Style Class . User presentable name. As skinning style classes are global. see the main Skinning section for more information. Style class of the container. Each item in list. Message to be displayed when validation fields. Message to be displayed when conversion fails. Name of the client side widget. Applies 356 . Callback to execute on value change.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar disabled label onchange style styleClass Default null null null null null FALSE null null null null Type MethodExpr String String String String Boolean String String String String Description A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Disables the component.

When it’s an EL expression.97 SelectOneMenu SelectOneMenu is an extended version of the standard SelectOneMenu with theme integration.primefaces.component.selectonemenu.PrimeFaces Userʼs Guide 3. process validations logic is executed at apply request values phase for this component.SelectOneMenuRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneMenu org.component org. Marks component as required binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required FALSE Boolean 357 . it must refer to a converter id When set true.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces.component.component. An el expression or a literal text that defines a converter for the component. In case it’s a static text. when set to false component will not be rendered.selectonemenu.component.SelectOneMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.SelectOneMenu org.primefaces.SelectOneMenu org. it’s resolved to a converter instance.

default effect is blind and following options are available for effect attribute. input becomes editable. Name of the item iterator. Name of the toggle animation. Message to be displayed when conversion fails. Style class of the container. • • • • • • • blind bounce clip drop explode fold highlight 358 . Message to be displayed when validation fields. Callback to execute on value change.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar effect effectDuration disabled label onchange style styleClass var height tabindex editable Default null null null null null null blind 400 FALSE null null null null null auto null FALSE Type MethodExpr MethodExpr String String String String String Integer Boolean String String String String String Integer String Boolean Description A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Disables the component. Tabindex of the input. User presentable name. Duration of toggle animation in milliseconds. Name of the client side widget. Effects An animation is executed to show and hide the overlay menu. When true. Inline style of the component. Getting started with SelectOneMenu Basic SelectOneMenu usage is same as the standard one. Height of the overlay.

PrimeFaces Userʼs Guide • • • • • • puff pulsate scale shake size slide Custom Content SelectOneMenu can display custom content in overlay panel by using column component and the var option to refer to each item. 6. 7. public OrderListBean() { players = new ArrayList<Player>().jpg")).add(new Player("Villa". 8. "messi. players.jpg")). "iniesta. public class MenuBean { private List<Player> players.add(new Player("Messi".name}" itemValue="#{player}"/> <p:column> <p:graphicImage value="/images/barca/#{p. } } //getters and setters <p:selectOneMenu value="#{menuBean. players. 10. players. private Player selectedPlayer.#{p.number} </p:column> </p:selectOneMenu> 359 .players}" var="player" itemLabel="#{player.jpg")).add(new Player("Iniesta". players.photo}" width="40" height="50"/> </p:column> <p:column> #{p.jpg")).add(new Player("Xavi".name} . "xavi. "villa.selectedPlayer}" converter="player" var="p"> <f:selectItem itemLabel="Select One" itemValue="" /> <f:selectItems value="#{menuBean.

As skinning style classes are global. Skinning SelectOneMenu resides in a container element that style and styleClass attributes apply.PrimeFaces Userʼs Guide Editable Editable SelectOneMenu provides a UI to either choose from the predefined options or enter a manual input. Set editable option to true to use this feature. Following is the list of structural style classes. Applies 360 .ui-selectonemenu-trigger .ui-selectonemenu-label . Style Class .ui-selectonemenu . Label of the component.ui-selectonemenu-items Main container. see the main Skinning section for more information. Container of dropdown icon.ui-selectonemenu-items . Each item in the list. Items list.

it’s resolved to a converter instance.SelectOneRadio org. When it’s an EL expression. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org.primefaces. process validations logic is executed at apply request values phase for this component.component org. when set to false component will not be rendered.component.98 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.component.PrimeFaces Userʼs Guide 3.selectoneradio.primefaces. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails.primefaces.SelectOneRadio org. 361 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener requiredMessage FALSE null null null Boolean MethodExpr MethodExpr String .component.SelectOneRadioRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.SelectOneRadioRenderer org.primefaces. In case it’s a static text. An el expression or a literal text that defines a converter for the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces. it must refer to a converter id When set true.selectoneradio.

selectOneRadio itself does not render any output. Callback to execute on value change. Note that in custom mode. Style class of the container. Message to be displayed when validation fields. onchange style styleClass null null null String String String Getting started with SelectOneRadio SelectOneRadio usage is same as the standard one. Name of the client side widget. User presentable name. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical).option}" layout="custom"> <f:selectItem itemLabel="Option 1" itemValue="1" /> <f:selectItem itemLabel="Option 2" itemValue="2" /> <f:selectItem itemLabel="Option 3" itemValue="3" /> </p:selectOneRadio> <h:panelGrid columns="3"> <p:radioButton id="opt1" for="customRadio" itemIndex="0"/> <h:outputLabel for="opt1" value="Option 1" /> <p:spinner /> <p:radioButton id="opt2" for="customRadio" itemIndex="1"/> <h:outputLabel for="opt2" value="Option 2" /> <p:inputText /> <p:radioButton id="opt3" for="customRadio" itemIndex="2"/> <h:outputLabel for="opt3" value="Option 3" /> <p:calendar /> </h:panelGrid> 362 . <p:selectOneRadio id="customRadio" value="#{formBean. Disables the component. Inline style of the component.PrimeFaces Userʼs Guide Name converterMessage validatorMessage widgetVar disabled label layout Default null null null FALSE null lineDirection Type String String String Boolean String String Description Message to be displayed when conversion fails. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. This is implemented by setting layout option to custom and with standalone radioButton components. Layout of the checkboxes.

Applies 363 . Container of radio button icon. see the main Skinning section for more information.PrimeFaces Userʼs Guide RadioButton’s for attribute should refer to a selectOneRadio component and itemIndex points to the index of the selectItem.ui-selectoneradio .ui-radiobutton-icon Main container element. Style Class .ui-radiobutton . Skinning SelectOneRadio resides in a main container which style and styleClass attributes apply. Container of a radio button. Following is the list of structural style classes.ui-radiobutton-box . Radio button icon. As skinning style classes are global. selectOneRadio component should be placed above any radioButton that points to the selectOneRadio. When using custom layout option.

primefaces.separator.Separator org.component.Separator org. when set to false component will not be rendered.Separator org.primefaces. binding title style styleClass null null null null Object String String String Getting started with Separator In its simplest form.primefaces.separator. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class separator org. Inline style of the separator.component.primefaces.component org.99 Separator Seperator displays a horizontal line to separate content.primefaces. separator is used as.component. //content <p:separator /> //content 364 . Style class of the separator. An el expression that maps to a server side UIComponent instance in a backing bean Advisory tooltip informaton.Separator Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.PrimeFaces Userʼs Guide 3.

Class . style and styleClass options can be used to style the separator.ui-separator Separator element Applies As skinning style classes are global.height:20px" /> Special Separators Separator can be used inside other components such as menu and toolbar as well. 365 . <p:separator style="width:500px.PrimeFaces Userʼs Guide Dimensions Separator renders a <hr /> tag which style and styleClass options apply. see the main Skinning section for more information. Following is the list of structural style classes. <p:menu> //submenu or menuitem <p:separator /> //submenu or menuitem </p:menu> <p:toolbar> <p:toolbarGroup align="left"> //content <p:separator /> //content </p:toolbarGroup> </p:toolbar> Skinning As mentioned in dimensions section.

component.component org.component.component. 366 binding value var widgetVar style null null null null null Object Object String String String .sheet.primefaces.primefaces. bulk delete/update and more.primefaces. keyboard navigation. horizontal/vertical scrolling. frozen headers. multi cell selection with meta/ shift keys.component. when set to false component will not be rendered.SheetRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.sheet. ajax sorting.primefaces. Inline style of the container element. Name of the client side widget. An el expression that maps to a server side UIComponent instance in a backing bean Data of the component.Sheet org.SheetRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class sheet org.primefaces.Sheet org. Name of the data iterator.PrimeFaces Userʼs Guide 3.100 Sheet Sheet is an excel-like component to do data manipulation featuring resizable columns.

• Column child must be an input text. } public TableBean() { cars = //populate data } //getters and setters <p:sheet value="#{tableBean.color}" /> </p:column> </p:sheet> When the parent form of the sheet is submitted.manufacturer}" /> </p:column> <p:column headerText="Color" style="width:125px"> <h:inputText value="#{car. Getting started with Sheet Sheet usage is similar to a datatable. • Columns must be fixed width. 367 .cars}" var="car" scrollHeight="300"> <f:facet name="caption"> List of Cars </f:facet> <p:column headerText="Model" style="width:125px"> <h:inputText value="#{car.year}"/> </p:column> <p:column headerText="Manufacturer" style="width:125px"> <h:inputText value="#{car. two important points for sheet are. Height of the viewport.PrimeFaces Userʼs Guide Name styleClass scrollWidth scrollHeight Default null null null String Integer Integer Type Description Style class of the container element. public class TableBean { private List<Car> cars. sheet will update the data according to the changes on client side.model}" /> </p:column> <p:column headerText="Year" style="width:125px"> <h:inputText value="#{car. Width of the viewport.

model}”> <h:inputText value="#{car.PrimeFaces Userʼs Guide Sorting Sorting can be enabled using the sortBy option of the column component. Label to display current cell. Style Class . Following is the list of structural style classes. Editor of a cell.ui-sheet .ui-sh-c-d .ui-sheet-editor-bar . Label of a cell.model}" /> </p:column> Skinning Sheet resides in a container that style and styleClass attributes apply.ui-sh-c . see the main Skinning section for more information. Global cell editor.ui-sh-c-e Main container element. Each cell.ui-sheet-editor .ui-sheet-cell-info . As skinning style classes are global. Editor bar. Applies 368 . <p:column headerText="Model" style="width:125px" sortBy=”#{car.

component. "horizontal" or "vertical".component org. display modes and skinning.primefaces.slider.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Id of the input text that the slider will be used for Id of the component to display the slider value. Fixed pixel increments that the slider move in Disables or enables the slider. Minimum value of the slider Maximum value of the slider Inline style of the container element Style class of the container element Boolean value to enable/disable the animated move when background of slider is clicked Sets the type of the slider.primefaces.component.Slider org.component.Slider org.PrimeFaces Userʼs Guide 3.SliderRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.primefaces.101 Slider Slider is used to provide input with various customization options like orientation.component. 369 binding for display minValue maxValue style styleClass animate type step disabled null null null 0 100 null null TRUE horizontal 1 FALSE Object String String Integer Integer String String Boolean String Integer Boolean .primefaces.slider.SliderRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.

} <h:inputText id="number" value="#{sliderBean. Getting started with Slider Slider requires an input component to work with. <h:inputHidden id="number" value="#{sliderBean. } public void setNumber(int number) { this.PrimeFaces Userʼs Guide Name onSlideStart onSlide onSlideEnd Default null null null Type String String String Description Client side callback to execute when slide begins.number}" /> <p:slider for="number" display="output" /> 370 . Client side callback to execute when slide ends. Client side callback to execute during sliding. public class SliderBean { } private int number. you can present a readonly display value and still use slider to provide input.number}" /> <h:outputText value="Set ratio to %" /> <h:outputText id="output" value="#{sliderBean.number}" /> <p:slider for="number" /> Display Value Using display feature.number = number. in this case for should refer to a hidden input to bind the value. public int getNumber() { return number. for attribute is used to set the id of the input component whose input will be provided by the slider.

PrimeFaces Userʼs Guide Vertical Slider By default slider’s orientation is horizontal. <h:inputText id="number" value="#{sliderBean. vertical sliding is also supported and can be set using the type attribute. Default value is one and it is customized using step option.number}" /> <p:slider for="number" minValue="-100" maxValue="100"/> 371 . Following slider can slide between -100 and +100. Boundaries Maximum and minimum boundaries for the sliding is defined using minValue and maxValue attributes. <h:inputText id="number" value="#{sliderBean.number}" /> <p:slider for="number" type="vertical" minValue="0" maxValue="200"/> Step Step factor defines the interval between each point during sliding. <h:inputText id="number" value="#{sliderController.number}" /> <p:slider for="number" step="10" /> Animation Sliding is animated by default. if you want to turn it of animate attribute set the animate option to false.

} public void onSlideEnd(SlideEndEvent event) { int value = event. <h:inputText id="number" value="#{sliderBean. If you have a listener defined. it will be called by passing org.event. onSlide and onSlideEnd.number}" /> <p:slider for="number" onSlideEnd="handleSlideEnd(event. ui)"/> function handleSlideEnd(event.number = number. All of these callbacks receive two parameters.helper = Handle element of slider //ui.SlideEndEvent instance. onSlideStart. <h:inputText id="number" value="#{sliderBean.PrimeFaces Userʼs Guide Client Side Callbacks Slider provides three callbacks to hook-in your custom javascript.number}" /> <p:slider for="number"> <p:ajax event="slideEnd" listener="#{sliderBean. } public void setNumber(int number) { this.primefaces. //add faces message } 372 .value = Current value of slider } Ajax Behavior Events Slider provides one ajax behavior event called slideEnd that is fired when the slide completes.getValue(). slide event and the ui object containing information about the event. public int getNumber() { return number. Example below adds a message and displays it using growl component when slide ends. ui) { //ui.onSlideEnd}" update="msgs" /> </p:slider> <p:messages id="msgs" /> public class SliderBean { } private int number.

Skinning Slider resides in a main container which style and styleClass attributes apply.ui-slider-vertical . These attributes are handy to specify the dimensions of the slider.ui-slider-handle Main container element Main container element of horizontal slider Main container element of vertical slider Slider handle Applies As skinning style classes are global.ui-slider .ui-slider-horizontal . Disables slider. 373 . Following is the list of structural style classes.Slider Method getValue() setValue(value) disable() enable() Params value: Value to set index: Index of tab to disable index: Index of tab to enable Return Type Number void void void Description Returns the current value Updates slider value with provided one.widget. Class . see the main Skinning section for more information. Enables slider.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.

spacer. Height of the space. Style class of the spacer. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spacer org.SpacerRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Advisory tooltip informaton.Spacer org. Inline style of the spacer.component.Spacer org.component.primefaces.component. 374 .primefaces.component. Spacer in this example separates this text <p:spacer width="100" height="10"> and <p:spacer width="100" height="10"> this text.SpacerRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.component org.spacer. binding title style styleClass width height null null null null null null Object String String String String String Getting started with Spacer Spacer is used by either specifying width or height of the space.102 Spacer Spacer is used to put spaces between elements. Width of the space.primefaces.primefaces.primefaces.

primefaces. valueChange Events are fired in "process validations" phase Marks component as required A method binding expression that refers to a method validationg the input immediate FALSE Boolean required validator FALSE null Boolean Method Expr 375 .spinner.component org.primefaces.component. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed. when true the events will be fired at "apply request values". if immediate is set to false. In case it’s a static text. When it’s an EL expression.spinner.primefaces.component.Spinner org.SpinnerRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component. it’s resolved to a converter instance.PrimeFaces Userʼs Guide 3.component.primefaces.SpinnerRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spinner org. when set to false component will not be rendered.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces.103 Spinner Spinner is an input component to provide a numerical input via increment and decrement buttons.Spinner org.

Maximum number of characters that may be entered in this field. 376 . Client side callback to execute when a key is pressed down over input element. Client side callback to execute when input element loses focus. Code describing the language used in the generated markup for this component. Disables input field A localized user presentable name. Controls browser autocomplete behavior. Message to be displayed when conversion fails. Name of the client side widget. Client side callback to execute when input element is clicked. Alternate textual description of the input field. Message to be displayed when validation fields. Valid values are LTR and RTL. Client side callback to execute when input element receives focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Stepping factor for each increment and decrement Minimum boundary value Maximum boundary value Prefix of the input Suffix of the input Access key that when pressed transfers focus to the input element. Direction indication for text that does not inherit directionality.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stepFactor min max prefix suffix accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown Default null null null null null 1 null null null null null null null null FALSE null null null null null null null null null Type Method Expr String String String String Double Double Double String String String String String String Boolean String String Integer String String String String String String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Client side callback to execute when input element is double clicked.

Position of the input element in the tabbing order. //getter and setter <p:spinner value="#{spinnerBean. Style class of the input element. Client side callback to execute when a pointer button is released over input element. Getting Started with Spinner Spinner is an input component and used just like a standard input text. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a key is released over input element.PrimeFaces Userʼs Guide Name onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null null null null null null FALSE null null null null null Type String String String String String String String String Boolean Integer String String Integer String Description Client side callback to execute when a key is pressed and released over input element. Advisory tooltip informaton. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a pointer button is moved away from input element. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. public class SpinnerBean { } private int number. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element.number}" /> 377 . Inline style of the input element.

<p:spinner value="#{spinnerBean.PrimeFaces Userʼs Guide Step Factor Other than integers. Following example uses a stepFactor 0. //getter and setter Output of this spinner would be. After an increment happens a couple of times. spinner also support decimals so the fractional part can be controller with spinner as well.number}" stepFactor="0.number}" prefix="$" /> Boundaries In order to restrict the boundary values. use min and max options. <p:spinner value="#{spinnerBean. <p:spinner value="#{spinnerBean.25.number}" min="0" max="100"/> 378 .25"/> public class SpinnerBean { } private double number. Prefix and Suffix Prefix and Suffix options enable placing fixed strings on input field. Note that you would need to use a converter to avoid conversion errors since prefix/suffix will also be posted. For decimals use the stepFactor attribute to specify stepping amount.

see the main Skinning section for more information. <p:spinner value="#{spinnerBean.number}"> <p:ajax update="display" /> </p:spinner> <h:outputText id="display" value="#{spinnerBean. an ajax request is done to update the outputtext with new value whenever a spinner button is clicked.ui-spinner-button-down Applies Main container element of spinner Input field Spinner buttons Increment button Decrement button As skinning style classes are global.PrimeFaces Userʼs Guide Ajax Spinner Spinner can be ajaxified using client behaviors like f:ajax or p:ajax.ui-spinner-button . In example below.ui-spinner .ui-spinner-input .ui-spinner-button-up .number}" /> Skinning Spinner resides in a container element that using style and styleClass applies. Following is the list of structural style classes. 379 . Class .

splitbutton.primefaces. An actionlistener that’d be processed when button is clicked. 380 type ajax submit TRUE String Boolean .splitbutton.SplitButtonRenderer org. when false at invoke_application phase. An el expression that maps to a server side UIComponent instance in a backing bean Label for the button A method expression or a String outcome that’d be processed when button is clicked.component.SplitButton org. submit would be made with Ajax. Boolean value that determines the phaseId. when true actions are processed at apply_request_values.SplitButton org. Sets the behavior of the button.component.SplitButtonRenderer Attributes Name id rendered binding value action actionListener immediate Default null TRUE null null null null FALSE Type String Boolean Object String MethodExpr/ String MethodExpr Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.104 SplitButton SplitButton displays a command by default and additional ones in an overlay. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class splitButton org. when set to false component will not be rendered.component.PrimeFaces Userʼs Guide 3.primefaces. when set to true(default).primefaces.component.primefaces.primefaces.component org. Specifies the submit mode.

Client side callback to execute when a key is released over button. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when button loses focus. Client side callback to execute before ajax request is begins. Inline style of the button element. Client side callback to execute when a pointer button is pressed down over button. Client side callback to execute when a pointer button is moved within button. Client side callback to execute when ajax request fails. Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when a key is pressed and released over button. Client side callback to execute when ajax request is completed. 381 . Defines whether to trigger ajaxStatus or not. Client side callback to execute when button loses focus and its value has been modified since gaining focus. StyleClass of the button element. Client side callback to execute when button is double clicked. ajax requests are not queued. Component(s) to be updated with ajax. Client side callback to execute when a pointer button is released over button. Client side callback to execute when ajax request succeeds. Client side callback to execute when button receives focus. Client side callback to execute when button is clicked.PrimeFaces Userʼs Guide Name async process update onstart oncomplete onsuccess onerror global style styleClass onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup Default FALSE null null null null null null TRUE null null null null null null null null null null null null null null null Type Boolean String String String String String String Boolean String String String String String String String String String String String String String String String Description When set to true. Client side callback to execute when a key is pressed down over button. Component(s) to process partially instead of whole view.

update}" update="messages" icon="ui-icon-arrowrefresh-1-w"/> <p:menuitem value="Delete" actionListener="#{buttonBean. Nested options defined as menuitems do ajax. Style class for the button icon. non-ajax requests as well as regular navigation to an external url. Disables the button. Position of the icon. clicking the save button invokes save method of the bean and updates messages. Direction indication for text that does not inherit directionality. Access key that when pressed transfers focus to the button. Icon of the button as a css class. Code describing the language used in the generated markup for this component. Advisory tooltip information.save}" update="messages" icon="ui-icon-disk"> <p:menuitem value="Update" actionListener="#{buttonBean. Additional commands are placed inside the component and displayed in an overlay. Alternate textual description of the button.PrimeFaces Userʼs Guide Name onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos widgetVar Default null null null null FALSE null null null null null FALSE null left null Type String String String String Boolean String String String Integer String Boolean String String String Description Client side callback to execute when text within button is selected by user.org" icon="ui-icon-extlink"/> </p:splitButton> 382 . <p:splitButton value="Save" actionListener="#{buttonBean. Getting started with SplitButton SplitButton usage is similar to a regular commandButton. (deprecated: use icon) A localized user presentable name. In example below. Name of the client side widget.delete}" ajax="false" icon="ui-icon-close"/> <p:separator /> <p:menuitem value="Homepage" url="http://www. Valid values are LTR and RTL. Flag indicating that this component will prevent changes by the user. Position of the button element in the tabbing order.primefaces.

PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Style Class .ui-menu-list . Skinning SplitButton renders a container element which style and styleClass applies.ui-menuitem .ui-button . 383 .SplitButton Method show() hide() Params Return Type void void Description Displays overlay.ui-menuitem-text Container element. Hides overlay.ui-splitbutton-menubutton . see the main Skinning section for more information.ui-menuitem-link . Following is the list of structural style classes. Button element Dropdown button Button element when icon is not used Label of button Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global.ui-button-text-only .ui-splitbutton .widget.ui-menu .ui-button-text .

An el expression that maps to a server side UIComponent instance in a backing bean. binding label icon style styleClass null null null null null Object String String String String Getting started with Submenu Please see Menu or Menubar section to find out how submenu is used with the menus.105 Submenu Submenu is nested in menu components and represents a sub menu items.component.primefaces.component.PrimeFaces Userʼs Guide 3. Icon of a submenu. Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family submenu org.Submenu org. Label of the submenu header. Style class of the submenu. 384 .submenu. when set to false component will not be rendered.primefaces.Submenu org.primefaces. see menuitem to see how it is used Inline style of the submenu.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.

An optional image to contain stacked items.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org.component org.StackRenderer org.primefaces.PrimeFaces Userʼs Guide 3. Name of the client side widget. MenuModel instance to create menus programmatically Whether to display stack as expanded or not.primefaces.StackRenderer Attributes Name id rendered binding icon openSpeed closeSpeed widgetVar model expanded Default null TRUE null null 300 300 null null FALSE Type String Boolean Object String String Integer String MenuModel Boolean Description Unique identifier of the component.component.stack. Boolean value to specify the rendering of the component.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X. Speed of the animation when opening the stack. An el expression that maps to a server side UIComponent instance in a backing bean.Stack org.component. when set to false component will not be rendered.primefaces.primefaces.Stack org.stack. 385 .component. Speed of the animation when opening the stack.primefaces.

ui-stack { bottom: 28px. There’s one important css selector for stack called . Stack below has five items with different icons and labels. Skinning Class .. see the dynamic menus part in menu component section for more information and an example. Location Stack is a fixed positioned element and location can be change via css. Override this style to change the location of stack. right: 40px.ui-stack ul li span Applies Main container element of stack Each item in stack Icon of a stack item Label of a stack item 386 .ui-stack.ui-stack . } Dynamic Menus Menus can be created programmatically as well.png" url="#"/> //. </p:stack> Initially stack will be rendered in collapsed mode. <p:stack icon="/images/stack/stack.PrimeFaces Userʼs Guide Getting started with Stack Each item in the stack is represented with menuitems. .png" url="#"/> <p:menuitem value="Photoshop" icon="/images/stack/photoshop..png"> <p:menuitem value="Aperture" icon="/images/stack/aperture.ui-stack ul li .ui-stack ul li img .

SubTable org.component.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class subTable org.107 SubTable SummaryRow is a helper component of datatable used for grouping. 387 .primefaces.component.primefaces.SubTableRenderer org.subtable.primefaces.primefaces.component org.PrimeFaces Userʼs Guide 3. Name of the data iterator. when set to false component will not be rendered.subtable.SubTableRenderer Attributes Name id rendered binding value var Default null TRUE null null null Type String Boolean Object Object String Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Data of the component. Getting started with SubTable See DataTable section for more information.primefaces.SubTable org.

component org. Getting started with SummaryRow See DataTable section for more information.component.component.SummaryRow org.summaryrow.component.primefaces.primefaces.component.SummaryRow org.primefaces. to calculate totals).108 SummaryRow SummaryRow is a helper component of datatable used for dynamic grouping.PrimeFaces Userʼs Guide 3.SummaryRowRenderer Attributes Name id rendered binding listener Default null TRUE null null Type String Boolean Object MethodExpr Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Method expression to execute before rendering summary row.SummaryRowRenderer org. (e.g. when set to false component will not be rendered.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class summaryRow org. 388 .summaryrow.primefaces.

Style class of the tab.primefaces.TabView.Tab org.109 Tab Tab is a generic container component used by other PrimeFaces components such as tabView and accordionPanel. Makes the tab closable when enabled. Disables tab element. binding title titleStyle titleStyleClass disabled closable titletip null null null null FALSE FALSE null Object Boolean String String Boolean Boolean String Getting started with the Tab See the sections of components who utilize tab component for more information.primefaces. Boolean value to specify the rendering of the component. when set to false component will not be rendered. Tooltip of the tab header.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. An el expression that maps to a server side UIComponent instance in a backing bean. Info Tag Component Class Component Type Component Family tab org.primefaces.Tab org. As tab is a shared component.PrimeFaces Userʼs Guide 3. Title text of the tab Inline style of the tab.component.component. not all attributes may apply to the components that use tab. 389 .

tabview.PrimeFaces Userʼs Guide 3. Enables lazy loading of inactive tabs.TabView org.TabViewRenderer org. Variable name of the client side widget.component.TabView org.tabview. dynamic content loading with ajax and content transition effects. Index of the active tab. when set to false component will not be rendered.110 TabView TabView is a tabbed panel component featuring client side tabs.component.primefaces.component.primefaces.primefaces.component org.primefaces. Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean. binding widgetVar activeIndex effect effectDuration dynamic null null 0 null null FALSE Object String Integer String String Boolean 390 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tabView org. Name of the transition effect.TabViewRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. Duration of the transition effect.primefaces.component.

Style class of the main container. <p:tabView> <p:tab title="Tab One"> <h:outputText value="Lorem" /> </p:tab> <p:tab title="Tab Two"> <h:outputText value="Ipsum" /> </p:tab> <p:tab title="Tab Three"> <h:outputText value="Dolor" /> </p:tab> </p:tabView> Dynamic Tabs There’re two toggleModes in tabview. Titles can also be defined by using “title” facet. Client side callback to execute when a tab is shown. onTabChange onTabShow style styleClass var value orientation null null null null null null top String String String String String Object String Getting started with the TabView TabView requires one more child tab components to display. tab contents are reloaded from server each time tab is clicked. content is loaded with ajax. Orientation of tab headers. Client side callback to execute when a tab is clicked. If caching is turned off. caching only retrieves the tab contents once and subsequent toggles of a cached tab does not communicate with server. To enable dynamic loading. on the other hand in dynamic mode. all tab contents are rendered to the client. non-dynamic (default) and dynamic.PrimeFaces Userʼs Guide Name cache Default TRUE Type Boolean Description When tab contents are lazy loaded by ajax toggleMode. simply set dynamic option to true. By default. Collection model to display dynamic tabs. only the active tab contents are rendered and when an inactive tab header is selected. Dynamic mode is handy in reducing page size. Name of iterator to refer an item in collection. Inline style of the main container. pages will load faster. since inactive tabs are lazy loaded. 391 .

If you want to reload content of a tab each time a tab is selected. 392 . slow.primefaces. //. <p:tabView> <p:ajax event=”tabChange” listener=”#{bean. } Your listener(if defined) will be invoked with an org. EffectDuration specifies the speed of the effect.TabCloseEvent. by doing so.primefaces. Effects Content transition effects are controlled with effect and effectDuration attributes.onChange}” /> //tabs </p:tabView> public void onChange(TabChangeEvent event) { //Tab activeTab = event. <p:tabView effect="fade" effectDuration="fast"> //tabs </p:tabView> Ajax Behavior Events tabChange and tabClose are the ajax behavior events of tabview that are executed when a tab is changed and closed respectively. For tabClose event. turn off caching by cache to false. reactivating a tab doesn’t result in an ajax request since contents are cached.event.event.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself.PrimeFaces Userʼs Guide <p:tabView dynamic="true"> //tabs </p:tabView> Content Caching Dynamically loaded tabs cache their contents by default. Here is an example of a tabChange behavior implementation.. normal (default) and fast are the valid options.getTab().. listener will be passed an instance of org.

propertyA}"> <h:outputText value= "#{listItem. index)"> //tabs </p:tabView> function handleTabChange(index) { //index = Index of the new tab } 393 . top(default)..More content </p:tab> </p:tabView> Orientations Tabview supports four different orientations mode. onTabChange is executed when an inactive tab is clicked and onTabShow is executed when an inactive tab becomes active to be shown. <p:tabView onTabChange="handleTabChange(event. left. use the built-in iteration feature similar to ui:repeat.PrimeFaces Userʼs Guide Dynamic Number of Tabs When the tabs to display are not static. right and bottom. <p:tabView value="#{bean.propertyB}"/> . <p:tabView orientation="left"> //tabs </p:tabView> Client Side Callbacks Tabview has two callbacks for client side..list}" var="listItem"> <p:tab title="#{listItem.

use select instead) Activates tab with given index Disables tab with given index Enables tab with given index Removes tab with given index Returns the number of tabs Returns index of current tab disable(index) enable(index) remove(index) getLength() getActiveIndex() index: Index of tab to disable index: Index of tab to enable index: Index of tab to remove - void void void Number Number Skinning As skinning style classes are global.ui-tabs-nav . Method select(index) selectTab(index) Params index: Index of tab to display index: Index of tab to display Return Type void void Description Activates tab with given index (Deprecated.ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container 394 .ui-tabs . Following is the list of structural style classes.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Class . see the main Skinning section for more information.widget.TabView.

primefaces.TagCloud org. Inline style of the container element. Backing tag cloud model. Style class of the container element.component. <p:tagCloud model="#{timelineBean.primefaces.component.TagCloud org.primefaces.tagcloud.primefaces.component.TagCloudRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.model}" /> 395 . binding widgetVar model style styleClass null null null null null Object String TagCloudModel String String Getting started with the TagCloud TagCloud requires a backend TagCloud model to display.TagCloudRenderer org.111 TagCloud TagCloud displays a collection of tag with different strengths.tagcloud. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tagCloud org.component org.PrimeFaces Userʼs Guide 3.component.primefaces.

primefaces. Adds a tag. .ui-tagcloud-strength-[1. Returns url of the tag.PrimeFaces Userʼs Guide public class TagCloudBean { private TagCloudModel model.TagCloudItem Method String getLabel() String getUrl() int getStrength() Returns label of the tag.addTag(new DefaultTagCloudItem("Transformers". Description PrimeFaces provides org. 396 .primefaces. "#".TagCloudModel Method List<TagCLoudItem> getTags() void addTag(TagCloudItem item) void removeTag(TagCloudItem item) void clear() Returns all tags in model. 1)).model. Removes all tags. Removes a tag.model. //more } //getter } TagCloud API org.tagcloud.ui-tagcloud applies to main container and .DefaultTagCloudModel as the default implementation.tagcloud.tagcloud. Description PrimeFaces provides org.tagcloud. model.model. Returns strength of the tag between 1 and 5. org. As skinning style classes are global.primefaces.primefaces. Skinning TagCloud resides in a container element that style and styleClass attributes apply.5] applies to each tag. see the main Skinning section for more information.model. public TagCloudBean() { model = new DefaultTagCloudModel().DefaultTagCloudItem as the default implementation.

PrimeFaces Userʼs Guide 3.primefaces.terminal.Terminal org.primefaces.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.primefaces.primefaces. Primary prompt text.component. when set to false component will not be rendered.Terminal org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.TerminalRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load.component.terminal.TerminalRenderer org.primefaces.component.component org.component. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .

Name of the client side widget. else return command + " not found".equals("greet")) return "Hello " + params[0]. <p:commandButton type="Show Terminal" type="button" onclick="dlg. <p:terminal commandHandler="#{terminalBean.focus().PrimeFaces Userʼs Guide Name commandHandler widgetVar Default null null Type MethodExpr String Description Method to be called with arguments to process. Getting started with the Terminal A command handler is necessary to interpret commands entered in terminal.term. following example shows how to add focus on a terminal nested inside a dialog.equals("date")) return new Date(). handleCommand method is invoked with the command name and the command arguments as a String array.show().toString(). String[] params) { if(command. use client side api.handleCommand}" /> public class TerminalBean { } public String handleCommand(String command.handleCommand}" width="590px" /> </p:dialog> 398 . Focus To add focus on terminal. } Whenever a command is sent to the server. else if(command."/> <p:dialog widgetVar="dlg" width="600" height="400" header="Terminal"> <p:terminal widgetVar="term" commandHandler="#{terminalBean.

ThemeSwitcher org. Client side callback to execute on theme change. User presentable name.component.113 ThemeSwitcher ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh. Duration of the animation in milliseconds. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Name of the animation.component org.themeswitcher.ThemeSwitcher org.primefaces.primefaces. Inline style of the component.primefaces.themeswitcher.component.primefaces.primefaces.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.component.component.ThemeSwitcherRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class themeSwitcher org. 399 binding widgetVar effect effectDuration disabled label onchange style null null blind 400 FALSE null null null Object String String Integer Boolean String String String .ThemeSwitcherRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Disables the component.

image}"/> </p:column> <p:column> #{t.name} </p:column> </p:themeSwitcher> 400 .themes}" /> <p:ajax listener="#{bean. Height of the panel. you can use an ajax behavior.themes}" /> </p:themeSwitcher> Stateful ThemeSwitcher By default.advancedThemes}" var="theme" itemLabel="#{theme.name}" itemValue="#{theme}"/> <p:column> <p:graphicImage value="/images/themes/#{t. Variable name to refer to each item.theme}" effect="fade"> <f:selectItem itemLabel="Choose Theme" itemValue="" /> <f:selectItems value="#{themeSwitcherBean. to update user preferences).saveTheme}" /> </p:themeSwitcher> Advanced ThemeSwitcher ThemeSwitcher supports displaying custom content so that you can show theme previews. <p:themeSwitcher style="width:150px"> <f:selectItem itemLabel="Choose Theme" itemValue="" /> <f:selectItems value="#{bean.PrimeFaces Userʼs Guide Name styleClass var height tabindex Default null null null null Type String String Integer Integer Description Style class of the component. themeswitcher just changes the theme on the fly with no page refresh. Position of the element in the tabbing order.g. <p:themeSwitcher value="#{bean. in case you’d like to get notified when a user changes the theme (e. <p:themeSwitcher> <f:selectItem itemLabel="Choose Theme" itemValue="" /> <f:selectItems value="#{themeSwitcherBean. Getting Started with the ThemeSwitcher ThemeSwitcher usage is very similar to selectOneMenu.

An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the container element.ToolbarRenderer org.toolbar.ToolbarRenderer Attributes Name id rendered null TRUE Default Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Toolbar org. binding style styleClass null null null Object String String Getting Started with the Toolbar Toolbar has two placeholders(left and right) that are defined with toolbarGroup component.component org.primefaces.component.component.primefaces.component. Style class of the container element.toolbar.primefaces.component.primefaces. <p:toolbar> <p:toolbarGroup align="left"> </p:toolbarGroup> <p:toolbarGroup align="right"> </p:toolbarGroup> </p:toolbar> 401 .114 Toolbar Toolbar is a horizontal grouping component for commands and other content.primefaces.Toolbar org. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class toolbar org.

<p:toolbar> <p:toolbarGroup align="left"> <p:commandButton type="push" value="New" image="ui-icon-document" /> <p:commandButton type="push" value="Open" image="ui-icon-folder-open"/> <p:separator /> <p:commandButton type="push" title="Save" image="ui-icon-disk"/> <p:commandButton type="push" title="Delete" image="ui-icon-trash"/> <p:commandButton type="push" title="Print" image="ui-icon-print"/> </p:toolbarGroup> <p:divider /> <p:toolbarGroup align="right"> <p:menuButton value="Navigate"> <p:menuitem value="Home" url="#" /> <p:menuitem value="Logout" url="#" /> </p:menuButton> </p:toolbarGroup> </p:toolbar> Skinning Toolbar resides in a container element which style and styleClass options apply.ui-toolbar-group-left .ui-toolbar-group-right Main container Divider in a toolbar Left toolbarGroup container Right toolbarGroup container Applies As skinning style classes are global. 402 . see the main Skinning section for more information. Here is an example.ui-toolbar . Additionally p:separator component can be used to separate items in toolbar. Style Class .PrimeFaces Userʼs Guide Any number of components can be placed inside toolbarGroups.ui-separator .ui-toolbar . Following is the list of structural style classes.

toolbar. Info Tag Component Class Component Type Component Family toolbarGroup org.ToolbarGroup org. Style class of the container element. An el expression that maps to a server side UIComponent instance in a backing bean Defines the alignment within toolbar.primefaces.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.component Attributes Name id rendered null TRUE Default Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.ToolbarGroup org.component.primefaces.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders.primefaces. 403 . valid values are left and right.component. binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used. Inline style of the container element.

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tooltip org. when set to false component will not be rendered. In case it’s a static text.component.component. Event hiding the tooltip.PrimeFaces Userʼs Guide 3.Tooltip org.116 Tooltip Tooltip goes beyond the legacy html title attribute by providing custom effects.primefaces.primefaces.tooltip. When it’s an EL expression.component org.component. Effect to be used for displaying.primefaces. html content and advance theme support. Event displaying the tooltip.TooltipRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Effect to be used for hiding. events.primefaces.TooltipRenderer org. it’s resolved to a converter instance. it must refer to a converter id Name of the client side widget. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.Tooltip org.tooltip.component.primefaces. binding value converter null null null Object Object Converter/ String widgetVar showEvent showEffect hideEvent hideEffect null mouseover fade mouseout fade String String String String String 404 .

If you need to change this behaviour use the showEvent and hideEvent feature.password}" title="Only numbers"/> <p:tooltip for="pwd"/> Events and Effects A tooltip is shown on mouseover event and hidden when mouse is out by default. <h:inputSecret id="pwd" value="#{myBean.password}" /> <p:tooltip for="pwd" value="Only numbers"/> <h:inputSecret id="pwd" value="#{myBean.password}" /> <p:tooltip for="pwd" value="Password must contain only numbers" showEvent="focus" hideEvent="blur" showEffect="blind" hideEffect="explode" /> Available options for effects are. so following is same. Tooltip below is displayed when the input gets the focus and hidden with onblur. Getting started with the Tooltip Tooltip is used by attaching it to a target component.PrimeFaces Userʼs Guide Name for style styleClass Default null null null Type String String String Description Id of the component to attach the tooltip. <h:inputSecret id="pwd" value="#{myBean. Style class of the tooltip. Inline style of the tooltip. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide 405 . Tooltip value can also be retrieved from target’s title.

406 .PrimeFaces Userʼs Guide Html Content Another powerful feature of tooltip is the ability to display custom content as a tooltip not just plain texts. see main skinning section for more information.ui-tooltip as a style class and is styled with global skinning selectors. An example is as follows. <h:outputLink id="lnk" value="#"> <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> <p:graphicImage value="/images/prime_logo.png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only .

binding widgetVar value var dynamic cache null null null null FALSE TRUE Object String Object String Boolean Boolean 407 . when set to false component will not be rendered.tree. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tree org. A TreeNode instance as the backing model.primefaces.component.primefaces. Specifies the ajax/client toggleMode Specifies caching on dynamically loaded nodes.Tree org.TreeRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Name of the request-scoped variable that'll be used to refer each treenode data.primefaces.component.TreeRenderer org.component.tree.primefaces.component org. When set to true expanded nodes will be kept in memory. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.PrimeFaces Userʼs Guide 3.component.primefaces.117 Tree Tree is is used for displaying hierarchical data and creating site navigations.Tree org.

node0). TreeNode node001 = new TreeNode("Node 0. TreeNode array to reference the selections. TreeNode node11 = new TreeNode("Node 1.0.1.0". node1). node01). node10). node0). TreeNode node10 = new TreeNode("Node 1. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. node00). Style of the main container element of tree Style class of the main container element of tree Defines the selectionMode Getting started with the Tree Tree is populated with a org.0". public class TreeBean { } private TreeNode root.0.root}" var="node"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> 408 . root).primefaces. //getter Then specify a UI treeNode component as a child to display the nodes. TreeNode node00 = new TreeNode("Node 0. <p:tree value="#{treeBean. TreeNode node01 = new TreeNode("Node 0.PrimeFaces Userʼs Guide Name onNodeClick selection style styleClass selectionMode Default null null null null null Type String Object String String String Description Javascript event to process when a tree node is clicked.1". TreeNode node100 = new TreeNode("Node 1. node1). TreeNode node0 = new TreeNode("Node 0".1".0.model.1".TreeNode instance which corresponds to the root. root). public } TreeBean() { root = new TreeNode("Root". TreeNode node010 = new TreeNode("Node 0.0". TreeNode node000 = new TreeNode("Node 0. node00). root).0".0". null). TreeNode node1 = new TreeNode("Node 1". TreeNode node2 = new TreeNode("Node 2".

primefaces.root}" var="node" dynamic="true"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> Non-Dynamic: When toggling is set to client all the treenodes in model are rendered to the client and tree is created. dynamic mode has the advantage of dealing with large data because only the child nodes of the root node is sent to the client initially and whole tree is lazily populated. In order to enable ajax toggling set dynamic setting to true. For example if you call node. Dynamic: Dynamic mode uses ajax to fetch the treenodes from server side on demand. 409 .setExpanded(true) on a particular node. compared to the client toggling. You can bind a TreeNode to a particular p:treeNode using the type name. this mode is suitable for relatively small datasets and provides fast user interaction. on the other hand <p:treeNode /> tag represents a component of type org. Document Tree example in upcoming section demonstrates a sample usage. tree only loads the children of the particular expanded node and send to the client for display. When a node is expanded.tree.primefaces. Encapsulated data List of child nodes Parent node Flag indicating whether the node is expanded or not Dynamic Tree Tree is non-dynamic by default and toggling happens on client-side.model.UITreeNode. TreeNode API TreeNode has a simple API to use when building the backing model.TreeNode instances. tree will render that node as expanded. On the otherhand it’s not suitable for large data since all the data is sent to the client. default type name is "default".component.PrimeFaces Userʼs Guide TreeNode vs p:TreeNode TreeNode API is used to create the node model and consists of org. Property type data children parent expanded String Object List<TreeNode> TreeNode Boolean Type Description type of the treeNode name. <p:tree value="#{treeBean.

name}" /> </p:treeNode> </p:tree> 410 .name}"/> </p:treeNode> <p:treeNode type="document" icon="ui-icon ui-icon-document"> <h:outputText value="#{doc. Document Explorer is implemented with four different <p:treeNode /> components and additional CSS skinning to visualize expanded/closed folder icons.name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <h:outputText value="#{doc. video). <p:tree value="#{bean.root}" var="doc"> <p:treeNode expandedIcon="ui-icon ui-icon-folder-open" collapsedIcon="ui-icon ui-icon-folder-collapsed"> <h:outputText value="#{doc. Following example demonstrates a document explorer. In order to solve this. files each having a different formats (music. you can place more than one <p:treeNode /> components each having a different type and use that "type" to bind TreeNode’s in your model. Suppose you’re using tree to visualize a company with different departments and different employees. or a document tree with various folders.PrimeFaces Userʼs Guide Multiple TreeNode Types It’s a common requirement to display different TreeNode types with a different UI (eg icon). To begin with here is the final output.name}" /> </p:treeNode> <p:treeNode type="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc.

public Bean() { root = new TreeNode("root". turkish). TreeNode pictures = new TreeNode("Pictures". TreeNode resume = new TreeNode("document". null).jpg". erkinKoray). "Nem Alacak Felek Benim". TreeNode toprakana = new TreeNode("mp3". mogollar).png". "Resimdeki Goz Yaslari". TreeNode cemKaraca = new TreeNode("Cem Karaca". "RefDoc.jpg". This results in rendering all music nodes using that particular p:treeNode representation which displays a note icon. TreeNode oylebirgecer = new TreeNode("mp3". erkinKoray). primefaces). //Music TreeNode turkish = new TreeNode("Turkish". } public TreeNode getRoot() { return root. "barcelona. pictures). turkish).pages". cemKaraca). TreeNode refdoc = new TreeNode("document". //Documents TreeNode expenses = new TreeNode("document". "Expenses. TreeNode resimdeki = new TreeNode("mp3". work). TreeNode primelogo = new TreeNode("picture". "Resume. TreeNode erkinKoray = new TreeNode("Erkin Koray". documents). "Oyle Bir Gecer". TreeNode music = new TreeNode("Music". TreeNode primefaces = new TreeNode("PrimeFaces". "Bisi Yapmali". TreeNode bisiyapmali = new TreeNode("mp3". TreeNode copculer = new TreeNode("mp3". there’s also a p:treeNode component with same type "mp3". root). pictures). root). for example music files in document explorer are represented using TreeNodes with type "mp3".PrimeFaces Userʼs Guide public class Bean { private TreeNode root. "Copculer". TreeNode nemalacak = new TreeNode("mp3". mogollar). documents). //Pictures TreeNode barca = new TreeNode("picture". TreeNode work = new TreeNode("Work".doc".doc". Folders on the other hand have two states whose icons are defined by expandedIcon and collapsedIcon attributes. } } Integration between a TreeNode and a p:treeNode is the type attribute. music). TreeNode documents = new TreeNode("Documents". turkish). work). "Toprak Ana". "logo. cemKaraca). pictures). root). TreeNode mogollar = new TreeNode("Mogollar". 411 . "optimus. TreeNode optimus = new TreeNode("picture". Similarly document and pictures have their own p:treeNode representations.

checkbox: Multiple selection is done with checkbox UI.NodeSelectEvent org.primefaces.PrimeFaces Userʼs Guide Ajax Behavior Events Tree provides various ajax behavior events.getTreeNode().getData().onNodeSelect}" /> <p:ajax event="expand" listener="#{treeBean. multiple: Multiple nodes can be selected.NodeExpandEvent org. The idea for implementing such a use case would be providing only the root and child nodes to the tree. } Event listeners are also useful when dealing with huge amount of data.onNodeCollapse}" /> .primefaces.NodeCollapseEvent org.toString(). selection should be a TreeNode reference.event.toString(). Following tree has three listeners.event. selection should be a TreeNode[] reference. Selection Node selection is a built-in feature of tree and it supports three different modes.event. 412 . } public void onNodeExpand(NodeExpandEvent event) { String node = event. When a node is collapsed. selection should be a TreeNode[] reference.NodeUnselectEvent Fired When a node is expanded. } public void onNodeCollapse(NodeCollapseEvent event) { String node = event. When a node is unselected. <p:tree value="#{treeBean.getTreeNode(). Event expand collapse select collapse Listener Parameter org.toString(). single: Only one at a time can be selected.model}" dynamic="true"> <p:ajax event="select" listener="#{treeBean.onNodeExpand}" /> <p:ajax event="collapse" listener="#{treeBean. Selection should be a TreeNode for single case and an array of TreeNodes for multiple and checkbox cases. use event listeners to get the selected node and add new nodes to that particular tree at runtime. When a node is selected..getData().primefaces.event..getTreeNode(). </p:tree> public void onNodeSelect(NodeSelectEvent event) { String node = event.primefaces. tree finds the selected nodes and assign them to your selection model.getData().

//populate nodes } //getters and setters That’s it.root}" var="node" selectionMode="checkbox" selection="#{treeBean. In case it’s set to false. 413 . null). private TreeNode[] selectedNodes. } public TreeBean() { root = new TreeNode("Root". Handling Node Click If you need to execute custom javascript when a treenode is clicked. now the checkbox based tree looks like below. dynamically loaded nodes will be kept in memory so reexpanding a node will not trigger a server side request. Node Caching When caching is turned on by default.selectedNodes}"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> public class TreeBean { private TreeNode root.PrimeFaces Userʼs Guide <p:tree value="#{treeBean. Your javascript method will be processed with passing the html element of the node. collapsing the node will remove the children and expanding it later causes the children nodes to be fetched from server again. selected nodes will be populated in selectedNodes property of TreeBean. When the form is submitted with a command component like a button. use the onNodeClick attribute.

Skinning Tree resides in a container element which style and styleClass options apply. see the main Skinning section for more information.ui-tree-node-label Main container Child nodes container Tree node Tree node content Tree node icon Tree node label Applies As skinning style classes are global.ui-tree-nodes . 414 .ui-tree . you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type. Following is the list of structural style classes.ui-tree-node-content .ui-tree-node . Style Class .ui-tree-icon .PrimeFaces Userʼs Guide ContextMenu Tree has special integration with context menu.

UITreeNode org. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family treeNode org.tree.component.primefaces.UITreeNode org. refer to sections of these components for more information. Expanded icon of the node.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. binding type styleClass icon expandedIcon collapsedIcon null default null null null null Object String String String String String Getting started with the TreeNode TreeNode is used by Tree and TreeTable components.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Type of the tree node Style class to apply a particular tree node type Icon of the node.component.PrimeFaces Userʼs Guide 3.118 TreeNode TreeNode is used with Tree component to represent a node in tree. Collapsed icon of the node. 415 .

Name of the client side widget.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class treeTable org. 416 .TreeTableRenderer Attributes Name id rendered binding value var widgetVar style styleClass selection Default null TRUE null null null null null null null Type String Boolean Object Object String String String String Object Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces. Style class of the container element.TreeTable org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean A TreeNode instance as the backing model.component org.treetable. Selection reference.treetable.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.component.TreeTable org. Name of the request-scoped variable used to refer each treenode.TreeTableRenderer org.component. Inline style of the container element.primefaces.119 TreeTable Treetable is is used for displaying hierarchical data in tabular format.component.primefaces.

TreeNode instance that corresponds to the root node. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. setters <p:treeTable value="#{bean. Height of scrollable data. For an example. Getting started with the TreeTable Similar to the Tree. TreeTable is populated with an org.type}" /> </p:column> </p:treeTable> 417 . private String type. model to be displayed is a collection of documents. Style class of the table element.name}" /> </p:column> <p:column> <f:facet name="header"> Size </f:facet> <h:outputText value="#{document. private String size. //getters.PrimeFaces Userʼs Guide Name selectionMode scrollable scrollHeight scrollWidth tableStyle tableStyleClass Default null FALSE null null null null Type String Boolean Integer Integer String String Type of selection mode. public class Document { } private String name. Inline style of the table element. Description Whether or not the data should be scrollable.model. Width of scrollable data.size}" /> </p:column> <p:column> <f:facet name="header"> Type </f:facet> <h:outputText value="#{document.root}" var="document"> <p:column> <f:facet name="header"> Name </f:facet> <h:outputText value="#{document.primefaces.

tree finds the selected nodes and assign them to your selection model.NodeUnselectEvent org. Selection Node selection is a built-in feature of tree and it supports two different modes. When a column is resized.primefaces. Body element of the table containing data Each cell in treetable.ui-treetable . Class . you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type. single: Only one at a time can be selected. 418 . When a node is collapsed.event.primefaces.NodeExpandEvent org.ColumnResizeEvent Fired When a node is expanded.primefaces. When a node is selected.ui-treetable-data . Event expand collapse select collapse colResize Listener Parameter org.event.event. When a node is unselected. ContextMenu TreeTable has special integration with context menu. multiple: Multiple nodes can be selected. Selection should be a TreeNode for single case and an array of TreeNodes for multiple case.event.NodeCollapseEvent org. Skinning TreeTable content resides in a container element which style and styleClass attributes apply. Header of treetable. see the main Skinning section for more information. selection should be a TreeNode[] reference.ui-tt-c Main container element.PrimeFaces Userʼs Guide Backing model is same as the documents example in tree.primefaces.NodeSelectEvent org.primefaces. Ajax Behavior Events TreeTable provides various ajax behavior events to respond user actions.ui-treetable-header . selection should be a TreeNode reference.event. Following is the list of structural style classes. Applies As skinning style classes are global.

one way is to use for attribute.primefaces.watermark. Boolean value to specify the rendering of the component.120 Watermark Watermark displays a hint on an input field.component.Watermark org.primefaces.component.WatermarkRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> 419 .Watermark org. An el expression that maps to a server side UIComponent instance in a backing bean Text of watermark. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class watermark org.primefaces.primefaces.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.primefaces.component org.component. <h:inputText id="txt" value="#{bean.WatermarkRenderer org. Id of the component to attach the watermark jQuery selector to attach the watermark binding value for forElement null 0 null null Object Integer String String Getting started with Watermark Watermark requires a target of the input component.watermark.

ui-watermark’. Note that this style class is not applied when watermark uses html5 placeholder if available. 420 . <h:inputText id="txt" value="#{bean.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> <h:commandButton value="Submit" /> <p:commandButton value="Submit" onclick="PrimeFaces. This would result in updating bean properties with watermark values. Watermark component is clever enough to handle this case.cleanWatermarks()" oncomplete="PrimeFaces.PrimeFaces Userʼs Guide Form Submissions Watermark is set as the text of an input field which shouldn’t be sent to the server when an enclosing for is submitted.showWatermarks()" /> Skinning There’s only one css style class applying watermark which is ‘. However ajax submissions requires a little manual effort. by default in non-ajax form submissions. you can override this class to bring in your own style. watermarks are cleared.

Style class of the main wizard container element. Specifies visibility of default navigator arrows.WizardRenderer org.Wizard org. An el expression that maps to a server side UIComponent instance in a backing bean Id of the current step in flow Style of the main wizard container element. 421 .primefaces.component.wizard.component.PrimeFaces Userʼs Guide 3. Wizard consists of several child tab components where each tab represents a step in the process. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class wizard org.wizard.component org.WizardRenderer Attributes Name id rendered binding step style styleClass flowListener showNavBar showStepStatus Default null TRUE null 0 null null null TRUE TRUE Type String Boolean Object String String String MethodExpr Boolean Boolean Description Unique identifier of the component. when set to false component will not be rendered.primefaces.primefaces.121 Wizard Wizard provides an ajax enhanced UI to implement a workflow easily in a single page.component. Server side listener to invoke when wizard attempts to go forward or back.component.primefaces.Wizard org. Specifies visibility of default step title bar.primefaces. Boolean value to specify the rendering of the component.

} public void save(ActionEvent actionEvent) { //Persist user FacesMessage msg = new FacesMessage("Successful".getFirstname()). Label of next navigation button. } User is a simple pojo with properties such as firstname. Following wizard requires 3 steps to get the user data. As an example following wizard is used to create a new user in a total of 4 steps where last step is for confirmation of the information provided in first 3 steps. } public void setUser(User user) { this. To begin with create your backing bean. "Welcome :" + user.PrimeFaces Userʼs Guide Name onback onnext nextLabel backLabel widgetVar Default null null null null null Type String String String String String Description Javascript event handler to be invoked when flow goes back.addMessage(null. lastname. msg). FacesContext. it’s important that the bean lives across multiple requests so avoid a request scope bean. Label of back navigation button. 422 . Note that last tab contains read-only data for confirmation and the submit button. Personal Details. public class UserWizard { } private User user = new User(). public User getUser() { return user.getCurrentInstance(). Optimal scope for wizard is viewScope. email and etc. Javascript event handler to be invoked when flow goes forward.user = user. Address Details and Contact Details. Name of the client side widget Getting Started with Wizard Each step in the flow is represented with a tab.

user.user.PrimeFaces Userʼs Guide <h:form> <p:wizard> <p:tab id="personal"> <p:panel header="Personal Details"> <h:messages errorClass="error"/> <h:panelGrid columns="2"> <h:outputText value="Firstname: *" /> <h:inputText value="#{userWizard.user.user. value"> <h:outputText value="Street: " /> <h:inputText value="#{userWizard.firstname}" required="true"/> <h:outputText value="Lastname: *" /> <h:inputText value="#{userWizard.email}" required="true"/> <h:outputText value="Phone: " /> <h:inputText value="#{userWizard.lastname}" required="true"/> <h:outputText value="Age: " /> <h:inputText value="#{userWizard.info}"/> </h:panelGrid> </p:panel> </p:tab> 423 .user.phone}"/> <h:outputText value="Additional Info: " /> <h:inputText value="#{userWizard.user.user.user.postalCode}" /> <h:outputText value="City: " /> <h:inputText value="#{userWizard.user.street}" /> <h:outputText value="Postal Code: " /> <h:inputText value="#{userWizard.age}" /> </h:panelGrid> </p:panel> </p:tab> <p:tab id="address"> <p:panel header="Adress Details"> <h:messages errorClass="error"/> <h:panelGrid columns="2" columnClasses="label.city}" /> </h:panelGrid> </p:panel> </p:tab> <p:tab id="contact"> <p:panel header="Contact Information"> <h:messages errorClass="error"/> <h:panelGrid columns="2"> <h:outputText value="Email: *" /> <h:inputText value="#{userWizard.

if the current step is valid.user. next tab’s contents are loaded with ajax.user.user.age}" /> <h:outputText value="Street: " /> <h:outputText value="#{userWizard.user.phone}"/> <h:outputText value="Info: " /> <h:outputText value="#{userWizard.user.user.info}"/> <h:outputText /> <h:outputText /> </h:panelGrid> <p:commandButton value="Submit" actionListener="#{userWizard. Partial validation is also built-in.street}" /> <h:outputText value="Postal Code: " /> <h:outputText value="#{userWizard. Validations are not executed when flow goes back.user.city}"/> <h:outputText value="Email: " /> <h:outputText value="#{userWizard.email}" /> <h:outputText value="Phone " /> <h:outputText value="#{userWizard. 424 . next and prev.save}" /> </p:panel> </p:tab> </p:wizard> </h:form> AJAX and Partial Validations Switching between steps is based on ajax. by this way when you click next.lastname}"/> <h:outputText value="Age: " /> <h:outputText value="#{userWizard.user.PrimeFaces Userʼs Guide <p:tab id="confirm"> <p:panel header="Confirmation"> <h:panelGrid id="confirmation" columns="6"> <h:outputText value="Firstname: " /> <h:outputText value="#{userWizard. Navigations Wizard provides two icons to interact with.postalCode}"/> <h:outputText value="City: " /> <h:outputText value="#{userWizard. only the current step is validated.firstname}"/> <h:outputText value="Lastname: " /> <h:outputText value="#{userWizard. Please see the skinning wizard section to know more about how to change the look and feel of a wizard. meaning each step is loaded dynamically with ajax.user.

. else return event. if you need to come up with your own UI.back(). </p:wizard> 425 .handleFlow}"> . <p:wizard showNavBar="false" widgetVar="wiz"> .. } if(skip) return "confirm". Steps here are simply the ids of tab.">Back</h:outputLink> Ajax FlowListener If you’d like get notified on server side when wizard attempts to go back or forward. </p:wizard> public String handleFlow(FlowEvent event) { String currentStepId = event.. in case you need to execute custom javascript after wizard goes back or forth. <p:wizard onnext="alert(‘Next’)" onback="alert(‘Back’)"> . set showNavBar to false and use the provided the client side api..PrimeFaces Userʼs Guide Custom UI By default wizard displays right and left arrows to navigate between steps.getNextStep(). by using a flowListener you can decide which step to display next so wizard does not need to be linear always.. You just need to provide the names of javascript functions as the values of these attributes. define a flowListener.next().getNextStep().getCurrentStep(). <p:wizard flowListener="#{userWizard.. String stepToGo = event. </p:wizard> <h:outputLink value="#" onclick="wiz.">Next</h:outputLink> <h:outputLink value="#" onclick="wiz. Client Side Callbacks Wizard is equipped with onback and onnext attributes.

ui-wizard-content . Following is the list of structural css classes. Skinning Wizard Wizard reside in a container element that style and styleClass attributes apply. Selector .widget. Goes back in flow. Returns the index of current step. 426 .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-wizard-nav-back .ui-wizard-navbar . see the main Skinning section for more information.Wizard Method next() back() getStepIndex() Params Return Type void void Number Description Proceeds to next step.ui-wizard-nav-next Main container element Container element of content Container of navigation controls Back navigation control Forward navigation control Applies As skinning style classes are global.ui-wizard .

slider with built-in ajax capabilities. poll. remoteCommand and etc.1 Partial Rendering In addition to components like autoComplete.g. oncomplete). On client side rather than using client side API implementations of JSF implementations like Mojarra and MyFaces. PrimeFaces also provides a generic PPR (Partial Page Rendering) mechanism to update JSF components with ajax. you can use the server ids directly. Servlet Filters.PrimeFaces Userʼs Guide 4. <h:form> <p:commandButton update="display" /> <h:outputText id="display" value="#{bean. process. HtmlParsers. Partial Rendering and Processing PrimeFaces provides a partial rendering and view processing feature based on standard JSF 2 APIs to enable choosing what to process in JSF lifecyle and what to render in the end with ajax. datatable. AjaxStateManager. Several components are equipped with the common PPR attributes (e. In this section although we’ll be using commandButton.1 Infrastructure PrimeFaces Ajax Framework is based on standard server side APIs of JSF 2. There are no additional artfacts like custom AjaxViewRoot. dom handling. PhaseListeners and so on.2 Using IDs Getting Started When using PPR you need to specify which component(s) to update with ajax. If the component that triggers PPR request is at the same namingcontainer (eg. PrimeFaces scripts are based on the most popular javascript library. stable regarding ajax. same applies to every component that’s capable of PPR such as commandLink. 427 . dom tree traversing than a JSF implementations scripts.value}"/> </h:form> PrependId Setting prependId setting of a form has no effect on how PPR is used.1. update. AjaxViewHandler. fast and lightweight.1. jQuery which is far more tested. 4. 4. form) with the component(s) it renders. onstart. PrimeFaces aims to keep it clean. 4.

value}"/> </h:form> ClientId It is also possible to define the client id of the component to update. <h:form id="form1"> <p:commandButton update=":form2:display" /> </h:form> <h:form id="form2"> <h:outputText id="display" value="#{bean. http://docs. dataGrid. two forms). galleria. note that this uses same search algorithm as standard JSF 2 implementation. dataList.value}"/> </h:form> Please read findComponent algorithm described in link below used by both JSF core and PrimeFaces to fully understand how component referencing works.html JSF h:form.oracle. 428 . ring. sheet and subTable are PrimeFaces component that implement NamingContainer.com/javaee/6/api/javax/faces/component/UIComponent. you also need to add the container id to search expression so that PPR can handle requests that are triggered inside a namingcontainer that updates another namingcontainer.PrimeFaces Userʼs Guide <h:form prependId="false"> <p:commandButton update="display" /> <h:outputText id="display" value="#{bean. <h:form id="myform"> <p:commandButton update="myform:display" /> <h:outputText id="display" value="#{bean. Following is the suggested way using separator char as a prefix. dataTable.g. composite components are naming containers. accordionPanel.value}"/> </h:form> Different NamingContainers If your page has different naming containers (e. datatable. in addition tabView. carousel.

Keyword @this @parent @form @none @all Description Component that triggers the PPR is updated Parent of the PPR trigger is updated. Encapsulating form of the PPR trigger is updated PPR does not change the DOM with ajax response.value2}"/> </h:form> Keywords There are a couple of reserved keywords which serve as helpers.value1}"/> <h:outputText id="display2" value="#{bean. Example below updates the whole form.1.value}"/> </h:form> Keywords can also be used together with explicit ids. <h:form> <p:commandButton update="display1.3 Notifying Users ajaxStatus is the component to notify the users about the status of global ajax requests. 4. so update="@form. display" is also supported. whitespace or even both. 429 . Whole document is updated as in non-ajax requests.display2" /> <p:commandButton update="display1 display2" /> <h:outputText id="display1" value="#{bean. See the ajaxStatus section to get more information about the component. <h:form> <p:commandButton update="@form" /> <h:outputText value="#{bean.PrimeFaces Userʼs Guide Multiple Components Multiple Components to update can be specified with providing a list of ids separated by a comma.

PrimeFaces Userʼs Guide Global vs Non-Global By default ajax requests are global. If you want to do a "silent" request not to trigger ajaxStatus instead. An example with commandButton would be. 430 . it is triggered. meaning if there is an ajaxStatus component present on page. set global to false.1.4 Bits&Pieces PrimeFaces Ajax Javascript API See the javascript section to learn more about the PrimeFaces Javascript Ajax API. <p:commandButton value="Silent" global="false" /> <p:commandButton value="Notify" global="true" /> 4.

When city is selected.email}" required="true"/> </h:form> When the city dropdown is changed an ajax request is sent to execute populateSuburbs method which populates suburbChoices and finally update the suburbs dropdown. Process Validations. Various components such as commandButton. commandLink are equipped with process attribute. <h:form> <h:selectOneMenu id="cities" value="#{bean. suppose you have a simple contact form with two dropdown components for selecting city and suburb. only processing that should happen is cities dropdown.cityChoices}" /> <p:ajax listener="#{bean. related suburbs of the selected city is populated in suburb dropdown.suburbChoices}" /> </h:selectOneMenu> <h:inputText value="#{bean.1 Partial Validation A common use case of partial process is doing partial validations.suburb}"> <f:selectItems value="#{bean. Processing means executing Apply Request Values.PrimeFaces Userʼs Guide 4. As we’re just making a city change request. also there’s an inputText which is required. eliminating need of using immediate and many more use cases. in examples we’ll be using commandButton.populateSuburbs}" update="suburbs" process="@all"/> </h:selectOneMenu> <h:selectOneMenu id="suburbs" value="#{bean. similarly in Partial Processing only defined components are processed.2.city}"> <f:selectItems value="#{bean.2 Partial Processing In Partial Page Rendering. Problem is populateSuburbs method will not be executed as lifecycle will stop after process validations phase to jump render response as email input is not provided. avoiding validating unwanted components. 4. The solution is to define what to process in p:ajax. only specified components are rendered. This feature is a simple but powerful enough to do group validations. 431 . Reason is p:ajax has @all as the value stating to process every component on page but there is no need to process the inputText. Update Model and Invoke Application JSF lifecycle phases only on defined components.

1.2. it is explicitly defined here to give a better understanding of how partial processing works.2.2 for more information about how to define ids in process specification using commas and whitespaces. <p:commandButton process="panel" /> <p:panel id="panel"> //Children </p:panel> 4. when a component is specified to process partially. 4. partial processing also supports keywords.city}"> <f:selectItems value="#{bean. Note that default value for process option is @this already for p:ajax as stated in AjaxBehavior documentation.populateSuburbs}" event="change" update="suburbs" process="@this"/> </h:selectOneMenu> <h:selectOneMenu id="suburbs" value="#{bean. 432 . See section 5.cityChoices}" /> <p:ajax actionListener="#{bean. Parent of the PPR trigger is processed. Whole component tree is processed just like a regular request. So for example if you specify a panel.2 Keywords Just like updates. useful to revert changes to form.email}" required="true"/> </h:form> That is it. children of this component is processed as well.suburb}"> <f:selectItems value="#{bean.PrimeFaces Userʼs Guide <h:form> <h:selectOneMenu id="cities" value="#{bean. all children of that panel would be processed in addition to the panel itself.suburbChoices}" /> </h:selectOneMenu> <h:inputText value="#{bean. Encapsulating form of the PPR trigger is processed No component is processed.3 Using Ids Partial Process uses the same technique applied in PPR to specify component identifiers to process. Important point to note is. Keyword @this @parent @form @none @all Description Component that triggers the PPR is processed. now populateSuburbs method will be called and suburbs list will be populated.

433 . PrimeFaces Mobile PrimeFaces Mobile is a separate project with it’s own release cycle and documentation. Please consult Mobile User’s Guide for more information.PrimeFaces Userʼs Guide 5.

PushServlet</servlet-class> <load-on-startup>1</load-on-startup> <init-param> <param-name>channels</param-name> <param-value>chat. Pushed data from JSF app is send to the push server which is then pushed to all connected clients. <servlet> <servlet-name>Push Servlet</servlet-name> <servlet-class>org.PUSH_SERVER_URL</param-name> <param-value>ws://url_to_push_server</param-value> </context-param> 434 . This servlet should be in a different application than the JSF application and at the moment can only be deployed on jetty server. <context-param> <param-name>primefaces. 6.PrimeFaces Userʼs Guide 6. PushServer and JSF application are two different applications.primefaces.counter</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>Push Servlet</servlet-name> <url-pattern>/prime-push/*</url-pattern> </servlet-mapping> channels configuration defines the topic names that push server can publish to.1 Setup Push Server PrimeFaces Push uses a servlet as a dispatcher. PrimeFaces Push PrimePush enables implementing push based use-cases powered by WebSockets. URL Configuration The JSF application needs to define the push server url to send messages.push.

4 Samples 6. 6.push(String channel.count = count. public class GlobalCounterBean implements Serializable{ } private int count. it has two attributes you need to define. <p:push channel="chat" onmessage="handlePublish"/> channel: Name of the channel to connect and listen. } public synchronized void increment() { count++.3 Push Component <p:push /> is a PrimeFaces component that handles the connection between the server and the browser. onpublish: Javascript event handler to be called when server sends data.getCurrentInstance(). } 435 .PrimeFaces Userʼs Guide 6. /** * @param channel Unique name of communication channel * @param data Information to be pushed to the subscribers as json */ RequestContext. Object data).push("counter". RequestContext. } public void setCount(int count) { this.2 Push API JSF app can push data to the server by using the RequestContext API. count).1 Counter Counter is a global counter where each button click increments the count value and new value is pushed to all subscribers. 6. public int getCount() { return count.4.

username + ": " + message). private boolean loggedIn. Finally handleMessage javascript function is called where data parameter is the new count integer. username + " has logged in.").getCurrentInstance().4. private String username.getCurrentInstance(). public void send(ActionEvent event) { RequestContext. } </script> When the button is clicked. RequestContext.2 Chat Chat is a simple p2p messaging implementation.html(data).display').push("chat". public class ChatBean implements Serializable { } private String message. data) { $('. } //getters&setters 436 .increment}" /> </h:form> <p:push onmessage="handleMessage" channel="counter" /> <script type="text/javascript"> function handleMessage(evt. JSF button invokes the increment method and RequestContext API forwards the pushed data to the counter channel of the push server. then push server forwards this data to all subscribers. message = null.push("chat".count}" styleClass=”display”/> <p:commandButton value="Click" actionListener="#{globalCounter. 6.PrimeFaces Userʼs Guide <h:form> <h:outputText value="#{globalCounter. } public void login(ActionEvent event) { loggedIn = true.

messageInput').height:200px.send}" global="false" oncomplete="$('. PrimeFaces Push currently provides P2P communication and next feature to support is JMS integration.login}" update="container" image="ui-icon ui-icon-person"/> </h:panelGroup> </p:fieldset> </h:form> <p:push onmessage="handleMessage" channel="chat" widgetVar="chatAgent" /> <script type="text/javascript"> function handleMessage(evt.height()). c hatContent.append(data + '').val('').disconnect}" global="false" oncomplete="chatAgent.overflow:auto" styleClass="chatContent" /> <p:separator /> <p:inputText value="#{chatController. 437 .username}" /> <p:spacer width="5" /> <p:commandButton value="Login" actionListener="#{chatController.chatContent').loggedIn}" > <p:outputPanel layout="block" style="width:600px.close()" update="container" /> </h:panelGroup> <h:panelGroup rendered="#{not chatController.message}" styleClass="messageInput" /> <p:spacer width="5" /> <p:commandButton value="Send" actionListener="#{chatController.PrimeFaces Userʼs Guide <h:form> <p:fieldset id="container" legend="PrimeChat"> <h:panelGroup rendered="#{chatController.scrollTop(chatContent. data) { var chatContent = $('.loggedIn}" > Username: <p:inputText value="#{chatController. } </script> //keep scroll chatContent.focus()"/> <p:spacer width="5" /> <p:commandButton value="Disconnect" actionListener="#{chatController.

Progressively enhances an input element with theming.ajax.and more. 438 . Client side log API.1 PrimeFaces Namespace PrimeFaces is the main javascript object providing utilities and namespace. Sets a cookie with given nam and value. Shows watermarks on form.Tree . warn(msg).PrimeFaces.PrimeFaces Userʼs Guide 7. .* PrimeFaces. Watermark component extension. name.Poll .PrimeFaces.. PrimeFaces defines two javascript namespaces. PrimeFaces. To be compatible with other javascript entities on a page.widget. Changes theme on the fly with no page refresh. PrimeFaces.widget. Adds request parameters dynamically to the element. debug(msg). Javascript API PrimeFaces renders unobstrusive javascript which cleanly seperates behavior from the html. 7. cleans all watermarks on page before submitting the form.widget. Returns cookie with given name. Client side engine is powered by jQuery version 1.4 which is the latest at the time of the writing.widget.* Contains custom PrimeFaces widgets like.PrimeFaces.6.ajax namespace contains the ajax API which is described in next section. Most of the components have a corresponding client side widget with same name. error(msg) changeTheme(theme) cleanWatermarks() showWatermarks() Description Escaped JSF ids with semi colon to work with jQuery. value) skinInput(input) info(msg).DataTable . Method escapeClientId(id) addSubmitParam(el. param) getCookie(name) setCookie(name..

ajax. exception) oncomplete(xhr. onerror(xhr. status. Takes three arguments. default is true. Whole API consists of three properly namespaced simple javascript functions. Javascript callback to process when ajax request returns with success code. Javascript callback to process when ajax request fails. default is false. xhr. Takes three arguments. status. Takes four arguments. PrimeFaces. Javascript callback to process before sending the ajax request. xmlhttprequest and optional arguments provided by RequestContent API. Configuration Options Option formId async global update process source params onstart() onsuccess(data. Component(s) to process in partial request. Component(s) to update with ajax.PrimeFaces Userʼs Guide 7. xml response.AjaxRequest Sends ajax requests that execute JSF lifecycle and retrieve partial output.AjaxRequest(cfg). if not defined parent form of source is used. status. Flag to define if p:ajaxStatus should be triggered or not. Flag to define whether request should go in ajax queue or not. xmlhttprequest. args) 439 .ajax. Javascript callback to process when ajax request completes. PrimeFaces. Client id of the source component causing the request. Function signature is as follows. status string and exception thrown if any. args) Description Id of the form element to serialize. status string and optional arguments provided by RequestContext API. status code. Additional parameters to send in ajax request. xmlhttprequest. return false to cancel the request.2 Ajax API PrimeFaces Ajax Javascript API is powered by jQuery and optimized for JSF.

We highly recommend using p:remoteComponent instead of low level javascript api as it generates the same with much less effort and less possibility to do an error. . More components </h:form> You can post all the information in form with ajax using. PrimeFaces.source:’userForm’ .ajax. <h:form id="userForm"> <h:inputText id="username" value="#{userBean. PrimeFaces. 440 . PrimeFaces.AjaxResponse updates the specified components if any and synchronizes the client side JSF state.user.params:{ ‘param_name1’:’value1’.ajax.ajax.process:’userForm’ }). status) {alert(‘Done’).PrimeFaces Userʼs Guide Examples Suppose you have a JSF page called createUser with a simple form and some input components. ‘param_name2’:’value2’ } ..source:’userForm’ . DOM updates are implemented using jQuery which uses a very fast algorithm.process:’userForm’ .oncomplete:function(xhr..name}" /> .AjaxRequest({ formId:’userForm’ .} }).ajax.AjaxRequest({ formId:’userForm’.update:’msgs’ . More complex example with additional options.AjaxResponse PrimeFaces.

http://www.org/themes. Currently there are 30+ predesigned themes that you can preview and download from PrimeFaces theme gallery.primefaces. Themes PrimeFaces is integrated with powerful ThemeRoller CSS Framework.html 441 .PrimeFaces Userʼs Guide 8.

THEME</param-name> <param-value>aristo</param-value> </context-param> That's it.THEME context parameter at your deployment descriptor (web.2</version> </dependency> artifactId is the name of the theme as defined at Theme Gallery page.PrimeFaces Userʼs Guide 8.1 Applying a Theme Applying a theme to your PrimeFaces project is very easy.THEME</param-name> <param-value>#{loggedInUser. Each theme is packaged as a jar file. In case you’d like to make the theme dynamic.0.preferences. Download Each theme is available for manual download at PrimeFaces Theme Gallery. <context-param> <param-name>primefaces.xml) with the theme name as the value. configure PrimeFaces to use it.themes</groupId> <artifactId>cupertino</artifactId> <version>1.theme}</param-value> </context-param> 442 . define theme artifact as. you don't need to manually add any css to your pages or anything else. <context-param> <param-name>primefaces. define an EL expression as the param value. If you are a maven user.primefaces. PrimeFaces will handle everything for you. download the theme you want to use. add it to the classpath of your application and then define primefaces. <dependency> <groupId>org. Configure Once you've downloaded the theme.

Extract the contents of the package and rename jquery-ui{version}.css to theme. Applying your own custom theme is same as applying a pre-built theme however you need to migrate the downloaded theme files from ThemeRoller to PrimeFaces Theme Infrastructure.META-INF .jar .THEME</param-name> <param-value>yourtheme</param-value> </context-param> 443 . You can have one or more themes in same jar.PrimeFaces Userʼs Guide 8. example would be. Jar file must have the following folder structure. url("images/ui-bg_highlight-hard_100_f9f9f9_1x100. Make sure you have “deselect all components” option on download page so that your theme only includes skinning styles.2 Creating a New Theme If you’d like to create your own theme instead of using the pre-defined ones. that is easy as well because ThemeRoller provides a powerful and easy to use online visual tool.png']}") Once the jar of your theme is in classpath.css.custom.primefaces-yourtheme . url("#{resource['primefaces-yourtheme:images/ui-bg_highlight-hard_100_f9f9f9_1x100. you can use your theme like.images 1) The theme package you've downloaded from ThemeRoller will have a css file and images folder. <context-param> <param-name>primefaces. PrimeFaces Theme convention is the integrated way of applying your custom themes to your project. this approach requires you to create a jar file and add it to the classpath of your application.css must also be converted to an expression that JSF resource loading can understand. . 2) Image references in your theme.png") should be.theme.css .resources .

Skinning Selectors ThemeRoller features a couple of skinning selectors.ui-state-hover . 444 . border colors.ui-widget-header also that defines the panel colors also applies to the panel header. This clean separation brings great flexibility in theming because you don’t need to know each and every skinning selectors of components to change their style. dimensions and positioning. PrimeFaces separates structural css from skinning css.ui-widget-content . For example Panel component’s header section has the . Skinning CSS Skinning defines the look and feel properties like colors. Applies These classes are not aware of structural css like margins and paddings. Selector . padding. background images.ui-panel-titlebar structural class.3 How Themes Work Powered by ThemeRoller. Highlighted elements.ui-state-default .ui-state-highlight . to change the color of a panel header you don’t need to about this class as .ui-widget-header . Structural CSS These style classes define the skeleton of the components and include css properties such as margin.ui-state-disabled . display type. most important of these are.ui-widget . mostly they only define colors.PrimeFaces Userʼs Guide 8.ui-icon All PrimeFaces components Header section of a component Content section of a component Default class of a clickable Hover class of a clickable When a clickable is selected Disabled elements.ui-state-active . An element to represent an icon.

example below demonstrates how to change header of all panels. to change the font-size of PrimeFaces components globally.THEME_FORMS context parameter to false if you’d like to disable theming on input field components such as p:inputText.ui-widget. } • When creating your own theme with themeroller tool.ui-paneltitlebar.ui-widget style class.ui-widget-header { //css } To apply css on a particular panel. An example of smaller fonts. .custom . <p:panel styleClass="custom"> . select one of the pre-designed themes that is close to the color scheme you want and customize that to save time.ui-panel-titlebar { //css } • Set primefaces.PrimeFaces Userʼs Guide 8. use the .4 Theming Tips • Default font size of themes might be bigger than expected. • To change the style of a particular component instead of all components of same type use namespacing. p:inputTextarea.. • If you are using Apache Trinidad or JBoss RichFaces. . .ui-widget { font-size: 90% !important. </p:panel> .ui-widget .ui-panel-titlebar { //css } or . 445 . PrimeFaces Theme Gallery includes Trinidad’s Casablanca and RichFaces’s BlueSky theme.. You can use these themes to make PrimeFaces look like Trinidad or RichFaces components during migration.

Callback Parameters are serialized to JSON and provided as an argument in ajax callbacks. Adds parameters to ajax callbacks like oncomplete. RequestContext can be obtained similarly to FacesContext. requestContext. } 446 .getCurrentInstance().PrimeFaces Userʼs Guide 9. args)" /> public void validate() { //isValid = calculate isValid RequestContext requestContext = RequestContext.getCurrentInstance(). Executes script after ajax request completes. true or false). Specifies component(s) to update at runtime. you need to hide the dialog or if there’re any validation errors. Object value) update(String clientId).validate}" oncomplete="handleComplete(xhr.addCallbackParam("isValid". Scrolls to the component with given clientId after ajax request completes. status. dialog needs to stay open. RequestContext API Method isAjaxRequest() addCallBackParam(String name.1 RequestContext RequestContext is a simple utility that provides useful goodies such as adding parameters to ajax callback functions. RequestContext requestContext = RequestContext. Suppose you have a form in a p:dialog and when the user ends interaction with form. Utilities 9. Callback Parameters There may be cases where you need values from backing beans in ajax callbacks. <p:commandButton actionListener="#{bean. execute(String script) scrollTo(String clientId) Description Returns a boolean value if current request is a PrimeFaces ajax request.

var lastname = args.addCallbackParam("user".lastname.addCallbackParam("isValid".. if(isValid) dialog. args) { var firstname = args. Runtime Partial Update Configuration There may be cases where you need to define which component(s) to update at runtime rather than specifying it declaratively at compile time. user).PrimeFaces Userʼs Guide isValid parameter will be available in handleComplete callback as. Following example sends a pojo called User that has properties like firstname and lastname to the client.. <script type="text/javascript"> function handleComplete(xhr.user. requestContext. Each parameter is serialized as JSON and accessible through args parameter so pojos are also supported just like primitive values. button actionListener decides which part of the page to update on-the-fly.firstname. </p:panel> 447 . status.. <p:commandButton value="Save" actionListener="#{bean.save}" /> <p:panel id="panel"> . </p:panel> <p:dataTable id="table"> . } </script> Default validationFailed By default validationFailed callback parameter is added implicitly if JSF validation fails. status.getCurrentInstance().hide(). } <script type="text/javascript"> function handleComplete(xhr. true or false). requestContext. public void validate() { //isValid = calculate isValid RequestContext requestContext = RequestContext.isValid.. addPartialUpdateTarget method is added to handle this case. } </script> You can add as many callback parameters as you want with addCallbackParam API. In example below.user. args) { var isValid = args.

} When the save button is clicked.PrimeFaces Userʼs Guide public void save() { //boolean outcome = . Example below hides the dialog when ajax request completes.execute(“dialog. public void save() { RequestContext requestContext = RequestContext. requestContext. if(outcome) requestContext..getCurrentInstance().update("panel"). depending on the outcome. Execute Javascript RequestContext provides a way to execute javascript when the ajax request completes.hide()”). RequestContext requestContext = RequestContext.. this approach is easier compared to passing callback params and execute conditional javascript. else requestContext. you can either configure the datatable or the panel to be updated with ajax response.getCurrentInstance().update("table"). } 448 .

show()" /> Page Authorization Function ifGranted(String role) ifAllGranted(String roles) ifAnyGranted(String roles) ifNotGranted(String roles) remoteUser() userPrincipal() Description Returns a boolean value if user has given role or not. Returns a boolean value if has any of the given roles or not. Returns the name of the logged in user. Returns the principial instance of the logged in user. 449 . Common Functions Function component(‘id’) widgetVar(‘id’) Component <h:form id="form1"> <h:inputText id="name" /> </h:form> //#{p:component(‘name’)} returns ‘form1:name’ Description Returns clientId of the component with provided server id parameter. Returns a boolean value if has all of the given roles or not. WidgetVar <p:dialog id="dlg"> //contents </p:dialog> <p:commandButton type="button" value="Show" onclick="#{p:widgetVar(‘dlg’)}. This function is useful if you need to work with javascript. Returns a boolean value if has all of the given roles or not.PrimeFaces Userʼs Guide 9.2 EL Functions PrimeFaces provides built-in EL extensions that are helpers to common use cases. Provides the widgetVar of a component.

PrimeFaces Userʼs Guide <p:commandButton rendered="#{p:ifGranted(‘ROLE_ADMIN’)}" /> <h:inputText disabled="#{p:ifGranted(‘ROLE_GUEST’)}" /> <p:inputMask rendered="#{p:ifAllGranted(‘ROLE_EDITOR. ROLE_EDITOR’)}" /> <p:commandButton rendered="#{p:ifNotGranted(‘ROLE_GUEST’)}" /> <h:outputText value="Welcome: #{p:remoteUser}" /> 450 . ROLE_READER’)}" /> <p:commandButton rendered="#{p:ifAnyGranted(‘ROLE_ADMIN.

1 Dependencies Only necessary dependency compared to a regular PrimeFaces application is the JSF bridge. 2. http://primefaces.faces</groupId> <artifactId>jsf-api</artifactId> <version>2.faces</groupId> <artifactId>jsf-impl</artifactId> <version>2.sun.1 is the latest version of portletfaces at the time of writing.1</version> </dependency> </dependencies> 451 . Here's maven dependencies configuration from portlet sample.googlecode. A portlet bridge is necessary to run a JSF application as a portlet and we've tested the bridge from portletfaces project.PrimeFaces Userʼs Guide 10.0</version> </dependency> <dependency> <groupId>com.portlet</groupId> <artifactId>portlet-api</artifactId> <version>2.0.2</version> </dependency> <dependency> <groupId>javax.portletfaces</groupId> <artifactId>portletfaces-bridge</artifactId> <version>2.4-b09</version> </dependency> <dependency> <groupId>org. Portlets PrimeFaces supports portlet environments based on JSF 2 and Portlet 2 APIs. A kickstart example is available at PrimeFaces examples repository.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.com/svn/examples/trunk/prime-portlet 10.0.0. <dependencies> <dependency> <groupId>javax.primefaces</groupId> <artifactId>primefaces</artifactId> <version>2.

This portlet has two modes.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.w3.0"?> <portlet-app xmlns="http://java.GenericFacesPortlet</portlet-class> <init-param> <name>javax.faces.com/xml/ns/j2ee http://java.xhtml</value> </init-param> <init-param> <name>javax.sun.portlet.PrimeFaces Userʼs Guide 10. view and edit.portlet.5"> <servlet> <servlet-name>Faces Servlet</servlet-name> <servlet-class>javax.com/xml/ns/j2ee" xmlns:xsi="http://www.FacesServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> </web-app> 452 .bridge.xml Faces Servlet is only necessary to initialize JSF framework internals.view</name> <value>/view. <?xml version="1.xsd http://java.xsd"> <portlet> <portlet-name>1</portlet-name> <display-name>PrimeFaces Portlet</display-name> <portlet-class>org.xhtml</value> </init-param> <supports> <mime-type>text/html</mime-type> <portlet-mode>view</portlet-mode> <portlet-mode>edit</portlet-mode> </supports> <portlet-info> <title>PrimeFaces Portlet</title> <short-title>PrimeFaces Portlet</short-title> <keywords>JSF 2.2 Configuration portlet.w3.defaultViewId.edit</name> <value>/edit.com/xml/ns/portlet/portlet-app_2_0.org/2001/ XMLSchema-instance" xsi:schemaLocation="http://java.0</keywords> </portlet-info> </portlet> </portlet-app> web.sun.xsd" version="2.com/xml/ns/portlet/portlet-app_2_0.defaultViewId.sun.portletfaces.sun.0" encoding="UTF-8"?> <web-app xmlns="http://java.webapp.com/xml/ns/portlet/portlet-app_2_0.faces.com/xml/ns/ j2ee/web-app_2_5.faces.0" xmlns:xsi="http://www.sun.xml Portlet configuration file should be located under WEB-INF folder. <?xml version="1.xsd" version="2.

dtd"> <display> <category name="category.xsd" version="2.com/xml/ns/javaee http://java. 453 .1.sun.xml seems to be necessary otherwise bridge is giving an error.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java. <?xml version="1.com/xml/ns/javaee" xmlns:xsi="http://www. a sample portlet page is a partial version of the regular page to provide only the content without html and body tags.0//EN" "http://www.sun.0" encoding="UTF-8"?> <faces-config xmlns="http://java. <?xml version="1.PrimeFaces Userʼs Guide faces-config.liferay.xml An empty faces-config.com/ dtd/liferay-display_5_1_0. <?xml version="1.0"?> <!DOCTYPE display PUBLIC "-//Liferay//DTD Display 5.xml Liferay portlet configuration file is an extension to standard portlet configuration file.w3.0"> </faces-config> liferay-portlet.sample"> <portlet id="1" /> </category> </display> Pages That is it for the configuration.sun.com/xml/ns/ javaee/web-facesconfig_2_0.xml Display configuration is used to define the location of your portlet in liferay menu.0"?> <liferay-portlet-app> <portlet> <portlet-name>1</portlet-name> <instanceable>true</instanceable> <ajaxable>false</ajaxable> </portlet> </liferay-portlet-app> liferay-display.

com.playBlack}" update="@parent" /> </h:panelGrid> </h:form> </f:view> PrimeFaces Team is in contact with PortletBridge team to improve the integration.xhtml <f:view xmlns="http://www.org/1999/xhtml" xmlns:h="http://java.tr/ui"> <h:head></h:head> <h:form> <h:panelGrid id="grid" columns="2" cellpadding="10px"> <f:facet name="header"> <p:messages id="messages" /> </f:facet> <h:outputText value="Total Amount: " /> <h:outputText value="#{gambitController.com/jsf/core" xmlns:ui="http://java.com/jsf/html" xmlns:f="http://java.bet}" /> <p:commandButton value="RED" actionListener="#{gambitController.sun.amount}" /> <h:outputText value="Bet:" /> <h:inputText value="#{gambitController.sun.playRed}" update="@parent" /> <p:commandButton value="BLACK" actionListener="#{gambitController.PrimeFaces Userʼs Guide edit.sun.com/jsf/facelets" xmlns:p="http://primefaces.prime.w3. 454 .

Following frameworks are fully supported. • • • • • Spring Core (JSF Centric JSF-Spring Integration) Spring WebFlow (Spring Centric JSF-Spring Integration) Spring Roo (PrimeFaces Addon) EJBs CDI We’ve created sample applications to demonstrate several technology stacks involving PrimeFaces and JSF at the front layer.PrimeFaces Userʼs Guide 11. Integration with Java EE PrimeFaces is all about front-end and can be backed by your favorite enterprise application framework. a small showcase and booking-faces example. Spring WebFlow We as PrimeFaces team work closely with Spring WebFlow team. PrimeFaces is suggested by SpringSource as the preferred JSF component suite for SWF applications.org/browse/ROO-516 455 . https://jira. SpringSource repository has two samples based on SWF-PrimeFaces. Spring ROO SpringSource provides an official JSF-PrimeFaces Addon.springsource. Source codes of these applications are available at the PrimeFaces subversion repository and they’re deployed online time to time. CDI and EJBs PrimeFaces fully supports a JAVA EE 6 environment with CDI and EJBs.

9+ .1 NetBeans NetBeans 7. Code completion is supported by NetBeans 6. when creating a new project you can select PrimeFaces from components tab.PrimeFaces Userʼs Guide 12.0+ bundles PrimeFaces. IDE Support 12. 456 .

2 Eclipse Code completion works out of the box for Eclipse when JSF facet is enabled. 457 .PrimeFaces Userʼs Guide PrimeFaces and NetBeans teams are in communication to discuss the next step of PrimeFaces integration in NetBeans at the time of writing. 12.

Please use the forum before creating an issue instead. for additional documentation like apidocs. wiki and more please visit. taglib docs.org/documentation. http://code.org Source Code PrimeFaces source is at google code subversion repository.primefaces. Project Resources Documentation This guide is the main resource for documentation. http://code.com/p/primefaces/issues/list WIKI PrimeFaces Wiki is a community driven additional documentation resource. http://forum.PrimeFaces Userʼs Guide 13.org Social Networks You can follow PrimeFaces on twitter using @primefaces and join the Facebook group.primefaces. 458 .com/p/primefaces/source/ Issue Tracker PrimeFaces issue tracker uses google code’s issue management system.primefaces.google.html Support Forum PrimeFaces discussions take place at the support forum. http://www.google. Forum is public to everyone and registration is required to do a post. http://wiki.

My page does not navigate with PrimeFaces commandButton and commandLink. Which browsers are supported by PrimeFaces? IE7-8-9. 9. You can use the <f:view contentType="text/html"> to enforce this. 3. http://www. Please visit support page on PrimeFaces website for more information. 7. Apache V2 License is a commercial friendly library.primefaces.html 4.primefaces. 2. enterprise support is also available. FAQ 1. a Turkish software development company specialized in Agile Software Development. Is enterprise support available? Yes. Please do not email the developers of PrimeFaces directly and use support forum instead. Can I use PrimeFaces in a commercial software? Yes. Chrome and Opera. Where can I get an unreleased snapshot? Nightly snapshot builds of a future release is deployed at http://repository. use redirect instead of forward or set ajax to false. Some components like charts do not work in Safari or Chrome but there’s no problem with Firefox. 6.org/support.PrimeFaces Userʼs Guide 14. 8. You need to make sure responseType is "text/html". 5. 10. JSF and Java EE.? If you'd like to navigate within an ajax request. it’s publicly available and free registration is required before posting. 459 . Who develops PrimeFaces? PrimeFaces is developed and maintained by Prime Teknoloji. The common reason is the response mimeType when using with PrimeFaces.org. Snapshot builds of samples are deployed at PrimeFaces Repository time to time. Safari. What is the license PrimeFaces have? PrimeFaces is free to use and licensed under Apache License V2. How can I get support? Support forum is the main area to ask for help. PrimeFaces does not bundle any third party software that conflicts with Apache. Where is the source for the example demo applications? Source code of demo applications are in the svn repository of PrimeFaces at /examples/trunk folder. Firefox.

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful