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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.BlockUIRenderer Attributes Name id rendered binding widgetVar Default null TRUE null null Type String Boolean Object String Description Unique identifier of the component.component org.primefaces.BlockUI org.component.component.BlockUI org.component.blockui.BlockUIRenderer org.5 BlockUI BlockUI is used to block JSF components during ajax processing.blockui.primefaces.primefaces.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class blockUI 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 Name of the client side widget.primefaces.primefaces. 33 .

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

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

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

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

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

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

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

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

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

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

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

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

Valid values are. This feature is tuned with the pages attribute. <p:calendar value="#{dateController.date}" pages="3"/> 46 .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. • focus: When input field receives focus • button: When popup button is clicked • both: Both focus and button cases Popup Button <p:calendar value="#{dateBean.PrimeFaces Userʼs Guide showOn option defines the client side event to display the calendar.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

56.68.addRecord(new ohlcModel.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .97)).44)).02)). OhlcChartSeries(2012.139.46.123.139.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.addRecord(new ohlcModel.primefaces. ohlcModel.67.81)).122.143.144. OhlcChartSeries(2009.5. public Bean() { model = new OhlcChartModel().139.7. <p:ohlcChart value="#{bean.138.79.129. OhlcChartSeries(2011. <p:ohlcChart value="#{bean.135.57.143.56.144.139.48)).88.addRecord(new ohlcModel.9.124.143.model.76.66.121.5)).4)).135.135.OhlcChartModel instance.136.134.31.04.addRecord(new ohlcModel.chart.addRecord(new ohlcModel.140.82.136.136. public class Bean { private OhlcChartModel model.132.73.18.140. OhlcChartSeries(2008.addRecord(new } //getter } OhlcChartSeries(2007.53. OhlcChartSeries(2012.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.124.01.135.142. OhlcChartSeries(2010.55.addRecord(new ohlcModel.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

widget.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.CommandButton Method disable() enable() Params Return Type void void Description Disables button Enables button Skinning CommandButton renders a button tag which style and styleClass applies. 97 .ui-button-text-only .ui-button . see the main Skinning section for more information.ui-button-text Button element Button element when icon is not used Label of button Applies As skinning style classes are global. Style Class . Following is the list of structural style classes.

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

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

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

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

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

widget.ui-dialog-content .ui-dialog-titlebar-close .ui-dialog .ConfirmDialog Method show() hide() Params Return Type void void Description Displays dialog. Closes dialog.ui-dialog-title .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. see the main Skinning section for more information. Skinning ConfirmDialog resides in a main container element which style and styleClass options apply. Following is the list of structural style classes. 103 .ui-dialog-buttonpane Applies Container element of dialog Title bar Header text Close icon Dialog body Footer button panel As skinning style classes are global.ui-dialog-titlebar . Style Class .

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

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

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

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

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

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

ui-dashboard . see the main Skinning section for more information. 110 . 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. Here is an example based on a different theme.ui-dashboard-column div.ui-state-hover Applies Container element of dashboard Each column in dashboard Placeholder As skinning style classes are global. This way you can add new panels from outside of the dashboard. 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. <p:dashboard model="#{dashboardBean. Following is the list of structural style classes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ajax based filtering is enabled at column level by setting filterBy option..more columns </p:dataTable> public int sortByModel(Car car1.cars}" sortBy=”#{car. <p:dataTable var="car" value="#{carBean.sortByModel}" headerText=”Model”> <h:outputText value="#{car. Table below would be initially displayed as sorted by model.model}" sortFunction="#{carBean. 0 . you can plug-in your own sort method.more columns </p:dataTable> Data Filtering Similar to sorting. <p:dataTable var="car" value="#{carBean.model}"> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car.. to implement this use the sortBy option of datatable and optional sortOrder. <p:dataTable var="car" value="#{carBean.more columns </p:dataTable> 129 ...model}" sortFunction="#{carBean.model}" /> </p:column> .model}" /> </p:column> . equal to or greater than car2 } DataTable can display data sorted by default.PrimeFaces Userʼs Guide Instead of using the default sorting algorithm which uses a java comparator..model}”> <p:column sortBy="#{car..cars}"> <p:column filterBy="#{car.model}" /> </p:column> .sortByModel}" headerText=”Model”> <h:outputText value="#{car. Car car2) { //return -1. 1 if car1 is less than.cars}" dynamic="true"> <p:column sortBy="#{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.year}" /> </p:column> <p:column filterBy="#{car.model}" headerText="Model" filterMatchMode="contains"> <h:outputText value="#{car.cars}" widgetVar="carsTable"> <f:facet name="header"> <p:outputPanel> <h:outputText value="Search all fields:" /> <h:inputText id="globalFilter" onkeyup="carsTable.manufacturer}" headerText="Manufacturer" filterOptions="#{carBean.filter()" /> </p:outputPanel> </f:facet> <p:column filterBy="#{car. In addition. filterMatchMode defines the built-in matcher which is startsWith by default.model}" /> </p:column> <p:column filterBy="#{car.year}" headerText="Year" footerText="startsWith"> <h:outputText value="#{car. important part is to specify the id of the input text as globalFilter which is a reserved identifier for datatable.manufacturerOptions}" filterMatchMode="exact"> <h:outputText value="#{car. 130 . Following is an advanced filtering datatable with these options demonstrated. <p:dataTable var="car" value="#{carBean. this is implemented by calling client side api method called filter().color}" /> </p:column> </p:dataTable> Filter located at header is a global one applying on all fields. filterStyleClass attributes.color}" headerText="Color" filterMatchMode="endsWith"> <h:outputText value="#{car.manufacturer}" /> </p:column> <p:column filterBy="#{car.PrimeFaces Userʼs Guide Filtering is triggered with keyup event and filter inputs can be styled using filterStyle .

columns </p:dataTable> 131 . private Car[] selectedCars. //add more cars //getters and setters Single Selection with a Command Component This method is implemented with a command component such as commandLink or commandButton. <p:dataTable var="car" value="#{carBean.2005. public } CarBean() { cars = new ArrayList<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.."blue")).selectedCar}" /> </p:commandButton> </p:column> .PrimeFaces Userʼs Guide Row Selection There are several ways to select row(s) from datatable. public class CarBean { } private List<Car> cars.2 or using f:setPropertyActionListener.id}"> . <p:dataTable var="car" value="#{carBean. private Car selectedCar."ManufacturerX".cars}"> <p:column> <p:commandButton value="Select"> <f:setPropertyActionListener value="#{car}" target="#{carBean.cars}" selectionMode="single" selection="#{carBean. if you’d like to enable selection wherever the row is clicked.selectedCar}" rowKey="#{car.columns </p:dataTable> Single Selection with Row Click Previous method works when the button is clicked. 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. use selectionMode option.

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

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

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

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

Set liveScroll to enable this option. <p:dataTable var="car" value="#{carBean. 136 . <p:dataTable var="car" value="#{carBean. x. Expandable Rows RowToggler and RowExpansion facet are used to implement expandable rows.cars}" scrollable="true" height="150" liveScroll="true"> <p:column style="width:100px" .. y and x-y scrolling that are defined by scrollHeight and scrollWidth.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. clicking on a collapsed row loads expanded content with ajax.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. //columns </p:dataTable> Scrolling has 3 modes. live scrolling is necessary to deal with huge data..

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

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

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

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

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

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

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

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

Dialog org. dialog is visible by default.component.dialog.Dialog org.component. When enabled. 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 . An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Text of the header Specifies draggability Specifies resizability Enables modality. when set to false component will not be rendered.primefaces.primefaces.PrimeFaces Userʼs Guide 3.primefaces.dialog.component.component.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.DialogRenderer org.28 Dialog Dialog is a panel component that can overlay other elements on page.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.primefaces. Width of the dialog Height of the dialog Minimum width of a resizable dialog.

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

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

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

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

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

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

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

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

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

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

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

droppedCars}"> <p:column headerText="Model"> <h:outputText value="#{car.manufacturer}.model}" /> </p:column> <p:column headerText="Year"> <h:outputText value="#{car.model}" style="text-align:center"> <p:graphicImage value="/images/cars/#{car." /> <p:dataTable var="car" value="#{tableBean.color}" /> </p:column> </p:dataTable> </p:outputPanel> </p:fieldset> <p:droppable for="selectedCars" tolerance="touch" activeStyleClass="ui-state-highlight" datasource="availableCars" onDrop="handleDrop"/> <p:ajax listener="#{tableBean.year}" /> </p:column> <p:column headerText="Manufacturer"> <h:outputText value="#{car.ui-panel-titlebar" stack=".jpg" /> </p:panel> <p:draggable for="pnl" revert="true" h andle=".fadeOut(‘fast’).droppedCars}" rendered="#{not empty tableBean.droppedCars}" style="font-size:24px. } </script> //fade out the dropped item 157 .manufacturer}" /> </p:column> <p:column headerText="Color"> <h:outputText value="#{car.draggable.availableCars}" columns="3"> <p:column> <p:panel id="pnl" header="#{car. ui) { ui.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.onCarDrop}" update="dropArea availableCars" /> </p:droppable> </h:form> <script type="text/javascript"> function handleDrop(event.PrimeFaces Userʼs Guide <h:form id="carForm"> <p:fieldset legend="AvailableCars"> <p:dataGrid id="availableCars" var="car" value="#{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. <p:graphicImage id="messi" value="barca/messi_thumb. 158 .PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable.jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. only first image can be accepted by droppable. Following example has two images.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb.

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

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

primefaces.PrimeFaces Userʼs Guide 3.Editor org. When it’s an EL expression.component. 161 . 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.editor.Editor org. it must refer to a converter id.editor. Boolean value to specify the rendering of the component.EditorRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class editor org.EditorRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component.component.primefaces. it’s resolved to a converter instance.component org.component.primefaces.component.31 Editor Editor is an input component with rich text editing capabilities.primefaces. In case it’s a static text.primefaces. Value of the component than can be either an EL expression of a literal text.

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

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

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

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

• • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 .PrimeFaces Userʼs Guide <h:outputText value="#{bean. initially hidden graphicImage comes up with a fade effect. Use for option to specify a target.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. <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. List of Effects Following is the list of effects supported by PrimeFaces. outputLink becomes the trigger for the effect on graphicImage. When the link is clicked. Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly.

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. <h:outputText value="#{bean. Following example animates messages with pulsate effect after ajax request completes. <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.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.jquery. <h:outputText value="#{bean. In order to change the configuration of the animation. please see the jquery documentation.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. provide these parameters with the f:param tag. http://docs.action}" update="messages"/> 167 . duration and more.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.component. /> 182 . 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.component.primefaces.FocusTag org.primefaces.primefaces. when set to false component will not be rendered.FocusRenderer org. /> <h:inputText . <p:focus /> <p:inputText .focus..component org.Focus org..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....37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.primefaces. textarea and select. Input component can be any element such as input.focus. 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. /> <h:selectOneMenu .Focus.PrimeFaces Userʼs Guide 3.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

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

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

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

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

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

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

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

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

2" <p:menuitem value="TV.3" </p:submenu> <p:submenu label="TV.3.4.3"> <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.6"> <p:menuitem value="TV.2" </p:submenu> <p:submenu label="TV.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.5.1" <p:menuitem value="TV.2" <p:menuitem value="TV.5.6.1" <p:menuitem value="TV.1.2"> <p:menuitem value="TV.2.6.3" </p:submenu> <p:submenu label="TV.3.4. Style class of the component.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.2.1"> <p:menuitem value="TV.4"> <p:menuitem value="TV.2.1" <p:menuitem value="TV.1" <p:menuitem value="TV.1.3" </p:submenu> </p:column> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> </p:submenu> //more root items </p:megaMenu> 255 .5"> <p:menuitem value="TV.2" <p:menuitem value="TV.1" <p:menuitem value="TV. Getting Started with MegaMenu Layout of MegaMenu is grid based and root items require columns as children to define each section in a grid.6.2" </p:submenu> <p:submenu label="TV.1" <p:menuitem value="TV.5.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

‘warn’ and error. • icon : Only message severity is displayed and message text is visible as a tooltip. • 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. ‘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’.PrimeFaces Userʼs Guide Display Mode Message component has three different display modes. 272 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.primefaces. Message to be displayed when validation fields.component.primefaces.PhotoCam org.primefaces.PhotoCamRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. 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 . 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. it’s resolved to a converter instance.component. Message to be displayed when conversion fails.photocam. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org.photocam.PhotoCam org.component. In case it’s a static text. 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.PhotoCamRenderer org.component org.primefaces. process validations logic is executed at apply request values phase for this component.72 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model. When it’s an EL expression.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

roweditor.RowEditor org.primefaces.component.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.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowEditor org. when set to false component will not be rendered.roweditor.RowEditor org. 328 .primefaces.component.component org.component.primefaces.primefaces.primefaces. 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.84 RowEditor RowEditor is a helper component for datatable.RowEditorRenderer org.PrimeFaces Userʼs Guide 3.

primefaces. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with RowExpansion See datatable expandable rows section for more information about how rowExpansion is used.PrimeFaces Userʼs Guide 3.RowExpansion org. Info Tag Component Class Component Type Component Family rowExpansion org.primefaces.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.primefaces.component.rowexpansion. 329 .RowExpansion org.component. when set to false component will not be rendered.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.

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class scrollPanel org.scrollpanel.component.scrollpanel.component.primefaces. when set to false component will not be rendered.component.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Inline style of the container element.primefaces.primefaces.component org.PrimeFaces Userʼs Guide 3.88 ScrollPanel ScrollPanel is used to display overflowed content with theme aware scrollbars instead of native browsers scrollbars. valid values are default and native.ScrollPanelRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.ScrollPanel org.ScrollPanelRenderer org. binding style styleClass mode null null null default Object String String String 339 .ScrollPanel org.component. Scrollbar display mode. Style class of the container element.

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

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

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

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

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

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

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

primefaces.component org.SelectManyButton org.SelectManyButton org. process validations logic is executed at apply request values phase for this 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.component.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 .component.selectmanybutton.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.primefaces.primefaces. 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. it must refer to a converter id When set true. when set to false component will not be rendered. it’s resolved to a converter instance. When it’s an EL expression.92 SelectManyButton SelectManyButton is a multi select component using button UI.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectManyButton org.selectmanybutton.primefaces.

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

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

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

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

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

primefaces.SelectOneButton org.primefaces.95 SelectOneButton SelectOneButton is an input component to do a single select.PrimeFaces Userʼs Guide 3. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent 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.component. An el expression or a literal text that defines a converter for the component.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 Value of the component referring to a List. process validations logic is executed at apply request values phase for this component.primefaces. it must refer to a converter id When set true.primefaces.SelectOneButton org. it’s resolved to a converter instance. In case it’s a static text.selectonebutton.component.SelectOneButtonRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneButton org.component.component org.selectonebutton. When it’s an EL expression.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-toolbar .ui-separator . Following is the list of structural style classes. 402 . Style Class . <p:toolbar> <p:toolbarGroup align="left"> <p:commandButton type="push" value="New" image="ui-icon-document" /> <p:commandButton type="push" value="Open" image="ui-icon-folder-open"/> <p:separator /> <p:commandButton type="push" title="Save" image="ui-icon-disk"/> <p:commandButton type="push" title="Delete" image="ui-icon-trash"/> <p:commandButton type="push" title="Print" image="ui-icon-print"/> </p:toolbarGroup> <p:divider /> <p:toolbarGroup align="right"> <p:menuButton value="Navigate"> <p:menuitem value="Home" url="#" /> <p:menuitem value="Logout" url="#" /> </p:menuButton> </p:toolbarGroup> </p:toolbar> Skinning Toolbar resides in a container element which style and styleClass options apply.ui-toolbar . 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. Here is an example. see the main Skinning section for more information.ui-toolbar-group-right Main container Divider in a toolbar Left toolbarGroup container Right toolbarGroup container Applies As skinning style classes are global.ui-toolbar-group-left .

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

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

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

ui-tooltip as a style class and is styled with global skinning selectors. 406 .png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only .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. <h:outputLink id="lnk" value="#"> <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> <p:graphicImage value="/images/prime_logo. see main skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

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

component. <h:inputText id="txt" value="#{bean.component.primefaces.PrimeFaces Userʼs Guide 3.watermark.120 Watermark Watermark displays a hint on an input field.WatermarkRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> 419 .Watermark org. Boolean value to specify the rendering of the component.Watermark org. when set to false component will not be rendered.primefaces.component. Id of the component to attach the watermark jQuery selector to attach the watermark binding value for forElement null 0 null null Object Integer String String Getting started with Watermark Watermark requires a target of the input component. An el expression that maps to a server side UIComponent instance in a backing bean Text of watermark.watermark.WatermarkRenderer org.component.component org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class watermark org.primefaces. one way is to use for attribute.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. watermarks are cleared.ui-watermark’. Note that this style class is not applied when watermark uses html5 placeholder if available. Watermark component is clever enough to handle this case. <h:inputText id="txt" value="#{bean.showWatermarks()" /> Skinning There’s only one css style class applying watermark which is ‘. However ajax submissions requires a little manual effort. 420 . you can override this class to bring in your own style. This would result in updating bean properties with watermark values. by default in non-ajax form submissions.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> <h:commandButton value="Submit" /> <p:commandButton value="Submit" onclick="PrimeFaces.

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

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

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

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

define a flowListener.getNextStep().">Next</h:outputLink> <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. String stepToGo = event.PrimeFaces Userʼs Guide Custom UI By default wizard displays right and left arrows to navigate between steps. </p:wizard> <h:outputLink value="#" onclick="wiz.handleFlow}"> .getNextStep(). Client Side Callbacks Wizard is equipped with onback and onnext attributes.next().. 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. Steps here are simply the ids of tab.getCurrentStep().. } if(skip) return "confirm". in case you need to execute custom javascript after wizard goes back or forth. <p:wizard onnext="alert(‘Next’)" onback="alert(‘Back’)"> .... </p:wizard> 425 .">Back</h:outputLink> Ajax FlowListener If you’d like get notified on server side when wizard attempts to go back or forward. if you need to come up with your own UI. else return event.back(). <p:wizard flowListener="#{userWizard. <p:wizard showNavBar="false" widgetVar="wiz"> .

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

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

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

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

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

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

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

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. 433 .PrimeFaces Userʼs Guide 5.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful