USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

name} .handleSelect" update="msg" /> </p:autoComplete> <p:messages id=”msg” /> 30 .completePlayer}" var="p" itemLabel="#{p.number} </p:column> </p:autoComplete> public class AutoCompleteBean { } private List<Player> selectedPlayers. //. <p:autoComplete id="advanced" value="#{autoCompleteBean..#{p.selectedPlayers}" completeMethod="#{autoCompleteBean. Example below demonstrates how to display a message about the selected item instantly..text}" completeMethod="#{bean.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. Ajax Behavior Events Instead of waiting for user to submit the form manually to process the selected item. you can enable instant ajax selection by using the itemSelect ajax behavior.photo}"/> </p:column> <p:column style="width:80%"> #{p.text-align:center"> <p:graphicImage value="/images/barca/#{p.complete}"> <p:ajax event="itemSelect" listener="bean.name}" itemValue="#{p}" converter="player" multiple="true"> <p:column style="width:20%. <p:autoComplete value="#{bean.

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

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

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

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

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

breadcrumb.component. 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.BreadCrumb org. MenuModel instance to create menus programmatically Style of main container element.BreadCrumbRenderer Attributes Name id rendered binding widgetVar model style styleClass Default null TRUE null null null null null Type String Boolean Object String MenuModel String String Description Unique identifier of the component.breadcrumb. <p:breadCrumb> <p:menuitem label="Categories" url="#" /> <p:menuitem label="Sports" url="#" /> //more menuitems </p:breadCrumb> 36 . Style class of main container Getting Started with BreadCrumb Steps are defined as child menuitem components in breadcrumb.primefaces.BreadCrumb org.BreadCrumbRenderer org.primefaces.6 BreadCrumb Breadcrumb is a navigation component that provides contextual information about page hierarchy in the workflow.component org.primefaces.primefaces.primefaces.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class breadCrumb org. Boolean value to specify the rendering of the component.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

cars}" var="car" rows="1" itemStyle=”width:200px” > . • • • • • • • • • • • • • • • • 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.model}" /> <h:outputText value="Year: #{car.year}" /> <h:outputText value="Color: #{car.cars}" var="car" itemStyle=”width:200px”> <p:graphicImage value="/images/cars/#{car. This is customizable with the rows attribute. Limiting Visible Items Bu default carousel lists it’s items in pages with size 3.. </p:carousel> Effects Paging happens with a slider effect by default and following easing options are supported. <p:carousel value="#{carBean..PrimeFaces Userʼs Guide <p:carousel value="#{carBean.jpg"/> <h:outputText value="Model: #{car.color}" /> </p:carousel> Carousel iterates through the cars collection and renders it’s children for each car.manufacturer}.

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org. Enables stacked display of bars.chart. Style class of the chart.primefaces.BarChart org.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. Orientation of bars. binding widgetVar value style styleClass title legendPosition barPadding barMargin orientation stacked min max null null null null null null null 8 10 vertical FALSE null null Object String ChartModel String String String String Integer Integer String Boolean Double Double 68 .component.bar.chart.primefaces. Maximum boundary value.component. Title of the chart.12. Padding of bars.component.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.bar.BarChartRenderer org.primefaces. Minimum boundary value. valid values are “vertical” and “horizontal”. Margin of bars.PrimeFaces Userʼs Guide 3.component org.chart.BarChart org.3 Bar Chart Bar chart visualizes one or more series of data using bars.primefaces. Position of the legend.primefaces.component.

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

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

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

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

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

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

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

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

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

144.139.142.addRecord(new ohlcModel.addRecord(new ohlcModel. public class Bean { private OhlcChartModel model.88.139.model.18.04.139. OhlcChartSeries(2011.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.81)).46.136.55.124.66.68.123.97)).135.136.7. OhlcChartSeries(2010.01.143.135.44)).56.addRecord(new ohlcModel.56.121.135.02)).31.144.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .136. OhlcChartSeries(2012.4)).addRecord(new ohlcModel. OhlcChartSeries(2008.139.143.143.57.addRecord(new ohlcModel.134.67.122.124.9. ohlcModel. <p:ohlcChart value="#{bean. OhlcChartSeries(2009.132.chart.82. <p:ohlcChart value="#{bean.129.5.138.135.OhlcChartModel instance.addRecord(new ohlcModel.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.140. public Bean() { model = new OhlcChartModel().5)).76.48)).primefaces. OhlcChartSeries(2012.addRecord(new } //getter } OhlcChartSeries(2007.73.53.79.140.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.primefaces. contextMenu is attached to the page meaning. Getting started with ContextMenu ContextMenu is created with menuitems.component.component.primefaces.PrimeFaces Userʼs Guide 3.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class contextMenu org. When for is not defined.contextmenu.component.ContextMenu org. 104 . 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.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. Id of the component to attach to Style of the main container element Style class of the main container element Menu model instance to create menu programmatically.ContextMenu org. right-click on anywhere on page will display the menu.21 ContextMenu ContextMenu provides an overlay menu displayed on mouse right-click event.primefaces.ContextMenuRenderer org. Optional for attribute defines which component the contextMenu is attached to.primefaces.contextmenu.

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

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

component org.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.component.primefaces.primefaces.component. when set to false component will not be rendered.primefaces.DashboardRenderer org. 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.primefaces.PrimeFaces Userʼs Guide 3. Disables reordering feature.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.Dashboard org. 107 .dashboard.Dashboard org.component. Inline style of the dashboard container Style class of the dashboard container binding widgetVar model disabled style styleClass null null null FALSE null null Object String Dashboard Model Boolean String String Getting started with Dashboard Dashboard is backed by a DashboardModel and consists of panel components.primefaces.dashboard.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Data to display.PrimeFaces Userʼs Guide 3.DataTable org. binding value var rows first widgetVar null null null null 0 null Object Object String Integer Integer String 125 . sorting. selection.DataTableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.DataTable org. Name of the request-scoped variable used to refer each data. lazy loading.DataTableRenderer org.primefaces.component.component.component org.datatable. filtering and more.component. Index of the first row to be displayed Name of the client side widget. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataTable org. Number of rows to display per page.datatable.primefaces. 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.

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

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

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

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

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

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

g..cars}" selectionMode="multiple" selection="#{carBean. <p:dataTable var="car" value="#{carBean. <p:dataTable var="car" value="#{carBean. enable dblClickSelect so that clicking double on a row does the selection.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.cars}" selection="#{carBean. Single Selection with RadioButton Selection a row with a radio button placed on each row is a common case.id}" > <p:column selectionMode="multiple"/> . 132 ..SelectableDataModel.selectedCars}" rowKey="#{car.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"/> .columns </p:dataTable> Selection on Double Click By default. ctrl) during selection. define a column with selectionMode set as single.PrimeFaces Userʼs Guide Multiple Selection with Row Click Multiple row selection is similar to single selection but selection should reference an array of the domain object displayed and user needs to use press modifier key(e..model. In order to enable this feature. <p:dataTable var="car" value="#{carBean.columns </p:dataTable> Multiple Selection with Checkboxes Similar to how radio buttons are enabled.selecedCars}" rowKey="#{car..id}" > . define a selection column with a multiple selectionMode. You can either define this key by using the rowKey attribute or by binding a data model which implements org..primefaces. DataTable will also provide a selectAll checkbox at column header. row based selection is enabled by click event.selecedCar}" rowKey="#{car.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.Droppable org. Style class to apply when an acceptable draggable is being dragged.primefaces.dnd.DroppableRenderer org.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 .component. Selector to define the accepted draggables. Scope key to match draggables and droppables.primefaces.primefaces. Client side callback to execute when a draggable is dropped.29.component. when set to false component will not be rendered.component.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. 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.component.Droppable org.PrimeFaces Userʼs Guide 3.dnd. Id of a UIData component to connect with.component org. Specifies the intersection mode to accept a draggable.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

223 .handleSave}" update="msgs" /> <h:inputText value="#{inplaceBean. //getter-setter } <p:inplace editor="true"> <h:inputText value="#{inplaceBean.text}" /> </p:inplace> save and cancel are two provided ajax behaviors events you can use to hook-in the editing process. public class InplaceBean { private String text.widget.PrimeFaces Userʼs Guide Ajax Behavior Events Inplace editing is enabled via editor option.text}" /> </p:inplace> <p:growl id="msgs" /> Client Side API Widget: PrimeFaces. } public void handleSave() { //add faces message with update text value } //getter-setter <p:inplace editor="true"> <p:ajax event="save" listener="#{inplaceBean. Shows display element and hides content. public class InplaceBean { private String text.Inplace Method show() hide() Params Return Type void void Description Shows content and hides 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. Editor controls container. 224 .ui-inplace-content . As skinning style classes are global. see the main Skinning section for more information. Style Class . Cancel button.ui-inplace-cancel Applies Main container element. Triggers an ajax request to revert inplace input. Triggers an ajax request to process inplace input.ui-inplace .ui-inplace-disabled .ui-inplace-display . Inline content. Save button. Following is the list of structural style classes. Main container element when disabled.ui-inplace-save . Skinning Inplace resides in a main container element which style and styleClass options apply.ui-inplace-editor . Display element.

PrimeFaces Userʼs Guide

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

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

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

binding mask placeHolder value

null null null null

Object Integer String Object

225

PrimeFaces Userʼs Guide

Name converter

Default null

Type Converter/ String

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

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

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

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

onclick ondblclick

null null

String String

226

PrimeFaces Userʼs Guide

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

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

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

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

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

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

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

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

228

PrimeFaces Userʼs Guide

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

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

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

immediate required validator valueChangeListener requiredMessage

FALSE FALSE null null null

Boolean Boolean Method Expr Method Expr String

PrimeFaces Userʼs Guide

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

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

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

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

230

PrimeFaces Userʼs Guide

Name onmouseover onmouseup onselect readonly size style styleClass tabindex title type

Default null null null FALSE null null null null null text

Type String String String Boolean Integer String String Integer String String

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

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

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

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

231

PrimeFaces Userʼs Guide

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

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

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

immediate required validator

FALSE FALSE null

Boolean Boolean Method Expr

PrimeFaces Userʼs Guide

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

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

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

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

233

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

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

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

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

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

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

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

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

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

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

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

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

4.2.2" <p:menuitem value="TV.1" <p:menuitem value="TV.1" <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.1" <p:menuitem value="TV.1.2.5.4.2" </p:submenu> <p:submenu label="TV.1.1" <p:menuitem value="TV.5"> <p:menuitem value="TV.3.6.6.6"> <p:menuitem value="TV.3"> <p:menuitem value="TV.1" <p:menuitem value="TV.4"> <p:menuitem value="TV.3. 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. Style class of the component.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.3" </p:submenu> <p:submenu label="TV.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.5.2" </p:submenu> <p:submenu label="TV.2" <p:menuitem value="TV.2"> <p:menuitem value="TV.6.5.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.1"> <p:menuitem value="TV.1" <p:menuitem value="TV.2" <p:menuitem value="TV.

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

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

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

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

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

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

ui-menu .ui-menu-list .ui-menuitem-link . 262 .ui-menuitem .PrimeFaces Userʼs Guide Style Class .ui-menuitem-text . 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.panel.primefaces. Speed of toggling in milliseconds Renders a toggleable panel as collapsed. when set to false component will not be rendered.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.component org.component.component. Style of the panel Style class of the panel 286 binding header footer toggleable toggleSpeed collapsed style styleClass null null null FALSE 1000 FALSE null null Object String String Boolean Integer Boolean String String .primefaces.PanelRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.Panel org.panel.primefaces.PanelRenderer org.PrimeFaces Userʼs Guide 3.69 Panel Panel is a grouping component with content toggle.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. close and menu integration.

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

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

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

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. Style class of the panel.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 .PrimeFaces Userʼs Guide Name columns style styleClass columnClasses 0 Default Type Integer String String String Description Number of columns in grid. Inline style of the panel. <p:panelGrid columns="2"> <h:outputLabel for="firstname" value="Firstname:" /> <p:inputText id="firstname" value="#{bean. null null null Getting started with PanelGrid Basic usage of panelGrid is same as the standard one. Comma separated list of column style classes. <p:panelGrid columns="2"> <f:facet name="header"> Basic PanelGrid </f:facet> <h:outputLabel for="firstname" value="Firstname: *" /> <p:inputText id="firstname" value="#{bean.

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

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

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

Client side callback to execute when input element is clicked. Flag indicating that this component will prevent changes by the user. Advisory tooltip informaton. Position of the input element in the tabbing order.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. onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title null null null null null null null null null null null null FALSE null null null null null String String String String String String String String String String String String Boolean Integer String String Integer String 294 . Client side callback to execute when a key is pressed down over input element. Client side callback to execute when input element is double clicked. Client side callback to execute when a pointer button is released over input element. Style class of the input element. Client side callback to execute when a key is released over input element. Inline style of the input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a pointer button is moved away from 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 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 input element receives focus. Number of characters used to determine the width of the input element.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.RadioButtonRenderer org.component org.component. when set to false component will not be rendered.radiobutton.component.radiobutton.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.RadioButton org.78 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts.RadioButton org.primefaces. Client side callback to execute on state change.RadioButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3. Style class of the container.primefaces. Id of the selectOneRadio to attach to.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.primefaces.component. 314 . Inline style of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.

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

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

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

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

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

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

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

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

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

ring.primefaces.component. Collection to display.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.Ring org.component.primefaces. binding widgetVar value var style styleClass easing null null null null null null swing Object String Object String String String String 324 .ring.Ring org. Style class of the container element.RingRenderer org.82 Ring Ring is a data display component with a circular animation.primefaces.component org. when set to false component will not be rendered. Type of easing to use in animation. Name of the data iterator. 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 ring org.component.component. Inline style of the container element.PrimeFaces Userʼs Guide 3.primefaces.primefaces.

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

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

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

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

primefaces. 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.component.RowExpansion org. 329 .primefaces.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.PrimeFaces Userʼs Guide 3.component.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.RowExpansion org.rowexpansion. Info Tag Component Class Component Type Component Family rowExpansion org.primefaces. when set to false component will not be rendered.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces.stack.component.component.Stack org.primefaces.StackRenderer Attributes Name id rendered binding icon openSpeed closeSpeed widgetVar model expanded Default null TRUE null null 300 300 null null FALSE Type String Boolean Object String String Integer String MenuModel Boolean Description Unique identifier of the component. Boolean value to specify the rendering of the component. when set to false component will not be rendered.primefaces. Speed of the animation when opening the stack.component.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.component. Name of the client side widget. 385 .StackRenderer org.PrimeFaces Userʼs Guide 3.component org. Speed of the animation when opening the stack.stack.Stack org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org. 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. An optional image to contain stacked items.primefaces.

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

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

when set to false component will not be rendered.component.component.summaryrow. Getting started with SummaryRow See DataTable section for more information.g. (e. to calculate totals).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.summaryrow.SummaryRowRenderer org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class summaryRow org.primefaces.primefaces.primefaces. 388 .SummaryRow org.component.primefaces.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 Userʼs Guide 3.component.component org.108 SummaryRow SummaryRow is a helper component of datatable used for dynamic grouping.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful