Primefaces Users Guide 3 2 | Boolean Data Type | Java Server Faces

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Client side callback to execute when a pointer button is moved onto input element. used to customize date display. Position of the input element in the tabbing order. Advisory tooltip informaton. Client side callback to execute when input element is clicked. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a pointer button is released over input element. Client side callback to execute before displaying a date. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is released over input element. Number of characters used to determine the width of the input element. Client side callback to execute when input element is double clicked. Client side callback to execute when a key is pressed and 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 pointer button is moved away from input element. Client side callback to execute when input element receives focus. 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.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Comma separated list of colors in hex format. Render solid slices. Position of the legend.component org.DonutChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.12. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class donutChart org.component. Style class of the chart.primefaces. Gap between slices.DonutChart org.DonutChartRenderer org.chart.chart.component.component. Specifies interactive legend.primefaces.chart. Format of data labels. 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 data on each slice.4 Donut Chart DonutChart is a combination of pie charts.PrimeFaces Userʼs Guide 3.primefaces.component.donut.donut.chart. Shows shadow or not. Title of the chart.DonutChart org. when set to false component will not be rendered.primefaces. 71 binding widgetVar value style styleClass title legendPosition seriesColors sliceMargin fill shadow showDataLabels dataFormat enhancedLegend null null null null null null null null 0 TRUE TRUE FALSE percent TRUE Object String ChartModel String String String String String Integer Boolean Boolean Boolean String Boolean .primefaces.

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

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

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

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

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

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

5)).model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.135.122.5.124.138.129. OhlcChartSeries(2010. OhlcChartSeries(2011.124.143.18.134.139.144.02)). <p:ohlcChart value="#{bean. <p:ohlcChart value="#{bean.132.addRecord(new ohlcModel. OhlcChartSeries(2008.121.56.46.97)).76. OhlcChartSeries(2009.addRecord(new ohlcModel.9.139.136. public Bean() { model = new OhlcChartModel().123.56.4)).143.79.model.144.55.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .139.chart.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.7.66.143.142.82.48)).addRecord(new ohlcModel.67.57.135.135.140. OhlcChartSeries(2012. ohlcModel.136. OhlcChartSeries(2012.addRecord(new ohlcModel.04.44)).81)).addRecord(new ohlcModel.53.139.88.136.68.31.addRecord(new ohlcModel.OhlcChartModel instance. public class Bean { private OhlcChartModel model.01.addRecord(new } //getter } OhlcChartSeries(2007.primefaces.140.135.73.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

season} </p:column> <p:column> #{stats.allAssists}" /> </p:row> </p:columnGroup> </p:subTable> </p:dataTable> 140 .goals} </p:column> <p:column> #{stats.assists} </p:column> <p:columnGroup type="footer"> <p:row> <p:column footerText="Totals: " style="text-align:right"/> <p:column footerText="#{player. Example below displays a collection of players and a subtable for the stats collection of each player.name}"/> <p:column colspan="2" headerText="Stats" /> </p:row> <p:row> <p:column headerText="Goals" /> <p:column headerText="Assists" /> </p:row> </p:columnGroup> <p:subTable var="stats" value="#{player.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.stats}"> <f:facet name="header"> #{player. <p:dataTable var="player" value="#{tableBean.allGoals}" /> <p:column footerText="#{player.name} </f:facet> <p:column> #{stats.

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

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

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

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

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

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

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

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

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

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

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

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

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

Droppable org.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org.primefaces.component. when set to false component will not be rendered.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. An el expression that maps to a server side UIComponent instance in a backing bean Variable name of the client side widget Id of the component to add droppable behavior Disables of enables droppable behavior Style class to apply when an acceptable draggable is dragged over. Style class to apply when an acceptable draggable is being dragged.component.component. 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 . Client side callback to execute when a draggable is dropped.29.DroppableRenderer org. Selector to define the accepted draggables.Droppable org.dnd.primefaces.primefaces. Id of a UIData component to connect with.primefaces. Scope key to match draggables and droppables.component org. Specifies the intersection mode to accept a draggable.primefaces.PrimeFaces Userʼs Guide 3.dnd.component.

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

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

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

jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. only first image can be accepted by droppable. <p:graphicImage id="messi" value="barca/messi_thumb.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. Following example has two images. Mode fit intersect pointer touch Description draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount Acceptance You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has. 158 .

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

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

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

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

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

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

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

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

<h:outputText value="#{bean.action}" update="messages"/> 167 .PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors. provide these parameters with the f:param tag.jquery. Following example animates messages with pulsate effect after ajax request completes. <h:outputText value="#{bean.com/UI/Effects Effect on Load Effects can also be applied to any JSF component when page is loaded for the first time or after an ajax request is completed by using load as the event name. duration and more. In order to change the configuration of the animation. <p:messages id="messages"> <p:effect type="pulsate" event="load" delay=”500”> <f:param name="mode" value="'show'" /> </p:effect> </p:messages> <p:commandButton value="Save" actionListener="#{bean. please see the jquery documentation.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.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. http://docs.

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

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

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

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

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

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

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

monitorDownload(showStatus.gif" /> </p:dialog> <p:commandButton value="Download" ajax="false" onclick="PrimeFaces.file}"/> </p:commandButton> </h:form> 175 .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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.primefaces.GMapInfoWindow 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. 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.primefaces. 198 .gmap.primefaces.component.GMapInfoWindowTag org.primefaces.component.gmap. when set to false component will not be rendered.GMapInfoWindow org. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.40 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.

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

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

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

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

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

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

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

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

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

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

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

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

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

component.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inplace org.component. Style class of the main container element.InplaceRenderer org. when set to false component will not be rendered.primefaces. 221 binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor null null null null fade normal FALSE null null FALSE Object String String String String String Boolean String String Boolean .component.inplace.inplace.primefaces. Inline style of the main container element.Inplace org. Label to be shown in display mode when value is empty. Label to be shown in display mode.48 Inplace Inplace provides easy inplace editing and inline content display. Prevents hidden content to be shown. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces. Specifies the editor mode.component.primefaces.InplaceRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3. display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled. Effect to be used when toggling.primefaces.Inplace org. Speed of the effect. Inplace consists of two members.

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

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

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

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

log.PrimeFaces Userʼs Guide 3.component.component org.56 Log Log component is a visual console to display logs on JSF pages.LogRenderer org.primefaces.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.component.primefaces.primefaces. when set to false component will not be rendered.LogRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.log.component.Log org.Log org. 250 . 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.

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

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

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

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

3.3"> <p:menuitem value="TV.4"> <p:menuitem value="TV.4.1" <p:menuitem value="TV.6.1"> <p:menuitem value="TV. Style class of the component.2" </p:submenu> <p:submenu label="TV.2.2" </p:submenu> <p:submenu label="TV.2" <p:menuitem value="TV.5.2"> <p:menuitem value="TV.1" <p:menuitem value="TV.6"> <p:menuitem value="TV.1" <p:menuitem value="TV.6.1.3.1.2" <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.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.5.2.1" <p:menuitem value="TV.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.6.5"> <p:menuitem value="TV.4.3" </p:submenu> <p:submenu label="TV.3" </p:submenu> <p:submenu label="TV.2" <p:menuitem value="TV.2.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.1" <p:menuitem value="TV.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

messages component is updated with each ajax request automatically. 274 .PrimeFaces Userʼs Guide Name redisplay autoUpdate Default TRUE FALSE Type Boolean Boolean Description Defines if already rendered messages should be displayed Enables auto update mode if set true. Getting started with Messages Message usage is exactly same as standard messages. <p:messages /> AutoUpdate When auto update is enabled. {severity} can be ‘info’. ‘warn’ and error. ‘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. Skinning Message Full list of CSS selectors of message is as follows.

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

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

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

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

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

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

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

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

Inline style of the panel.primefaces.component.primefaces.OverlayPanelRenderer org. binding widgetVar style styleClass for null null null null null Object String String String String 283 .OverlayPanelRenderer org. Identifier of the target component to attach the panel.68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content.component.component.PrimeFaces Userʼs Guide 3.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.OverlayPanel org.component org.primefaces.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class overlayPanel org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.overlaypanel.overlaypanel. Style class of the panel. when set to false component will not be rendered.

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

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

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

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

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

component 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.panelgrid.PanelGrid org.component.primefaces.component.PanelGridRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.panelgrid.component.PanelGridRenderer org.PanelGridRenderer org.primefaces.primefaces.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org. when set to false component will not be rendered.component.70 PanelGrid PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.

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

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

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

Access key that when pressed transfers focus to the input element. Label of good password. Message to be displayed when validation fields. Enables strength indicator. Label of prompt. Whether or not to display previous value. Valid values are LTR and RTL. Direction indication for text that does not inherit directionality. Id of another password component to match value against. 293 . Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Controls browser autocomplete behavior.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage feedback inline promptLabel Default null null null null null FALSE FALSE Please enter a password 1 Weak Good Strong FALSE null null null null null null FALSE null null null null Type MethodExpr MethodExpr String String String Boolean boolean String Description A method expression that refers to a method validationg the input. Alternate textual description of the input field. level weakLabel goodLabel strongLabel redisplay match widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur Integer String String String Boolean String String String String String String Boolean String String Integer String Level of security. Name of the client side widget. A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Displays feedback inline rather than using a popup. Message to be displayed when conversion fails. Client side callback to execute when input element loses focus. Label of weak password. Label of strong password. Maximum number of characters that may be entered in this field.

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

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

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

component.PhotoCamRenderer org. Message to be displayed when validation fields.primefaces.PhotoCam org.primefaces.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 . Message to be displayed when conversion fails.primefaces.primefaces.72 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model.component.photocam.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org.PhotoCam org. when set to false component will not be rendered. In case it’s a static text. it must refer to a converter id When set true.component org.component. When it’s an EL expression. it’s resolved to a converter instance.PrimeFaces Userʼs Guide 3.photocam. process validations logic is executed at apply request values phase for this component.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. 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.

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

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

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

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

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

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

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

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

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

">Start</a> <a href="#" onclick="myPoll.start(). <h:form> <h:outputText id="txt_count" value="#{counterBean.">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. 307 .count}" /> <p:poll interval="5" actionListener="#{counterBean.PrimeFaces Userʼs Guide Start and Stop Poll can be started and stopped using client side api.stop().

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Effect duration of animation.component. Specifies the resize handles.Resizable org.component org.primefaces. 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. 320 . Enables animation. Defines if aspectRatio should be kept or not.81 Resizable Resizable component is used to make another JSF component resizable. Maximum height boundary in pixels. Minimum width boundary in pixels.resizable. Maximum height boundary in pixels.component.Resizable org. Displays proxy element instead of actual element.primefaces.primefaces.primefaces. when set to false component will not be rendered.component.resizable. Maximum width boundary in pixels.ResizableRenderer Attributes Name id rendered binding widgetVar for aspectRatio proxy handles ghost animate effect effectDuration maxWidth maxHeight minWidth minHeight Default null TRUE null null null FALSE FALSE null FALSE FALSE swing normal null null 10 10 Type String Boolean Object String String Boolean Boolean String Boolean Boolean String String Integer Integer Integer Integer Description Unique identifier of the component Boolean value to specify the rendering of the component. Identifier of the target component to make resizable. resize helper is displayed as the original element with less opacity.ResizableRenderer org.component. In ghost mode. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org. Effect to use in animation.

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

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

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

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

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

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

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

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

primefaces. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean 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. 329 .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. Info Tag Component Class Component Type Component Family rowExpansion org.RowExpansion org.primefaces.component.primefaces.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.component.RowExpansion org.rowexpansion.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<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. Following slider can slide between -100 and +100. Default value is one and it is customized using step option.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. <h:inputText id="number" value="#{sliderBean.number}" /> <p:slider for="number" step="10" /> Animation Sliding is animated by default. if you want to turn it of animate attribute set the animate option to false.number}" /> <p:slider for="number" minValue="-100" maxValue="100"/> 371 .

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

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

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

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

Message to be displayed when conversion fails. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Alternate textual description of the input field. Disables input field A localized user presentable name.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stepFactor min max prefix suffix accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown Default null null null null null 1 null null null null null null null null FALSE null null null null null null null null null Type Method Expr String String String String Double Double Double String String String String String String Boolean String String Integer String String String String String String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element receives focus. Maximum number of characters that may be entered in this field. Client side callback to execute when input element is double clicked. Code describing the language used in the generated markup for this component. Client side callback to execute when input element is clicked. Message to be displayed when validation fields. Client side callback to execute when input element loses focus. 376 . Stepping factor for each increment and decrement Minimum boundary value Maximum boundary value Prefix of the input Suffix of the input Access key that when pressed transfers focus to the input element. Controls browser autocomplete behavior. Name of the client side widget. 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 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.number}" /> 377 . Inline style of the input element.PrimeFaces Userʼs Guide Name onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null null null null null null FALSE null null null null null Type String String String String String String String String Boolean Integer String String Integer String Description Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. 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. Advisory tooltip informaton. Style class of the input element. Position of the input element in the tabbing order. public class SpinnerBean { } private int number. Client side callback to execute when a pointer button is released over input element. 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. //getter and setter <p:spinner value="#{spinnerBean.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

0".0". node10). TreeNode node11 = new TreeNode("Node 1. //getter Then specify a UI treeNode component as a child to display the nodes.root}" var="node"> <p:treeNode> <h:outputText value="#{node}"/> </p:treeNode> </p:tree> 408 . node1).1". node0). root). TreeNode node10 = new TreeNode("Node 1. node1). TreeNode node000 = new TreeNode("Node 0. node00).1". null). public } TreeBean() { root = new TreeNode("Root". TreeNode node01 = new TreeNode("Node 0.primefaces. TreeNode node0 = new TreeNode("Node 0".0". TreeNode node1 = new TreeNode("Node 1".0".0". TreeNode node001 = 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.1. TreeNode node00 = new TreeNode("Node 0. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. root). public class TreeBean { } private TreeNode root.1". root).0. <p:tree value="#{treeBean.0.model. node00). node01).TreeNode instance which corresponds to the root. TreeNode node2 = new TreeNode("Node 2". Style of the main container element of tree Style class of the main container element of tree Defines the selectionMode Getting started with the Tree Tree is populated with a org.0. TreeNode node100 = new TreeNode("Node 1. node0). TreeNode node010 = new TreeNode("Node 0. TreeNode array to reference the selections.

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

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

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

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

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

ui-tree-nodes .PrimeFaces Userʼs Guide ContextMenu Tree has special integration with context menu.ui-tree .ui-tree-node . Skinning Tree resides in a container element which style and styleClass options apply. see the main Skinning section for more information.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. Following is the list of structural style classes. Style Class .ui-tree-node-content .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. 414 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

process:’userForm’ . 440 .oncomplete:function(xhr.source:’userForm’ .source:’userForm’ . ‘param_name2’:’value2’ } .ajax. PrimeFaces.AjaxRequest({ formId:’userForm’ .user.} })..PrimeFaces Userʼs Guide Examples Suppose you have a JSF page called createUser with a simple form and some input components.params:{ ‘param_name1’:’value1’.name}" /> .process:’userForm’ }).AjaxRequest({ formId:’userForm’. .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. PrimeFaces. More components </h:form> You can post all the information in form with ajax using.AjaxResponse PrimeFaces. More complex example with additional options. We highly recommend using p:remoteComponent instead of low level javascript api as it generates the same with much less effort and less possibility to do an error.. status) {alert(‘Done’).update:’msgs’ . PrimeFaces.ajax. <h:form id="userForm"> <h:inputText id="username" value="#{userBean.ajax.ajax.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful