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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:calendar value="#{dateBean. 49 .date}" pattern=”MM/dd/yyyy HH:mm” /> Advanced Customization Use beforeShowDay javascript callback to customize the look of each date.date}" mode="inline" navigator="true" /> TimePicker TimePicker functionality is enabled by adding time format to your pattern. Following example disabled tuesdays and fridays. 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. The function returns an array with two values.PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly. <p:calendar value="#{dateBean.

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

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

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

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

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

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

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

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

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

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

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

when set to false component will not be rendered.primefaces. 61 .CellEditorRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.CellEditorRenderer org.component.CellEditor org.CellEditor org.component.celleditor.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.component org.celleditor.component.component.primefaces.primefaces. 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.11 CellEditor CellEditor is a helper component of datatable used for incell editing.PrimeFaces Userʼs Guide 3.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

addRecord(new ohlcModel.121.124.04. OhlcChartSeries(2012.143.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.139. <p:ohlcChart value="#{bean. public Bean() { model = new OhlcChartModel().81)).144.135.143.01.135.123.addRecord(new } //getter } OhlcChartSeries(2007.136.138.primefaces.124. OhlcChartSeries(2011.5)).134.79.122.129.135.88.140. <p:ohlcChart value="#{bean. OhlcChartSeries(2008.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .18.46.140. OhlcChartSeries(2010.142. OhlcChartSeries(2009.addRecord(new ohlcModel.82.132.7. public class Bean { private OhlcChartModel model.68.chart.4)).55.5.addRecord(new ohlcModel.144.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.76.9.53.139.addRecord(new ohlcModel.135.48)). ohlcModel.139.31.OhlcChartModel instance.addRecord(new ohlcModel.73.97)).56.57.136.136.67.addRecord(new ohlcModel.56. OhlcChartSeries(2012.66.44)).02)).139.model.143.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

97 .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. Following is the list of structural style classes.widget. Style Class .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.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-button .

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

Defines whether to trigger ajaxStatus or not. Position and shape of the hot spot on the screen for client use in image maps. Client side callback to execute when a key is pressed down over link. Client side callback to execute when a pointer button is moved within link. Client side callback to execute when link is clicked. Client side callback to execute when ajax request fails. Client side callback to execute when a key is pressed and released over link. Client side callback to execute when link receives focus.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 moved away from link. Client side callback to execute when a key is released over link. Client side callback to execute when ajax request succeeds. Client side callback to execute when a pointer button is released over link. Client side callback to execute when link is double clicked. 99 Boolean String String String String String String String String String String String String String String String String String . Character encoding of the resource designated by this hyperlink. 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 moved onto link. Client side callback to execute when a pointer button is pressed down over link. Access key that when pressed transfers focus to the link.

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

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

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

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

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

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Dashboard model instance representing the layout of the UI. Disables reordering feature.component org.Dashboard org. 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.component.primefaces. 107 .component.primefaces.PrimeFaces Userʼs Guide 3.dashboard.primefaces.component. when set to false component will not be rendered.primefaces. 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.dashboard.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.DashboardRenderer org.Dashboard org.

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

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

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

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

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

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

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

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

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

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

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

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

widget.ui-datagrid-content . 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. Table element containing data A row in grid A column in grid Applies As skinning style classes are global. 120 . Tips • DataGrid supports lazy loading data via LazyDataModel. Class . see the main Skinning section for more information.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-datagrid-data .ui-datagrid .ui-datagrid-column Main container element Content container. see DataTable lazy loading section.ui-datagrid-row . Following is the list of structural style classes.

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

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

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

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

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

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

127 . <p:dataTable var="car" value="#{carBean. Controls incell editing.manufacturer}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Color" /> </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.cars}"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </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.model}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Year" /> </f:facet> <h:outputText value="#{car.year}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Manufacturer" /> </f:facet> <h:outputText value="#{car.color}" /> </p:column> </p:dataTable> Header and Footer Both datatable itself and columns can have headers and footers.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DialogRenderer org.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.dialog.primefaces. Width of the dialog Height of the dialog Minimum width of a resizable dialog.Dialog org.primefaces.component.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org. 145 binding widgetVar header draggable resizable modal visible width height minWidth null null null TRUE TRUE FALSE FALSE auto auto 150 Object String String Boolean Boolean Boolean Boolean Integer Integer Integer . when set to false component will not be rendered.component.Dialog org. dialog is visible by default.28 Dialog Dialog is a panel component that can overlay other elements on page.component.primefaces.component.primefaces.primefaces.component org. 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. When enabled.dialog.

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

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

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

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

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

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

<p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I will be reverted back to my original position" /> </p:panel> <p:draggable for="pnl" revert="true"/> Opacity During dragging. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am 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. helper of following panel’s opacity is reduced in dragging. use a clone helper. if you need to keep the component at it’s original location. actual component is used as the drag indicator. opacity option can be used to give visual feedback. 152 . <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.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically. revert option enables the component to move back to it’s original position with an animation.

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

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

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

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

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

PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable. <p:graphicImage id="messi" value="barca/messi_thumb. Mode fit intersect pointer touch Description draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount Acceptance You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has.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.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. Following example has two images. 158 . only first image can be accepted by droppable.

Distance to enlarge. Horizontal alignment.component org. 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.dock. binding model position itemWidth maxWidth proximity halign widgetVar null null bottom 40 50 90 center null Object MenuModel String Integer Integer Integer String String 159 . bottom or top.primefaces.dock.30 Dock Dock component mimics the well known dock interface of Mac OS X.component.PrimeFaces Userʼs Guide 3. Name of the client side widget.primefaces.primefaces.Dock org.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.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.component.component.DockRenderer org.Dock org. Initial width of items.component. Maximum width of items.primefaces. when set to false component will not be rendered.

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

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

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

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

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

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

Use for option to specify a target.PrimeFaces Userʼs Guide <h:outputText value="#{bean. initially hidden graphicImage comes up with a fade effect. 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. When the link is clicked. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 . List of Effects Following is the list of effects supported by PrimeFaces.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. 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.jpg" style="display:none"/> With this setting.

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

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

primefaces. Makes content toggleable with animation.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. Toggle duration in milliseconds. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org.Fieldset org.component.Fieldset org.fieldset.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. Inline style of the fieldset.primefaces.component.34 Fieldset Fieldset is a grouping component as an extension to html fieldset. Defines initial visibility state of content. 169 binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null null null null null FALSE 500 FALSE Object String String String String Boolean Integer Boolean .component org.component.fieldset. Style class of the fieldset. when set to false component will not be rendered. Title text.primefaces.primefaces.FieldsetRenderer org.component.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. /> 182 . textarea and select.. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.primefaces.primefaces.Focus..Focus org. 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.FocusTag org.primefaces.PrimeFaces Userʼs Guide 3.component..focus.. when set to false component will not be rendered. <p:focus /> <p:inputText .37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.component..focus.FocusRenderer org.component.. Input component can be any element such as input.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. /> <h:inputText .component org. Minimum severity level to be used when finding the first invalid component binding for context minSeverity null null null error Object String String String Getting started with Focus By default focus will find the first enabled and visible input component on page and apply focus. /> <h:selectOneMenu .primefaces.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.GraphicImage org.graphicimage.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Binary data to stream or context relative path. 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.graphicimage.GraphicImageRenderer org.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.PrimeFaces Userʼs Guide 3.primefaces.41 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream.component org.component.component. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier. Alternate text for the image Alias to value attribute Width of the image Height of the image Title of the image Direction of the text displayed Language code Specifies to use a server-side image map Name of the client side map Style of the image 199 binding value alt url width height title dir lang ismap usemap style null null null null null null null null null FALSE null null Object Object String String String String String String String Boolean String String .GraphicImage org. when set to false component will not be rendered.component.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class graphicImage org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Shows display element and hides content.PrimeFaces Userʼs Guide Ajax Behavior Events Inplace editing is enabled via editor option.widget.Inplace Method show() hide() Params Return Type void void Description Shows content and hides display element. public class InplaceBean { private String text. 223 . //getter-setter } <p:inplace editor="true"> <h:inputText value="#{inplaceBean. } public void handleSave() { //add faces message with update text value } //getter-setter <p:inplace editor="true"> <p:ajax event="save" listener="#{inplaceBean. public class InplaceBean { private String text.handleSave}" update="msgs" /> <h:inputText value="#{inplaceBean.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.

Main container element when disabled. see the main Skinning section for more information.ui-inplace-cancel Applies Main container element. Triggers an ajax request to revert inplace input.ui-inplace-display .ui-inplace-editor . Skinning Inplace resides in a main container element which style and styleClass options apply.ui-inplace-save .ui-inplace-disabled . Triggers an ajax request to process inplace input. Editor controls container. Style Class . Following is the list of structural style classes. Inline content. 224 . Cancel button.ui-inplace-content . As skinning style classes are global. Save button. Display element.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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:menubar> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www. <p:menubar> <p:menuitem label="Logout" action="#{bean.hotmail.com" /> <p:menuitem value="Yahoo Mail" url="http://mail.youtube.com" /> <p:menuitem value="Break" url="http://www. nest submenus in parent submenus.com" /> </p:submenu> </p:menubar> Nested Menus To create a menubar with a higher depth.google.yahoo.break.PrimeFaces Userʼs Guide Getting started with Menubar Submenus and menuitems as child components are required to compose the menubar.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.com" /> <p:menuitem value="Hotmail" url="http://www. <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.logout}"/> </p:menubar> 264 .

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

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

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

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

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

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

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

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

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

Getting started with Messages Message usage is exactly same as standard messages. <p:messages /> AutoUpdate When auto update is enabled. 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. messages component is updated with each ajax request automatically. ‘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. ‘warn’ and error. 274 .

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

<p:notificationBar widgetVar="topBar"> //Content </p:notificationBar> <h:outputLink value="#" onclick="topBar.ui-notificationbar-close Main container element Close icon element 276 Applies .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. bar will not scroll. <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.ui-notificationbar . notificationBar provides an easy to use client side api that can be accessed through the widgetVar. set effect name to "none". Effects Default effect to be used when displaying and hiding the bar is "fade". Selector . 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. other possibility is placing the bar at the bottom of the page. Note that bar positioning is fixed so even page is scrolled. "slow" or "fast" as it’s value. Position Default position of bar is "top".show()">Show</h:outputLink> <h:outputLink value="#" onclick="topBar. isVisible() and toggle() are additional client side api methods. another possible effect is "slide".

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

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

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

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

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.primefaces. 281 .primefaces.primefaces. 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.component.output. Enables auto update mode if set true.67 OutputPanel OutputPanel is a panel component with the ability to auto update.component.primefaces.outputpanel.OutputPanel org. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax. 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. The problem is although partial output is generated.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.component. OutputPanel is useful in this case.OutputPanel org. 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org.component.PrimeFaces Userʼs Guide 3.component org.OutputPanelRenderer org. the markup on page cannot be updated since it doesn’t exist. when set to false component will not be rendered.

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

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

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

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

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

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

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

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

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

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

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

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

Advisory tooltip informaton. 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 . Position of the input element in the tabbing order. Client side callback to execute when a key is pressed down over input element. Inline style of the input element. 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 released over input element. Client side callback to execute when input element is double clicked. Flag indicating that this component will prevent changes by the user.PrimeFaces Userʼs Guide Name onchange Default null Type String Description Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when a key is released over input element. Client side callback to execute when text within input element is selected by user. Client side callback to execute when input element receives focus. Style class of the input element. Client side callback to execute when a pointer button is moved onto input element. Number of characters used to determine the width of the input element. Client side callback to execute when input element is clicked. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element.

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

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

primefaces.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. when set to false component will not be rendered.PhotoCamRenderer org. it’s resolved to a converter instance.primefaces.component.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. process validations logic is executed at apply request values phase for this component. it must refer to a converter id When set true.PhotoCam org.72 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model.primefaces. When it’s an EL expression. 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 .component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails.component.PhotoCam org.primefaces. Message to be displayed when validation fields.photocam.photocam. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org. In case it’s a static text.PrimeFaces Userʼs Guide 3.primefaces.component org.

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

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

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

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

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

command.from //toList = e.item //fromList = e.toList //type = e. <p:pickList value="#{pickListBean. dblclick or dragdrop) } </script> Captions Caption texts for lists are defined with facets named sourceCaption and targetCaption. normal and fast. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide effectSpeed attribute is used to customize the animation speed. onTransfer If you’d like to execute custom javascript when an item is transferred bind your javascript function to onTransfer attribute. default effect is fade and following options are available to be applied using effect attribute. <p:pickList value="#{pickListBean. valid values are slow.type (type of transfer.cities}" var="city" itemLabel="#{city}" itemValue="#{city}" onTransfer="handleTransfer(e)"> <script type="text/javascript"> function handleTransfer(e) { //item = e.PrimeFaces Userʼs Guide Effects An animation is displayed when transferring when item to another or reordering a list.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-button-add Applies Main container element(table) of picklist Lists of a picklist Source list Target list Container element of source list reordering controls Container element of target list reordering controls Buttons of a picklist Move up button Move top button Move down button Move bottom button Add button Add all button Remove all button Add button As skinning style classes are global.ui-picklist-button-add-all .ui-picklist-button-remove-all .ui-picklist-button-move-down .ui-picklist-list .ui-picklist-button-add .ui-picklist-target-controls .ui-picklist-source-controls . Style Class . Following is the list of structural style classes.ui-picklist-list-source .ui-picklist-button-move-bottom . 304 .ui-picklist .ui-picklist-button-move-up . see the main Skinning section for more information.ui-picklist-button .ui-picklist-list-target .ui-picklist-button-move-top .PrimeFaces Userʼs Guide Skinning PickList resides in a main container which style and styleClass attributes apply.

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

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

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

component. binding target null null Object String Getting started with the Printer Printer is attached to any command component like a button or a link.primefaces. 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. An el expression that maps to a server side UIComponent instance in a backing bean Id of the component to print. when set to false component will not be rendered.behavior.jpg" /> 308 . not the whole page. Info Tag Behavior Class printer org.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. <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.

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

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

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

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

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

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

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

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

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

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

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

primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org. Displays proxy element instead of actual element. when set to false component will not be rendered.primefaces. Maximum height boundary in pixels.81 Resizable Resizable component is used to make another JSF component resizable.Resizable 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.component org. Minimum width boundary in pixels.component.component. Maximum height boundary in pixels.primefaces.primefaces. 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. Identifier of the target component to make resizable.Resizable org. Effect to use in animation. Maximum width boundary in pixels. In ghost mode.component.resizable.ResizableRenderer org.primefaces. Defines if aspectRatio should be kept or not. 320 . Enables animation. Specifies the resize handles.PrimeFaces Userʼs Guide 3. Effect duration of animation.

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

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

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

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

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

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. Applies 326 . Style Class .ui-ring-item Main container element.ui-ring . Each item in the list.

primefaces.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. 327 .primefaces.primefaces.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.83 Row Row is a helper component for datatable.Row org. Info Tag Component Class Component Type Component Family row org.Row org.component.row. 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.

roweditor.roweditor.RowEditorRenderer org.primefaces.RowEditor org.component.component org. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with RowEditor See inline editing section in datatable documentation for more information about usage.RowEditor org.component.primefaces.primefaces.component.PrimeFaces Userʼs Guide 3.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowEditor org.84 RowEditor RowEditor is a helper component for datatable.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. when set to false component will not be rendered.primefaces. 328 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.component. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 345 .primefaces. it must refer to a converter id When set true.component. when set to false component will not be rendered. In case it’s a static text.SelectCheckboxMenu org.selectcheckboxmenu.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectCheckboxMenu org.primefaces.SelectCheckboxMenuRenderer org.selectcheckboxmenu. 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. process validations logic is executed at apply request values phase for this component.component. it’s resolved to a converter instance.91 SelectChecboxMenu SelectCheckboxMenu is a multi select component that displays options in an overlay.SelectCheckboxMenu org.primefaces. An el expression or a literal text that defines a converter for the component.primefaces.component. When it’s an EL expression.PrimeFaces Userʼs Guide 3.

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

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

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

93 SelectManyCheckbox SelectManyCheckbox is an extended version of the standard SelectManyCheckbox with theme integration.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 org. it’s resolved to a converter instance.SelectManyCheckbox org. When it’s an EL expression.primefaces.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyCheckbox org.primefaces.selectmanycheckbox.selectmanycheckbox.SelectManyCheckboxRenderer org.component.component. process validations logic is executed at apply request values phase for this component. it must refer to a converter id When set true. In case it’s a static text.primefaces. An el expression or a literal text that defines a converter for the component.SelectManyCheckbox org.component. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener FALSE null null Boolean MethodExpr MethodExpr 349 . 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. when set to false component will not be rendered.component.

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

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

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

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

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

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

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

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

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

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

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

component.selectoneradio. it must refer to a converter id When set true.PrimeFaces Userʼs Guide 3. In case it’s a static text.primefaces. it’s resolved to a converter instance.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.selectoneradio.component. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. 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.primefaces.SelectOneRadio org.component. when set to false component will not be rendered.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org. 361 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener requiredMessage FALSE null null null Boolean MethodExpr MethodExpr String .98 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.primefaces.component org.primefaces.primefaces.SelectOneRadio org. process validations logic is executed at apply request values phase for this component. An el expression or a literal text that defines a converter for the component.SelectOneRadioRenderer org.

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

selectOneRadio component should be placed above any radioButton that points to the selectOneRadio.ui-radiobutton-icon Main container element. Radio button icon.ui-selectoneradio .ui-radiobutton . Skinning SelectOneRadio resides in a main container which style and styleClass attributes apply. Container of a radio button. As skinning style classes are global. Container of radio button icon. Following is the list of structural style classes. Style Class . see the main Skinning section for more information. Applies 363 .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.

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

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

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

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

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

primefaces.primefaces. Fixed pixel increments that the slider move in Disables or enables the slider.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.component.SliderRenderer org. 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.101 Slider Slider is used to provide input with various customization options like orientation.Slider org. when set to false component will not be rendered. Minimum value of the slider Maximum value of the slider Inline style of the container element Style class of the container element Boolean value to enable/disable the animated move when background of slider is clicked Sets the type of the slider.PrimeFaces Userʼs Guide 3.primefaces. display modes and skinning.Slider org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.component.slider.primefaces. 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.component.slider. "horizontal" or "vertical".component.primefaces.

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

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

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

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

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

primefaces.spinner. when true the events will be fired at "apply request values". it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed.component org.Spinner org. In case it’s a static text.component.component.Spinner org.SpinnerRenderer org. if immediate is set to false.primefaces.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. 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 .component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spinner org. When it’s an EL expression.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.spinner.103 Spinner Spinner is an input component to provide a numerical input via increment and decrement buttons.primefaces.primefaces. it’s resolved to a converter instance. 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 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. Code describing the language used in the generated markup for this component. 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. Client side callback to execute when input element is clicked. Maximum number of characters that may be entered in this field. Disables input field A localized user presentable name. Valid values are LTR and RTL. 376 . Message to be displayed when conversion fails. Alternate textual description of the input field. Name of the client side widget. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Direction indication for text that does not inherit directionality. Message to be displayed when validation fields. Client side callback to execute when input element is double clicked. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when input element receives focus. Controls browser autocomplete behavior. Client side callback to execute when input element loses focus.

//getter and setter <p:spinner value="#{spinnerBean. 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. Advisory tooltip informaton. public class SpinnerBean { } private int number.number}" /> 377 .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. Inline style of the input element. Getting Started with Spinner Spinner is an input component and used just like a standard input text. Style class of the input element. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when a pointer button is moved onto input element. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a key is released over input element. Number of characters used to determine the width of the input element. Client side callback to execute when a pointer button is moved away from input element. Position of the input element in the tabbing order.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TabView. Method select(index) selectTab(index) Params index: Index of tab to display index: Index of tab to display Return Type void void Description Activates tab with given index (Deprecated.ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container 394 .ui-tabs-nav . 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. see the main Skinning section for more information.widget. Following is the list of structural style classes.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-tabs . Class .

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

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

primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load.primefaces. when set to false component will not be rendered.terminal. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.component org.component.component.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.PrimeFaces Userʼs Guide 3.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.primefaces. Primary prompt text.Terminal org.TerminalRenderer org.primefaces.component. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .primefaces.terminal.

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

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

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

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

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

component. binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used. 403 .ToolbarGroup org. Inline style of the container element.primefaces.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders. when set to false component will not be rendered.toolbar.ToolbarGroup org. valid values are left and right. An el expression that maps to a server side UIComponent instance in a backing bean Defines the alignment within toolbar.primefaces.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.component.primefaces. Style class of the container element.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family toolbarGroup 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 .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. Event hiding the tooltip. it must refer to a converter id Name of the client side widget.primefaces. when set to false component will not be rendered. events.Tooltip org.component.TooltipRenderer org.116 Tooltip Tooltip goes beyond the legacy html title attribute by providing custom effects.Tooltip org. html content and advance theme support.component.PrimeFaces Userʼs Guide 3. Effect to be used for displaying. it’s resolved to a converter instance. When it’s an EL expression. Effect to be used for hiding.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tooltip 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.tooltip.component.component.primefaces.primefaces. In case it’s a static text.primefaces.tooltip.primefaces. Event displaying the tooltip.

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

see main skinning section for more information.ui-tooltip as a style class and is styled with global skinning selectors. 406 . 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.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.

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

1. node0). TreeNode node01 = new TreeNode("Node 0.0.0".0. Style of the main container element of tree Style class of the main container element of tree Defines the selectionMode Getting started with the Tree Tree is populated with a org.0". TreeNode array to reference the selections. node00). TreeNode node001 = new TreeNode("Node 0.1".0". TreeNode node00 = new TreeNode("Node 0. root).model. null). public class TreeBean { } private TreeNode root. TreeNode node100 = new TreeNode("Node 1. <p:tree value="#{treeBean. TreeNode node0 = new TreeNode("Node 0". root). node01).TreeNode instance which corresponds to the root. node1). root). TreeNode node10 = new TreeNode("Node 1. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. //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.1". node1). TreeNode node11 = new TreeNode("Node 1. public } TreeBean() { root = new TreeNode("Root". node00).0". TreeNode node010 = new TreeNode("Node 0.primefaces.0. TreeNode node1 = new TreeNode("Node 1". node10).0".1". TreeNode node2 = new TreeNode("Node 2". node0). TreeNode node000 = new TreeNode("Node 0.root}" var="node"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> 408 .

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

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="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc. Following example demonstrates a document explorer. <p:tree value="#{bean. 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. Suppose you’re using tree to visualize a company with different departments and different employees. In order to solve this.name}"/> </p:treeNode> <p:treeNode type="document" icon="ui-icon ui-icon-document"> <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). files each having a different formats (music. or a document tree with various folders.name}" /> </p:treeNode> </p:tree> 410 .name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <h:outputText value="#{doc. video). 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.

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

When a node is unselected.event.primefaces. When a node is selected..toString(). 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. Selection should be a TreeNode for single case and an array of TreeNodes for multiple and checkbox cases.getTreeNode(). Selection Node selection is a built-in feature of tree and it supports three different modes. } public void onNodeExpand(NodeExpandEvent event) { String node = event.getData().onNodeSelect}" /> <p:ajax event="expand" listener="#{treeBean. </p:tree> public void onNodeSelect(NodeSelectEvent event) { String node = event.toString().onNodeExpand}" /> <p:ajax event="collapse" listener="#{treeBean.getTreeNode().getData().NodeSelectEvent org.model}" dynamic="true"> <p:ajax event="select" listener="#{treeBean.NodeExpandEvent org.onNodeCollapse}" /> .getTreeNode().event. multiple: Multiple nodes can be selected.primefaces. selection should be a TreeNode reference. The idea for implementing such a use case would be providing only the root and child nodes to the tree. <p:tree value="#{treeBean.event. checkbox: Multiple selection is done with checkbox UI.toString().primefaces. selection should be a TreeNode[] reference.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.event. selection should be a TreeNode[] reference. } public void onNodeCollapse(NodeCollapseEvent event) { String node = event. Event expand collapse select collapse Listener Parameter org.getData()..primefaces. single: Only one at a time can be selected.NodeCollapseEvent org. } Event listeners are also useful when dealing with huge amount of data. When a node is collapsed. 412 . Following tree has three listeners.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<h:form id="form1"> <p:commandButton update=":form2:display" /> </h:form> <h:form id="form2"> <h:outputText id="display" value="#{bean.value}"/> </h:form> Please read findComponent algorithm described in link below used by both JSF core and PrimeFaces to fully understand how component referencing works. dataList. two forms). datatable.oracle. note that this uses same search algorithm as standard JSF 2 implementation. 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. ring. galleria. http://docs. <h:form id="myform"> <p:commandButton update="myform:display" /> <h:outputText id="display" value="#{bean.g. accordionPanel.value}"/> </h:form> Different NamingContainers If your page has different naming containers (e. dataGrid.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. 428 . dataTable.PrimeFaces Userʼs Guide <h:form prependId="false"> <p:commandButton update="display" /> <h:outputText id="display" value="#{bean. Following is the suggested way using separator char as a prefix. sheet and subTable are PrimeFaces component that implement NamingContainer. carousel. composite components are naming containers. in addition tabView.html JSF h:form.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Provides the widgetVar of a component. Common Functions Function component(‘id’) widgetVar(‘id’) Component <h:form id="form1"> <h:inputText id="name" /> </h:form> //#{p:component(‘name’)} returns ‘form1:name’ Description Returns clientId of the component with provided server id parameter. Returns the principial instance of the logged in user.PrimeFaces Userʼs Guide 9. 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’)}. 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.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. This function is useful if you need to work with javascript. Returns the name of the logged in user. 449 .2 EL Functions PrimeFaces provides built-in EL extensions that are helpers to common use cases.

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_READER’)}" /> <p:commandButton rendered="#{p:ifAnyGranted(‘ROLE_ADMIN. ROLE_EDITOR’)}" /> <p:commandButton rendered="#{p:ifNotGranted(‘ROLE_GUEST’)}" /> <h:outputText value="Welcome: #{p:remoteUser}" /> 450 .

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

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

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

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

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

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

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.

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful