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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BlockUI org.primefaces.PrimeFaces Userʼs Guide 3.blockui. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class blockUI org.component org.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.component.BlockUI org.component. 33 .primefaces.BlockUIRenderer org.primefaces.component.primefaces.blockui.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.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-datepicker td .ui-datepicker-prev .ui-datepicker-month .Calendar Method getDate() setDate(date) disable() enable() Params date: Date to display Return Type Date void void void Description Return selected date Sets display date Disables calendar Enables calendar Skinning Calendar resides in a container element which style and styleClass options apply.ui-datepicker .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-title .PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.ui-datepicker-header .widget. ''] } Client Side API Widget: PrimeFaces.ui-datepicker-table .   return [(day != 2 && day != 5).ui-datepicker-week-end .getDay().ui-datepicker-next . Following is the list of structural style classes.ui-datepicker-other-month . Style Class .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.component. Maximum boundary value. Title of the chart.chart.component.primefaces. Margin of bars. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org. Padding of bars. Style class of the chart.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.12.chart.3 Bar Chart Bar chart visualizes one or more series of data using bars.bar. Position of the legend.primefaces.chart. valid values are “vertical” and “horizontal”.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 . Enables stacked display of bars.chart.component.BarChart org.BarChartRenderer org.component org.component.BarChart org.bar. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.primefaces.PrimeFaces Userʼs Guide 3. Minimum boundary value. Orientation of bars.

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

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

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

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

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

Displays labels on buttons.BubbleChart 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org. Label of the x-axis.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.chart.component.primefaces.PrimeFaces Userʼs Guide 3.primefaces.component. Shows shadow or not.chart. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. Comma separated list of colors in hex format.BubbleChartRenderer org.bubble.chart.primefaces.bubble.chart.primefaces. Specifies interactive legend.component org.component. Title of the chart. Position of the legend.12.BubbleChart org.primefaces. Style class of the chart.BubbleChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Alpha transparency of a bubble.component.

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

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

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

68.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .addRecord(new ohlcModel. OhlcChartSeries(2011.138. public Bean() { model = new OhlcChartModel().144.5)).136.chart.79.88.134.5. public class Bean { private OhlcChartModel model.44)).04.139.132.67. <p:ohlcChart value="#{bean.addRecord(new ohlcModel.53. OhlcChartSeries(2009.addRecord(new ohlcModel.124.97)).140.135.136. OhlcChartSeries(2010.addRecord(new } //getter } OhlcChartSeries(2007.135.56.addRecord(new ohlcModel.model.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org. ohlcModel.139.73.129.144.7.31.136.46.primefaces. <p:ohlcChart value="#{bean.82.140.143.123.55.121.143.66.OhlcChartModel instance.124.addRecord(new ohlcModel.18.122.addRecord(new ohlcModel.76. OhlcChartSeries(2012.01.142.139.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.143.48)).9.56.81)).135.4)). OhlcChartSeries(2012.139.57.02)).135. OhlcChartSeries(2008.

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

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

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

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

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

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

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

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

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

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

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

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

91 .column. Name of iterator to access a column.component.primefaces.component. 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.16 Columns Columns is used by datatable to create columns programmatically. 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. Inline style of the column.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Name of iterator to access a column index.PrimeFaces Userʼs Guide 3.Columns org.Columns org.primefaces. Style class of the column. when set to false component will not be rendered.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. <p:dashboard model="#{dashboardBean. Here is an example based on a different theme. Following is the list of structural style classes.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 . Tips • Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets. Style Class .PrimeFaces Userʼs Guide New Widgets Draggable component is used to add new widgets to the dashboard.ui-dashboard-column div. see the main Skinning section for more information.

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

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

Exporter below ignores first column. set pageOnly to true.2. Same solution applies to data export as well.PrimeFaces Userʼs Guide Excel export <p:commandButton value="Export as Excel" ajax="false"> <p:dataExporter type="xls" target="tableId" fileName="cars"/> </p:commandButton> PDF export <p:commandButton value="Export as PDF" ajax="false" > <p:dataExporter type="pdf" target="tableId" fileName="cars"/> </p:commandButton> CSV export <p:commandButton value="Export as CSV" ajax="false" > <p:dataExporter type="csv" target="tableId" fileName="cars"/> </p:commandButton> XML export <p:commandButton value="Export as XML" ajax="false" > <p:dataExporter type="xml" target="tableId" fileName="cars"/> </p:commandLink> PageOnly By default dataExporter works on whole dataset.6"). if you’d like export only the data displayed on current page. <p:dataExporter type="pdf" target="tableId" excludeColumns="0"/> Monitor Status DataExport is a non-ajax process so ajaxStatus component cannot apply. to exclude more than one column define the indexes as a comma separated string (excludeColumns="0. 113 . <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. See FileDownload Monitor Status section to find out how monitor export process.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public CarBean() { populateColumns(). } public void populateColumns() { columns = new ArrayList(). It requires a collection as the value.add(cars).model}" /> <br /> <h:outputText value="#{cars[colIndex]. populateCars().dynamicCars}" id="carsTable"> <p:columns value="#{tableBean.color}"/> </p:columns> </p:dataTable> public class CarBean { } private List<String> columns. private List<Car[]> dynamicCars.year}" /> <br /> <h:outputText value="#{cars[colIndex]. } public void populateCars() { dynamicCars = new ArrayList<Car[]>().size(). <p:dataTable var="cars" value="#{tableBean. i < 9.size()].add("Brand:" + i). i++) { Car[] cars = new Car[columns. 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 . for(int i=0. Columns component is used to define the columns programmatically. } } for(int j = 0. i++) { columns.columns}" var="column" columnIndexVar="colIndex"> <f:facet name="header"> #{column} </f:facet> <h:outputText value="#{cars[colIndex]. i < 3. Features like sortBy and filterBy are supported however advanced features like editing is not. two iterator variables called var and columnIndexVar. j++) { cars[j] = //Create car object } dynamicCars. j < columns.

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

cars}" scrollable="true" scrollHeight="150"> <p:column style="width:100px" . //columns </p:dataTable> 135 . define a fixed height in pixels and set a fixed width to each column. 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. } Scrolling Scrolling is a way to display data with fixed headers.sales. in order to enable simple scrolling set scrollable option to true.. <p:dataTable var="car" value="#{carBean.

in this case data is fetched whenever the scrollbar reaches bottom.PrimeFaces Userʼs Guide Simple scrolling renders all data to client and places a scrollbar. x. y and x-y scrolling that are defined by scrollHeight and scrollWidth. //columns </p:dataTable> Scrolling has 3 modes. 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. live scrolling is necessary to deal with huge data.. <p:dataTable var="car" value="#{carBean. clicking on a collapsed row loads expanded content with ajax. Expandable Rows RowToggler and RowExpansion facet are used to implement expandable rows. Set liveScroll to enable this option.cars}" scrollable="true" height="150" liveScroll="true"> <p:column style="width:100px" . <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.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. row is displayed in editable mode meaning input facets are displayed and output facets are hidden. <p:dataTable var="car" value="#{carBean. Clicking tick icon only saves that particular row and cancel icon reverts the changes. both options are implemented with ajax. 137 . See ajax behavior events section for more information about cell edit event. 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}" /> </f:facet> <f:facet name="input"> <h:inputText value="#{car.

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

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

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

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

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

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

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

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

Inline style of the dialog.hide()" /> 146 .PrimeFaces Userʼs Guide Name minHeight style styleClass showEffect hideEffect position closable onShow onHide appendToBody showHeader footer dynamic minimizable maximizable Default 0 null null null null null TRUE null null FALSE TRUE null FALSE FALSE FALSE Type Integer String String String String String Boolean String String Boolean Boolean String Boolean Boolean Boolean Description Minimum height of a resizable dialog. Defines visibility of the header content. note that by default dialog is not visible. Whether a dialog is maximizable or not. Getting started with the Dialog Dialog is a panel component containing other components. <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. Enables lazy loading of the content with ajax. 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. Appends dialog as a child of document body. Text of the footer.show()" /> <p:commandButton value="Hide" type="button" onclick="dlg. 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. Client side callback to execute when dialog is hidden.

(Use single quotes when using a combination) Some examples are described below..> <p:dialog position="left. • Single string value like ‘center’. 500 • Comma separated position values like ‘top’..... • • • • • • • • • • • • • • • blind bounce clip drop explode fade fold highlight puff pulsate scale shake size slide transfer <p:dialog showEffect="fade" hideEffect="explode" .PrimeFaces Userʼs Guide Effects There are various effect options to be used when displaying and closing the dialog.50" . <p:dialog position="top" ... ‘bottom’ representing the position within viewport.> <p:dialog position="200.‘right’. Use showEffect and hideEffect options to apply these effects.. </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. • Comma separated x and y coordinate values like 200.> 147 . Possible values are.top" ..> //.. ‘left’. ‘right’. ‘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. If there is a listener defined it’ll be executed by passing an instace of org. Skinning Dialog resides in a main container element which styleClass option apply. onShow and onHide are handy callbacks for client side in case you need to execute custom javascript. Following is the list of structural style classes.Dialog Method show() hide() Params Return Type void void Description Displays dialog. <p:dialog> <p:ajax event="close" listener="#{dialogBean. Example below adds a FacesMessage when dialog is closed and updates the messages component to display the added message.event.handleClose}" update="msg" /> //Content </p:dialog> <p:messages id="msg" /> public class DialogBean { } public void handleClose(CloseEvent event) { //Add facesmessage } Client Side Callbacks Similar to close listener. 148 . <p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)"> //Content </p:dialog> Client Side API Widget: PrimeFaces.CloseEvent.primefaces.widget. Closes dialog.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• • • • • • • • • • • • • • • • 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. Clears the text in editor. Saves html text in iframe back to the textarea. subsequent calls do not reinit the editor.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.Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor. <p:editor value="#{bean.

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

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

<h:outputLink id="lnk" value="#"> <h:outputText value="Show the Barca Temple" /> <p:effect type="appear" event="click" for="img" /> </h:outputLink> <p:graphicImage id="img" value="/ui/barca/campnou. When the link is clicked. 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. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 .PrimeFaces Userʼs Guide <h:outputText value="#{bean. initially hidden graphicImage comes up with a fade effect. Use for option to specify a target. List of Effects Following is the list of effects supported by PrimeFaces.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. outputLink becomes the trigger for the effect on graphicImage.

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

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

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

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

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

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

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

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

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

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

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

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

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

handleFileUpload}" sizeLimit="1000" /> Skinning FileUpload FileUpload resides in a container element which style and styleClass options apply. <p:fileUpload fileUploadListener="#{fileBean.fileupload-buttonbar . It is also suggested to offer simple upload mode to the users of your application as a fallback. Upload button. Applies As skinning style classes are global. this is as simple as setting the sizeLimit configuration. Cancel button.|\/)(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. Class . 180 . Following is the list of structural style classes.PrimeFaces Userʼs Guide File Filters Users can be restricted to only select the file types you’ve configured. Browser Compatibility Rich upload functionality like dragdrop from filesystem.ui-fileupload cancel fileupload-content Main container element Button bar. <p:fileUpload fileUploadListener="#{fileBean. threshold size and temporary file upload location. example below demonstrates how to accept images only. Two configuration options exist. see the main Skinning section for more information.ui-fileupload . multi uploads. Content container.fileinput-button .ui-fileupload start . Following fileUpload limits the size to 1000 bytes for each file.handleFileUpload}" allowTypes="/(\. Browse button. Filter Configuration FileUpload filter’s default settings can be configured with init parameters.

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

textarea and select..focus..PrimeFaces Userʼs Guide 3.component.Focus org... Input component can be any element such as input.. <p:focus /> <p:inputText .37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.primefaces.component org. /> <h:inputText . 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.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.component. /> <h:selectOneMenu .Focus.primefaces.FocusRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces. when set to false component will not be rendered.primefaces.primefaces..FocusRenderer org.FocusTag org. An el expression that maps to a server side UIComponent instance in a backing bean Specifies the exact component to set focus The root component to start first input search. /> 182 .focus.

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

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

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

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

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

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

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

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

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

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

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

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

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

org.model.primefaces.PrimeFaces Userʼs Guide Property strokeOpacity strokeWeight fillColor fillOpacity 1 1 Default Type Double Integer String Double Opacity of a line Weight of a line Description null 1 Background color of the polygon Opacity of the polygon org.map.map. Background color of the circle. Stroke opacity of rectangle.primefaces. Stroke opacity of circle. Stroke 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.map.map. Background color of the rectangle.map.model. 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 . Stroke weight of the rectangle.primefaces. Stroke weight of the circle. Opacity of the circle.primefaces. Opacity of the rectangle. Description org.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.model.primefaces.Circle extends org.model.model.

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

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

component. 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 graphicImage org.GraphicImageRenderer org.component org. Alternate text for the image Alias to value attribute Width of the image Height of the image Title of the image Direction of the text displayed Language code Specifies to use a server-side image map Name of the client side map Style of the image 199 binding value alt url width height title dir lang ismap usemap style null null null null null null null null null FALSE null null Object Object String String String String String String String Boolean String String .graphicimage. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier.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.component.GraphicImage org.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Binary data to stream or context relative path.41 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream. GraphicImage does all the hard work without the need of a Servlet.primefaces.primefaces.graphicimage. Legacy way to do this is to come up with a Servlet that does the streaming.GraphicImage org.primefaces.primefaces.component.

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean.MegaMenu org.component. Name of the client side widget MenuModel instance to create menus programmatically binding widgetVar model null null null Object String MenuModel 254 .megamenu.MegaMenu org.primefaces.component.component.component org.PrimeFaces Userʼs Guide 3.58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together.primefaces.megamenu.MegaMenuRenderer 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. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class megaMenu org.primefaces.MegaMenuRenderer org.

4.2" <p:menuitem value="TV.2" <p:menuitem value="TV.3.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.4.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.2.6"> <p:menuitem value="TV.2.1" <p:menuitem value="TV. Style class of the component.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.1"> <p:menuitem value="TV.5.2.1.2"> <p:menuitem value="TV.1.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 .3" </p:submenu> <p:submenu label="TV.2" <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.3"> <p:menuitem value="TV.1" <p:menuitem value="TV.6.3" </p:submenu> <p:submenu label="TV.1" <p:menuitem value="TV.1" <p:menuitem value="TV.6.3.1" <p:menuitem value="TV.4"> <p:menuitem value="TV.1" <p:menuitem value="TV.5.2" </p:submenu> <p:submenu label="TV.5.5"> <p:menuitem value="TV.6.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

‘warn’ and error. ‘error’. 272 . Skinning Message Full list of CSS selectors of message is as follows.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’. • both (default) : Both icon and text are displayed. • text : Only message text is displayed. • icon : Only message severity is displayed and message text is visible as a tooltip.

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

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

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

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

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

Location of the reorder buttons.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. In case it’s a static text. Name of the client side widget. Label of an item. Message to be displayed when validation fields. 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 Message to be displayed when required field validation fails. Label of move down button. Name of animation to display. Message to be displayed when conversion fails. Label of move top button. Label of move bottom button. process validations logic is executed at apply request values phase for this component. valid values are “left”. Disables the component. Name of the iterator. immediate FALSE Boolean required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar var itemLabel itemValue style styleClass disabled effect moveUpLabel moveTopLabel moveDownLabel moveBottomLabel controlsLocation FALSE null null null null null null null null null null null FALSE fade Move Up Move Top Move Down Move Bottom left Boolean MethodExpr MethodExpr String String String String String String String String String Boolean String String String String String String 278 . Label of move up button. Inline style of container element. “right” and “none”. Value of an item. it’s resolved to a converter instance. Style class of container element.

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

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

component. Suppose the rendered condition on bean is false when page if loaded initially and search method on bean sets the condition to be true meaning datatable will be rendered after a page submit. it is much simpler to update an existing element on page rather than inserting a new element to the dom.primefaces. when set to false component will not be rendered.OutputPanelRenderer org.outputpanel.OutputPanel org. 281 . no markup is rendered so for components with conditional rendering regular PPR mechanism may not work since the markup to update on page does not exist.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org. The problem is although partial output is generated. valid values are inline(span) or block(div).component.output. When a JSF component is not rendered.component.primefaces.component org.primefaces. Enables auto update mode if set true.primefaces.PrimeFaces Userʼs Guide 3.component. 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.67 OutputPanel OutputPanel is a panel component with the ability to auto update. the markup on page cannot be updated since it doesn’t exist. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax.OutputPanel org.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.

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

component org.primefaces.OverlayPanel 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. Inline style of the panel. when set to false component will not be rendered.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. Style class of the panel.component.68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content. Identifier of the target component to attach the panel.overlaypanel.primefaces.primefaces.OverlayPanelRenderer org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class overlayPanel org.primefaces.overlaypanel.component.OverlayPanelRenderer org.component.primefaces. binding widgetVar style styleClass for null null null null null Object String String String String 283 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Style Class . Value of the progressbar Progress label. 312 . Applies As skinning style classes are global.ui-progressbar-value .ui-progressbar-label Main container. 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 . see the main Skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Inline style of the separator.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.primefaces.component.PrimeFaces Userʼs Guide 3.component. Style class of the separator.Separator org.separator. //content <p:separator /> //content 364 .Separator org.primefaces.Separator org. when set to false component will not be rendered. separator is used as. 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 separator org. binding title style styleClass null null null null Object String String String Getting started with Separator In its simplest form.99 Separator Seperator displays a horizontal line to separate content.separator.primefaces.component.component.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

403 .ToolbarGroup org.ToolbarGroup org. Inline style of the container element.component. binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used. Info Tag Component Class Component Type Component Family toolbarGroup org.primefaces. Style class of the container element.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 Defines the alignment within toolbar.component Attributes Name id rendered null TRUE Default Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.toolbar.primefaces. valid values are left and right.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

png") should be.resources . Jar file must have the following folder structure.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.custom.META-INF .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. PrimeFaces Theme convention is the integrated way of applying your custom themes to your project. url("images/ui-bg_highlight-hard_100_f9f9f9_1x100. Extract the contents of the package and rename jquery-ui{version}. that is easy as well because ThemeRoller provides a powerful and easy to use online visual tool. .css must also be converted to an expression that JSF resource loading can understand.THEME</param-name> <param-value>yourtheme</param-value> </context-param> 443 . 2) Image references in your theme.png']}") Once the jar of your theme is in classpath.css to theme.theme.css . url("#{resource['primefaces-yourtheme:images/ui-bg_highlight-hard_100_f9f9f9_1x100.css.primefaces-yourtheme .jar . this approach requires you to create a jar file and add it to the classpath of your application. 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. You can have one or more themes in same jar. example would be. <context-param> <param-name>primefaces. you can use your theme like.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful