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

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

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

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

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

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

primefaces. 15 .component org.Accordionpanel org.1 AccordionPanel AccordionPanel is a container component that displays content in stacked format.accordionpanel.primefaces.primefaces.PrimeFaces Userʼs Guide 3.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class accordionPanel org. 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.component.primefaces.AccordionPanel org.component.component.accordionpanel.component. An EL expression that maps to a server side UIComponent instance in a backing bean.AccordionPanelRenderer org.

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

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

Skinning AccordionPanel resides in a main container element which style and styleClass options apply. Class . <p:accordionPanel multiple=”true”> //tabs </p:accordionPanel> Client Side API Widget: PrimeFaces. 18 . only one tab at a time can be active.ui-accordion .ui-accordion-header . enable multiple mode to activate multiple tabs. Following is the list of structural style classes. 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.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. Deactivates tab with given index.widget. <p:accordionPanel> <p:tab title="First Tab Title" disabled=”true”> <h:outputText value= "Lorem"/> ..ui-accordion-content Main container element Tab header Tab content Applies As skinning style classes are global.PrimeFaces Userʼs Guide Disabled Tabs A tab can be disabled by setting disabled attribute to true..

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Client side callback to execute after ajax requests start. Style class of the component.component.primefaces.component.component org.primefaces.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. 21 . Name of the client side widget.AjaxStatusRenderer org. Client side callback to execute after ajax requests complete.ajaxstatus. Client side callback to execute before ajax requests start. Client side callback to execute when an ajax request fails. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ajaxStatus org.component.component.primefaces. Client side callback to execute after ajax requests completed succesfully. Boolean value to specify the rendering of the component.primefaces. Inline style of the component.3 AjaxStatus AjaxStatus is a global notifier for ajax requests made by PrimeFaces components.ajaxstatus.PrimeFaces Userʼs Guide 3.AjaxStatus org.AjaxStatus org.primefaces.

complete: When everything finishes. success: When ajax response is received without error. <p:ajaxStatus> <f:facet name="prestart"> <h:outputText value="Starting." /> </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 . • • • • • • default: Initially visible when page is loaded.PrimeFaces Userʼs Guide Getting Started with AjaxStatus AjaxStatus uses facets to represent the request status. start: After ajax request begins.. Most common used facets are start and complete.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.. prestart: Before ajax request is sent. Once the ajax response is received start facet becomes hidden and complete facet shows up. Start facet will be visible once ajax request begins and stay visible until it’s completed. error: When ajax response is received with error. <p:ajaxStatus> <f:facet name="start"> <p:graphicImage value="ajaxloading.

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

component.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.primefaces.autocomplete.AutoComplete org.AutoComplete org.component org. it’s resolved to a converter instance.primefaces.component. Boolean value to specify the rendering of the component.primefaces. it must refer to a converter id.autocomplete.component.PrimeFaces Userʼs Guide 3. When it’s an EL expression. Value of the component than can be either an EL expression of a literal text. In case it’s a static text.AutoCompleteRenderer org. An el expression or a literal text that defines a converter for the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class autoComplete org.4 AutoComplete AutoComplete provides live suggestions while an input is being typed. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces. 24 .primefaces.component.

Name of the iterator used in pojo based suggestion. Enables dropdown mode when set true. Number of characters to be typed before starting to query. Effect to use when showing/hiding suggestions. A method expression that refers to a method validationg the input. When enabled. Message to be displayed when validation fails. Client side callback to execute before ajax request to load suggestions begins. Message to be displayed when required field validation fails. Duration of effect in milliseconds. Label of the item. autoComplete only accepts input from the selection list. Maximum number of results to be displayed. 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 . Marks component as required. A method expression that refers to a method for handling a valuchangeevent. Client side callback to execute after ajax request to load suggestions completes. 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. Defines the height of the items viewport. Name of the client side widget. process validations logic is executed at apply request values phase for this component. Defines whether to trigger ajaxStatus or not. Message to be displayed when conversion fails. Value of the item. Inline style of the items container element. Method providing suggestions.

When true. Client side callback to execute when a pointer button is moved away from input element. 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. enables multiple selection. Controls browser autocomplete behavior. 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 . Maximum number of characters that may be entered in this field. Access key that when pressed transfers focus to the input element. Disables input field A localized user presentable name. Valid values are LTR and RTL. Direction indication for text that does not inherit directionality. 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 input element is double clicked. Client side callback to execute when a key is released over input element. Client side callback to execute when input element is clicked. Client side callback to execute when input element loses focus. Alternate textual description of the input field. Component(s) to process on query request. 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. Code describing the language used in the generated markup for this component.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.

} //getter setter 27 .complete}" /> public class Bean { } private String text. Client side callback to execute when a pointer button is released over input element. Flag indicating that this component will prevent changes by the user.add(query + i). Number of characters used to determine the width of the input element. Since autoComplete is an input component. return results.text}" completeMethod="#{bean. Position of the input element in the tabbing order. for (int i = 0. Inline style of the input element. Advisory tooltip informaton. i < 10. Style class of the input element. Client side callback to execute when text within input element is selected by user.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. it requires a value as usual. Getting Started with AutoComplete Suggestions are loaded by calling a server side completeMethod that takes a single string parameter which is the text entered. i++) results. public List<String> complete(String query) { List<String> results = new ArrayList<String>(). <p:autoComplete value="#{bean.

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

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

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

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

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

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

Identifier of the component to block.model}" /> </p:column> //more columns </p:dataTable> <p:blockUI block="dataTable" trigger="dataTable"> LOADING<br /> <p:graphicImage value="/images/ajax-loader. <p:blockUI block="pnl" trigger="saveBtn. Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received. place the content inside the blockUI.cars}" paginator="true" rows="10"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car. ajax requests whose source is trigger components will block the ui onstart and unblock oncomplete.deleteBtn.updateBtn" /> Custom Content In order to display custom content like a loading text and animation. Getting Started with BlockUI BlockUI requires trigger and block attributes to be defined.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. With the special ajax integration.gif"/> </p:blockUI> 34 . <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.

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

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

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

component.primefaces. Name of the client side widget.primefaces.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class button org. Used to resolve a navigation case.primefaces.primefaces.ButtonRenderer org. Style class for the button icon.button.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. Boolean value to specify the rendering of the component.Button org. Valid values are LTR and RTL.7 Button Button is an extension to the standard h:button component with skinning capabilities.primefaces. (deprecated: use icon) 38 .Button org. Value of the component than can be either an EL expression of a literal text. An el expression that maps to a server side UIComponent instance in a backing bean. Alternate textual description. Access key that when pressed transfers focus to button. Whether to include page parameters in target URI Identifier of the target page which should be scrolled to.component.component. Disables button.component. Direction indication for text that does not inherit directionality.button.PrimeFaces Userʼs Guide 3.

Client side callback to execute when button loses focus. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Client side callback to execute when a pointer button is moved within button Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when button receives focus. Advisory tooltip informaton. Inline style of the button. 39 . Client side callback to execute when a pointer button is pressed down over button. Client side callback to execute when a key is pressed and released over button. Position of the button icon. Client side callback to execute when a key is released over button. Client side callback to execute when button is clicked. Style class of the button. Icon of the button. Client side callback to execute when a pointer button is released over button. Makes button read only. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when a key is pressed down over button. Position in the tabbing order.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. Resource to link directly to implement anchor behavior. Client side callback to execute when button is double clicked.

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

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

defaults to TimeZone. Visibility of button panel containing today and done buttons. Defines how the calendar will be displayed.util. Duration of the effect. Client side event that displays the popup calendar.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. Effect to use when displaying and showing the popup calendar. 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. Icon of the popup button When enabled.getDefault () Makes input text of a popup calendar readonly. Enables month/year navigator String or a java. readOnlyInputText showButtonPanel effect effectDuration showOn FALSE FALSE null normal both Boolean Boolean String String String 42 . DateFormat pattern for localization Locale to be used for labels and conversion. popup icon is rendered without the button. Message to be displayed when validation fails. Name of the client side widget. Message to be displayed when conversion fails. Disables the calendar when set to true.

Maximum boundary for second selection. Year range for the navigator. Client side callback to execute when input element loses focus. Disables weekend columns.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. Maximum number of characters that may be entered in this field. Code describing the language used in the generated markup for this component. Minute steps. Minimum boundary for hour selection. Minimum boundary for minute selection. Alternate textual description of the input field. label lang maxlength onblur null null null null String String Integer String 43 . Valid values are LTR and RTL. Direction indication for text that does not inherit directionality. Enables selection of days belonging to other months. Minimum boundary for second selection. Controls browser autocomplete behavior. A localized user presentable name. Access key that when pressed transfers focus to the input element. Initial date to display if value is null. Second steps. default "c-10:c +10" Shows only timepicker without date. Maximum boundary for hour selection. Hour steps. Displays days belonging to other months. Maximum boundary for hour selection.

Advisory tooltip informaton. Client side callback to execute when a pointer button is released over input element. Flag indicating that this component will prevent changes by the user. 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 before displaying a date. 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 . Number of characters used to determine the width of the input element. Position of the input element in the tabbing order. Client side callback to execute when a key is pressed and 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 input element is double clicked. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a key is released over input element. 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 input element is clicked.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. used to customize date display.

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

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. Valid values are. <p:calendar value="#{dateController.date}" pages="3"/> 46 .date}" mode="popup" showOn="button" /> Popup Icon Only <p:calendar value="#{dateBean. This feature is tuned with the pages attribute.

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

DateSelectEvent instance. Values for these attributes can either be a string or a java. Date Ranges Using mindate and maxdate options. keyup and more.util.handleDateSelect}” update=”msg” /> </p:calendar> <p:messages id="msg" /> public void handleDateSelect(DateSelectEvent event) { Date date = event. • • • • • • • • • 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. calendar also supports regular ajax behavior events like blur. //Add facesmessage } In popup mode. selectable dates can be restricted.primefaces.date}" mode="inline" mindate="07/10/2010" maxdate="07/15/2010"/> 48 . <p:calendar value="#{calendarBean.date}"> <p:ajax event=”dateSelect” listener=”#{bean. it will be invoked by passing an org.PrimeFaces Userʼs Guide Effects Various effects can be used when showing and hiding the popup calendar. <p:calendar value="#{dateBean.event. options are.getDate(). If you define a method as a listener.Date.

49 . 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. 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. <p:calendar value="#{dateBean.PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly.date}" pattern=”MM/dd/yyyy HH:mm” /> Advanced Customization Use beforeShowDay javascript callback to customize the look of each date. Following example disabled tuesdays and fridays.

ui-datepicker-week-end .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 .ui-datepicker-other-month .getDay().ui-datepicker-title .ui-datepicker-next . Style Class .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-header .widget.ui-datepicker-table .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.PrimeFaces Userʼs Guide <p:calendar value="#{dateBean. ''] } Client Side API Widget: PrimeFaces.ui-datepicker-prev .ui-datepicker-month .ui-datepicker td .   return [(day != 2 && day != 5). Following is the list of structural style classes.

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. 51 .

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

Enables https support Getting Started with Captcha Catpcha is implemented as an input component with a built-in validator that is integrated with reCaptcha. Once you have the keys for your domain. Key of the supported languages. <p:captcha /> 53 . First thing to do is to sign up to reCaptcha to get public&private keys. User presentable field name.xml as follows. Message to be displayed when required field validation fails. now you can use captcha as follows.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. Message to be displayed when conversion fails. Message to be displayed when validation fields. <context-param> <param-name>primefaces. Position of the input element in the tabbing order.PRIVATE_CAPTCHA_KEY</param-name> <param-value>YOUR_PRIVATE_KEY</param-value> </context-param> <context-param> <param-name>primefaces. add them to web.PUBLIC_CAPTCHA_KEY</param-name> <param-value>YOUR_PUBLIC_KEY</param-value> </context-param> That is it. A method binding expression that refers to a method for handling a valuchangeevent. Public recaptcha key for a specific domain (deprecated) Theme of the captcha.

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

Carousel org.component org.primefaces. 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.PrimeFaces Userʼs Guide 3.component. when set to false component will not be rendered.component.carousel. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class carousel org.primefaces.Carousel org.component.component.primefaces.carousel.primefaces.10 Carousel Carousel is a multi purpose component to display a set of data or general content with slide effects.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. 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 .CarouselRenderer org.

Label for footer. public class CarBean { } private List<Car> cars. "blue")). 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. could be “fade” or “slide”. Inline style of each item.. int year. data and general content display. To begin with data iteration let’s use a list of cars to display with carousel. Getting Started with Carousel Calendar has two main use-cases. 2005. Inline style of the component. //add more cars //getter setter 56 ... Name of the easing animation. cars.PrimeFaces Userʼs Guide Name autoPlayInterval pageLinks effect easing effectDuration dropdownTemplate. Name of the animation. String model. String color. Duration of the animation in milliseconds. Style class of the component.. public class Car { } private private private private . Style class of each item. "ManufacturerX". public } CarListController() { cars = new ArrayList<Car>(). String manufacturer. Template string for dropdown of paginator.add(new Car("myModel". Label for header.

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

.jpg" /> <h:outputText value="The story begins as Don Vito ."/> </h:panelGrid> </p:tab> <p:tab title="Godfather Part III"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather3. for this purpose autoPlayInterval and circular attributes are used....width:600px.jpg"/> <p:graphicImage value="/images/nature4..jpg"/> </p:carousel> Content Display Another use case of carousel is tab based content display." /> </h:panelGrid> </p:tab> </p:carousel> 58 .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. <p:carousel rows="1" itemStyle="height:200px. Following carousel displays a collection of images as a slideshow.jpg"/> <p:graphicImage value="/images/nature2.jpg"/> <p:graphicImage value="/images/nature3.jpg" /> <h:outputText value="After a break of ." /> </h:panelGrid> </p:tab> <p:tab title="Godfather Part II"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather2."> <p:tab title="Godfather Part I"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather1. <p:carousel autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” > <p:graphicImage value="/images/nature1.jpg" /> <h:outputText value="Francis Ford Coppola's ..

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

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

CellEditor org. when set to false component will not be rendered.component.component.primefaces.CellEditor org.primefaces.celleditor. 61 .primefaces.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.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.PrimeFaces Userʼs Guide 3.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.11 CellEditor CellEditor is a helper component of datatable used for incell editing.CellEditorRenderer org.

line and more.chart.component. Render solid slices. 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.primefaces.12 Charts Charts are used to display graphical data. 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 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pieChart org. There’re various chart types like pie. Title of the chart.12. Position of the legend.primefaces.component.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. auto computed by default.primefaces. Gap between slices.component org.primefaces. Style class of the chart.PieChartRenderer org.pie.1 Pie Chart Pie chart displays category-data pairs in a pie graphic.chart.PrimeFaces Userʼs Guide 3.PieChart org. bar. when set to false component will not be rendered.chart.PieChart org. Diameter of the pie.component. 3. Comma separated list of colors in hex format.component.primefaces.chart.pie.

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

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

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 .2 Line Chart Line chart visualizes one or more series of data in a line graph.chart.component.primefaces. Comma separated list of colors in hex format.LineChart org.primefaces. Maximum Y axis value. 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. Style class of the chart. when set to false component will not be rendered.chart. Minimum X axis value.chart.line.12.line. Minimum Y axis value.PrimeFaces Userʼs Guide 3. Position of the legend. Maximum X axis value.component.primefaces.LineChart org.LineChartRenderer org.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.component org.chart.component. Title of the chart. fall will join point on either side of line. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lineChart org.component.primefaces. Whether line segments should be broken at null value.primefaces.

True will force filled series to fill toward zero. boys.CartesianChartModel instance. 100). Label of the x-axis. Specifies interactive legend.model. public CartesianChartModel getModel() { return model. girls. girls.addSeries(boys). 120). Whether to stack series. ChartSeries girls = new ChartSeries().set("2004".set("2005". 60). //. //. model.. Angle of the y-axis ticks. 52). ChartSeries boys = new ChartSeries().primefaces. Getting started with LineChart LineChart is created with an org. Angle of the x-axis ticks. public class Bean { private CartesianChartModel model.chart.addSeries(girs). boys.set("2005". girls.. } public } ChartBean() { model = new CartesianChartModel(). boys. model.setLabel("Girls"). Displays markers at data points.set("2004".setLabel("Boys").. Label of the y-axis. } 66 . Whether to fill under lines..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.

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

Maximum boundary value. Style class of the chart. Position of the legend.PrimeFaces Userʼs Guide 3. Minimum boundary value.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org.bar.chart.BarChartRenderer org. 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.component.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.primefaces.component org. Orientation of bars.12.bar. 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.chart. Padding of bars.primefaces.component. valid values are “vertical” and “horizontal”.primefaces.chart.3 Bar Chart Bar chart visualizes one or more series of data using bars. Enables stacked display of bars.primefaces.BarChart org. Title of the chart. Margin of bars.chart.BarChart org.

Specifies interactive legend. Comma separated list of colors in hex format. Angle of the y-axis ticks.primefaces. Label of the x-axis.model.model}" legendPosition="ne" orientation=”horizontal” /> 69 .chart.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. <p:barChart value="#{bean. Getting Started with Bar Chart BarChart is created with an org. Reusing the same model sample from lineChart section.model}" legendPosition="ne" /> Orientation Bars can be displayed horizontally using the orientation attribute. Label of the y-axis. Angle of the x-axis ticks. fall will join point on either side of line. Shows shadow or not. <p:barChart value="#{bean.CartesianChartModel instance.

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

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 .component.chart. Render solid slices. 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.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.component.chart.primefaces.component. Comma separated list of colors in hex format.donut. Title of the chart.PrimeFaces Userʼs Guide 3.primefaces.chart.component org. Displays data on each slice.DonutChart org. Specifies interactive legend.DonutChartRenderer org.chart.DonutChart org.12.primefaces. Shows shadow or not.component. Format of data labels.donut.4 Donut Chart DonutChart is a combination of pie charts. Gap between slices. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class donutChart org. Style class of the chart. Position of the legend.primefaces.primefaces.

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

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

Style class of the chart.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.primefaces.chart.primefaces.PrimeFaces Userʼs Guide 3.component org.component.primefaces.chart.component.BubbleChartRenderer org.BubbleChart org.12. Displays labels on buttons. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org. 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. Specifies interactive legend. Position of the legend.primefaces.BubbleChart org. Alpha transparency of a bubble. Comma separated list of colors in hex format.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.component. Enables gradient fills instead of flat colors.chart.chart.primefaces. Shows shadow or not. Label of the x-axis.bubble.component. 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 . Title of the chart.bubble.

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

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

Enables candle stick display mode. Specifies interactive legend. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org. Comma separated list of colors in hex format.12.OhlcChart org.chart. Label of the x-axis.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. Position of the legend.chart.chart.primefaces. Angle of the x-axis ticks.component org. 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.primefaces.ohlc.primefaces. Angle of the y-axis ticks. Label of the y-axis.OhlcChartRenderer org. Title of the chart.OhlcChart org.component.PrimeFaces Userʼs Guide 3.component.ohlc. Style class of the chart.component.chart.primefaces.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.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 .

OhlcChartSeries(2010.135.144. <p:ohlcChart value="#{bean.129.addRecord(new ohlcModel.02)).136.139.143.124.139.135.140.138.66.56.5.addRecord(new } //getter } OhlcChartSeries(2007. OhlcChartSeries(2009.139.57.04.68.81)).addRecord(new ohlcModel.73.122.135.136. ohlcModel.OhlcChartModel instance. OhlcChartSeries(2008.56.44)).9.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .88.140.144.132.addRecord(new ohlcModel.139.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.7.addRecord(new ohlcModel.primefaces.123.48)). public Bean() { model = new OhlcChartModel().67.55.46.76. <p:ohlcChart value="#{bean. public class Bean { private OhlcChartModel model.143.142.53.143.01. OhlcChartSeries(2012.97)).135.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.18.79.5)).chart.4)).addRecord(new ohlcModel.addRecord(new ohlcModel. OhlcChartSeries(2012.124.121.model.134. OhlcChartSeries(2011.82.136.31.

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.component org.component.component.component. Position of the legend.7 MeterGauge Chart MeterGauge chart visualizes data on a meter gauge display. Number of pixels to offset the label up and down.component.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.metergauge.MeterGaugeChart org. Radius of the outer circle of the internal ring.MeterGaugeChartRenderer org.chart.primefaces. Specifies interactive legend.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.primefaces.MeterGauge org. Comma separated list of colors in hex format. Style class of the chart.metergauge. Title of the chart.12.chart.primefaces.primefaces.primefaces. 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 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class meterGaugeChart org.chart.chart. Displays ticks around gauge.

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

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

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

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. see the JFreeChart integration example at graphicImage section.PrimeFaces Userʼs Guide 3. jFreeChart If you like to use static image charts instead of canvas based charts.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.

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

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

Name of the client side widget.color.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.color}" mode="inline"/> 86 .color}" /> Display Mode ColorPicker has two modes. Inline style of the component. } public void setColor(String color) { this. public String getColor() { return this. <p:colorPicker value="#{bean. Message to be displayed when required field validation fails. Display mode. public class Bean { } private String color. } <p:colorPicker value="#{bean. A method binding expression that refers to a method for handling a valuchangeevent. Getting started with ColorPicker ColorPicker’s value should be a hex string. valid values are “popup” and “inline”. Message to be displayed when conversion fails.color = color. Message to be displayed when validation fields. A method expression that refers to a method for validation the input. default mode is popup and other available option is inline. Style class of the component.

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

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

primefaces. Match mode for filtering. Custom pluggable sortFunction.component.Column org. Property to be used for sorting.Column org. Enables selection mode.component. Defines the number of rows the column spans. Style class of the column. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the column.primefaces. Shortcut for footer facet. Property to be used for filtering.primefaces. treetable and more.15 Column Column is an extended version of the standard column used by various PrimeFaces components like datatable. Shortcut for header facet. when set to false component will not be rendered. Inline style of the filter element Style class of the filter element A collection of selectitems for filter dropdown.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.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family column org. 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 . Defines the number of columns the column spans.column.

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

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.Columns org.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Data to represent columns.Columns org. when set to false component will not be rendered.primefaces.primefaces.column. Name of iterator to access a column index.component.PrimeFaces Userʼs Guide 3. Inline style of the column. Style class of the column. 91 . Info Tag Component Class Component Type Component Family columns org.16 Columns Columns is used by datatable to create columns programmatically.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. Name of iterator to access a column.

ColumnGroup org. Info Tag Component Class Component Type Component Family columnGroup org.primefaces.columngroup.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 null null Object String Getting Started with ColumnGroup See grouping section in datatable documentation for detailed information. valid values are “header” and “footer”. An el expression that maps to a server side UIComponent instance in a backing bean Type of group. 92 . when set to false component will not be rendered.17 ColumnGroup ColumnGroup is used by datatable for column grouping.primefaces.PrimeFaces Userʼs Guide 3.component.component.ColumnGroup org.primefaces.

component.CommandButton org. Sets the behavior of the button. When set to true. Component(s) to process partially instead of whole view. 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. Boolean value that determines the phaseId. Component(s) to be updated with ajax.component.primefaces.PrimeFaces Userʼs Guide 3. when false at invoke_application phase. Specifies the submit mode.primefaces. when set to true(default).commandbutton.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.component org.commandbutton. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class commandButton org. when true actions are processed at apply_request_values.primefaces.primefaces.CommandButtonRenderer org.component. submit would be made with Ajax. 93 type ajax async process update submit TRUE FALSE null null String Boolean Boolean String String .primefaces. when set to false component will not be rendered. ajax requests are not queued.CommandButton org. An actionlistener that’d be processed when button is clicked.component.

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 key is pressed down over button. 94 . Client side callback to execute when a key is pressed and released over button. 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. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when a pointer button is pressed down over button. Client side callback to execute when a pointer button is released over button. Client side callback to execute when text within button is selected by user. Client side callback to execute when ajax request fails. Access key that when pressed transfers focus to the button. Client side callback to execute when a key is released over button. Client side callback to execute when button is double clicked. Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when ajax request succeeds. Client side callback to execute when a pointer button is moved within button. Client side callback to execute when button receives focus. Client side callback to execute when button loses focus. Client side callback to execute when ajax request is completed. Inline style of the button element. StyleClass of the button element. Defines whether to trigger ajaxStatus or not.

(deprecated: use icon) A localized user presentable name. Code describing the language used in the generated markup for this component. Advisory tooltip information.saveBook}" /> public class BookBean { public void saveBook() { //Save book } } Reset Buttons Reset buttons do not submit the form. Icon of the button as a css class.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. Disables the button. Used by PrimeFaces mobile only. Direction indication for text that does not inherit directionality. just resets the form contents. Name of the client side widget. <p:commandButton value="Save" actionListener="#{bookBean. <p:commandButton type="reset" value="Reset" /> 95 . Style class for the button icon. Position of the icon. by default commandButton submits its enclosing form with ajax. Position of the button element in the tabbing order. Flag indicating that this component will prevent changes by the user. Getting started with CommandButton CommandButton usage is similar to standard commandButton. Valid values are LTR and RTL.

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

Following is the list of structural style classes. Style Class . 97 .widget.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.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-button-text Button element Button element when icon is not used Label of button Applies As skinning style classes are global. see the main Skinning section for more information.ui-button .

submit would be made with Ajax.component. ajax requests are not queued. When set to true.CommandLinkRenderer org. An actionlistener that’d be processed when link is clicked. when true actions are processed at apply_request_values. Boolean value that determines the phaseId. Specifies the submit mode.CommandLink org.component.component org.CommandLink org. A method expression or a String outcome that’d be processed when link is clicked. when set to false component will not be rendered. Client side callback to execute before ajax request is begins. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class commandLink org.primefaces. Component(s) to be updated with ajax.component.PrimeFaces Userʼs Guide 3.commandlink.primefaces. when set to true (default). commandlink. An el expression that maps to a server side UIComponent instance in a backing bean Href value of the rendered anchor. Component(s) to process partially instead of whole view. 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 .19 CommandLink CommandLink extends standard JSF commandLink with Ajax capabilities.primefaces.component.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.primefaces.primefaces. when false at invoke_application phase.

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 pointer button is pressed down over link. Client side callback to execute when ajax request fails. Client side callback to execute when a pointer button is moved onto link. Client side callback to execute when ajax request succeeds. Client side callback to execute when a key is pressed down over link. Defines whether to trigger ajaxStatus or not. 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 away from link. Client side callback to execute when link is double clicked. Access key that when pressed transfers focus to the link. Client side callback to execute when a key is released over link. 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. Client side callback to execute when link receives focus. Client side callback to execute when link is clicked.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. Client side callback to execute when a pointer button is released over link. Character encoding of the resource designated by this hyperlink. Client side callback to execute when a key is pressed and released over link.

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. values are provided by a space-separated list of link types. circle and poly. Name of a frame where the resource targeted by this link will be displayed. valid values are default. Shape of hot spot on the screen. rect. Disables the link Languae code of the resource designated by the link. A reverse link from the anchor specified by this link to the current document. difference is form is submitted with ajax by default.saveBook}"> <h:outputText value="Save" /> </p:commandLink> Skinning CommandLink renders an html anchor element that style and styleClass attributes apply. public class BookBean { public void saveBook() { //Save book } } <p:commandLink actionListener="#{bookBean. Advisory tooltip information. Type of resource referenced by the link. 100 . Position of the button element in the tabbing order. Valid values are LTR and RTL. values are provided by a space-separated list of link types. Relationship from the current document to the anchor specified by the link.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.

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class confirmDialog org.primefaces.primefaces. customization and avoiding popup blockers are notable advantages over classic javascript confirmation.20 ConfirmDialog ConfirmDialog is a replacement to the legacy javascript confirmation box. 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 . Text for the header.confirmdialog. Width of the dialog in pixels Width of the dialog in pixels Inline style of the dialog container. Text to be displayed in body.component org.primefaces.primefaces.component. Message severity for the displayed icon. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component.ConfirmDialogRenderer org. Skinning. when set to false component will not be rendered.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.component.PrimeFaces Userʼs Guide 3.ConfirmDialog org.ConfirmDialog org.component.confirmdialog.

Getting started with ConfirmDialog ConfirmDialog has a simple client side api.hide()"/> <p:commandButton value="Not Yet" onclick="confirmation. 102 .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. either via message option or message facet.. menuitem and more. <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //. default severity is alert and the other option is info.hide().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.. Whether to display confirm dialog on load." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways. <h:form> <p:commandButton type="button" onclick="cd. commandLink.destroyWorld}" update="messages" oncomplete="confirmation. Note that header can also be defined using the header attribute or the header facet. You can call these functions to display a confirmation from any component like commandButton. Message facet is useful if you need to place custom content instead of simple text. show() and hide() functions are used to display and close the dialog respectively. </p:confirmDialog> Severity Severity defines the icon to display next to the message.

widget.ui-dialog-titlebar .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-dialog-content . Closes dialog.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-close . 103 .ui-dialog-title .ConfirmDialog Method show() hide() Params Return Type void void Description Displays dialog. see the main Skinning section for more information. Style Class .ui-dialog . Following is the list of structural style classes. Skinning ConfirmDialog resides in a main container element which style and styleClass options apply.

When for is not defined.component org.component.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.PrimeFaces Userʼs Guide 3.primefaces.ContextMenu org.21 ContextMenu ContextMenu provides an overlay menu displayed on mouse right-click event.ContextMenuRenderer org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class contextMenu org.contextmenu. contextMenu is attached to the page meaning. Optional for attribute defines which component the contextMenu is attached to.primefaces.primefaces.primefaces. 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 org. when set to false component will not be rendered.contextmenu.component. 104 . An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Getting started with ContextMenu ContextMenu is created with menuitems.component. right-click on anywhere on page will display the menu.primefaces.

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

ui-menuitem-link .ui-menu-list . Style Class . see the main Skinning section for more information. Following is the list of structural style classes.ui-menuitem .PrimeFaces Userʼs Guide Dynamic Menus ContextMenus can be created programmatically as well.ui-contextmenu . Skinning ContextMenu resides in a main container which style and styleClass attributes apply. 106 .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. see the dynamic menus part in menu component section for more information and an example.

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.PrimeFaces Userʼs Guide 3.dashboard.Dashboard org.primefaces.component. Disables reordering feature. 107 .component org.dashboard.primefaces. 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 org.primefaces.primefaces.primefaces.DashboardRenderer org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities.component.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.component. when set to false component will not be rendered.

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

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

110 .ui-dashboard-column div. Following is the list of structural style classes.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. Tips • Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets.PrimeFaces Userʼs Guide New Widgets Draggable component is used to add new widgets to the dashboard.ui-dashboard . see the main Skinning section for more information. Style Class .ui-state-hover Applies Container element of dashboard Each column in dashboard Placeholder As skinning style classes are global. Here is an example based on a different theme. This way you can add new panels from outside of the dashboard. <p:dashboard model="#{dashboardBean.

primefaces.DefaultDashboardModel is the default implementation) Method void removeWidget(String widgetId) List<String> getWidgets() int getWidgetCount() String getWidget(int index) void addWidget(String widgetId) void addWidget(int index. String widgetId.primefaces.model.PrimeFaces Userʼs Guide Dashboard Model API org. org.DashboardModel (org. String widgetId) void reorderWidget(int index.primefaces.DefaultDashboardModel is the default implementation) Method void addColumn(DashboardColumn column) List<DashboardColumn> getColumns() int getColumnCount() DashboardColumn getColumn(int index) void transferWidget(DashboardColumn from.map.model.DashboardColumn (org. 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.map.model. 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. DashboardColumn to.model.

only selection would be exported."pdf".primefaces. pdf.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". Assume the table to be exported is defined as."csv". <p:dataTable id="tableId" . For pdf exporting itext and for xls exporting poi libraries are required in the classpath. Target must point to a PrimeFaces Datatable.export. defaults to datatable id. csv and xml.primefaces.component.23 DataExporter DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel. "xml" Id of the datatable whose data to export..PrimeFaces Userʼs Guide 3. Character encoding to use When enabled.export. Filename of the generated export file.> //columns </p:dataTable> 112 .component. PostProcessor for the exported document. Info Tag Tag Class ActionListener Class dataExporter org.. Getting Started with DataExporter DataExporter is nested in a UICommand component such as commandButton or commandLink.DataExporterTag org. 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.

<p:dataExporter type="pdf" target="tableId" excludeColumns="0"/> Monitor Status DataExport is a non-ajax process so ajaxStatus component cannot apply. Same solution applies to data export as well.2. Exporter below ignores first column. to exclude more than one column define the indexes as a comma separated string (excludeColumns="0. if you’d like export only the data displayed on current page. set pageOnly to true. <p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/> Excluding Columns In case you need one or more columns to be ignored use exludeColumns option.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. See FileDownload Monitor Status section to find out how monitor export process. 113 .6").

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

component.PrimeFaces Userʼs Guide 3.primefaces. when set to false component will not be rendered.primefaces.primefaces.component. 115 .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.DataGrid org.component.component.DataGridRenderer org.DataGrid org.primefaces.datagrid.primefaces.24 DataGrid DataGrid displays a collection of data in a grid layout.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataGrid org.datagrid.

Position of the paginator. Index of the first row to be displayed Name of the client side widget. String model. Number of rows to display per page. Template of the paginator.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. 116 . Template of the currentPageReport UI. Defines if paginator should be hidden if total data count is less than number of rows 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. String color. Inline style of the datagrid.. String manufacturer. Enables pagination. Name of the request-scoped variable used to refer each data. Style class of the datagrid. public class Car { } private private private private . datalist and datatable examples. Number of columns in grid.. int year. Template of the rowsPerPage dropdown. Name of the iterator to refer each row index.

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

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

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

widget.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 .ui-datagrid . Class . 120 . see DataTable lazy loading section. Tips • DataGrid supports lazy loading data via LazyDataModel.ui-datagrid-row .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. see the main Skinning section for more information.ui-datagrid-data . Skinning DataGrid resides in a main div container which style and styleClass attributes apply.DataGrid Method getPaginator() Params Return Type Paginator Description Returns the paginator widget. Following is the list of structural style classes.

25 DataList DataList presents a collection of data in list layout with several display types.component.DataList.PrimeFaces Userʼs Guide 3.component.component.DataListTag org.DataListRenderer org. Number of rows to display per page. Name of the request-scoped variable used to refer each data.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. An el expression that maps to a server side UIComponent instance in a backing bean Data to display. 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. when set to false component will not be rendered.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataList org.component org.primefaces.primefaces.datalist.DataList org.datalist.

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

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

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

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

Scroll viewport width. Position of the paginator. valid values are “single” and “multiple”. Property to be used for default sorting. Event to invoke filtering for input filters. Inline style of the table element. Number of rows to load on live scroll. Unique identifier of a row. Reference to the selection data. Enables live scrolling. 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 . Style class of the table element. Inline style of the component. Enables column resizing. “ascending” or “descending”. Defines if paginator should be hidden if total data count is less than number of rows per page. Client side callback to execute before expansion. Style class for each row. Text to display when there is no data to display. Enables row selection. Name of iterator to refer each row index. Template of the currentPageReport UI. Template of the rowsPerPage dropdown. Scroll viewport height. Makes data scrollable with fixed header. 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. Style class of the component. 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. Enables row selection on double click. Maximum number of page links to display.

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

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

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

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

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

enable dblClickSelect so that clicking double on a row does the selection.model. datatable has built-in support for this method so that you don’t need to deal with h:selectOneRadio’s and low level bits. <p:dataTable var="car" value="#{carBean..columns </p:dataTable> Multiple Selection with Checkboxes Similar to how radio buttons are enabled.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.id}" > .. row based selection is enabled by click event. <p:dataTable var="car" value="#{carBean.cars}" selectionMode="multiple" selection="#{carBean.cars}" selection="#{carBean. define a selection column with a multiple selectionMode.. 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.primefaces.selectedCars}" rowKey="#{car..id}" > <p:column selectionMode="multiple"/> . <p:dataTable var="car" value="#{carBean.selecedCars}" rowKey="#{car.g.columns </p:dataTable> Selection on Double Click By default.columns </p:dataTable> RowKey RowKey should a unique identifier from your data model and used by datatable to find the selected rows..cars}" selection="#{carBean.selecedCar}" rowKey="#{car.SelectableDataModel. 132 .id}"> <p:column selectionMode="single"/> . define a column with selectionMode set as single. ctrl) during selection. DataTable will also provide a selectAll checkbox at column header.. In order to enable this feature.

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

lastYearProfit}% </p:column> <p:column> #{sale.thisYearSale}$ </p:column> <p:columnGroup type="footer"> <p:row> <p:column colspan="3" style="text-align:right" footerText="Totals:"/> <p:column footerText="#{tableBean.PrimeFaces Userʼs Guide Grouping Grouping is defined by ColumnGroup component used to combine datatable header and footers.lastYearTotal}$" /> <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. <p:dataTable var="sale" value="#{carBean.thisYearTotal}$" /> </p:row> </p:columnGroup> </p:dataTable> 134 .manufacturer} </p:column> <p:column> #{sale.lastYearSale}$ </p:column> <p:column> #{sale.thisYearProfit}% </p:column> <p:column> #{sale.

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

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

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

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

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

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

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

DataTable Method getPaginator() clearFilters() Params Return Type Paginator void Description Returns the paginator insance.widget.ui-datatable-footer .ui-datatable-data-empty . Clears all column filters Skinning DataTable resides in a main container element which style and styleClass options apply.ui-editable-column .ui-sortable-column-icon .ui-cell-editor-input .ui-datatable-data . Following is the list of structural style classes.ui-sortable-column .ui-cell-editor-output .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. 142 .ui-row-toggler . Class . see the main Skinning section for more information.ui-cell-editor .ui-expanded-row-content .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.ui-datatable-even .ui-datatable .ui-datatable-header .

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.component.primefaces.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. when set to false component will not be rendered. 143 . button or link) to submit the form with on enter key press. 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. DefaultCommand solves this problem by normalizing the command(e.component.DefaultCommandRenderer org.primefaces.component.primefaces.DefaultCommand org.component org.defaultcommand.PrimeFaces Userʼs Guide 3.component.DefaultCommand org.g.primefaces. Example below triggers btn2 when enter key is pressed. IE probably will not care about it.defaultcommand. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class defaultCommand org. There are some ugly workarounds like placing a hidden button and writing javascript for every form in your app. Browsers tend to behave differently as there doesn’t seem to be a standard and even if a standard exists. 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. Note that an input must have focused due to browser nature.primefaces.

submit1}" ajax="false"/> <p:commandButton value="Button2" id="btn2" 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.submit2}" /> <h:commandButton value="Button3" id="btn3" actionListener="#{bean.submit3}" /> <p:defaultCommand target="bt2" /> </h:form> 144 .text}" id="display" /> </h:panelGrid> <p:commandButton value="Button1" id="btn1" actionListener="#{bean.

when set to false component will not be rendered.Dialog org.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.primefaces.component.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 Userʼs Guide 3.28 Dialog Dialog is a panel component that can overlay other elements on page. Width of the dialog Height of the dialog Minimum width of a resizable dialog.primefaces.dialog.dialog.primefaces.Dialog org.primefaces.component 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 . 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.component.primefaces. When enabled.DialogRenderer org. dialog is visible by default.

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. Appends dialog as a child of document body. Whether a dialog is minimizable or not. Text of the footer. Getting started with the Dialog Dialog is a panel component containing other components.show()" /> <p:commandButton value="Hide" type="button" onclick="dlg. Enables lazy loading of the content with ajax. <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. Client side callback to execute when dialog is hidden. Inline style of the dialog. <p:dialog header="Header Text" widgetVar="dlg"> //Content </p:dialog> <p:commandButton value="Show" type="button" onclick="dlg.hide()" /> 146 . Whether a dialog is maximizable or not. note that by default dialog is not visible.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. Defines visibility of the header content.

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

event.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. onShow and onHide are handy callbacks for client side in case you need to execute custom javascript.primefaces. If there is a listener defined it’ll be executed by passing an instace of org.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.Dialog Method show() hide() Params Return Type void void Description Displays dialog. <p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)"> //Content </p:dialog> Client Side API Widget: PrimeFaces.CloseEvent. Following is the list of structural style classes. Closes dialog. Skinning Dialog resides in a main container element which styleClass option apply. <p:dialog> <p:ajax event="close" listener="#{dialogBean. 148 .widget. Example below adds a FacesMessage when dialog is closed and updates the messages component to display the added message.

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

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 . when set to false component will not be rendered.DraggableRenderer org.29.dnd. 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. 3.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org. valid values are ‘x’ and ‘y’.primefaces. Id of the component to add draggable behavior Disables draggable behavior when true.PrimeFaces Userʼs Guide 3. Specifies a draggable that can’t be dropped.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.primefaces.primefaces.Draggable org.component.component. Draggable and Droppable.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. Specifies drag axis.component.Draggable org.dnd.primefaces.primefaces.component org.component.

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

revert option enables the component to move back to it’s original position with an animation. opacity option can be used to give visual feedback. actual component is used as the drag indicator. <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.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. 152 . use a clone helper. <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.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically. helper of following panel’s opacity is reduced in dragging. if you need to keep the component at it’s original location. <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.

<p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am dragged in grid mode" /> </p:panel> <p:draggable for="pnl" grid="20. following draggable cannot go outside of it’s parent."> <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 .5"/> Grid Defining a grid enables dragging in specific pixels.y format. This value takes a comma separated dimensions in x.height:200px. <p:outputPanel layout="block" style="width:400px.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.

Style class to apply when an acceptable draggable is being dragged.component. Scope key to match draggables and droppables. Selector to define the accepted draggables.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.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 .dnd.PrimeFaces Userʼs Guide 3.Droppable org. 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. when set to false component will not be rendered.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org.primefaces.component.Droppable org.component.primefaces.dnd.component.primefaces. Specifies the intersection mode to accept a draggable. Client side callback to execute when a draggable is dropped.primefaces.primefaces. Id of a UIData component to connect with.29.DroppableRenderer org.

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

} //draggable element. droppedCars. Object data = ddEvent.offset.getData(). Dropped cars are displayed with a datatable. datatable.helper. 156 . String droppedId = ddEvent. <p:outputPanel id="zone" styleClass="slot" /> <p:droppable for="zone" onDrop="handleDrop"/> function handleDrop(event. public class TableBean { private List<Car> availableCars.add(car). } //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. offset = ui. 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. private List<Car> droppedCars.position.g. datagrid). } public TableBean() { availableCars = //populate data } //getters and setters public } void onCarDrop(DragDropEvent event) { Car car = ((Car) ddEvent.draggable.PrimeFaces Userʼs Guide public void onDrop(DragDropEvent ddEvent) { String draggedId = ddEvent. helper = ui. availableCars. a jQuery object //helper element of draggable. ui) { var draggable = ui.remove(car). position = ui. Example below show how to drag data from datagrid and drop onto a droppable to implement a dragdrop based selection.getData()).getDragId(). it gets two parameters event and ui object holding information about the drag drop event. in order to connect a droppable to accept data from a data component define datasource option as the id of the data component.getDropId().

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

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. 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. 158 . <p:graphicImage id="messi" value="barca/messi_thumb.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_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.

dock.PrimeFaces Userʼs Guide 3.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.Dock org.primefaces. when set to false component will not be rendered. Distance to enlarge.component.Dock org.primefaces.primefaces.primefaces. Maximum width of items. Name of the client side widget.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. 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.component. Initial width of items.30 Dock Dock component mimics the well known dock interface of Mac OS X.DockRenderer org. bottom or top. 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 .primefaces. Horizontal alignment.component.dock.

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

PrimeFaces Userʼs Guide 3.primefaces.Editor org. An el expression that maps to a server side UIComponent instance in a backing bean.component. it’s resolved to a converter instance.EditorRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class editor org.primefaces.31 Editor Editor is an input component with rich text editing capabilities. When it’s an EL expression.component.editor.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. Boolean value to specify the rendering of the component. it must refer to a converter id.component org. An el expression or a literal text that defines a converter for the component. 161 .primefaces. Value of the component than can be either an EL expression of a literal text.primefaces.primefaces.component. In case it’s a static text.Editor org.editor.component.

A method expression that refers to a method for handling a valuchangeevent. Inline style of the editor container. List of controls to customize toolbar. Style class of the editor container. A method expression that refers to a method validationg the input. Message to be displayed when required field validation fails. Marks component as required. Height of the editor. public class Bean { private String text. 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. process validations logic is executed at apply request values phase for this component.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true. Message to be displayed when conversion fails. Name of the client side widget. //getter and setter <p:editor value="#{bean. Width of the editor.text}" /> 162 . Message to be displayed when validation fails. Disables editor. Client side callback to execute when editor data changes.

Clears the text in editor.PrimeFaces Userʼs Guide Custom Toolbar Toolbar of editor is easy to customize using controls option.widget. subsequent calls do not reinit the editor. Saves html text in iframe back to the textarea. <p:editor value="#{bean. • • • • • • • • • • • • • • • • 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. .text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls.Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor.

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

effect.primefaces.primefaces. Info Tag Tag Class Component Class Component Type Component Family Renderer Type Renderer Class effect org.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.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.component.component.EffectTag org.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.component.32 Effect Effect component is based on the jQuery UI effects library.component.Effect org.Effect org.primefaces. 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.effect.effect.primefaces.component org.EffectRenderer org. 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.primefaces. 165 .

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. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 . initially hidden graphicImage comes up with a fade effect. Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly. List of Effects Following is the list of effects supported by PrimeFaces.PrimeFaces Userʼs Guide <h:outputText value="#{bean.jpg" style="display:none"/> With this setting.value}"> <p:effect type="pulsate" event="click" /> </h:outputText> Effect Target There may be cases where you want to display an effect on another target on the same page while keeping the parent as the trigger. Use for option to specify a target. When the link is clicked.

action}" update="messages"/> 167 .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.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. duration and more.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.jquery. provide these parameters with the f:param tag. <h:outputText value="#{bean.PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors. <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. please see the jquery documentation. http://docs. In order to change the configuration of the animation. <h:outputText value="#{bean. Following example animates messages with pulsate effect after ajax request completes.

PrimeFaces Userʼs Guide 3.FeedReader org. <p:feedReader value="http://rss.news.feedreader. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class feedReader org.primefaces. Iterator to refer each item in feed. Number of items to display. when set to false component will not be rendered. 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.FeedReaderRenderer org.title}" style="font-weight: bold"/> <h:outputText value="#{feed.yahoo.com/rss/sports" var="feed"> <h:outputText value="#{feed.description.primefaces.33 FeedReader FeedReader is used to display content from a feed.component. An el expression that maps to a server side UIComponent instance in a backing bean URL of the feed.component. </f:facet> </p:feedReader> Note that you need the ROME library in your classpath to make feedreader work.value}" escape="false"/> <p:separator /> <f:facet name="error"> Something went wrong. 168 .feedreader.primefaces.primefaces.primefaces.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 org.component.FeedReader org.component.

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.Fieldset org.component org. Makes content toggleable with animation. Toggle duration in milliseconds.FieldsetRenderer org.component.primefaces. 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 .primefaces. Title text. Style class of the fieldset.primefaces.component. Inline style of the fieldset.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org. Defines initial visibility state of content.component.PrimeFaces Userʼs Guide 3.Fieldset org.fieldset.component. when set to false component will not be rendered.fieldset.34 Fieldset Fieldset is a grouping component as an extension to html fieldset.primefaces.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.

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

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

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

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

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

monitorDownload(showStatus. hideStatus)"> <p:fileDownload value="#{fileDownloadController.gif" /> </p:dialog> <p:commandButton value="Download" ajax="false" onclick="PrimeFaces.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.

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

Style class of the component. Message to be displayed when required field validation fails. Component(s) to process in fileupload request. Maximum number of files allowed to upload. Name of the client side widget. Message to be displayed when validation fails. 177 . Client side callback to execute when upload begins. Message to be displayed when conversion fails. can be simple or advanced. Label of the upload button. Allows multi file selection when true. Message to display when file limit exceeds. Inline style of the component. Message to display when size limit exceeds.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 display when file is not accepted. Regular expression to restrict uploadable files. Enables auto file uploads. Maximium file size limit in bytes. Visibility of upload and cancel buttons in button bar. Component(s) to update after fileupload completes. Label of the cancel button. Client side callback to execute when upload ends. Method to invoke when a file is uploaded. Disables component when set true. Mode of the fileupload. Whether or not to enable dragdrop from filesystem. Label of the browse button.

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

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

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

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

component org.Focus.primefaces. 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. when set to false component will not be rendered. /> <h:inputText .FocusRenderer org.. <p:focus /> <p:inputText .... textarea and select. /> <h:selectOneMenu .focus.component. 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.component.component.PrimeFaces Userʼs Guide 3.primefaces. Input component can be any element such as input.component. /> 182 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.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.focus..Focus org.primefaces..FocusTag org.primefaces.37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.

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

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class galleria org. when set to false component will not be rendered. Style class of the container element.component.galleria. Name of variable to access an item in collection.Galleria org.primefaces. Inline style of the container element.component. 184 binding widgetVar value var style styleClass null null null null null null Object String Collection String String String .primefaces.component org.galleria.component.38 Galleria Galleria is used to display a set of images.Galleria org. Collection of data to display.primefaces.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.primefaces.GalleriaRenderer org.component.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.

jpg" title="image1" <p:graphicImage value="/images/image4. Duration of animation in milliseconds. <p:galleria value="#{galleriaBean. Height of the frames. Width of the frames. Defines interval of slideshow.jpg" title="image1" <p:graphicImage value="/images/image3. Defines visibility of captions. For this you can use built-in data iteration feature. Width of the viewport. Height of the viewport. Dynamic Collection Most of the time.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.path}" title="#{image. Position of the filmstrip.images}" var="image" > <p:graphicImage value="#{image. <p:galleria effect="slide" effectDuration="1000"> <p:graphicImage value="/images/image1. Defines visibility of overlays. Getting Started with Galleria Images to displayed are defined as children of galleria.jpg" title="image1" <p:graphicImage value="/images/image2.description}" /> </p:galleria> 185 . you would need to display a dynamic set of images rather than defining each image declaratively. Style of the filmstrip. 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.title}" alt="#{image.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 visibility of filmstrip.

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

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

Defines draggability of map.com/maps/api/js?sensor=true|false" type="text/javascript"></script> As Google Maps api states.model. Defines visibility of map type control. Getting started with GMap First thing to do is placing V3 of the Google Maps API that the GMap is based on. <p:gmap center="41. Disables default UI controls Defines visibility of navigation control.height:400px" /> center: Center of the map in lat.MapModel instance. <script src="http://maps. zoom. Defines if center and zoom should be calculated automatically to contain all markers on the map. type and style. Center point of the map. Defines the initial zoom level. lng format zoom: Zoom level of the map 188 . Type of the map. Javascript callback to execute when a point on map is clicked. Four options are required to place a gmap on a page.381542.google. Style class of the map container.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. 2. these are center. Ideal location is the head section of your page.primefaces. Controls street view support. Inline style of the map container. Disables zooming on mouse double click.122893" zoom="15" type="hybrid" style="width:600px.

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

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

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

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

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

model. var gmap = yourWidgetVar.maps.primefaces. //gmap is a google.google.PrimeFaces Userʼs Guide Map Controls Controls on map can be customized via attributes like navigationControl and mapTypeControl. <p:gmap center="41. http://code.primefaces.com/apis/maps/documentation/javascript/reference. use provided getMap() method.122893" zoom="15" type="terrain" style="width:600px. Finds an overlay by it’s unique id 194 Description .model.html GMap API org.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.getMap().map. Alternatively setting disableDefaultUI to true will remove all controls at once.MapModel (org.map.Map instance Full map api is provided at.381542. 2.height:400px" Native Google Maps API In case you need to access native google maps api with javascript.

primefaces.primefaces.map.primefaces. shadow image is not displayed Defines visibility of the marker org.Polyline extends org. generated and used internally Data represented in marker Z-Index of the overlay org.Overlay Property paths strokeColor Default null null List String Type List of coordinates Color of a line 195 Description .map.Marker extends org.model.primefaces.model.model.Polygon extends org.map.model.primefaces.PrimeFaces Userʼs Guide org.model.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.Overlay Property id data zindex Default null null null Type String Object Integer Description Id of the overlay.map.map.primefaces.model.primefaces.map.model.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.map.

map. Stroke weight of the circle.map.primefaces.map.primefaces. Stroke opacity of rectangle. Opacity of the rectangle.map.map. Opacity of the circle. Stroke weight of the rectangle.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.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.primefaces. Stroke color of the rectangle. Stroke opacity of circle. Stroke color of the circle. Description org.Circle extends org. org.primefaces. Background color of the circle.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.model.primefaces.model.Rectangle extends org.model.LatLng Property lat lng Default null null Type double double Description Latitude of the coordinate Longitude of the coordinate 196 .model.model. Background color of the rectangle.

primefaces.MarkerDragEvent Property marker Default null Type Marker Description Dragged marker instance org.map.primefaces.map.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.model.primefaces.OverlaySelectEvent Property overlay Default null Type Overlay Description Selected overlay instance org.primefaces.PrimeFaces Userʼs Guide org.map.PointSelectEvent Property latLng Default null Type LatLng Description Coordinates of the selected point org.FacesEvent.event.map.event.primefaces.event.event.event.faces. org.StateChangeEvent Property bounds zoomLevel Default null 0 Type LatLngBounds Integer Description Boundaries of the map Zoom level of the map 197 .

GMapInfoWindow org.primefaces.gmap.primefaces.40 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.GMapInfoWindowTag org.component. 198 . when set to false component will not be rendered.gmap.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. 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. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.component.primefaces.component.GMapInfoWindow org.primefaces.

component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class graphicImage org. An el expression that maps to a server side UIComponent instance in a backing bean Binary data to stream or context relative path.component. when set to false component will not be rendered.component.GraphicImage org.component. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier.GraphicImage org. GraphicImage does all the hard work without the need of a Servlet. Legacy way to do this is to come up with a Servlet that does the streaming.41 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream.PrimeFaces Userʼs Guide 3.graphicimage.primefaces.primefaces.primefaces.component org.graphicimage.GraphicImageRenderer org.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. 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 .

getResourceAsStream("barcalogo.primefaces.image. } DefaultStreamedContent gets an inputstream as the first parameter and mime type as the second.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.jpg").image}" /> public class ImageBean { } private StreamedContent image. image = new DefaultStreamedContent(stream.getClass(). public DynamicImageController() { InputStream stream = this. <p:graphicImage value="#{imageBean. Following examples loads an image from the classpath. } public StreamedContent getImage() { return this. StreamedContent is an interface and PrimeFaces provides a built-in implementation called DefaultStreamedContent. 200 .model. "image/jpeg").StreamedContent content as it’s value.

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

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

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

Specifies if the detail of message should be displayed.primefaces.primefaces. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. Duration in milliseconds to display non-sticky messages.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.component. 204 binding sticky showSummary showDetail globalOnly life autoUpdate null FALSE TRUE FALSE FALSE 6000 FALSE Object Boolean Boolean Boolean Boolean Integer Boolean .42 Growl Growl is based on the Mac’s growl notification widget and used to display FacesMessages in an overlay.growl.primefaces.primefaces.component. only facesmessages without clientids are displayed.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.GrowlRenderer org.primefaces.component org. Specifies if the summary of message should be displayed.component.component. When true. Specifies auto update mode.growl.Growl org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class growl org.

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

ui-growl-image-warn .ui-growl .ui-growl-image-error .PrimeFaces Userʼs Guide Skinning Following is the list of structural style classes.ui-growl-image . Style Class .ui-growl-item .ui-growl-image-info .ui-growl-item-container .ui-growl-message p . see the main Skinning section for more information.ui-growl-title . 206 .ui-growl-message .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.

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

Javascript handler to execute when ajax request succeeds. Global ajax requests are listened by ajaxStatus component. setting global to false will not trigger ajaxStatus." /> <p:hotkey bind="right" handler="switcher." /> <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. Key combinations Most of the time you’d need key combinations rather than a single key. Using left and right keys will switch the images displayed via the p:imageSwitch component. Simplest example would be. pressing the a key will alert the ‘Pressed key a’ text. Javascript handler to execute when ajax request is completed." /> When this hotkey is on page. <p:hotkey bind="ctrl+s" handler="alert(‘Pressed ctrl+s’).next(). either on client side with the event handler or with ajax support.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:hotkey bind="left" handler="switcher.previous(). Javascript handler to execute when ajax request fails. Boolean Getting Started with HotKey HotKey is used in two ways. <p:hotkey bind="a" handler="alert(‘Pressed a’)." /> <p:imageSwitch widgetVar="switcher"> //content </p:imageSwitch> 208 .

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

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

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

Inline style of the main container element.primefaces.primefaces. Specifies the editor mode.Inplace org.component. Label to be shown in display mode when value is empty. Label to be shown in display mode.48 Inplace Inplace provides easy inplace editing and inline content display. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inplace org. when set to false component will not be rendered. Prevents hidden content to be shown.InplaceRenderer org.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. Effect to be used when toggling.component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component.primefaces. Inplace consists of two members.component.component org.primefaces. Style class of the main container element.inplace.Inplace org. 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 . display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.PrimeFaces Userʼs Guide 3. Speed of the effect.inplace.primefaces.

Tooltip text of cancel buttin in editor mode.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. Getting Started with Inplace The inline component needs to be a child of inplace. also effect speed can be tuned with values slow. <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. Name of the client side event to display inline content. <p:inplace label="Show Image" effect="slide" effectSpeed="fast"> <p:graphicImage value="/images/nature1. Defines if inplace is toggleable or not. normal and fast. you can customize it via the label attribute.jpg" /> </p:inplace> 222 . <p:inplace> <h:inputText value="Edit me" /> </p:inplace> Custom Labels By default inplace displays it’s first child’s value as the label.

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

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

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

234 . Client side callback to execute when a pointer button is moved onto input element. Getting Started with InputTextarea InputTextarea usage is same as standard inputTextarea. Client side callback to execute when text within input element is selected by user. Inline style of the input element. Number of characters used to determine the width of the input element. <p:inputTextarea value="#{bean. Use autoResize option to turn on/off this feature. Client side callback to execute when a pointer button is released over input element. Position of the input element in the tabbing order. As skinning style classes are global. if content height exceeds the allocated space. see the main Skinning section for more information. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a pointer button is moved away from input element.propertyName}" /> AutoResize When textarea is being typed. Skinning style and styleClass options apply to the textarea element. Advisory tooltip informaton. textarea can grow automatically. Style class of the input element.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.

it must refer to a converter id When set true. process validations logic is executed at apply request values phase for this component.component.component.primefaces.component. it’s resolved to a converter instance.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.Keyboard org. In case it’s a static text.52 Keyboard Keyboard is an input component that uses a virtual keyboard to provide the input. when set to false component will not be rendered.component org.Keyboard org.keyboard.keyboard. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class keyboard org.component. 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 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.KeyboardRenderer org.primefaces. 235 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean .primefaces.primefaces.PrimeFaces Userʼs Guide 3.primefaces. Notable features are the customizable layouts and skinning capabilities.

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

component. Makes the unit resizable.54 LayoutUnit LayoutUnit represents a region in the border layout model of the Layout component. Size of the unit. Info Tag Component Class Component Type Component Family layoutUnit org.PrimeFaces Userʼs Guide 3.primefaces. Gutter size of layout unit. Makes the unit closable. Style class of the component.primefaces. Minimum dimension for resize. Maximum dimension for resize. An el expression that maps to a server side UIComponent instance in a backing bean Position of the unit. when set to false component will not be rendered. Text of header. Makes the unit collapsible.primefaces.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. Text of footer.LayoutUnit org.LayoutUnit org.layout.component. Specifies default visibility Specifies toggle status of unit Size of the unit when collapsed Inline style of the component. 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 .

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. Effect speed of the layout transition. 246 .

247 . multimedia content.LightBox org.component. Style class of the container element not the overlay element.lightbox. other JSF components and external urls.55 LightBox Lightbox features a powerful overlay that can display images.primefaces.LightBox org.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lightBox org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.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.component.primefaces. when set to false component will not be rendered.primefaces. Style of the container element not the overlay element.LightBoxRenderer org.primefaces.PrimeFaces Userʼs Guide 3.component org.component lightbox.

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

ui-lightbox-nav-right . Description Skinning Lightbox resides in a main container element which style and styleClass options apply. Previous image navigator.ui-lightbox-nav-left . see the main Skinning section for more information. As skinning style classes are global.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.ui-lightbox-loading . Following is the list of structural style classes. Content wrapper element. Content container.ui-lightbox-content-wrapper .ui-lightbox-caption Applies Main container element. you can display other JSF content on the page using the lightbox overlay.widget.LightBox Method show() hide() Params Return Type void void Displays lightbox.ui-lightbox . Clicking the link in the example below will display the panelGrid contents in overlay. Loading image. Caption element. Style Class . Next image navigator. Simply place your overlay content in the "inline" facet. Hides lightbox.ui-lightbox-content . Client Side API Widget: PrimeFaces. 249 .

component.primefaces.primefaces.PrimeFaces Userʼs Guide 3.log.component. 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.Log org. when set to false component will not be rendered.LogRenderer org.component.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.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.component org.56 Log Log component is a visual console to display logs on JSF pages.log.Log org. 250 .primefaces.

</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.warn(‘Warning message’). PrimeFaces.info(‘Info message’). PrimeFaces. <script type=”text/javascript”> PrimeFaces.error(‘Error message’). for example you can use log component to see details of an ajax request.PrimeFaces Userʼs Guide <p:log /> Log API PrimeFaces uses client side log apis internally.debug(‘Debug message’).

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

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

primefaces.58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together. when set to false component will not be rendered.MegaMenu org.MegaMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.megamenu.component. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.component.primefaces.component org.MegaMenu org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class megaMenu org.MegaMenuRenderer org.megamenu. 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. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.component.

5. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.6.2"> <p:menuitem value="TV.4.3" </p:submenu> <p:submenu label="TV.2.2.5.3.2.3" </p:submenu> <p:submenu label="TV.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.2" <p:menuitem value="TV.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.5"> <p:menuitem value="TV.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 .2" </p:submenu> <p:submenu label="TV.6.1" <p:menuitem value="TV.4"> <p:menuitem value="TV. Getting Started with MegaMenu Layout of MegaMenu is grid based and root items require columns as children to define each section in a grid.1"> <p:menuitem value="TV.6.4.2" <p:menuitem value="TV.1. Style class of the component.2" <p:menuitem value="TV.3.2" </p:submenu> <p:submenu label="TV.1.3"> <p:menuitem value="TV.1" <p:menuitem value="TV.5.1" <p:menuitem value="TV.6"> <p:menuitem value="TV.1" <p:menuitem value="TV.

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

primefaces. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menu org.PrimeFaces Userʼs Guide 3. 257 .component.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. Name of the client side widget.primefaces.Menu org.primefaces. A menu model instance to create menu programmatically. Boolean value to specify the rendering of the component. Corner of menu to align with trigger element.MenuRenderer org.component org.Menu org.menu. ipod style sliding and overlays.component.menu.primefaces.component. Id of component whose click event will show the dynamic positioned menu.59 Menu Menu is a navigation component with various customized modes like multi tiers.component. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.

Easing type. Event to show the dynamic positioned menu. only applies to sliding menus. Defines positioning type of menu.youtube. <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.com" /> value="Metacafe" url="http://www.com" /> value="Youtube" url="http://www. Text for back link. Inline style of the main container element.google.com" /> value="Hotmail" url="http://www.myspace.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.com" /> value="Facebook" url="http://www.com" /> value="Break" url="http://www.facebook. Type of menu. valid values are plain.metacafe.hotmail. either static or dynamic.com" /> value="Yahoo Mail" url="http://mail.yahoo. Getting started with the Menu A menu is composed of submenus and menuitems. Style class of the main container element.com" /> 258 . tiered and sliding.com" /> value="MySpace" url="http://www.break.

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

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

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

see the main Skinning section for more information.ui-menu .ui-menuitem-text . 262 .ui-menu-list .ui-menuitem-link .PrimeFaces Userʼs Guide Style Class .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-menuitem .

binding widgetVar model style styleClass autoDisplay null null null null null FALSE Object String MenuModel String String Boolean 263 .Menubar org.MenubarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.component. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.primefaces.Menubar org.component org.MenubarRenderer org.60 Menubar Menubar is a horizontal navigation component. Boolean value to specify the rendering of the component. When set to false.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.menubar.PrimeFaces Userʼs Guide 3. click event is required to display.primefaces. when set to false component will not be rendered.primefaces.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menubar org.menubar.

logout}"/> </p:menubar> 264 . <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.hotmail.com" /> <p:menuitem value="Hotmail" url="http://www.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="Yahoo Mail" url="http://mail.google.youtube.break.yahoo. <p:menubar> <p:menuitem label="Logout" action="#{bean. <p:menubar> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.com" /> <p:menuitem value="Break" url="http://www.

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

menubutton.primefaces. Boolean value to specify the rendering of the component.component.component. binding value style styleClass widgetVar model disabled null null null null null null FALSE Object String String String String MenuModel Boolean 266 .MenuButton org.component org.PrimeFaces Userʼs Guide 3.MenuButtonRenderer org.61 MenuButton MenuButton displays different commands in a popup menu.primefaces.MenuButton org.primefaces.menubutton. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menuButton org.primefaces.primefaces. 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.component. An el expression that maps to a server side UIComponent instance in a backing bean.component. when set to false component will not be rendered.MenuButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.

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

primefaces.PrimeFaces Userʼs Guide 3.component.component.el.menuitem. Component id(s) to process partially instead of whole view.primefaces. Label of the menuitem Action listener to be invoked when menuitem is clicked. An el expression that maps to a server side UIComponent instance in a backing bean. 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.MethodE xpression Boolean String String String String String Boolean String 268 . action of this menuitem is processed after apply request phase. 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. Boolean value to specify the rendering of the component.62 MenuItem MenuItem is used by various menu components of PrimeFaces. Action to be invoked when menuitem is clicked.MenuItem org. Info Tag Tag Class Component Class Component Type Component Family menuItem org.MethodE xpression javax. ajax requests are not queued.menuitem.primefaces. When true. when set to false component will not be rendered.MenuItemTag org.el.primefaces.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.component.MenuItem org.

Javascript handler to execute when ajax request is completed. Javascript handler to execute when ajax request succeeds. you can either use bundled icons within PrimeFaces or provide your own via css. Global ajax requests are listened by ajaxStatus component. 269 . setting global to false will not trigger ajaxStatus. if not parent form is posted. Path of the menuitem image. Disables the menuitem. Specifies submit mode. Javascript handler to execute before ajax request is begins. This is decided by url attribute.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. Navigation vs Action Menuitem has two use cases. 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. 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. • • • • • • Menu MenuBar Breadcrumb Dock Stack MenuButton Note that some attributes of menuitem might not be supported by these menu components. Refer to the specific component documentation for more information. Javascript handler to execute when ajax request fails. Icons There are two ways to specify an icon of a menuitem. if it is present menuitem does a GET request.

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

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

‘warn’ and error. 272 . 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’. • icon : Only message severity is displayed and message text is visible as a tooltip.PrimeFaces Userʼs Guide Display Mode Message component has three different display modes. Skinning Message Full list of CSS selectors of message is as follows. • both (default) : Both icon and text are displayed. • text : Only message text is displayed. ‘error’.

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

Getting started with Messages Message usage is exactly same as standard messages. messages component is updated with each ajax request automatically. <p:messages /> AutoUpdate When auto update is enabled. ‘warn’ and error. 274 . 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. ‘error’. {severity} can be ‘info’.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. Skinning Message Full list of CSS selectors of message is as follows.

PrimeFaces Userʼs Guide 3. "fade". when set to false component will not be rendered.65 NotificationBar NotificationBar displays a multipurpose fixed positioned panel for notification. 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. panel is displayed on page load.component.component.primefaces.notificationbar.primefaces.NotificatonBar org. any content can be placed inside.primefaces. "top" or "bottom".notificationbar.primefaces. "slide" or "none". "normal" or "fast".NotificationBarRenderer org. 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.NotificationBar org. "slow". Name of the effect. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class notificationBar org.primefaces.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.component. When true.component org. <p:notificationBar widgetVar="topBar"> //Content </p:notificationBar> 275 . Speed of the effect.

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

transition effects and pojo support.component. when set to false component will not be rendered.primefaces.component.primefaces.component.OrderListRenderer org.component 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.primefaces.OrderList org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class orderList org.primefaces.OrderList org. binding value null null Object Object 277 .primefaces.component.PrimeFaces Userʼs Guide 3.orderlist.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.orderlist.

valid values are “left”. Message to be displayed when validation fields. Value of an item. “right” and “none”. Inline style of container element. Label of an item. Name of the client side widget. it must refer to a converter id When set true. Name of the iterator. Style class of container element. Disables the component. it’s resolved to a converter instance. Message to be displayed when conversion fails. Name of animation to display. When it’s an EL expression. Label of move bottom button. Location of the reorder buttons. 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 . process validations logic is executed at apply request values phase for this component. Label of move down button.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. Label of move up button. In case it’s a static text. Label of move top button. 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.

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

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

OutputPanelRenderer org.primefaces.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. 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. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax.outputpanel. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org.primefaces.component.primefaces. 281 . 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. OutputPanel is useful in this case.67 OutputPanel OutputPanel is a panel component with the ability to auto update. The problem is although partial output is generated.OutputPanel org.output.component.primefaces. the markup on page cannot be updated since it doesn’t exist. When a JSF component is not rendered. An el expression that maps to a server side UIComponent instance in a backing bean Style of the html container element StyleClass of the html container element Layout of the panel.primefaces. valid values are inline(span) or block(div). it is much simpler to update an existing element on page rather than inserting a new element to the dom. Enables auto update mode if set true.component org.component.OutputPanel org.PrimeFaces Userʼs Guide 3.component.

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

68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content. Inline style of the panel.overlaypanel.OverlayPanelRenderer org.OverlayPanel org.component.OverlayPanelRenderer org.primefaces.primefaces.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.component org. Identifier of the target component to attach the panel.primefaces. when set to false component will not be rendered.primefaces.component. Style class of the panel. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component.primefaces.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class overlayPanel org.component. binding widgetVar style styleClass for null null null null null Object String String String String 283 .overlaypanel.

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

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

PanelRenderer org.primefaces.PrimeFaces Userʼs Guide 3.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. 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 .component.primefaces. close and menu integration.component.Panel org. Speed of toggling in milliseconds Renders a toggleable panel as collapsed.primefaces.69 Panel Panel is a grouping component with content toggle.panel. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.panel.component org.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Header text Footer text Makes panel toggleable. when set to false component will not be rendered.component.component.Panel org.

primefaces.primefaces. facet will be used. </p:panel> Header and Footer Header and Footer texts can be provided by header and footer attributes or the corresponding facets. Tooltip for the close button.. Tooltip for the toggle button.event.event. When panel is closed. </p:panel> Ajax Behavior Events Panel provides custom ajax behavior events for toggling and closing features. <p:panel> //Child components here. Event toggle close Listener Parameter org.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. When same attribute and facet name are used.CloseEvent Fired When panel is expanded or collapsed.. 287 . <p:panel header="Header Text"> <f:facet name="footer"> <h:outputText value="Footer Text" /> </f:facet> //Child components here.ToggleEvent org. Speed of closing effect in milliseconds Renders panel as visible. Name of the client side widget Getting started with Panel Panel encapsulates other components... Tooltip for the menu button.

<p:panel closable="true"> //Child components here..ui-panel-titlebar-icon . an icon to display the menu is placed at top-right corner. see the main Skinning section for more information. <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. Following is the list of structural style classes.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.PrimeFaces Userʼs Guide Popup Menu Panel has built-in support to display a fully customizable popup menu.ui-panel-title . Style Class ..ui-panel-content . This feature is enabled by defining a menu component and defining it as the options facet.ui-panel . 288 .

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org.component.PrimeFaces Userʼs Guide 3.PanelGridRenderer org.primefaces.component.panelgrid.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.PanelGridRenderer org.primefaces.primefaces.PanelGrid org.70 PanelGrid PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean 289 binding null Object .component.panelgrid. when set to false component will not be rendered.component org.

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.firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname:" /> <p:inputText id="surname" 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.surname}" label="Surname"/> </p:panelGrid> Header and Footer PanelGrid provides facets for header and footer content. Comma separated list of column style classes.surname}" label="Surname"/> <f:facet name="footer"> <p:commandButton type="button" value="Save" icon="ui-icon-check" /> </f:facet> </p:panelGrid> 290 .firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname: *" /> <p:inputText id="surname" value="#{bean. <p:panelGrid columns="2"> <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. Style class of the panel.

ui-panelgrid . Following is the list of structural style classes. Footer. see the main Skinning section for more information. Style Class .PrimeFaces Userʼs Guide Rowspan and Colspan PanelGrid supports rowspan and colspan options as well. Header.ui-panelgrid-header .ui-panelgrid-footer Applies Main container element of panelGrid. <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. As skinning style classes are global. in this case row and column markup should be defined manually. 291 .

password.Password org. it must refer to a converter id When set true. it’s resolved to a converter instance.password. when set to false component will not be rendered.component.Password org.component.PrimeFaces Userʼs Guide 3.primefaces.PasswordRenderer org.component.primefaces.71 Password Password component is an extended version of standard inputSecret component with theme integration and strength indicator. process validations logic is executed at apply request values phase for this component. Marks component as required 292 binding value converter null null null Object Object Converter/ String immediate required FALSE FALSE Boolean boolean . In case it’s a static text.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.primefaces. When it’s an EL expression.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class password org.primefaces.

Name of the client side widget. A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Controls browser autocomplete behavior. Enables strength indicator. Access key that when pressed transfers focus to the input element. Code describing the language used in the generated markup for this component. Label of weak password. Message to be displayed when validation fields. Disables input field A localized user presentable name. Maximum number of characters that may be entered in this field. Message to be displayed when conversion fails. Alternate textual description of the input field. Client side callback to execute when input element loses focus. Valid values are LTR and RTL. Displays feedback inline rather than using a popup. Label of good password. 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. 293 . Label of prompt. Label of strong password. Id of another password component to match value against. Whether or not to display previous value. Direction indication for text that does not inherit directionality.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.

Position of the input element in the tabbing order. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when input element is double clicked. 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 . Client side callback to execute when input element receives focus. Client side callback to execute when a pointer button is moved onto input element. Advisory tooltip informaton. 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 input element is clicked. Client side callback to execute when a key is released over input element. Client side callback to execute when a key is pressed and released over input element. Number of characters used to determine the width of the input element. Flag indicating that this component will prevent changes by the user. 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 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 text within input element is selected by user.

<p:password id="pwd1" value="#{passwordBean. <p:password value="#{bean. you can provide custom labels as well.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" label="Password 2" required="true"/> 295 . if you prefer an inline indicator just enable inline mode. When feedback option is enabled a password strength indicator is displayed. <p:password value="#{bean. } public void setPassword(String password) { this.} I18N Although all labels are in English by default.password6}" feedback="false" match="pwd2" label="Password 1" required="true"/> <p:password id="pwd2" value="#{passwordBean. Following password gives feedback in Turkish.PrimeFaces Userʼs Guide Getting Started with Password Password is an input component and used just like a standard input text.password}" feedback="true|false" /> public class Bean { } private String password. <p:password value="#{mybean. The other password component’s id should be used to define the match option.password}" inline="true" feedback= "true"/> Confirmation Password confirmation is a common case and password provides an easy way to implement. public String getPassword() { return password.password = password.

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

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. 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.photocam.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.primefaces.PhotoCam org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org. 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 .primefaces. it’s resolved to a converter instance.72 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model. it must refer to a converter id When set true.PhotoCam org.photocam.PrimeFaces Userʼs Guide 3.primefaces. when set to false component will not be rendered. Message to be displayed when validation fields. process validations logic is executed at apply request values phase for this component.primefaces.PhotoCamRenderer org. Message to be displayed when conversion fails.component.component org. When it’s an EL expression.component.component.component. In case it’s a static text.

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pickList org.component. process validations logic is executed at apply request values phase for this component.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.component. 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 .component. In case it’s a static text. it’s resolved to a converter instance.primefaces.Panel org.PickList org.primefaces.component org.primefaces.PickListRenderer org.picklist.component.PrimeFaces Userʼs Guide 3. 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.73 PickList PickList is used for transferring data between two different collections.picklist.primefaces. When it’s an EL expression. it must refer to a converter id When set true.

Title of add button. Title of move bottom button. Name of the client side widget. Disables the component. Name of the animation to display. Specifies visibility of reorder buttons of source list. Speed of the animation. Title of add all button. A localized user presentable name. Specifies visibility of reorder buttons of target list. Value of an item. Specified if an item can be picked or not. Label of an item. Client side callback to execute when an item is transferred from one list to another. Title of move up button. Style of the main container. . Name of the iterator. Style class of the main container. Title of remove all button. Title of move down 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 remove button. Title of move top button. Message to be displayed when validation fields. Message to be displayed when conversion fails.

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

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

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

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

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

} public void setCount(int count) { this. polling starts automatically on page load. to start polling on demand set to false. } public int getCount() { return this.increment}" update="txt_count" /> public class CounterBean { } private int count. Stops polling when true.increment}" update="txt_count" interval="5" /> 306 .count}" /> <p:poll listener="#{counterBean. In autoStart mode.count = count.count}" /> <p:poll listener="#{counterBean. setting global to false will not trigger ajaxStatus. this is changed with the interval attribute.count. <h:outputText id="txt_count" value="#{counterBean. <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. Note that poll must be nested inside a form. } Tuning timing By default the periodic interval is 2 seconds. Following poll works every 5 seconds. public void increment() { 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.

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

<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. when set to false component will not be rendered. binding target null null Object String Getting started with the Printer Printer is attached to any command component like a button or a link. An el expression that maps to a server side UIComponent instance in a backing bean Id of the component to print.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.PrimeFaces Userʼs Guide 3. not the whole page.component.behavior.jpg" /> 308 . Info Tag Behavior Class printer org. Examples below demonstrates how to print a simple output text or a particular image on page.75 Printer Printer allows sending a specific JSF component to the printer.primefaces.

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.primefaces.component. Interval in seconds to do periodic requests in ajax mode.Progressbar org. 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 Name of the client side widget Value of the progress bar Disables or enables the progressbar Specifies the mode of progressBar.PrimeFaces Userʼs Guide 3.progressbar.component. 309 binding widgetVar value disabled ajax interval null null 0 FALSE FALSE 3000 Object String Integer Boolean Boolean Integer .76 ProgressBar ProgressBar is a process status indicator that can either work purely on client side or interact with server side using ajax.ProgressBar org.ProgressBarRenderer org. in ajax mode progress value is retrieved from a backing bean.primefaces.primefaces.progressbar.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class propressBar org.component.

} </script> Ajax Progress Ajax mode is enabled by setting ajax attribute to true.setValue(0).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 . "client"(default) or "ajax". Template of the progress label. Getting started with the ProgressBar ProgressBar has two modes.setValue(pbClient. Following is a pure client side progressBar.progress}" /> public class ProgressBean { } private int progress. <p:progressBar ajax="true" value="#{progressBean.progressInterval). Style class of the main container element. } function cancel() { clearInterval(this. in this case the value defined on a managed bean is retrieved periodically and used to update the progress.progressInterval = setInterval(function(){ pb. 2000). pb.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.

public void handleComplete() { //Add a faces message } //getter-setter <p:progressBar value="#{progressBean. 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.progress}" ajax="true"> <p:ajax event="complete" listener="#{progressBean. Example below demonstrates how to use this event.widget.handleComplete}" update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces. public class ProgressBean { } private int progress.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. use the interval attribute.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 .

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

component.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. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.component.primefaces. Getting Started with the Push See chapter 6. 313 .push.primefaces. Disconnects from channel.PrimeWebSocket Method void send(data) void connect() void close() Description Sends data in json format to push server.push.component. Client side callback to execute when data is pushed.primefaces.primefaces.77 Push Push component is an agent that creates a channel between the server and the client. Connects to the channel. "PrimeFaces Push" for detailed information.primefaces.component.Push org.PushRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class push org. Client side callback to execute when connection is closed. Connects to channel on page load when enabled.Push org. Client Side API of 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 org.widget.

component.component.radiobutton.78 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts. 314 .RadioButton org.primefaces.primefaces.component org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.primefaces. 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.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 Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Disabled the component.component. Index of the selectItem of selectOneRadio. Id of the selectOneRadio to attach to. Client side callback to execute on state change.primefaces. Inline style of the component. when set to false component will not be rendered.primefaces.RadioButtonRenderer org.RadioButton org.radiobutton. Style class of the container.

component. In case it’s a static text. 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 .component org.rating.Rating org.RatingRenderer org.primefaces. when true the events will be fired at "apply request values". Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rating 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. it’s resolved to a converter instance.component. if immediate is set to false.PrimeFaces Userʼs Guide 3.primefaces.rating.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.component.primefaces. When it’s an EL expression.79 Rating Rating component features a star based rating system. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed.primefaces. when set to false component will not be rendered.Rating org.

Name of the client side widget. <p:rating value="#{ratingBean. Getting Started with Rating Rating is an input component that takes a double variable as it’s value.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. Message to be displayed when validation fields. Message to be displayed when conversion fails. if you need less or more stars use the stars attribute. Number of stars to display Disabled user interaction Client side callback to execute when rate happens. Number of Stars Default number of stars is 5.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. 316 . set disabled to true. //getter-setter <p:rating value="#{ratingBean. public class RatingBean { } private double rating.rating}" /> When the enclosing form is submitted value of the rating will be assigned to the rating variable. Following rating consists of 10 stars.

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

RemoteCommand org.RemoteCommand org.component org.primefaces. Boolean value to specify the rendering of the component. 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 .primefaces. when set to false component will not be rendered. Javascript handler to execute when ajax request fails.primefaces. 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. when true actions are processed at apply_request_values.component. when false at invoke_application phase. ajax requests are not queued. Javascript handler to execute before ajax request is begins. Component(s) to update with ajax.component. Javascript handler to execute when ajax request succeeds.primefaces.primefaces.component.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.RemoteCommandRenderer org. Name of the command When set to true.remotecommand. Component(s) to process partially instead of whole view.80 RemoteCommand RemoteCommand provides a way to execute JSF backing bean methods directly from javascript.remotecommand. 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 remoteCommand org.PrimeFaces Userʼs Guide 3. Boolean value that determines the phaseId. Javascript handler to execute when ajax request is completed.component.

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

component. Maximum height boundary in pixels. Identifier of the target component to make resizable.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org. Effect to use in animation. In ghost mode.PrimeFaces Userʼs Guide 3.resizable. Defines if aspectRatio should be kept or not. when set to false component will not be rendered. Enables animation. Maximum height boundary in pixels. Displays proxy element instead of actual element.component.ResizableRenderer org.Resizable org.81 Resizable Resizable component is used to make another JSF component resizable.primefaces.primefaces.component.Resizable org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. resize helper is displayed as the original element with less opacity. Effect duration of animation.primefaces.component org.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.resizable. Maximum width boundary in pixels. Specifies the resize handles. Minimum width boundary in pixels.primefaces. 320 .

w. <p:graphicImage id="img" value="campnou. sw and nw as the value. Default value is "e.n.sw. if users need more space for a textarea. minHeight and maxHeight. Client side callback to execute after resizing end. make it resizable by. The valid values for these attributes are numbers in terms of pixels.w. Client side callback to execute when resizing begins. There’re 4 attributes for this minWidth. <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.se. maxWidth. ne. boundaries need to be specified.ne. Snaps resizing to grid structure. se. s. e. Client side callback to execute during resizing. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" handles="e. s.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. se".nw"/> 321 .jpg" /> <p:resizable for="img" /> Another example is the input fields. Getting started with Resizable Resizable is used by setting for option as the identifier of the target. <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.

By default actual element itself is the helper and two options are available to customize the way feedback is provided. • • • • • • • 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. Enabling ghost option displays the element itself with a lower opacity. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" proxy="true" /> . <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. In case you have a listener defined. Animation speed is customized using effectDuration option "slow". in addition enabling proxy option adds a css class called . it will be called by passing an org.event.PrimeFaces Userʼs Guide Visual Feedback Resize helper is the element used to provide visual feedback during resizing.handleResize}"> </p:resizable> 322 .ui-resizable-proxy { border: 2px dotted #00F. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area"> <p:ajax listener="#{resizeBean.primefaces. } Effects Resizing can be animated using animate option and setting an effect name. "normal" and "fast" as valid values.ui-resizable-proxy which you can override to customize.ResizeEvent instance as a parameter.

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

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

//getter&setter for players <p:ring value="#{ringBean. 8. "CM")). Player("Iniesta". 6. commandLink </p:column> </p:ring> Easing Following is the list of available options for easing animation.jpg".jpg". 7.players}" var="player”> <p:graphicImage value="/images/barca/#{player.PrimeFaces Userʼs Guide Getting started with Ring A collection is required to use the Ring component.jpg". "xavi.g. "CB")).add(new players. "iniesta.players}" var="player"> <p:column> //UI to select an item e. "CF")).add(new players. Player("Puyol". "puyol. Player("Xavi". } } players.add(new players.add(new Player("Messi".photo}"/> </p:ring> Item Selection A column is required to process item selection from ring properly. "messi. "villa. <p:ring value="#{ringBean. public class RingBean { private List<Player> players.jpg". "CF")). • • • • • • • 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 . public RingBean() { players = new ArrayList<Player>(). "CM")).add(new players.jpg". 10. 5. Player("Villa".

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

Info Tag Component Class Component Type Component Family row org.Row org.PrimeFaces Userʼs Guide 3.primefaces.primefaces.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.Row org.primefaces. 327 .83 Row Row is a helper component for datatable.row. 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 Row See datatable grouping section for more information about how row is used.component.

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowEditor org.primefaces.primefaces.84 RowEditor RowEditor is a helper component for datatable.component.primefaces.RowEditor org.component. 328 .component. 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.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 Userʼs Guide 3.component.primefaces.roweditor. when set to false component will not be rendered.roweditor.component org.RowEditor org.RowEditorRenderer org.

329 .PrimeFaces Userʼs Guide 3.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.primefaces.primefaces. Info Tag Component Class Component Type Component Family rowExpansion org.primefaces.RowExpansion org. when set to false component will not be rendered.component.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.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.component.

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.RowToggler org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.component. 330 .primefaces.primefaces.86 RowToggler RowToggler is a helper component for datatable. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.component org.component.RowTogglerRenderer org.rowtoggler.rowtoggler. 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.component.primefaces.primefaces.component.

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

Content of center of header. If ommitted. events are draggable.util. higher the value shorter the height is The view type to use.PrimeFaces Userʼs Guide Name aspectRatio view Default null month Type Float String Description Ratio of calendar width to height.TimeZone instance to specify the timezone used for date conversion. 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. 'agendaDay'. String or a java. First hour to display in day view. next today title month. events are resizable. timeFormat timeZone null null String Object 332 . 'agendaWeek'. Specifies visibility of header content. When true. Determines the time-text that will be displayed on the vertical axis of the agenda views. possible values are 'month'. initialDate null Object showWeekends style styleClass draggable resizable showHeader leftHeaderTemplate centerHeaderTemplate rightHeaderTemplate TRUE null null TRUE TRUE TRUE prev. Determines the time-text that will be displayed on each event. 'basicWeek'. 'basicDay' The initial date that is used when schedule loads. 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. Content of left side of header. Minimum time to display in a day view. Content of right side of header. agendaWeek. Maximum time to display in a day view.

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

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

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

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

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

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

component.component.88 ScrollPanel ScrollPanel is used to display overflowed content with theme aware scrollbars instead of native browsers scrollbars.ScrollPanelRenderer org.primefaces.primefaces.component org. valid values are default and native.PrimeFaces Userʼs Guide 3.scrollpanel.component. when set to false component will not be rendered. Scrollbar display mode. binding style styleClass mode null null null default Object String String String 339 .ScrollPanel org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class scrollPanel org.scrollpanel.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.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the container element.primefaces.primefaces.ScrollPanel org.component. Style class of the container element.

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

primefaces. it’s resolved to a converter instance.selectbooleanbutton.primefaces. it must refer to a converter id When set true.selectbooleanbutton.SelectBooleanButton org.primefaces.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. When it’s an EL expression. An el expression or a literal text that defines a converter for the component.component. process validations logic is executed at apply request values phase for this component.SelectBooleanButton 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 required validator valueChangeListener FALSE FALSE null null Boolean Boolean MethodExpr MethodExpr 341 . In case it’s a static text.component.component.primefaces.SelectBooleanButtonRenderer org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectBooleanButton org.component org.component.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.89 SelectBooleanButton SelectBooleanButton is used to select a binary decision with a toggle button. when set to false component will not be rendered.

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

When it’s an EL expression.component. it’s resolved to a converter instance.component.selectbooleancheckbox. process validations logic is executed at apply request values phase for this component.selectbooleancheckbox.SelectBooleanCheckboxRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectBooleanCheckbox org.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 Message to be displayed when required field validation fails. when set to false component will not be rendered.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.PrimeFaces Userʼs Guide 3. In case it’s a static text. An el expression or a literal text that defines a converter for the component.SelectBooleanCheckbox org.component org.90 SelectBooleanCheckbox SelectBooleanCheckbox is an extended version of the standard checkbox with theme integration.primefaces.primefaces. it must refer to a converter id When set true. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.component.primefaces.component.SelectBooleanCheckbox org. 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 .

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

primefaces.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.SelectCheckboxMenu org.SelectCheckboxMenu org.component org.selectcheckboxmenu.primefaces.SelectCheckboxMenuRenderer org.component. 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.91 SelectChecboxMenu SelectCheckboxMenu is a multi select component that displays options in an overlay.PrimeFaces Userʼs Guide 3. process validations logic is executed at apply request values phase for this component.component. In case it’s a static text.component. When it’s an EL expression. it must refer to a converter id When set true. it’s resolved to a converter instance. 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 .primefaces.selectcheckboxmenu.

Container of checkbox icon.ui-selectcheckboxmenu-item . Container of a checkbox. Height of the overlay.ui-selectcheckboxmenu-label-container . Option list container. Getting started with SelectCheckboxMenu SelectCheckboxMenu usage is same as the standard selectManyCheckbox or PrimeFaces selectCheckboxMenu components. Checkbox icon. As skinning style classes are global. Label container. Dropdown icon. Name of the client side widget.ui-selectcheckboxmenu-items .ui-chkbox . see the main Skinning section for more information. Label. Callback to execute on value change.ui-selectcheckboxmenu-label . Message to be displayed when conversion fails.ui-chkbox-box . Following is the list of structural style classes. Message to be displayed when validation fields. Style Class . Skinning SelectCheckboxMenu resides in a main container which style and styleClass attributes apply. Style class of the container. 346 Applies .ui-selectcheckboxmenu . Inline style of the component. Disables the component. Overlay panel.ui-selectcheckboxmenu-panel .ui-selectcheckboxmenu-trigger . User presentable name.ui-chkbox-icon Main container element. Each options in the collection.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.

process validations logic is executed at apply request values phase for this component.selectmanybutton. it must refer to a converter id When set true. it’s resolved to a converter instance.component.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.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyButton org.92 SelectManyButton SelectManyButton is a multi select component using button UI. In case it’s a static text. when set to false component will not be rendered.component org.SelectManyButton org.SelectManyButton org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.component.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 347 .PrimeFaces Userʼs Guide 3.component.SelectManyButton org.primefaces.primefaces.selectmanybutton. When it’s an EL expression.component.primefaces. An el expression or a literal text that defines a converter for the component.

Style Class . As skinning style classes are global.ui-selectmanybutton Main container element. Name of the client side widget. Applies 348 .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. Skinning SelectManyButton resides in a main container which style and styleClass attributes apply. User presentable name. Disables the component. Following is the list of structural style classes. Getting started with SelectManyButton SelectManyButton usage is same as selectManyCheckbox. Message to be displayed when validation fields. Inline style of the component. see the main Skinning section for more information. Message to be displayed when conversion fails. Callback to execute on value change. Style class of the container. buttons just replace checkboxes.

93 SelectManyCheckbox SelectManyCheckbox is an extended version of the standard SelectManyCheckbox with theme integration. process validations logic is executed at apply request values phase for this component. When it’s an EL expression.component. it must refer to a converter id When set true.primefaces.component org.PrimeFaces Userʼs Guide 3.selectmanycheckbox. it’s resolved to a converter instance. 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 .SelectManyCheckbox org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyCheckbox org.component.component.selectmanycheckbox. An el expression or a literal text that defines a converter for the component.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.component.primefaces.SelectManyCheckbox org. In case it’s a static text.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 Value of the component referring to a List.primefaces.primefaces.SelectManyCheckboxRenderer org.

Inline style of the component.ui-chkbox-box . Container of checkbox icon. Style Class . onchange style styleClass null null null String String String Getting started with SelectManyCheckbox SelectManyCheckbox usage is same as the standard one. Layout of the checkboxes.ui-chkbox-icon Main container element. Disables the component. Message to be displayed when conversion fails. Applies 350 . Container of a checkbox. see the main Skinning section for more information. Callback to execute on value change. Skinning SelectManyCheckbox resides in a main container which style and styleClass attributes apply.ui-selectmanycheckbox . Message to be displayed when validation fields. Following is the list of structural style classes.ui-chkbox . Checkbox icon. Style class of the container. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Name of the client side widget. User presentable name. As skinning style classes are global.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.

component.SelectManyMenu org. it’s resolved to a converter instance.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. When it’s an EL expression.primefaces.primefaces.SelectManyMenu org. In case it’s a static text.component org.primefaces. 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 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 351 .selectmanymenu. when set to false component will not be rendered.selectmanymenu.94 SelectManyMenu SelectManyMenu is an extended version of the standard SelectManyMenu with theme integration.component.PrimeFaces Userʼs Guide 3. An el expression or a literal text that defines a converter for the component. it must refer to a converter id When set true. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyMenu org.SelectManyMenuRenderer org.primefaces.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.

Style Class .ui-selectlistbox-item Main container element. Name of the client side widget. Following is the list of structural style classes. Message to be displayed when conversion fails. User presentable name. As skinning style classes are global. Inline style of the component.ui-selectmanymenu . Callback to execute on value change. Skinning SelectManyMenu resides in a container that style and styleClass attributes apply. Message to be displayed when validation fields. see the main Skinning section for more information. Style class of the container. Applies 352 . Each item in list.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. Getting started with SelectManyMenu SelectManyMenu usage is same as the standard one.

selectonebutton.PrimeFaces Userʼs Guide 3.primefaces. it’s resolved to a converter instance.component. process validations logic is executed at apply request values phase for this component. In case it’s a static text.SelectOneButton org.SelectOneButton org.component. When it’s an EL expression. when set to false component will not be rendered. 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 .primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneButton org.primefaces.95 SelectOneButton SelectOneButton is an input component to do a single select.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.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.component org.SelectOneButtonRenderer org. An el expression or a literal text that defines a converter for the component.primefaces.component.selectonebutton.component. it must refer to a converter id When set true.

ui-selectonebutton Main container element. Style Class . Getting started with SelectOneButton SelectOneButton usage is same as selectOneRadio component. Applies 354 . Name of the client side widget. buttons just replace the radios. Disables the component. Skinning SelectOneButton resides in a main container which style and styleClass attributes apply. Style class of the container. User presentable name. Message to be displayed when validation fields. Message to be displayed when conversion fails. Callback to execute on value change. Following is the list of structural style classes. see the main Skinning section for more information. As skinning style classes are global. Inline style of the 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.

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org.component. An el expression or a literal text that defines a converter for the component. when set to false component will not be rendered.component org.primefaces.PrimeFaces Userʼs Guide 3. When it’s an EL expression.primefaces.SelectOneListbox org.selectonelistbox. In case it’s a static text.component.primefaces.SelectOneListboxRenderer org.selectonelistbox. process validations logic is executed at apply request values phase for this component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.component.primefaces.component. 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.primefaces. it must refer to a converter id When set true. it’s resolved to a converter instance.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.96 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox with theme integration.

Getting started with SelectOneListbox SelectOneListbox usage is same as the standard one. Style Class .ui-selectonelistbox .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. Skinning SelectOneListbox resides in a main container which style and styleClass attributes apply. see the main Skinning section for more information. Applies 356 . Inline style of the component.ui-selectlistbox-item Main container element. Message to be displayed when conversion fails. User presentable name. Callback to execute on value change. Following is the list of structural style classes. Disables the component. As skinning style classes are global. Name of the client side widget. Each item in list. Style class of the container. Message to be displayed when validation fields.

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

When true. Message to be displayed when validation fields. Inline style of the component. default effect is blind and following options are available for effect attribute. input becomes editable. Name of the toggle animation.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. Height of the overlay. Style class of the container. Tabindex of the input. Duration of toggle animation in milliseconds. User presentable name. Name of the item iterator. • • • • • • • blind bounce clip drop explode fold highlight 358 . Disables the component. Effects An animation is executed to show and hide the overlay menu. Callback to execute on value change. Message to be displayed when conversion fails. Getting started with SelectOneMenu Basic SelectOneMenu usage is same as the standard one. Name of the client side widget.

"villa. public OrderListBean() { players = new ArrayList<Player>(). 10. "xavi.name} .add(new Player("Xavi".#{p. players. 7.selectedPlayer}" converter="player" var="p"> <f:selectItem itemLabel="Select One" itemValue="" /> <f:selectItems value="#{menuBean. 6.name}" itemValue="#{player}"/> <p:column> <p:graphicImage value="/images/barca/#{p.jpg")).add(new Player("Villa". "messi. players.players}" var="player" itemLabel="#{player. players.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. players.number} </p:column> </p:selectOneMenu> 359 . 8.add(new Player("Messi". public class MenuBean { private List<Player> players.jpg")). private Player selectedPlayer.photo}" width="40" height="50"/> </p:column> <p:column> #{p.jpg")).jpg")). } } //getters and setters <p:selectOneMenu value="#{menuBean. "iniesta.add(new Player("Iniesta".

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

primefaces.PrimeFaces Userʼs Guide 3.SelectOneRadioRenderer org. process validations logic is executed at apply request values phase for this 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. it’s resolved to a converter instance.primefaces.SelectOneRadio org. 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. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org.component. An el expression or a literal text that defines a converter for the component.component.primefaces. it must refer to a converter id When set true.primefaces.SelectOneRadio org.component.primefaces.98 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration. 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 . 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. When it’s an EL expression.selectoneradio.selectoneradio.component org.

Callback to execute on value change. This is implemented by setting layout option to custom and with standalone radioButton components. selectOneRadio itself does not render any output. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Name of the client side widget. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. Note that in custom mode. Inline style of the component. onchange style styleClass null null null String String String Getting started with SelectOneRadio SelectOneRadio usage is same as the standard one. Style class of the container. Disables 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.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. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. User presentable name. Message to be displayed when validation fields. Layout of the checkboxes.

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

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

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

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

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

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

primefaces.101 Slider Slider is used to provide input with various customization options like orientation. 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.component. "horizontal" or "vertical".component. 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 Id of the input text that the slider will be used for Id of the component to display the slider value. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.primefaces.slider. 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 .component org. display modes and skinning.slider.primefaces.PrimeFaces Userʼs Guide 3. Fixed pixel increments that the slider move in Disables or enables the slider.Slider org.component.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.primefaces.SliderRenderer org.component.Slider org.

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

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

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

ui-slider-horizontal .ui-slider-vertical .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. see the main Skinning section for more information. These attributes are handy to specify the dimensions of the slider. Disables slider.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Skinning Slider resides in a main container which style and styleClass attributes apply. Class .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. Following is the list of structural style classes.ui-slider . 373 . Enables slider.widget.

Spacer in this example separates this text <p:spacer width="100" height="10"> and <p:spacer width="100" height="10"> this text.spacer. 374 .primefaces.primefaces.SpacerRenderer org.Spacer org.spacer.102 Spacer Spacer is used to put spaces between elements.component. Width of the space. An el expression that maps to a server side UIComponent instance in a backing bean Advisory tooltip informaton.component.component.primefaces.Spacer org.primefaces. 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. Inline style of the spacer. Style class of the spacer.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.PrimeFaces Userʼs Guide 3.primefaces. Height of the space.component. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spacer org.component org.

spinner.primefaces.component.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.component.primefaces.103 Spinner Spinner is an input component to provide a numerical input via increment and decrement buttons. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spinner org.primefaces. when true the events will be fired at "apply request values". In case it’s a static text.SpinnerRenderer org. when set to false component will not be rendered. if immediate is set to false. 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. When it’s an EL expression.component org.component.PrimeFaces Userʼs Guide 3.spinner.component.Spinner org. 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 .primefaces.Spinner org. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed. it’s resolved to a converter instance.

Client side callback to execute when input element is clicked. 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. Disables input field A localized user presentable name. Message to be displayed when validation fields. Message to be displayed when conversion fails. Alternate textual description of the input field.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. 376 . 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. Controls browser autocomplete behavior. Maximum number of characters that may be entered in this field. Client side callback to execute when input element receives focus. Code describing the language used in the generated markup for this component. Name of the client side widget. Client side callback to execute when input element is double clicked. Direction indication for text that does not inherit directionality. Client side callback to execute when a key is pressed down over input element. Valid values are LTR and RTL.

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 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 onto 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. //getter and setter <p:spinner value="#{spinnerBean. 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.number}" /> 377 . Position of the input element in the tabbing order. Inline style of the input element. Flag indicating that this component will prevent changes by the user. Style class of the input element. 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. public class SpinnerBean { } private int number. Client side callback to execute when a pointer button is moved away from input element. Advisory tooltip informaton.

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

number}"> <p:ajax update="display" /> </p:spinner> <h:outputText id="display" value="#{spinnerBean. Following is the list of structural style classes. an ajax request is done to update the outputtext with new value whenever a spinner button is clicked.number}" /> Skinning Spinner resides in a container element that using style and styleClass applies.ui-spinner-button-up .ui-spinner-input . In example below. see the main Skinning section for more information.ui-spinner . 379 .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. <p:spinner value="#{spinnerBean.ui-spinner-button . Class .

component. Sets the behavior of the button. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class splitButton org. when set to false component will not be rendered. Boolean value that determines the phaseId. submit would be made with Ajax.splitbutton.component org.PrimeFaces Userʼs Guide 3. when true actions are processed at apply_request_values. when false at invoke_application phase.primefaces.component.component.SplitButtonRenderer org. when set to true(default). 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.splitbutton.104 SplitButton SplitButton displays a command by default and additional ones in an overlay. An actionlistener that’d be processed when button is clicked.primefaces.SplitButton org. Specifies the submit mode. 380 type ajax submit TRUE String Boolean .primefaces.component.primefaces.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.primefaces.SplitButton org.

Inline style of the button element. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Client side callback to execute when ajax request is completed. Defines whether to trigger ajaxStatus or not. Component(s) to be updated with ajax. Client side callback to execute when a key is released over button. Client side callback to execute when button is clicked. Client side callback to execute when a key is pressed and released over button. Client side callback to execute when button loses 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 a pointer button is moved away from button. Client side callback to execute when ajax request succeeds. Client side callback to execute when button is double clicked. 381 . Component(s) to process partially instead of whole view. Client side callback to execute when button receives focus. ajax requests are not queued. Client side callback to execute before ajax request is begins. Client side callback to execute when a key is pressed down over button. Client side callback to execute when a pointer button is moved onto button.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. StyleClass of the button element. Client side callback to execute when a pointer button is released over button. Client side callback to execute when a pointer button is moved within button.

Alternate textual description of the button. Valid values are LTR and RTL. Position of the icon. Getting started with SplitButton SplitButton usage is similar to a regular commandButton. Direction indication for text that does not inherit directionality. Code describing the language used in the generated markup for this component. Nested options defined as menuitems do ajax.org" icon="ui-icon-extlink"/> </p:splitButton> 382 . (deprecated: use icon) A localized user presentable name.delete}" ajax="false" icon="ui-icon-close"/> <p:separator /> <p:menuitem value="Homepage" url="http://www. non-ajax requests as well as regular navigation to an external url.update}" update="messages" icon="ui-icon-arrowrefresh-1-w"/> <p:menuitem value="Delete" actionListener="#{buttonBean. Additional commands are placed inside the component and displayed in an overlay.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.primefaces. clicking the save button invokes save method of the bean and updates messages. Position of the button element in the tabbing order. Flag indicating that this component will prevent changes by the user. Advisory tooltip information. Access key that when pressed transfers focus to the button. <p:splitButton value="Save" actionListener="#{buttonBean. Disables the button.save}" update="messages" icon="ui-icon-disk"> <p:menuitem value="Update" actionListener="#{buttonBean. Icon of the button as a css class. In example below. Name of the client side widget. Style class for the button icon.

ui-menuitem-link .ui-menu . Style Class .widget.ui-button-text-only . Following is the list of structural style classes.ui-button . Skinning SplitButton renders a container element which style and styleClass applies. Hides overlay. see the main Skinning section for more information.ui-menuitem-text Container element.ui-button-text .ui-menuitem .SplitButton Method show() hide() Params Return Type void void Description Displays overlay. 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.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-splitbutton .ui-splitbutton-menubutton .ui-menu-list . 383 .

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.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces. see menuitem to see how it is used Inline style of the submenu. Style class of the submenu. Boolean value to specify the rendering of the component. Label of the submenu header. Icon of a submenu.component.primefaces.submenu. 384 .105 Submenu Submenu is nested in menu components and represents a sub menu items.PrimeFaces Userʼs Guide 3.primefaces.Submenu org.Submenu org. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family submenu org. An el expression that maps to a server side UIComponent instance in a backing bean.component.

primefaces.PrimeFaces Userʼs Guide 3. Boolean value to specify the rendering of the component.stack. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org. Speed of the animation when opening the stack.component. when set to false component will not be rendered. MenuModel instance to create menus programmatically Whether to display stack as expanded or not. An optional image to contain stacked items.primefaces.component.Stack org.primefaces.stack.primefaces. Speed of the animation when opening the stack.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. An el expression that maps to a server side UIComponent instance in a backing bean.Stack org. 385 .106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.primefaces.StackRenderer org.component org.component. Name of the client side widget.

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

when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class subTable org.PrimeFaces Userʼs Guide 3.subtable.primefaces.component.SubTable org.107 SubTable SummaryRow is a helper component of datatable used for grouping.SubTable org. Getting started with SubTable See DataTable section for more information.primefaces.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.component. Name of the data iterator.subtable.component. 387 .primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Data of the component.primefaces.component.SubTableRenderer org.primefaces.component org.

component.108 SummaryRow SummaryRow is a helper component of datatable used for dynamic grouping.summaryrow.component. when set to false component will not be rendered.primefaces.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. to calculate totals).component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class summaryRow org.SummaryRow org.component. Getting started with SummaryRow See DataTable section for more information.SummaryRow org.PrimeFaces Userʼs Guide 3.summaryrow.component.g.primefaces. (e.primefaces. 388 . An el expression that maps to a server side UIComponent instance in a backing bean Method expression to execute before rendering summary row.primefaces.SummaryRowRenderer org.primefaces.

component. 389 .Tab org. Boolean value to specify the rendering of the component. when set to false component will not be rendered.primefaces.Tab org.primefaces.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces. Makes the tab closable when enabled. Style class of the tab. 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 Userʼs Guide 3. not all attributes may apply to the components that use tab. Info Tag Component Class Component Type Component Family tab org.component.109 Tab Tab is a generic container component used by other PrimeFaces components such as tabView and accordionPanel. Title text of the tab Inline style of the tab. As tab is a shared component.TabView. An el expression that maps to a server side UIComponent instance in a backing bean. Tooltip of the tab header.

component.component org.tabview.110 TabView TabView is a tabbed panel component featuring client side tabs. Boolean value to specify the rendering of the component. Duration of the transition effect. Name of the transition effect. tabview.primefaces.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.TabView org. Enables lazy loading of inactive tabs.TabViewRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.component.TabView org. 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 tabView org.primefaces.primefaces.primefaces. binding widgetVar activeIndex effect effectDuration dynamic null null 0 null null FALSE Object String Integer String String Boolean 390 . Variable name of the client side widget. Index of the active tab.primefaces.component. dynamic content loading with ajax and content transition effects.component.TabViewRenderer org.

391 . Inline style of the main container. Client side callback to execute when a tab is shown. caching only retrieves the tab contents once and subsequent toggles of a cached tab does not communicate with server. Orientation of tab headers. only the active tab contents are rendered and when an inactive tab header is selected. Dynamic mode is handy in reducing page size. 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. Name of iterator to refer an item in collection. To enable dynamic loading. pages will load faster.PrimeFaces Userʼs Guide Name cache Default TRUE Type Boolean Description When tab contents are lazy loaded by ajax toggleMode. non-dynamic (default) and dynamic. Collection model to display dynamic tabs. since inactive tabs are lazy loaded. <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. By default. If caching is turned off. Titles can also be defined by using “title” facet. simply set dynamic option to true. Style class of the main container. on the other hand in dynamic mode. Client side callback to execute when a tab is clicked. content is loaded with ajax. all tab contents are rendered to the client.

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

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

Following is the list of structural style classes. see the main Skinning section for more information.ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container 394 .ui-tabs . 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. 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.TabView.ui-tabs-nav . Class .widget.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.TagCloud org.primefaces.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.component.component.TagCloudRenderer org.component org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tagCloud org. Inline style of the container element.model}" /> 395 .primefaces.TagCloud org. Style class of the container element.primefaces.component.PrimeFaces Userʼs Guide 3. 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.tagcloud.111 TagCloud TagCloud displays a collection of tag with different strengths.primefaces. Backing tag cloud model. <p:tagCloud model="#{timelineBean.component.tagcloud. when set to false component will not be rendered.

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

terminal. when set to false component will not be rendered.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.TerminalRenderer org.component.primefaces. Primary prompt text. 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.primefaces.component. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.primefaces.primefaces.PrimeFaces Userʼs Guide 3.component.primefaces.Terminal org.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.component org.terminal.

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

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 . Duration of the animation in milliseconds. User presentable name. Disables the component.primefaces.ThemeSwitcher org.component org.primefaces.primefaces.themeswitcher. Inline style of the component. Name of the animation.ThemeSwitcher org.component.ThemeSwitcherRenderer org. when set to false component will not be rendered.component. Client side callback to execute on theme change.PrimeFaces Userʼs Guide 3.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.primefaces.component.themeswitcher. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces.113 ThemeSwitcher ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh.component.

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

<p:toolbar> <p:toolbarGroup align="left"> </p:toolbarGroup> <p:toolbarGroup align="right"> </p:toolbarGroup> </p:toolbar> 401 .toolbar.Toolbar org.component.primefaces.toolbar.component. when set to false component will not be rendered.114 Toolbar Toolbar is a horizontal grouping component for commands and other content.component.primefaces.component org.primefaces.ToolbarRenderer org.component.primefaces. 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.PrimeFaces Userʼs Guide 3.Toolbar org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class toolbar org.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. Style class of the container element.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the container element.

Here is an example.ui-toolbar-group-left .PrimeFaces Userʼs Guide Any number of components can be placed inside toolbarGroups. Following is the list of structural style classes. see the main Skinning section for more information.ui-toolbar-group-right Main container Divider in a toolbar Left toolbarGroup container Right toolbarGroup container Applies As skinning style classes are global. Additionally p:separator component can be used to separate items in toolbar. Style Class .ui-toolbar .ui-toolbar .ui-separator . <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. 402 .

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.PrimeFaces Userʼs Guide 3. 403 .primefaces.component.primefaces. 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. when set to false component will not be rendered. valid values are left and right. Inline style of the container element. Info Tag Component Class Component Type Component Family toolbarGroup org. An el expression that maps to a server side UIComponent instance in a backing bean Defines the alignment within toolbar. Style class of the container element.ToolbarGroup org.ToolbarGroup org.component.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders.toolbar.primefaces.

component.component.component org. 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 .primefaces.TooltipRenderer org.Tooltip org.component.tooltip.PrimeFaces Userʼs Guide 3. Effect to be used for hiding. events.primefaces.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.primefaces.component.Tooltip org.primefaces. Event hiding the tooltip. Effect to be used for displaying.primefaces. Event displaying the tooltip. it must refer to a converter id Name of the client side widget. In case it’s a static text. html content and advance theme support.116 Tooltip Tooltip goes beyond the legacy html title attribute by providing custom effects.tooltip. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tooltip org. 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.

<h:inputSecret id="pwd" value="#{myBean. Tooltip value can also be retrieved from target’s title. so following is same. If you need to change this behaviour use the showEvent and hideEvent feature. <h:inputSecret id="pwd" value="#{myBean. Inline style of the tooltip. Tooltip below is displayed when the input gets the focus and hidden with onblur.password}" /> <p:tooltip for="pwd" value="Password must contain only numbers" showEvent="focus" hideEvent="blur" showEffect="blind" hideEffect="explode" /> Available options for effects are.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. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide 405 . Style class of the tooltip.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.password}" /> <p:tooltip for="pwd" value="Only numbers"/> <h:inputSecret id="pwd" value="#{myBean. Getting started with the Tooltip Tooltip is used by attaching it to a target component.

ui-tooltip as a style class and is styled with global skinning selectors. An example is as follows.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. 406 . see main skinning section for more information.png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only . <h:outputLink id="lnk" value="#"> <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> <p:graphicImage value="/images/prime_logo.

tree.primefaces.component.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.TreeRenderer org.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tree org.component 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 Name of the client side widget.component.primefaces. Specifies the ajax/client toggleMode Specifies caching on dynamically loaded nodes.component.117 Tree Tree is is used for displaying hierarchical data and creating site navigations. Name of the request-scoped variable that'll be used to refer each treenode data.Tree org.Tree org.primefaces. A TreeNode instance as the backing model.tree. When set to true expanded nodes will be kept in memory.primefaces.primefaces. binding widgetVar value var dynamic cache null null null null FALSE TRUE Object String Object String Boolean Boolean 407 .

TreeNode array to reference the selections.0.TreeNode instance which corresponds to the root.0.model. node01). TreeNode node0 = new TreeNode("Node 0".0.0". TreeNode node10 = new TreeNode("Node 1. public class TreeBean { } private TreeNode root. node10).0". null). TreeNode node1 = new TreeNode("Node 1". root). public } TreeBean() { root = new TreeNode("Root".1".primefaces.0". root). node00).1". TreeNode node010 = new TreeNode("Node 0. <p:tree value="#{treeBean. node00).0".1. TreeNode node100 = new TreeNode("Node 1. node0).1". TreeNode node00 = new TreeNode("Node 0. root). node1). TreeNode node11 = new TreeNode("Node 1. TreeNode node000 = new TreeNode("Node 0. //getter Then specify a UI treeNode component as a child to display the nodes.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. TreeNode node001 = new TreeNode("Node 0. TreeNode node01 = new TreeNode("Node 0.0". node1). 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. node0). TreeNode node2 = new TreeNode("Node 2". TreeNode API has a hierarchical data structure and represents the data to be populated in tree.root}" var="node"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> 408 .

compared to the client toggling.primefaces. TreeNode API TreeNode has a simple API to use when building the backing model.TreeNode instances. You can bind a TreeNode to a particular p:treeNode using the type name. 409 . default type name is "default".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. tree will render that node as expanded. this mode is suitable for relatively small datasets and provides fast user interaction. Dynamic: Dynamic mode uses ajax to fetch the treenodes from server side on demand. On the otherhand it’s not suitable for large data since all the data is sent to the client.setExpanded(true) on a particular node.component. 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. When a node is expanded.primefaces. tree only loads the children of the particular expanded node and send to the client for display. <p:tree value="#{treeBean.model. In order to enable ajax toggling set dynamic setting to true. 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. on the other hand <p:treeNode /> tag represents a component of type org. Document Tree example in upcoming section demonstrates a sample usage.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.UITreeNode. For example if you call node.tree.

Suppose you’re using tree to visualize a company with different departments and different employees. 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="document" icon="ui-icon ui-icon-document"> <h:outputText value="#{doc.name}" /> </p:treeNode> <p:treeNode type="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc.PrimeFaces Userʼs Guide Multiple TreeNode Types It’s a common requirement to display different TreeNode types with a different UI (eg icon). In order to solve this. video). To begin with here is the final output.root}" var="doc"> <p:treeNode expandedIcon="ui-icon ui-icon-folder-open" collapsedIcon="ui-icon ui-icon-folder-collapsed"> <h:outputText value="#{doc. files each having a different formats (music. Following example demonstrates a document explorer. or a document tree with various folders. 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.name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <h:outputText value="#{doc. <p:tree value="#{bean.name}" /> </p:treeNode> </p:tree> 410 .

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

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

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

ui-tree . see the main Skinning section for more information. 414 .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. 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 .PrimeFaces Userʼs Guide ContextMenu Tree has special integration with context menu. Style Class .ui-tree-icon .ui-tree-nodes . Skinning Tree resides in a container element which style and styleClass options apply.ui-tree-node-content .

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. Expanded icon of the node.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.primefaces.primefaces. refer to sections of these components for more information.PrimeFaces Userʼs Guide 3.UITreeNode org.UITreeNode org.component. 415 .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.component. when set to false component will not be rendered.tree.118 TreeNode TreeNode is used with Tree component to represent a node in tree. Collapsed icon of the node. Info Tag Component Class Component Type Component Family treeNode org.

treetable.119 TreeTable Treetable is is used for displaying hierarchical data in tabular format.component.component.primefaces.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.primefaces. Name of the request-scoped variable used to refer each treenode.TreeTable org. 416 .primefaces.component. Name of the client side widget.treetable. when set to false component will not be rendered.component. Selection reference. An el expression that maps to a server side UIComponent instance in a backing bean A TreeNode instance as the backing model.primefaces. Inline style of the container element.component org.TreeTable org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class treeTable org. Style class of the container element.TreeTableRenderer org.PrimeFaces Userʼs Guide 3.primefaces.

model.root}" var="document"> <p:column> <f:facet name="header"> Name </f:facet> <h:outputText value="#{document. setters <p:treeTable value="#{bean. Height of scrollable data. Inline style of the table element. private String size. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. TreeTable is populated with an org. For an example. private String type. Description Whether or not the data should be scrollable.TreeNode instance that corresponds to the root node. Width of scrollable data.primefaces. //getters. Style class of the table element. Getting started with the TreeTable Similar to the Tree. public class Document { } private String name.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.name}" /> </p:column> <p:column> <f:facet name="header"> Size </f:facet> <h:outputText value="#{document. model to be displayed is a collection of documents.size}" /> </p:column> <p:column> <f:facet name="header"> Type </f:facet> <h:outputText value="#{document.type}" /> </p:column> </p:treeTable> 417 .

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

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

ui-watermark’.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> <h:commandButton value="Submit" /> <p:commandButton value="Submit" onclick="PrimeFaces. Note that this style class is not applied when watermark uses html5 placeholder if available.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.cleanWatermarks()" oncomplete="PrimeFaces. watermarks are cleared. by default in non-ajax form submissions. Watermark component is clever enough to handle this case. However ajax submissions requires a little manual effort. you can override this class to bring in your own style. This would result in updating bean properties with watermark values.showWatermarks()" /> Skinning There’s only one css style class applying watermark which is ‘. 420 . <h:inputText id="txt" value="#{bean.

primefaces.wizard. when set to false component will not be rendered. Server side listener to invoke when wizard attempts to go forward or back. Specifies visibility of default step title bar.component org. Wizard consists of several child tab components where each tab represents a step in the process. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.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.Wizard org. 421 .WizardRenderer org.primefaces.component. 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. Style class of the main wizard container element. Specifies visibility of default navigator arrows.wizard.121 Wizard Wizard provides an ajax enhanced UI to implement a workflow easily in a single page.Wizard org.component.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class wizard org.primefaces.component.component.

getFirstname()). Optimal scope for wizard is viewScope. Following wizard requires 3 steps to get the user data. "Welcome :" + user.user = user. To begin with create your backing bean. FacesContext. public class UserWizard { } private User user = new User(). 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. Address Details and Contact Details.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. public User getUser() { return user. Note that last tab contains read-only data for confirmation and the submit button. } User is a simple pojo with properties such as firstname.addMessage(null. } public void save(ActionEvent actionEvent) { //Persist user FacesMessage msg = new FacesMessage("Successful". Personal Details. 422 . Label of back navigation button. lastname. it’s important that the bean lives across multiple requests so avoid a request scope bean. Name of the client side widget Getting Started with Wizard Each step in the flow is represented with a tab. } public void setUser(User user) { this. email and etc.getCurrentInstance(). msg). Label of next navigation button. Javascript event handler to be invoked when flow goes forward.

user.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.info}"/> </h:panelGrid> </p:panel> </p:tab> 423 .user.user.firstname}" required="true"/> <h:outputText value="Lastname: *" /> <h:inputText value="#{userWizard.user.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.email}" required="true"/> <h:outputText value="Phone: " /> <h:inputText value="#{userWizard.postalCode}" /> <h:outputText value="City: " /> <h:inputText value="#{userWizard.user.user.user.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. value"> <h:outputText value="Street: " /> <h:inputText value="#{userWizard.street}" /> <h:outputText value="Postal Code: " /> <h:inputText value="#{userWizard.lastname}" required="true"/> <h:outputText value="Age: " /> <h:inputText value="#{userWizard.phone}"/> <h:outputText value="Additional Info: " /> <h:inputText value="#{userWizard.

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

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

widget.ui-wizard . Goes back in flow. Following is the list of structural css classes. 426 . Returns the index of current step.ui-wizard-navbar .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.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. see the main Skinning section for more information.ui-wizard-content . Skinning Wizard Wizard reside in a container element that style and styleClass attributes apply.ui-wizard-nav-back . Selector .Wizard Method next() back() getStepIndex() Params Return Type void void Number Description Proceeds to next step.

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

<h:form id="myform"> <p:commandButton update="myform:display" /> <h:outputText id="display" value="#{bean. 428 . galleria. composite components are naming containers. accordionPanel.value}"/> </h:form> ClientId It is also possible to define the client id of the component to update.com/javaee/6/api/javax/faces/component/UIComponent. <h:form id="form1"> <p:commandButton update=":form2:display" /> </h:form> <h:form id="form2"> <h:outputText id="display" value="#{bean.PrimeFaces Userʼs Guide <h:form prependId="false"> <p:commandButton update="display" /> <h:outputText id="display" value="#{bean. dataList. carousel.oracle.g. dataTable. 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.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. two forms). in addition tabView. dataGrid.html JSF h:form. sheet and subTable are PrimeFaces component that implement NamingContainer.value}"/> </h:form> Different NamingContainers If your page has different naming containers (e. http://docs. ring. datatable. note that this uses same search algorithm as standard JSF 2 implementation. Following is the suggested way using separator char as a prefix.

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

meaning if there is an ajaxStatus component present on page.PrimeFaces Userʼs Guide Global vs Non-Global By default ajax requests are global. 430 . An example with commandButton would be. set global to false. If you want to do a "silent" request not to trigger ajaxStatus instead. it is triggered.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.

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

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

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

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. Pushed data from JSF app is send to the push server which is then pushed to all connected clients.primefaces.PushServlet</servlet-class> <load-on-startup>1</load-on-startup> <init-param> <param-name>channels</param-name> <param-value>chat. 6. <servlet> <servlet-name>Push Servlet</servlet-name> <servlet-class>org. <context-param> <param-name>primefaces.1 Setup Push Server PrimeFaces Push uses a servlet as a dispatcher. PushServer and JSF application are two different applications.PrimeFaces Userʼs Guide 6.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.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.push.

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

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

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

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

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

ajax.ajax.} }).source:’userForm’ .process:’userForm’ .name}" /> .params:{ ‘param_name1’:’value1’.AjaxResponse PrimeFaces.PrimeFaces Userʼs Guide Examples Suppose you have a JSF page called createUser with a simple form and some input components. More complex example with additional options. More components </h:form> You can post all the information in form with ajax using.user. ‘param_name2’:’value2’ } . PrimeFaces.AjaxRequest({ formId:’userForm’ .update:’msgs’ . status) {alert(‘Done’).ajax.process:’userForm’ }). <h:form id="userForm"> <h:inputText id="username" value="#{userBean. 440 ..ajax.. PrimeFaces.oncomplete:function(xhr.AjaxResponse updates the specified components if any and synchronizes the client side JSF state. PrimeFaces.source:’userForm’ . 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.AjaxRequest({ formId:’userForm’. DOM updates are implemented using jQuery which uses a very fast algorithm. .

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

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

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

3 How Themes Work Powered by ThemeRoller. display type. Applies These classes are not aware of structural css like margins and paddings.ui-panel-titlebar structural class. Structural CSS These style classes define the skeleton of the components and include css properties such as margin. For example Panel component’s header section has the .ui-widget .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. PrimeFaces separates structural css from skinning css. 444 . dimensions and positioning. Skinning CSS Skinning defines the look and feel properties like colors.PrimeFaces Userʼs Guide 8.ui-state-disabled . background images. padding.ui-state-default . 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. to change the color of a panel header you don’t need to about this class as . Skinning Selectors ThemeRoller features a couple of skinning selectors. Highlighted elements. border colors.ui-widget-content .ui-state-highlight . An element to represent an icon.ui-widget-header .ui-widget-header also that defines the panel colors also applies to the panel header. mostly they only define colors. Selector .ui-state-active . most important of these are.ui-state-hover .

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

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

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

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

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.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. Provides the widgetVar of a component. Returns a boolean value if has all of the given roles or not.2 EL Functions PrimeFaces provides built-in EL extensions that are helpers to common use cases. Returns the name of the logged in user. 449 . Returns the principial instance of the logged in user.PrimeFaces Userʼs Guide 9. Returns a boolean value if has any of the given roles or not. 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.

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.

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

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

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

com/jsf/facelets" xmlns:p="http://primefaces.com.sun.playRed}" update="@parent" /> <p:commandButton value="BLACK" actionListener="#{gambitController.org/1999/xhtml" xmlns:h="http://java.amount}" /> <h:outputText value="Bet:" /> <h:inputText value="#{gambitController.prime.w3. 454 .xhtml <f:view xmlns="http://www.bet}" /> <p:commandButton value="RED" actionListener="#{gambitController.playBlack}" update="@parent" /> </h:panelGrid> </h:form> </f:view> PrimeFaces Team is in contact with PortletBridge team to improve the integration.com/jsf/html" xmlns:f="http://java.PrimeFaces Userʼs Guide edit.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.sun.com/jsf/core" xmlns:ui="http://java.sun.

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

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

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. 457 .2 Eclipse Code completion works out of the box for Eclipse when JSF facet is enabled.

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful