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

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

W-JAX.About the Author Çağatay Çivici is a member of JavaServer Faces Expert Group. Çağatay is also an author and technical reviewer of a couple books regarding web application development with Java and JSF. the company he cofounded in Turkey. JSFSummit.x and JPA. he has trained over 300 developers on Java EE technologies mainly JSF. . JAX. 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. Jazoon. Çağatay is currently working as a principal consultant for Prime Teknoloji. As an experienced trainer. EJB 3. Spring. JSFDays. He’s a recognized speaker in international conferences including SpringOne.

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

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

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

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

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

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

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

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

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

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

<p:ajaxStatus> <f:facet name="start"> <p:graphicImage value="ajaxloading. prestart: Before ajax request is sent.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. • • • • • • default: Initially visible when page is loaded. <p:ajaxStatus> <f:facet name="prestart"> <h:outputText value="Starting. Start facet will be visible once ajax request begins and stay visible until it’s completed. start: After ajax request begins.. complete: When everything finishes. success: When ajax response is received without error. Most common used facets are start and complete. Once the ajax response is received start facet becomes hidden and complete facet shows up. error: When ajax response is received with error.PrimeFaces Userʼs Guide Getting Started with AjaxStatus AjaxStatus uses facets to represent the request status.." /> </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. There is an ajax loading gif bundled with PrimeFaces which you can use.PrimeFaces Userʼs Guide Custom Events Facets are the declarative way to use. fn) void Binds a function to an event Skinning AjaxStatus is equipped with style and styleClass.widget. <p:ajaxStatus onstart="alert(‘Start’)" oncomplete="alert(‘End’)"/> A comman usage of programmatic approach is to implement a custom status dialog. facetId: Element id of facet container eventName: Name of status event. fn: function to bind Return Type void Description Binds a facet to an event bindCallback(eventName.show()" oncomplete="status. 23 .. if you’d like to implement advanced cases with scripting you can take advantage of on* callbacks which are the event handler counterparts of the facets. Components like commandButton has an attribute (global) to control triggering of AjaxStatus.height:32px" . Styling directly applies to a container element which contains the facets. Provide a fixed width/height to the ajaxStatus to prevent page layout from changing.AjaxStatus Method bindFacet(eventName.. /> Tips • • • • Avoid updating ajaxStatus itself to prevent duplicate facet/callback bindings.hide()"/> <p:dialog widgetVar="status" modal="true" closable="false"> Please Wait </p:dialog> Client Side API Widget: PrimeFaces. <p:ajaxStatus onstart="status. <p:ajaxStatus style="width:32px.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

date}" mode="popup" showOn="button" /> Popup Icon Only <p:calendar value="#{dateBean.date}" mode="popup" showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month. 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.PrimeFaces Userʼs Guide showOn option defines the client side event to display the calendar. <p:calendar value="#{dateController.date}" pages="3"/> 46 . This feature is tuned with the pages attribute.

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

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

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

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

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

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

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

<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.captcha. Corresponding keys are.INVALID primefaces. Summary Detail primefaces. this can be easily overridden by the JSF message bundle mechanism.PrimeFaces Userʼs Guide Themes Captcha features following built-in themes for look and feel customization. <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. 54 .com/recaptcha/learnmore to learn more about how reCaptcha works.captcha.google. • See http://www.INVALID_detail Tips • Use label option to provide readable error messages in case validation fails. Below is a captcha with Turkish text.

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

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

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

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

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

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

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

12 Charts Charts are used to display graphical data. 62 binding widgetVar value style styleClass title legendPosition seriesColors diameter sliceMargin fill null null null null null null null null null 0 TRUE Object String ChartModel String String String String String Integer Integer Boolean .1 Pie Chart Pie chart displays category-data pairs in a pie graphic.chart.component.chart. 3.12.primefaces.primefaces.primefaces.PieChart org.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.chart.component.PieChart org.pie.primefaces. Title of the chart. bar. Style class of the chart. Comma separated list of colors in hex format.primefaces. auto computed by default. Render solid slices. Position of the legend. when set to false component will not be rendered.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pieChart org.PieChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.pie. Gap between slices.component org. line and more.PieChartRenderer org. There’re various chart types like pie.component. Diameter of the pie.chart.

model}" legendPosition=”w” /> 63 . Displays data on each slice. public class Bean { } private PieChartModel model. model.set("Brand 4". model. 540). public } Bean() { model = new PieChartModel().set("Brand 1". 325). 421).set("Brand 2".model. 702).primefaces. public PieChartModel getModel() { return model.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. Specifies interactive legend.PieChartModel instance. Getting started with PieChart PieChart is created with an org. Format of data labels. model.set("Brand 3". model. } <p:pieChart value="#{bean.

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

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

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

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

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

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

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

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

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

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

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

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

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

component. Label of the y-axis.primefaces. Position of the legend.primefaces.PrimeFaces Userʼs Guide 3.OhlcChart org.primefaces.component.component.chart. Angle of the x-axis ticks. Title of the chart. Specifies interactive legend.primefaces. Style class of the chart.component org. Angle of the y-axis ticks. 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 . Enables candle stick display mode.ohlc. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.OhlcChart org.chart.component.ohlc. Label of the x-axis. Comma separated list of colors in hex format.chart.12.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.chart.primefaces.OhlcChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.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.

143. <p:ohlcChart value="#{bean.136.OhlcChartModel instance.138.addRecord(new ohlcModel.135.4)).73.139.31.04.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.135. OhlcChartSeries(2009.121.44)).82.122.68.143.56.addRecord(new ohlcModel.129.79.136.139.primefaces.136.addRecord(new ohlcModel.66.57.67.53.02)). OhlcChartSeries(2011.142.addRecord(new ohlcModel.135.81)). ohlcModel.01.144.addRecord(new ohlcModel.chart.46.139.140. public class Bean { private OhlcChartModel model.7.9.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.124.18. <p:ohlcChart value="#{bean.56. OhlcChartSeries(2012.144. public Bean() { model = new OhlcChartModel(). OhlcChartSeries(2010.97)).model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 . OhlcChartSeries(2008.140.134.143.5)).model.132.88.76.5.addRecord(new } //getter } OhlcChartSeries(2007. OhlcChartSeries(2012.55.123.124.135.139.48)).addRecord(new ohlcModel.

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

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

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

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

83 .PrimeFaces Userʼs Guide 3. see the JFreeChart integration example at graphicImage section. jFreeChart If you like to use static image charts instead of canvas based charts.12.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. Note that static images charts are not rich as PrimeFaces chart components and you need to know about jFreeChart apis to create the charts.

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-button-text-only .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. Style Class . Following is the list of structural style classes. 97 .widget.ui-button .CommandButton Method disable() enable() Params Return Type void void Description Disables button Enables button Skinning CommandButton renders a button tag which style and styleClass applies.

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

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

Boolean String String rev null String shape tabindex target title type null null null null null String Integer String String String Getting Started with CommandLink CommandLink is used just like the standard h:commandLink. values are provided by a space-separated list of link types. Valid values are LTR and RTL. 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. circle and poly.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. A reverse link from the anchor specified by this link to the current document. Relationship from the current document to the anchor specified by the link. Disables the link Languae code of the resource designated by the link. rect. difference is form is submitted with ajax by default. 100 . valid values are default.saveBook}"> <h:outputText value="Save" /> </p:commandLink> Skinning CommandLink renders an html anchor element that style and styleClass attributes apply. Advisory tooltip information. Position of the button element in the tabbing order. Name of a frame where the resource targeted by this link will be displayed.

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

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

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

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

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

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

primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Dashboard model instance representing the layout of the UI.dashboard.component.DashboardRenderer org.dashboard.Dashboard org.primefaces.primefaces. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities. 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.component. Disables reordering feature.primefaces.DashboardRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.component org.component.primefaces.Dashboard org. 107 .

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

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

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

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

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

Exporter below ignores first column. 113 .6"). Same solution applies to data export as well. set pageOnly to true. See FileDownload Monitor Status section to find out how monitor export process. <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.2.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. to exclude more than one column define the indexes as a comma separated string (excludeColumns="0. if you’d like export only the data displayed on current page.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model}" /> </f:facet> <f:facet name="input"> <h:inputText value="#{car. Clicking tick icon only saves that particular row and cancel icon reverts the changes. 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.cars}"> <f:facet name="header"> In-Cell Editing </f:facet> <p:column headerText="Model"> <p:cellEditor> <f:facet name="output"> <h:outputText value="#{car. 137 . both options are implemented with ajax. <p:dataTable var="car" value="#{carBean.model}"/> </f:facet> </p:cellEditor> </p:column> //more columns with cell editors <p:column> <p:rowEditor /> </p:column> </p:dataTable> When pencil icon is clicked. row is displayed in editable mode meaning input facets are displayed and output facets are hidden. 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.

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

model}"> #{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.year} </p:column> <p:column headerText="Manufacturer" sortBy="#{car.color}"> #{car.manufacturer}"> #{car.color} </p:column> <p:summaryRow> <p:column colspan="3" style="text-align:right"> Total: </p:column> <p:column> #{tableBean.manufacturer} </p:column> <p:column headerText="Color" sortBy="#{car.randomPrice}$ </p:column> </p:summaryRow> </p:dataTable> 139 .cars}" sortBy="#{car.manufacturer}" sortOrder="descending"> <p:column headerText="Model" sortBy="#{car.model} </p:column> <p:column headerText="Year" sortBy="#{car.year}"> #{car.

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

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

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

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

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

PrimeFaces Userʼs Guide 3.primefaces.dialog.component.28 Dialog Dialog is a panel component that can overlay other elements on page.primefaces.DialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Width of the dialog Height of the dialog Minimum width of a resizable dialog.dialog.Dialog org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.primefaces.Dialog 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. dialog is visible by default. 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 .primefaces.component org.primefaces.component. when set to false component will not be rendered.component. When enabled.DialogRenderer org.

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

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

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. Following is the list of structural style classes.primefaces. If there is a listener defined it’ll be executed by passing an instace of org.widget. Closes dialog. <p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)"> //Content </p:dialog> Client Side API Widget: PrimeFaces. Skinning Dialog resides in a main container element which styleClass option apply. <p:dialog> <p:ajax event="close" listener="#{dialogBean.event.Dialog Method show() hide() Params Return Type void void Description Displays dialog.CloseEvent. 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. 148 .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.

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

Id of the component to add draggable behavior Disables draggable behavior when true.Draggable org.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org. when set to false component will not be rendered.primefaces.29.dnd.component. Specifies a draggable that can’t be dropped.PrimeFaces Userʼs Guide 3.component.Draggable org.component. 3.primefaces. Specifies drag axis.component org.dnd.primefaces.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.DraggableRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Displays a proxy element instead of actual element. Draggable and Droppable. 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 .DraggableRenderer org.component. valid values are ‘x’ and ‘y’.

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

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

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

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

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

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

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

jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. <p:graphicImage id="messi" value="barca/messi_thumb. 158 .PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable.jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. only first image can be accepted by droppable. Following example has two images. 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.

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

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

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

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

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

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

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

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

Following example animates messages with pulsate effect after ajax request completes.action}" update="messages"/> 167 .value}"> <p:effect type="scale" event="mouseover"> <f:param name="percent" value="90"/> </p:effect> </h:outputText> It’s important to provide string options with single quotes. duration and more. provide these parameters with the f:param tag. <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.value}"> <p:effect type="blind" event="click"> <f:param name="direction" value="'horizontal'" /> </p:effect> </h:outputText> For the full list of configuration parameters for each effect. please see the jquery documentation. http://docs. <h:outputText value="#{bean.PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors.jquery. <h:outputText value="#{bean. In order to change the configuration of the animation.com/UI/Effects Effect on Load Effects can also be applied to any JSF component when page is loaded for the first time or after an ajax request is completed by using load as the event name.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

Label to be shown in display mode.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. Effect to be used when toggling. when set to false component will not be rendered. Label to be shown in display mode when value is empty.component.primefaces.primefaces.component.inplace.component.component org.primefaces.Inplace org.48 Inplace Inplace provides easy inplace editing and inline content display.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inplace org. Inplace consists of two members. 221 binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor null null null null fade normal FALSE null null FALSE Object String String String String String Boolean String String Boolean . Style class of the main container element. Prevents hidden content to be shown. Speed of the effect.Inplace org. Specifies the editor mode. Inline style of the main container element.InplaceRenderer org.primefaces.primefaces.inplace.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. display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting started with Log Log component is used simply as adding the component to the page.Log org.Log org.primefaces.component org. 250 .56 Log Log component is a visual console to display logs on JSF pages.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. when set to false component will not be rendered.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.log.primefaces.primefaces.component.log.component.LogRenderer org.

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

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

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

component org.MegaMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces.component.MegaMenu org.primefaces.component.megamenu.primefaces.megamenu.58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together.component.primefaces.MegaMenu org. Name of the client side widget MenuModel instance to create menus programmatically binding widgetVar model null null null Object String MenuModel 254 .primefaces.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.MegaMenuRenderer org. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class megaMenu org.component.

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

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

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

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

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

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

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

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

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

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

ui-menuitem-link . see the main Skinning section for more information.PrimeFaces Userʼs Guide Ajax and Non-Ajax Actions As menu uses menuitems. Style Class . List container Each menu item Anchor element in a link item Text element in an item As skinning style classes are global. See menuitem documentation for more information about the capabilities.org"/> </p:submenu> </p:menubar> Dynamic Menus Menus can be created programmatically as well.ui-menubar .ui-menuitem-text Applies Container element of menubar.update}" ajax="false"/> <p:menuitem value="Navigate" url="http://www. 265 .primefaces.save}" update="comp"/> <p:menuitem value="Update" actionListener="#{bean. 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-menuitem . <p:menubar> <p:submenu label="Options"> <p:menuitem value="Save" actionListener="#{bean.ui-menu-list .

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

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

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

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

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

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

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

only facesmessages with no clientIds are displayed. 273 binding showSummary showDetail globalOnly null FALSE TRUE FALSE Object Boolean Boolean String .component.component.Messages org.MessagesRenderer org.primefaces.Messages org.component org.primefaces.MessagesRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.component.messages.messages.component. Specifies if the detail of the FacesMessages should be displayed. Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class messages org.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.primefaces.primefaces.64 Messages Messages is a pre-skinned extended version of the standard JSF messages component. When true.primefaces. Specifies if the summary of the FacesMessages should be displayed.

<p:messages /> AutoUpdate When auto update is enabled. Getting started with Messages Message usage is exactly same as standard messages. ‘error’. 274 . Style Class ui-messages-{severity} ui-messages-{severity}-summary ui-messages-{severity}-detail ui-messages-{severity}-icon Applies Container element of the message Summary text Detail text Icon of the message. Skinning Message Full list of CSS selectors of message is as follows. messages component is updated with each ajax request automatically. {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. ‘warn’ and error.

component.primefaces.NotificatonBar org.notificationbar.primefaces. Speed of the effect. "slide" or "none". when set to false component will not be rendered. When true.component.primefaces. panel is displayed on page load.PrimeFaces Userʼs Guide 3. Name of the effect.primefaces. 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.component.notificationbar.component. "top" or "bottom". any content can be placed inside.NotificationBarRenderer org. <p:notificationBar widgetVar="topBar"> //Content </p:notificationBar> 275 .component org. An el expression that maps to a server side UIComponent instance in a backing bean Style of the container element StyleClass of the container element Position of the bar. "normal" or "fast". "fade". "slow".65 NotificationBar NotificationBar displays a multipurpose fixed positioned panel for notification.NotificationBar org. 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.primefaces.

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

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

In case it’s a static text. process validations logic is executed at apply request values phase for this component. Location of the reorder buttons. When it’s an EL expression. Name of the client side widget. Value of an item. Label of move down button. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Inline style of container element. it’s resolved to a converter instance. Name of the iterator. valid values are “left”. 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 .PrimeFaces Userʼs Guide Name converter Default null Type Converter/String Description An el expression or a literal text that defines a converter for the component. Message to be displayed when conversion fails. Label of move bottom button. Label of an item. Disables the component. it must refer to a converter id When set true. Name of animation to display. Label of move up button. Style class of container element. Label of move top button. Message to be displayed when validation fields. “right” and “none”.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-picklist-button-move-down .ui-picklist-button .ui-picklist-button-add-all .ui-picklist-button-move-top . Following is the list of structural style classes.PrimeFaces Userʼs Guide Skinning PickList resides in a main container which style and styleClass attributes apply.ui-picklist-button-move-bottom .ui-picklist-list .ui-picklist-button-remove-all .ui-picklist-button-add .ui-picklist-list-target .ui-picklist-list-source . Style Class .ui-picklist-source-controls .ui-picklist-target-controls . see the main Skinning section for more information.ui-picklist .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. 304 .ui-picklist-button-move-up .

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

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

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

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

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

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

handleComplete}" update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces.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 . Example below demonstrates how to use this event.progress}" ajax="true"> <p:ajax event="complete" listener="#{progressBean. use the interval attribute.PrimeFaces Userʼs Guide Interval ProgressBar is based on polling and 3000 milliseconds is the default interval for ajax progress bar meaning every 3 seconds progress value will be recalculated. public class ProgressBean { } private int progress. <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. In order to set a different value. public void handleComplete() { //Add a faces message } //getter-setter <p:progressBar value="#{progressBean.widget.

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

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

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

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

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

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

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

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

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

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

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

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

Collection to display.primefaces.Ring org. binding widgetVar value var style styleClass easing null null null null null null swing Object String Object String String String String 324 .primefaces.ring.component org. Name of the data iterator.RingRenderer org.RingRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Inline style of the container element.component. Type of easing to use in animation. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ring org.ring.component.primefaces.primefaces. Style class of the container element.82 Ring Ring is a data display component with a circular animation.component.primefaces.Ring org.component. when set to false component will not be rendered.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.

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

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

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

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

RowExpansion org.primefaces.component. Info Tag Component Class Component Type Component Family rowExpansion 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 binding null Object Getting Started with RowExpansion See datatable expandable rows section for more information about how rowExpansion is used. 329 .component.rowexpansion.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.PrimeFaces Userʼs Guide 3.primefaces.RowExpansion org.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.

RowToggler org.component.rowtoggler. 330 . 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.primefaces. when set to false component will not be rendered.RowToggler org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.PrimeFaces Userʼs Guide 3.component org.86 RowToggler RowToggler is a helper component for datatable.primefaces.component.RowTogglerRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component.rowtoggler.primefaces.RowTogglerRenderer org.primefaces.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

In case it’s a static text. process validations logic is executed at apply request values phase for this component.primefaces.primefaces.selectoneradio. it’s resolved to a converter instance. 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 .primefaces.primefaces.component.SelectOneRadio org.component. when set to false component will not be rendered.98 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.primefaces.SelectOneRadio org. 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.SelectOneRadioRenderer org. When it’s an EL expression. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org.selectoneradio. An el expression or a literal text that defines a converter for the component.SelectOneRadioRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. 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. it must refer to a converter id When set true.component.component.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Tooltip value can also be retrieved from target’s title. so following is same. If you need to change this behaviour use the showEvent and hideEvent feature. Inline style of the tooltip. <h:inputSecret id="pwd" value="#{myBean. Style class of the tooltip. Tooltip below is displayed when the input gets the focus and hidden with onblur. <h:inputSecret id="pwd" value="#{myBean.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="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.password}" /> <p:tooltip for="pwd" value="Only numbers"/> <h:inputSecret id="pwd" value="#{myBean. Getting started with the Tooltip Tooltip is used by attaching it to a target component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

PrimeFaces Userʼs Guide THE END 460 .