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

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

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

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

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

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

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

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

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

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

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

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

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

<p:ajaxStatus> <f:facet name="prestart"> <h:outputText value="Starting. Once the ajax response is received start facet becomes hidden and complete facet shows up. success: When ajax response is received without error. • • • • • • default: Initially visible when page is loaded. Start facet will be visible once ajax request begins and stay visible until it’s completed. <p:ajaxStatus> <f:facet name="start"> <p:graphicImage value="ajaxloading. start: After ajax request begins..gif" /> </f:facet> <f:facet name="complete"> <h:outputText value="Done!" /> </f:facet> </p:ajaxStatus> Events Here is the full list of available event names. prestart: Before ajax request is sent. complete: When everything finishes. error: When ajax response is received with error." /> </f:facet> <f:facet name="error"> <h:outputText value="Error" /> </f:facet> <f:facet name="success"> <h:outputText value="Success" /> </f:facet> <f:facet name="default"> <h:outputText value="Idle" /> </f:facet> <f:facet name="start"> <h:outputText value="Sending" /> </f:facet> <f:facet name="complete"> <h:outputText value="Done" /> </f:facet> </p:ajaxStatus> 22 .. Most common used facets are start and complete.PrimeFaces Userʼs Guide Getting Started with AjaxStatus AjaxStatus uses facets to represent the request status.

Provide a fixed width/height to the ajaxStatus to prevent page layout from changing.height:32px" . <p:ajaxStatus onstart="status. facetId) Params eventName: Name of status event. <p:ajaxStatus onstart="alert(‘Start’)" oncomplete="alert(‘End’)"/> A comman usage of programmatic approach is to implement a custom status dialog.PrimeFaces Userʼs Guide Custom Events Facets are the declarative way to use. There is an ajax loading gif bundled with PrimeFaces which you can use. /> 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. 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.AjaxStatus Method bindFacet(eventName.widget. Styling directly applies to a container element which contains the facets... 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.hide()"/> <p:dialog widgetVar="status" modal="true" closable="false"> Please Wait </p:dialog> Client Side API Widget: PrimeFaces. 23 .

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

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

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

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

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

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

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

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

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

5 BlockUI BlockUI is used to block JSF components during ajax processing. 33 .BlockUIRenderer org.primefaces. 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 blockUI org.BlockUI org.primefaces.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.blockui.PrimeFaces Userʼs Guide 3.component.primefaces.component.primefaces.blockui.component.component org.BlockUI org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces. process validations logic is executed at apply request values phase for this component. it’s resolved to a converter instance.9 Captcha Captcha is a form validation component based on Recaptcha API.component. In case it’s a static text. when set to false component will not be rendered.Captcha org.PrimeFaces Userʼs Guide 3.captcha.primefaces.Captcha org.component. An el expression that maps to a server side UIComponent instance in a backing bean.CaptchaRenderer org.component. 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 .captcha. Marks component as required. it must refer to a converter id. 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class captcha org.CaptchaRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. When set true.component org.component.primefaces. When it’s an EL expression.

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

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

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

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

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

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

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

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

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

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

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

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

2 Line Chart Line chart visualizes one or more series of data in a line graph. 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.LineChart org. when set to false component will not be rendered.component.chart. Title of the chart. Style class of the chart. Minimum X axis value.primefaces.chart.component.line.component. Maximum Y axis value.LineChart org.chart.12.chart.line.primefaces.LineChartRenderer org.LineChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Whether line segments should be broken at null value.primefaces. Position of the legend. Minimum Y axis value.PrimeFaces Userʼs Guide 3. binding value widgetVar style styleClass title legendPosition minY maxY minX maxX breakOnNull seriesColors null null null null null null null null null null null FALSE null Object ChartModel String String String String String Double Double Double Double Boolean String 65 .primefaces.component.component org. Maximum X axis value. Comma separated list of colors in hex format. fall will join point on either side of line.

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

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

component.3 Bar Chart Bar chart visualizes one or more series of data using bars.BarChart org.PrimeFaces Userʼs Guide 3.bar. Position of the legend.chart.component.primefaces.12. Orientation of bars.BarChartRenderer org. valid values are “vertical” and “horizontal”. 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 .BarChart org.component org. Style class of the chart. Enables stacked display of bars.component. Margin of bars.primefaces. Padding of bars.primefaces.chart.bar.chart. Minimum boundary value.BarChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Maximum boundary value.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 Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org. Title of the chart.chart.

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

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

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

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

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

Style class of the chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org. Label of the x-axis. Shows shadow or not.component org.chart.bubble.component.chart.primefaces.chart. Enables gradient fills instead of flat colors.component.component. Displays labels on buttons.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.BubbleChart org. 74 binding widgetVar value style styleClass title legendPosition shadow seriesColors enhancedLegend bubbleGradients bubbleAlpha showLabels xaxisLabel null null null null null null null TRUE null TRUE FALSE 70 TRUE null Object String ChartModel String String String String Boolean String Boolean Boolean Integer Boolean String .PrimeFaces Userʼs Guide 3.BubbleChartRenderer org. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.primefaces.primefaces. Position of the legend.bubble. Comma separated list of colors in hex format.BubbleChart org.primefaces.component. Alpha transparency of a bubble.chart.BubbleChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Specifies interactive legend. Title of the chart.primefaces.12.

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

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

Specifies interactive legend. 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 . Comma separated list of colors in hex format.component.primefaces.OhlcChart org. Enables candle stick display mode.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. Angle of the x-axis ticks.chart.ohlc.OhlcChart org.component org.component. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.primefaces. Label of the y-axis.component.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org. Position of the legend. Angle of the y-axis ticks.chart.chart.PrimeFaces Userʼs Guide 3.ohlc.chart. Style class of the chart.primefaces. Label of the x-axis.primefaces.12.component. Title of the chart.primefaces.OhlcChartRenderer org.

44)).04.02)).addRecord(new ohlcModel.124.142.140.66. public Bean() { model = new OhlcChartModel().122.46.135.01.OhlcChartModel instance.57.56.136.addRecord(new ohlcModel.135. ohlcModel.68.139.79.143.addRecord(new } //getter } OhlcChartSeries(2007.136.135.139.144.138.48)).129.143.140.81)).PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.139.143.144.18.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.5)). OhlcChartSeries(2011.132.9.88.chart. <p:ohlcChart value="#{bean. public class Bean { private OhlcChartModel model.model. OhlcChartSeries(2008.134. OhlcChartSeries(2012.97)).73.56. <p:ohlcChart value="#{bean.124. OhlcChartSeries(2012.123.4)).addRecord(new ohlcModel.55. OhlcChartSeries(2009.53.5.31.82.addRecord(new ohlcModel.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .7.76.139.136.primefaces.67.121.addRecord(new ohlcModel.addRecord(new ohlcModel. OhlcChartSeries(2010.135.

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

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

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

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

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

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

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

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

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

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

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

90 . see documentation of components that use a column. Datatable's resizableColumns must be enabled to use this option. Maximum number of characters for an input filter. not all attributes of column are implemented by the components that use column. Note 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. Specifies resizable feature at column level. for example filterBy is only used by datatable whereas sortBy is used by datatable and sheet. Getting Started with Column As column is a reused component.

component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.16 Columns Columns is used by datatable to create columns programmatically. 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.Columns org. 91 . Name of iterator to access a column index.primefaces. Name of iterator to access a column.component.Columns org. Info Tag Component Class Component Type Component Family columns org.column. An el expression that maps to a server side UIComponent instance in a backing bean Data to represent columns.component.primefaces.primefaces. Inline style of the column.

component. Info Tag Component Class Component Type Component Family columnGroup org.primefaces.17 ColumnGroup ColumnGroup is used by datatable for column grouping. valid values are “header” and “footer”. ColumnGroup org.ColumnGroup org.PrimeFaces Userʼs Guide 3.columngroup.primefaces.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 Type of group.primefaces.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. binding type null null Object String Getting Started with ColumnGroup See grouping section in datatable documentation for detailed information. 92 .

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

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

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

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

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

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

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

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

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

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

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

contextMenu is attached to the page meaning.ContextMenu org.component.ContextMenu org. 104 . when set to false component will not be rendered. When for is not defined.contextmenu.contextmenu.primefaces.PrimeFaces Userʼs Guide 3.component org. Id of the component to attach to Style of the main container element Style class of the main container element Menu model instance to create menu programmatically. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class contextMenu org. Getting started with ContextMenu ContextMenu is created with menuitems.ContextMenuRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces.21 ContextMenu ContextMenu provides an overlay menu displayed on mouse right-click event.primefaces. right-click on anywhere on page will display the menu.component.component.primefaces.component.primefaces. Optional for attribute defines which component the contextMenu is attached to.ContextMenuRenderer Attributes Name id rendered binding widgetVar for style styleClass model Default null TRUE null null null null null null Type String Boolean Object String String String String MenuModel Description Unique identifier of the component Boolean value to specify the rendering of the component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

dialog is visible by default.component. 145 binding widgetVar header draggable resizable modal visible width height minWidth null null null TRUE TRUE FALSE FALSE auto auto 150 Object String String Boolean Boolean Boolean Boolean Integer Integer Integer .28 Dialog Dialog is a panel component that can overlay other elements on page.DialogRenderer org.primefaces.dialog. When enabled. when set to false component will not be rendered.primefaces.DialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Width of the dialog Height of the dialog Minimum width of a resizable dialog.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Text of the header Specifies draggability Specifies resizability Enables modality.component org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.primefaces.dialog.component.Dialog org.Dialog org.primefaces.component.

Enables lazy loading of the content with ajax. Inline style of the dialog. note that by default dialog is not visible. Defines visibility of the header content. Style class of the dialog Effect to use when showing the dialog Effect to use when hiding the dialog Defines where the dialog should be displayed Defines if close icon should be displayed or not Client side callback to execute when dialog is displayed. <p:dialog 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. Appends dialog as a child of document body. Whether a dialog is maximizable or not. Text of the footer. <p:dialog> <h:outputText value="Resistance to PrimeFaces is Futile!" /> //Other content </p:dialog> Show and Hide Showing and hiding the dialog is easy using the client side api.hide()" /> 146 . Getting started with the Dialog Dialog is a panel component containing other components. Client side callback to execute when dialog is hidden.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. Whether a dialog is minimizable or not.

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

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

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

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

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

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

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

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

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

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

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

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

Horizontal alignment. Name of the client side widget.primefaces.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. 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 .component.30 Dock Dock component mimics the well known dock interface of Mac OS X.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.primefaces. Distance to enlarge. bottom or top.Dock org.primefaces.DockRenderer org.Dock org. An el expression that maps to a server side UIComponent instance in a backing bean MenuModel instance to create menus programmatically Position of the dock.primefaces.primefaces. Initial width of items.component org. Maximum width of items.component.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.dock.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 .38 Galleria Galleria is used to display a set of images.primefaces. Inline style of the container element.component. Name of variable to access an item in collection. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class galleria org.GalleriaRenderer org.component org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.Galleria org. Collection of data to display.primefaces.GalleriaRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.galleria.Galleria org.primefaces. Style class of the container element.component.primefaces.component.PrimeFaces Userʼs Guide 3.primefaces.galleria.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding mask placeHolder value

null null null null

Object Integer String Object

225

PrimeFaces Userʼs Guide

Name converter

Default null

Type Converter/ String

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

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

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

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

onclick ondblclick

null null

String String

226

PrimeFaces Userʼs Guide

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

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

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

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

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

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

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

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

228

PrimeFaces Userʼs Guide

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

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

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

immediate required validator valueChangeListener requiredMessage

FALSE FALSE null null null

Boolean Boolean Method Expr Method Expr String

PrimeFaces Userʼs Guide

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

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

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

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

230

PrimeFaces Userʼs Guide

Name onmouseover onmouseup onselect readonly size style styleClass tabindex title type

Default null null null FALSE null null null null null text

Type String String String Boolean Integer String String Integer String String

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

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

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

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

231

PrimeFaces Userʼs Guide

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

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

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

immediate required validator

FALSE FALSE null

Boolean Boolean Method Expr

PrimeFaces Userʼs Guide

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

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

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

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

233

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

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

PrimeFaces Userʼs Guide

Name required validator valueChangeListener requiredMessage converterMessage validatorMessage password showMode buttonImage buttonImageOnly effect effectDuration layout layoutTemplate keypadOnly promptLabel closeLabel clearLabel backspaceLabel accesskey alt autocomplete dir disabled label lang

Default FALSE null null null null null FALSE focus null FALSE fadeIn null qwerty null focus null null null null null null null null FALSE null null

Type Boolean MethodExpr MethodExpr String String String Boolean String String boolean String String String String Boolean String String String String String String String String Boolean String String

Description Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Makes the input a password field. Specifies the showMode, ‘focus’, ‘button’, ‘both’ Image for the button. When set to true only image of the button would be displayed. Effect of the display animation. Length of the display animation. Built-in layout of the keyboard. Template of the custom layout. Specifies displaying a keypad instead of a keyboard. Label of the prompt text. Label of the close key. Label of the clear key. Label of the backspace key. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component.

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

Description Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton.
237

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

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

String String String String String String String String String String String String Boolean Integer String String Integer String

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

Getting Started with Keyboard Keyboard is used just like a simple inputText, by default when the input gets the focus a keyboard is displayed.
<p:keyboard value="#{bean.value}" />

Built-in Layouts There’re a couple of built-in keyboard layouts these are ‘qwerty’, ‘qwertyBasic’ and ‘alphabetic’. For example keyboard below has the alphabetic layout.
<p:keyboard value="#{bean.value}" layout="alphabetic"/>

Custom Layouts Keyboard has a very flexible layout mechanism allowing you to come up with your own layout.
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="prime-back,faces-clear,rocks-close"/>

Another example;

238

PrimeFaces Userʼs Guide
<p:keyboard value="#{bean.value}" layout="custom" layoutTemplate="create-space-your-close,owntemplate-shift,easily-spacespacebar"/>

A layout template basically consists of built-in keys and your own keys. Following is the list of all built-in keys. • • • • • • • back clear close shift spacebar space halfspace

All other text in a layout is realized as seperate keys so "prime" would create 5 keys as "p" "r" "i" "m" "e". Use dash to seperate each member in layout and use commas to create a new row. Keypad By default keyboard displays whole keys, if you only need the numbers use the keypad mode.
<p:keyboard value="#{bean.value}" keypadOnly="true"/>

ShowMode There’re a couple of different ways to display the keyboard, by default keyboard is shown once input field receives the focus. This is customized using the showMode feature which accept values ‘focus’, ‘button’, ‘both’. Keyboard below displays a button next to the input field, when the button is clicked the keyboard is shown.
<p:keyboard value="#{bean.value}" showMode="button"/>

Button can also be customized using the buttonImage and buttonImageOnly attributes.
239

PrimeFaces Userʼs Guide

3.53 Layout
Layout component features a highly customizable borderLayout model making it very easy to create complex layouts even if you’re not familiar with web design.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class layout org.primefaces.component.layout.Layout org.primefaces.component.Layout org.primefaces.component org.primefaces.component.LayoutRenderer org.primefaces.component.layout.LayoutRenderer

Attributes
Name id rendered binding widgetVar fullPage Default null TRUE null null FALSE Type String Boolean Object String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Specifies whether layout should span all page or not.

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

Description Style to apply to container element, this is only applicable to element based layouts. Style class to apply to container element, this is only applicable to element based layouts. Client side callback to execute when a layout unit is resized. Client side callback to execute when a layout unit is closed. Client side callback to execute when a layout unit is toggled. Title label of the resize button. Title label of the collapse button. Title label of the expand button. Title label of the close button.

Getting started with Layout Layout is based on a borderLayout model that consists of 5 different layout units which are top, left, center, right and bottom. This model is visualized in the schema below;

Full Page Layout Layout has two modes, you can either use it for a full page layout or for a specific region in your page. This setting is controlled with the fullPage attribute which is false by default. The regions in a layout are defined by layoutUnits, following is a simple full page layout with all possible units. Note that you can place any content in each layout unit.

241

PrimeFaces Userʼs Guide
<p:layout fullPage="true"> <p:layoutUnit position="north" size="50"> <h:outputText value="Top content." /> </p:layoutUnit> <p:layoutUnit position="south" size="100"> <h:outputText value="Bottom content." /> </p:layoutUnit> <p:layoutUnit position="west" size="300"> <h:outputText value="Left content" /> </p:layoutUnit> <p:layoutUnit position="east" size="200"> <h:outputText value="Right Content" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Center Content" /> </p:layoutUnit> </p:layout>

Forms in Full Page Layout When working with forms and full page layout, avoid using a form that contains layoutunits as generated dom may not be the same. So following is invalid.
<p:layout fullPage="true"> <h:form> <p:layoutUnit position="west" size="100"> h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> </h:form>

</p:layout>

A layout unit must have it’s own form instead, also avoid trying to update layout units because of same reason, update it’s content instead. Dimensions Except center layoutUnit, other layout units must have dimensions defined via size option. Element based layout Another use case of layout is the element based layout. This is the default case actually so just ignore fullPage attribute or set it to false. Layout example below demonstrates creating a split panel implementation.
242

PrimeFaces Userʼs Guide

<p:layout style="width:400px;height:200px"> <p:layoutUnit position="west" size="100"> <h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> //more layout units

</p:layout>

Ajax Behavior Events Layout provides custom ajax behavior events for each layout state change.
Event toggle close resize Listener Parameter org.primefaces.event.ToggleEvent org.primefaces.event.CloseEvent org.primefaces.event.ResizeEvent Fired When a unit is expanded or collapsed. When a unit is closed. When a unit is resized.

Stateful Layout Making layout stateful would be easy, once you create your data to store the user preference, you can update this data using ajax event listeners provided by layout. For example if a layout unit is collapsed, you can save and persist this information. By binding this persisted information to the collapsed attribute of the layout unit layout will be rendered as the user left it last time. Client Side API Widget: PrimeFaces.widget.Layout
Method toggle(position) show(position) hide(unit) Params position position position Return Type void void void Toggles layout unit. Shows layout unit. Hides layout unit. Description

243

PrimeFaces Userʼs Guide

Skinning Following is the list of structural style classes;
Style Class .ui-layout .ui-layout-doc .ui-layout-unit .ui-layout-{position} .ui-layout-unit-header .ui-layout-unit-content Applies Main wrapper container element Layout container Each layout unit container Position based layout unit Layout unit header Layout unit body

As skinning style classes are global, see the main Skinning section for more information.

244

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

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

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

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

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

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.component.primefaces.LogRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.Log org.component.56 Log Log component is a visual console to display logs on JSF pages.PrimeFaces Userʼs Guide 3. 250 .LogRenderer org.component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting started with Log Log component is used simply as adding the component to the page.Log org.primefaces.log. when set to false component will not be rendered.component org.primefaces.log.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.jpg" /> 308 . <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. 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. Info Tag Behavior Class printer org. Examples below demonstrates how to print a simple output text or a particular image on page.PrimeFaces Userʼs Guide 3.behavior.75 Printer Printer allows sending a specific JSF component to the printer. not the whole page.component. binding target null null Object String Getting started with the Printer Printer is attached to any command component like a button or a link.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.RowTogglerRenderer org.rowtoggler.86 RowToggler RowToggler is a helper component for datatable.RowToggler org.component.RowToggler org.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See expandable rows section in datatable documentation for more information about usage.component org.primefaces.component.rowtoggler.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.primefaces. when set to false component will not be rendered.primefaces. 330 .

primefaces. An org.schedule.Locale instance binding widgetVar value locale null null null null Object String Object Object 331 .primefaces.PrimeFaces Userʼs Guide 3.component.primefaces. iCal like JSF component to manage events.87 Schedule Schedule provides an Outlook Calendar.Schedule org.primefaces org.ScheduleRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.ScheduleRenderer org.model.schedule.component.ScheduleModel instance representing the backed model Locale for localization.component.util.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. can be String or a java.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class schedule org.Schedule org.

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

util. End date of type java.Date. new Date())). Visual style class to enable multi resource display. When an event is selected.util. Event dateSelect eventSelect Listener Parameter org. new Date().primefaces.event.model}" /> public class ScheduleBean { } private ScheduleModel model. . Flag indicating event is all day.DateSelectEvent org. Start date of type java. Property id title startDate endDate allDay styleClass data editable Description Used internally by PrimeFaces.Date.addEvent(new DefaultScheduleEvent("title". <p:schedule value="#{scheduleBean. } public ScheduleModel getModel() { return model. public ScheduleBean() { eventModel = new ScheduleModel<ScheduleEvent>().PrimeFaces Userʼs Guide Getting started with Schedule Schedule needs to be backed by an org. start date and end date.event. auto generated. Optional data you can set to be represented by Event. Ajax Behavior Events Schedule provides various ajax behavior events to respond user actions.model.ScheduleModel instance.ScheduleEntrySelectEvent 333 Fired When a date is selected. Mandatory properties required to create a new event are the title.model.primefaces.ScheduleEvent instances.primefaces. Whether the event is editable or not. Title of the event. } DefaultScheduleEvent is the default implementation of ScheduleEvent interface. Other properties such as allDay get sensible default values. Table below describes each property in detail. a schedule model consists of org. eventModel.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. Schedule provides a simple client side api and the update method. as a result this approach is much more effective then updating with regular PPR. Whenever you call update.event.ScheduleEntryMoveEvent org. <h:form> <p:schedule value="#{bean.primefaces.allDay}" /> <p:commandButton type="reset" value="Reset" /> <p:commandButton value="Save" actionListener="#{bean.show()" /> <p:ajax event="eventSelect" listener="#{bean.widget. transport method used to load events dynamically is JSON. Instead.update() at oncomplete event handler. When an event is resized. save button is calling myschedule.event. schedule will query it’s server side ScheduleModel instance to check for updates. Ajax Updates Schedule has a quite complex UI which is generated on-the-fly by the client side PrimeFaces.hide(). Editable Schedule Let’s put it altogether to come up a fully editable and complex schedule.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."/> </h:panelGrid> </p:dialog> </h:form> 334 .addEvent}" oncomplete="myschedule.event.eventDialog.event. An example of this is demonstrated at editable schedule example. As a result when you try to update schedule like with a regular PrimeFacess PPR.Schedule widget to save bandwidth and increase page load performance.event.eventModel}" editable="true" widgetVar="myschedule"> <p:ajax event="dateSelect" listener="#{bean.event.onDateSelect}" update="eventDetails" oncomplete="eventDialog.PrimeFaces Userʼs Guide Event eventMove eventResize Listener Parameter org.update().primefaces.title}" required="true"/> <h:outputLabel for="from" value="From:" /> <p:inputMask id="from" value="#{bean. you may notice a UI lag as the DOM will be regenerated and replaced.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.ScheduleEntryResizeEvent Fired When an event is moved.

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

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

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

Locale attribute can take a locale key as a String or a java. 338 . see the main skinning section for more information.org/display/Components/PrimeFaces+Locales Translation is a simple javascript object.PrimeFaces Userʼs Guide basicDay <p:schedule value="#{scheduleBean. As skinning style classes are global.util. <p:schedule value="#{scheduleBean. 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.model}" locale="tr"/> Skinning Schedule resides in a main container which style and styleClass attributes apply.primefaces. 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. Following is a Turkish calendar. we suggest adding the code to a javascript file and include in your application. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. 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. it must refer to a converter id When set true. it’s resolved to a converter instance. When it’s an EL expression.primefaces.component.component.SelectOneButtonRenderer org.component. when set to false component will not be rendered.primefaces.95 SelectOneButton SelectOneButton is an input component to do a single select. 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 353 .SelectOneButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.SelectOneButton org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneButton org.primefaces. In case it’s a static text.component.SelectOneButton org.selectonebutton.component org.primefaces.PrimeFaces Userʼs Guide 3.selectonebutton.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<h:inputText id="number" value="#{sliderBean. public int getNumber() { return number. Example below adds a message and displays it using growl component when slide ends. All of these callbacks receive two parameters.number}" /> <p:slider for="number"> <p:ajax event="slideEnd" listener="#{sliderBean. onSlideStart. //add faces message } 372 . slide event and the ui object containing information about the event.number = number.primefaces.helper = Handle element of slider //ui. If you have a listener defined. ui) { //ui.SlideEndEvent instance. } public void setNumber(int number) { this. it will be called by passing org. } public void onSlideEnd(SlideEndEvent event) { int value = event.value = Current value of slider } Ajax Behavior Events Slider provides one ajax behavior event called slideEnd that is fired when the slide completes. <h:inputText id="number" value="#{sliderBean. ui)"/> function handleSlideEnd(event.getValue(). onSlide and onSlideEnd.event.number}" /> <p:slider for="number" onSlideEnd="handleSlideEnd(event.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.

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

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

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

376 . Message to be displayed when validation fields. 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. Maximum number of characters that may be entered in this field.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stepFactor min max prefix suffix accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown Default null null null null null 1 null null null null null null null null FALSE null null null null null null null null null Type Method Expr String String String String Double Double Double String String String String String String Boolean String String Integer String String String String String String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Code describing the language used in the generated markup for this component. Client side callback to execute when input element loses focus. Client side callback to execute when input element receives focus. Disables input field A localized user presentable name. Client side callback to execute when input element is clicked. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Valid values are LTR and RTL. Direction indication for text that does not inherit directionality. Client side callback to execute when input element is double clicked. Alternate textual description of the input field. Controls browser autocomplete behavior. Client side callback to execute when a key is pressed down over input element. Name of the client side widget.

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

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

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

An actionlistener that’d be processed when button is clicked.primefaces. Specifies the submit mode. when set to true(default).splitbutton. when set to false component will not be rendered.primefaces.104 SplitButton SplitButton displays a command by default and additional ones in an overlay. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class splitButton org. An el expression that maps to a server side UIComponent instance in a backing bean Label for the button A method expression or a String outcome that’d be processed when button is clicked. 380 type ajax submit TRUE String Boolean . when false at invoke_application phase.splitbutton.SplitButton org.component org.component. submit would be made with Ajax.primefaces.primefaces.SplitButton org. Boolean value that determines the phaseId.SplitButtonRenderer Attributes Name id rendered binding value action actionListener immediate Default null TRUE null null null null FALSE Type String Boolean Object String MethodExpr/ String MethodExpr Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when true actions are processed at apply_request_values.component.SplitButtonRenderer org.component.primefaces.PrimeFaces Userʼs Guide 3. Sets the behavior of the button.component.

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

delete}" ajax="false" icon="ui-icon-close"/> <p:separator /> <p:menuitem value="Homepage" url="http://www. Access key that when pressed transfers focus to the button. Disables the button. Position of the button element in the tabbing order.save}" update="messages" icon="ui-icon-disk"> <p:menuitem value="Update" actionListener="#{buttonBean. non-ajax requests as well as regular navigation to an external url. Valid values are LTR and RTL. Getting started with SplitButton SplitButton usage is similar to a regular commandButton. Style class for the button icon. Name of the client side widget. Position of the icon.org" icon="ui-icon-extlink"/> </p:splitButton> 382 . In example below. Direction indication for text that does not inherit directionality. (deprecated: use icon) A localized user presentable name.PrimeFaces Userʼs Guide Name onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos widgetVar Default null null null null FALSE null null null null null FALSE null left null Type String String String String Boolean String String String Integer String Boolean String String String Description Client side callback to execute when text within button is selected by user. Additional commands are placed inside the component and displayed in an overlay.primefaces. <p:splitButton value="Save" actionListener="#{buttonBean. Advisory tooltip information. Alternate textual description of the button. clicking the save button invokes save method of the bean and updates messages. Flag indicating that this component will prevent changes by the user. Code describing the language used in the generated markup for this component. Nested options defined as menuitems do ajax. Icon of the button as a css class.update}" update="messages" icon="ui-icon-arrowrefresh-1-w"/> <p:menuitem value="Delete" actionListener="#{buttonBean.

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

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

An el expression that maps to a server side UIComponent instance in a backing bean. 385 .Stack org.component. MenuModel instance to create menus programmatically Whether to display stack as expanded or not. when set to false component will not be rendered.primefaces.component.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.primefaces.Stack org.component org.StackRenderer org.stack.component.StackRenderer Attributes Name id rendered binding icon openSpeed closeSpeed widgetVar model expanded Default null TRUE null null 300 300 null null FALSE Type String Boolean Object String String Integer String MenuModel Boolean Description Unique identifier of the component. An optional image to contain stacked items. Boolean value to specify the rendering of the component.component. Speed of the animation when opening the stack. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org.primefaces.PrimeFaces Userʼs Guide 3. Name of the client side widget.primefaces. Speed of the animation when opening the stack.stack.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <h:outputText value="#{doc.name}" /> </p:treeNode> </p:tree> 410 . or a document tree with various folders. video). files each having a different formats (music. 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="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc. To begin with here is the final output. Document Explorer is implemented with four different <p:treeNode /> components and additional CSS skinning to visualize expanded/closed folder icons. Suppose you’re using tree to visualize a company with different departments and different employees. 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). <p:tree value="#{bean.

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

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

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

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

Collapsed icon of the node.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Type of the tree node Style class to apply a particular tree node type Icon of the node.primefaces. refer to sections of these components for more information.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. Expanded icon of the node.UITreeNode org.118 TreeNode TreeNode is used with Tree component to represent a node in tree. Info Tag Component Class Component Type Component Family treeNode org. 415 .tree. when set to false component will not be rendered.UITreeNode org.primefaces. 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.

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

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

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

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

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

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

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

user.postalCode}" /> <h:outputText value="City: " /> <h:inputText value="#{userWizard.street}" /> <h:outputText value="Postal Code: " /> <h:inputText value="#{userWizard.city}" /> </h:panelGrid> </p:panel> </p:tab> <p:tab id="contact"> <p:panel header="Contact Information"> <h:messages errorClass="error"/> <h:panelGrid columns="2"> <h:outputText value="Email: *" /> <h:inputText value="#{userWizard.user.user.user.lastname}" required="true"/> <h:outputText value="Age: " /> <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.email}" required="true"/> <h:outputText value="Phone: " /> <h:inputText value="#{userWizard.firstname}" required="true"/> <h:outputText value="Lastname: *" /> <h:inputText value="#{userWizard.user.info}"/> </h:panelGrid> </p:panel> </p:tab> 423 . value"> <h:outputText value="Street: " /> <h:inputText value="#{userWizard.user.phone}"/> <h:outputText value="Additional Info: " /> <h:inputText value="#{userWizard.user.age}" /> </h:panelGrid> </p:panel> </p:tab> <p:tab id="address"> <p:panel header="Adress Details"> <h:messages errorClass="error"/> <h:panelGrid columns="2" columnClasses="label.user.user.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns a boolean value if has all of the given roles or not. Returns a boolean value if has any of the given roles or not. WidgetVar <p:dialog id="dlg"> //contents </p:dialog> <p:commandButton type="button" value="Show" onclick="#{p:widgetVar(‘dlg’)}.PrimeFaces Userʼs Guide 9. 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. 449 . This function is useful if you need to work with javascript. Returns the name of the logged in user.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. 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.

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

sun. <dependencies> <dependency> <groupId>javax.com/svn/examples/trunk/prime-portlet 10.2</version> </dependency> <dependency> <groupId>javax.primefaces</groupId> <artifactId>primefaces</artifactId> <version>2. Here's maven dependencies configuration from portlet sample.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.0.0.0.1</version> </dependency> </dependencies> 451 . http://primefaces. 2.portletfaces</groupId> <artifactId>portletfaces-bridge</artifactId> <version>2.0</version> </dependency> <dependency> <groupId>com.1 Dependencies Only necessary dependency compared to a regular PrimeFaces application is the JSF bridge.googlecode.PrimeFaces Userʼs Guide 10.1 is the latest version of portletfaces at the time of writing.4-b09</version> </dependency> <dependency> <groupId>org.portlet</groupId> <artifactId>portlet-api</artifactId> <version>2.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.faces</groupId> <artifactId>jsf-api</artifactId> <version>2. Portlets PrimeFaces supports portlet environments based on JSF 2 and Portlet 2 APIs.

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful