USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:autoComplete value="#{bean. Flag indicating that this component will prevent changes by the user. it requires a value as usual.complete}" /> public class Bean { } private String text. return results. i++) results.PrimeFaces Userʼs Guide Name onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null FALSE null null null null null Type String String String Boolean Integer String String Integer String Description Client side callback to execute when a pointer button is moved onto input element. } //getter setter 27 . i < 10. Since autoComplete is an input component. Client side callback to execute when a pointer button is released over input element.text}" completeMethod="#{bean. Style class of the input element. Advisory tooltip informaton. Client side callback to execute when text within input element is selected by user. 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>(). Position of the input element in the tabbing order.add(query + i). Inline style of the input element. for (int i = 0. Number of characters used to determine the width of the input element.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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-next .ui-datepicker-title .getDay().ui-datepicker-table .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.ui-datepicker-buttonpane Main container Header container Previous month navigator Next month navigator Title Month display Date table Label of weekends Dates belonging to other months Each cell date Button panel 50 Applies .ui-datepicker-week-end .ui-datepicker-month .widget.ui-datepicker-other-month . ''] } Client Side API Widget: PrimeFaces.ui-datepicker-prev .ui-datepicker .ui-datepicker-header . Style Class . Following is the list of structural style classes.   return [(day != 2 && day != 5).PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.ui-datepicker td .

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

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

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

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

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.component.primefaces. Sets continuous scrolling Sets vertical scrolling binding value var rows first widgetVar circular vertical null null null 3 0 null FALSE FALSE Object Object String Integer Integer String Boolean Boolean 55 .component org.10 Carousel Carousel is a multi purpose component to display a set of data or general content with slide effects. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class carousel org.PrimeFaces Userʼs Guide 3.primefaces.Carousel org.primefaces.CarouselRenderer org.component.Carousel org.CarouselRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.carousel.primefaces. when set to false component will not be rendered.primefaces.component.carousel.component.

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

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

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

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

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

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

Gap between slices.PieChart org.component.component.chart.primefaces.pie. line and more. Title of the chart. 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 .1 Pie Chart Pie chart displays category-data pairs in a pie graphic.chart.primefaces.chart. Render solid slices.chart.PieChart org.pie. bar.primefaces.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pieChart org.12 Charts Charts are used to display graphical data.component. Position of the legend. 3.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered. Style class of the chart.component org.12.primefaces.component.PieChartRenderer org. auto computed by default. Comma separated list of colors in hex format.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. Diameter of the pie.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

68.57.139.5)).7. OhlcChartSeries(2010.01. OhlcChartSeries(2012.143.122.139.addRecord(new ohlcModel.88.46.124.addRecord(new ohlcModel.144.66.139.82.132.79. OhlcChartSeries(2009.129.73. OhlcChartSeries(2012.121.67.04.143. public Bean() { model = new OhlcChartModel().addRecord(new ohlcModel.143.136.addRecord(new ohlcModel.142.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .02)).4)).81)).134.135.135.31.138.56.97)). <p:ohlcChart value="#{bean. OhlcChartSeries(2008.9.56. OhlcChartSeries(2011.addRecord(new ohlcModel. ohlcModel.140.123.addRecord(new } //getter } OhlcChartSeries(2007.76.chart.48)).5.124. public class Bean { private OhlcChartModel model.135.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.135.53.136.139.model.136.144.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.18.primefaces.addRecord(new ohlcModel.55.44)).OhlcChartModel instance. <p:ohlcChart value="#{bean.140.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class confirmDialog org.primefaces.component. Message severity for the displayed icon. when set to false component will not be rendered.component. 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 . Skinning.component.primefaces.ConfirmDialog org.ConfirmDialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Width of the dialog in pixels Width of the dialog in pixels Inline style of the dialog container.PrimeFaces Userʼs Guide 3.ConfirmDialog org. customization and avoiding popup blockers are notable advantages over classic javascript confirmation.20 ConfirmDialog ConfirmDialog is a replacement to the legacy javascript confirmation box. Text to be displayed in body. Text for the header.primefaces.primefaces.ConfirmDialogRenderer org.confirmdialog.confirmdialog.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 Name styleClass closable appendToBody visible Default null TRUE FALSE FALSE Type String Boolean Boolean Boolean Description Style class of the dialog container Defines if close icon should be displayed or not Appends dialog as a child of document body. show() and hide() functions are used to display and close the dialog respectively. Message facet is useful if you need to place custom content instead of simple text.. either via message option or message facet. </p:confirmDialog> Severity Severity defines the icon to display next to the message. You can call these functions to display a confirmation from any component like commandButton. Whether to display confirm dialog on load.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. default severity is alert and the other option is info.destroyWorld}" update="messages" oncomplete="confirmation. Note that header can also be defined using the header attribute or the header facet." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways. 102 . commandLink.hide()"/> <p:commandButton value="Not Yet" onclick="confirmation..hide(). Getting started with ConfirmDialog ConfirmDialog has a simple client side api. <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //. <h:form> <p:commandButton type="button" onclick="cd.

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

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

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

ui-menuitem . 106 . Following is the list of structural style classes.ui-contextmenu . 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. Style Class .ui-menuitem-text Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global. see the dynamic menus part in menu component section for more information and an example.ui-menuitem-link . see the main Skinning section for more information.

component.component.component.Dashboard org.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities.primefaces.primefaces.primefaces.primefaces.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. 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. when set to false component will not be rendered. Disables reordering feature.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.Dashboard org.PrimeFaces Userʼs Guide 3.component.dashboard.DashboardRenderer org. 107 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

lastYearSale}$ </p:column> <p:column> #{sale. <p:dataTable var="sale" value="#{carBean.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.thisYearSale}$ </p:column> <p:columnGroup type="footer"> <p:row> <p:column colspan="3" style="text-align:right" footerText="Totals:"/> <p:column footerText="#{tableBean.lastYearProfit}% </p:column> <p:column> #{sale.thisYearProfit}% </p:column> <p:column> #{sale.lastYearTotal}$" /> <p:column footerText="#{tableBean.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 .manufacturer} </p:column> <p:column> #{sale.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Specifies a draggable that can’t be dropped.component.primefaces.29.PrimeFaces Userʼs Guide 3.component.primefaces.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org.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.Draggable org.dnd.component org.primefaces.component. Id of the component to add draggable behavior Disables draggable behavior when true.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.DraggableRenderer org.primefaces.dnd. 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. 3.component. 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. Specifies drag axis.Draggable org. valid values are ‘x’ and ‘y’. Draggable and Droppable. when set to false component will not be rendered.

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

helper of following panel’s opacity is reduced in dragging.PrimeFaces Userʼs Guide <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I can only be dragged using my header" /> </p:panel> <p:draggable for="pnl" handle="div. <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. actual component is used as the drag indicator. <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. 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. 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.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically. use a clone helper. opacity option can be used to give visual feedback.

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

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

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

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

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

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

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

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

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

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

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

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

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

<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 . initially hidden graphicImage comes up with a fade effect.PrimeFaces Userʼs Guide <h:outputText value="#{bean. Use for option to specify a target.value}"> <p:effect type="pulsate" event="click" /> </h:outputText> Effect Target There may be cases where you want to display an effect on another target on the same page while keeping the parent as the trigger. 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.jpg" style="display:none"/> With this setting. outputLink becomes the trigger for the effect on graphicImage. When the link is clicked.

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

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

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

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

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

172 . you don’t need to manage this using toggleListener and collapsed option.ui-fieldset-legend .PrimeFaces Userʼs Guide Style Class .ui-fieldset .ui-fieldset-toggleable .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. Tips • A collapsed fieldset will remain collapsed after a postback since fieldset keeps its toggle state internally.

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

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

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

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

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

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

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

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

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

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

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

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

Defines visibility of overlays. For this you can use built-in data iteration feature.description}" /> </p:galleria> 185 . Height of the viewport. Getting Started with Galleria Images to displayed are defined as children of galleria.path}" title="#{image. <p:galleria effect="slide" effectDuration="1000"> <p:graphicImage value="/images/image1. Style of the filmstrip. Width of the frames. Defines visibility of captions. Height of the frames.title}" alt="#{image.jpg" title="image1" <p:graphicImage value="/images/image4.PrimeFaces Userʼs Guide Name effect effectSpeed panelWidth panelHeight frameWidth frameHeight filmstripStyle filmstripPosition showFilmstrip showCaptions showOverlays transitionInterval Default fade 700 600 400 60 40 null null TRUE FALSE FALSE 4000 Type String Integer Integer Integer Integer Integer String String Boolean Boolean Boolean Integer Description Name of animation to use. Defines interval of slideshow. Defines visibility of filmstrip. <p:galleria value="#{galleriaBean.jpg" title="image1" <p:graphicImage value="/images/image2. Dynamic Collection Most of the time. you would need to display a dynamic set of images rather than defining each image declaratively. Position of the filmstrip.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.jpg" title="image1" <p:graphicImage value="/images/image3. Width of the viewport.images}" var="image" > <p:graphicImage value="#{image. 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. Duration of animation in milliseconds.

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

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

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

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

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

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

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

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

com/apis/maps/documentation/javascript/reference.DefaultMapModel is the default implementation) Method addOverlay(Overlay overlay) List<Marker> getMarkers() List<Polyline> getPolylines() List<Polygon> getPolygons() List<Circle> getCircles() List<Rectangle> getRectangles() Overlay findOverlay(String id) Adds an overlay to map Returns the list of markers Returns the list of polylines Returns the list of polygons Returns the list of circles Returns the list of rectangles.model.PrimeFaces Userʼs Guide Map Controls Controls on map can be customized via attributes like navigationControl and mapTypeControl. Finds an overlay by it’s unique id 194 Description .getMap().map.122893" zoom="15" type="terrain" style="width:600px. var gmap = yourWidgetVar.381542.primefaces.maps.MapModel (org.primefaces.html GMap API org. use provided getMap() method.google.model.Map instance Full map api is provided at.height:400px" Native Google Maps API In case you need to access native google maps api with javascript. <p:gmap center="41. Alternatively setting disableDefaultUI to true will remove all controls at once.map. //gmap is a google. 2. http://code.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.primefaces. Corner of menu to align with trigger element.primefaces. Id of component whose click event will show the dynamic positioned menu.59 Menu Menu is a navigation component with various customized modes like multi tiers. Boolean value to specify the rendering of the component.primefaces. 257 . ipod style sliding and overlays.menu.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menu org.Menu 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.primefaces. Name of the client side widget.component org. A menu model instance to create menu programmatically.component.component.PrimeFaces Userʼs Guide 3.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.Menu org.MenuRenderer org.menu.

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

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

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

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

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

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

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

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

primefaces.menubutton.primefaces.primefaces. 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.component.MenuButtonRenderer org.61 MenuButton MenuButton displays different commands in a popup menu.MenuButton org.primefaces. Label of the button Style of the main container element Style class of the main container element Name of the client side widget MenuModel instance to create menus programmatically Disables or enables the button.primefaces.component.component. when set to false component will not be rendered.component org.MenuButton org. binding value style styleClass widgetVar model disabled null null null null null null FALSE Object String String String String MenuModel Boolean 266 .component.PrimeFaces Userʼs Guide 3.menubutton.MenuButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. Boolean value to specify the rendering of the component.

second one does the similar but without ajax and third one is used for redirect purposes.ui-menuitem . see the dynamic menus part in menu component section for more information and an example.ui-menuitem-text . Skinning MenuButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global.update}" ajax="false" /> <p:menuitem value="Go Home" url="/home.ui-button-text Applies Container element of menu.jsf" /> </p:menuButton> 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 Button element Label of button 267 .ui-menuitem-link . Following is the list of structural style classes. Following menubutton example has three menuitems.save}" update="comp" /> <p:menuitem value="Update" actionListener="#{bean.ui-button . <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. see the main Skinning section for more information.ui-menu .ui-menu-list . first one is used triggers an action with ajax. Style Class .

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

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

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

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

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

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

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

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

component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class orderList org.orderlist.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering.orderlist.PrimeFaces Userʼs Guide 3.OrderList org.OrderListRenderer org.primefaces. binding value null null Object Object 277 .primefaces.primefaces.OrderList org.primefaces.primefaces.component.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. when set to false component will not be rendered.component.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 org. transition effects and pojo support.

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

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

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

OutputPanelRenderer org.OutputPanelRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component org.OutputPanel org. The problem is although partial output is generated. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax. 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.component. no markup is rendered so for components with conditional rendering regular PPR mechanism may not work since the markup to update on page does not exist.primefaces.primefaces.primefaces. when set to false component will not be rendered.component.outputpanel. An el expression that maps to a server side UIComponent instance in a backing bean Style of the html container element StyleClass of the html container element Layout of the panel.primefaces. valid values are inline(span) or block(div).67 OutputPanel OutputPanel is a panel component with the ability to auto update.component.primefaces. When a JSF component is not rendered.component. 281 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org. OutputPanel is useful in this case. 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.output.PrimeFaces Userʼs Guide 3.OutputPanel org. Enables auto update mode if set true.

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.component. Speed of toggling in milliseconds Renders a toggleable panel as collapsed. 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 Header text Footer text Makes panel toggleable.component org.primefaces.PanelRenderer org.69 Panel Panel is a grouping component with content toggle.component.PanelRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Panel org. close and menu integration.panel.panel.Panel org.primefaces. 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 .component.primefaces.component.PrimeFaces Userʼs Guide 3.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

} Effects Resizing can be animated using animate option and setting an effect name. By default actual element itself is the helper and two options are available to customize the way feedback is provided.ui-resizable-proxy { border: 2px dotted #00F.ui-resizable-proxy which you can override to customize.event. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" proxy="true" /> .primefaces. Enabling ghost option displays the element itself with a lower opacity. it will be called by passing an org. • • • • • • • 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. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" animate="true" effect="swing" effectDuration="normal" /> Following is the list of available effect names. In case you have a listener defined.ResizeEvent instance as a parameter. in addition enabling proxy option adds a css class called . Animation speed is customized using effectDuration option "slow".PrimeFaces Userʼs Guide Visual Feedback Resize helper is the element used to provide visual feedback during resizing. "normal" and "fast" as valid values. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area"> <p:ajax listener="#{resizeBean.handleResize}"> </p:resizable> 322 .

ui-resizable-handle-{handlekey} . ui) { //ui. left after resizing //ui. s. All of these callbacks receive two parameters that provide various information about resize event.PrimeFaces Userʼs Guide public class ResizeBean { } public void handleResize(ResizeEvent event) { int width = event. ui)" /> function handleStop(event.originalPosition = top. ne Proxy helper element for visual feedback Applies 323 .positon = top. onResize and onStop.originalSize = width. height before resizing //ui. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" onStop="handleStop(event. left position before resizing //ui.helper = helper element as a jQuery object //ui. onStart.ui-resizable-proxy Element that is resizable Handle element Particular handle element identified by handlekey like e.getWidth(). int height = event.getHeight().ui-resizable .ui-resizable-handle . } 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 .

ring.Ring org.Ring org.component.primefaces. binding widgetVar value var style styleClass easing null null null null null null swing Object String Object String String String String 324 .ring.primefaces. when set to false component will not be rendered.RingRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.RingRenderer org. Collection to display. Name of the data iterator.primefaces.component.primefaces.82 Ring Ring is a data display component with a circular animation. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ring org.component. Type of easing to use in animation. Style class of the container element.component.component org. 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 container element.PrimeFaces Userʼs Guide 3.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Set editable option to true to use this feature.ui-selectonemenu-trigger . Container of dropdown icon. Items list.ui-selectonemenu-items . Label of the component. see the main Skinning section for more information. Following is the list of structural style classes.ui-selectonemenu-label .ui-selectonemenu-items Main container.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. Each item in the list. As skinning style classes are global. Style Class .ui-selectonemenu . Applies 360 .

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

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

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

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

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

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

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

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

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

Client side callback to execute during sliding. 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="output" /> 370 . you can present a readonly display value and still use slider to provide input. <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. Getting started with Slider Slider requires an input component to work with.number = number.number}" /> <h:outputText value="Set ratio to %" /> <h:outputText id="output" value="#{sliderBean. } <h:inputText id="number" value="#{sliderBean. public class SliderBean { } private int number. Client side callback to execute when slide ends.number}" /> <p:slider for="number" /> Display Value Using display feature.PrimeFaces Userʼs Guide Name onSlideStart onSlide onSlideEnd Default null null null Type String String String Description Client side callback to execute when slide begins. } public void setNumber(int number) { this.

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3. Style class of the submenu. An el expression that maps to a server side UIComponent instance in a backing bean.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. Boolean value to specify the rendering of the component.component.primefaces. Label of the submenu header. see menuitem to see how it is used Inline style of the submenu. 384 . Info Tag Component Class Component Type Component Family submenu org.primefaces. when set to false component will not be rendered.component.Submenu org.105 Submenu Submenu is nested in menu components and represents a sub menu items.primefaces. Icon of a submenu.submenu.Submenu org. 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. when set to false component will not be rendered. Speed of the animation when opening the stack.Stack org. An el expression that maps to a server side UIComponent instance in a backing bean.component.Stack org. MenuModel instance to create menus programmatically Whether to display stack as expanded or not. 385 .component.PrimeFaces Userʼs Guide 3.primefaces.component.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.StackRenderer org.component org.primefaces. Boolean value to specify the rendering of the component. An optional image to contain stacked items. Speed of the animation when opening the stack.stack.primefaces.primefaces.stack. Name of the client side widget.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.primefaces.

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

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

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

Info Tag Component Class Component Type Component Family tab org.primefaces. Tooltip of the tab header.109 Tab Tab is a generic container component used by other PrimeFaces components such as tabView and accordionPanel. Makes the tab closable when enabled. Disables tab element.component.TabView.primefaces.PrimeFaces Userʼs Guide 3.component. Style class of the tab.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. not all attributes may apply to the components that use tab. Title text of the tab Inline style of the tab.primefaces. when set to false component will not be rendered. 389 . Boolean value to specify the rendering of the component. binding title titleStyle titleStyleClass disabled closable titletip null null null null FALSE FALSE null Object Boolean String String Boolean Boolean String Getting started with the Tab See the sections of components who utilize tab component for more information.Tab org. An el expression that maps to a server side UIComponent instance in a backing bean. As tab is a shared component.Tab org.

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

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

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

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

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

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

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

component.component.TerminalRenderer org.component.Terminal org. when set to false component will not be rendered.primefaces.component.primefaces.PrimeFaces Userʼs Guide 3.primefaces. Primary prompt text.terminal.terminal. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .TerminalRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.Terminal org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.

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

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

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

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

ui-toolbar-group-right Main container Divider in a toolbar Left toolbarGroup container Right toolbarGroup container Applies As skinning style classes are global. see the main Skinning section for more information. Additionally p:separator component can be used to separate items in toolbar. Following is the list of structural style classes. 402 .ui-toolbar .ui-toolbar-group-left .PrimeFaces Userʼs Guide Any number of components can be placed inside toolbarGroups. Here is an example. <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. Style Class .ui-toolbar .ui-separator .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.watermark.WatermarkRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.Watermark 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 Text of watermark.primefaces.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> 419 .primefaces.component. <h:inputText id="txt" value="#{bean. Boolean value to specify the rendering of the component.watermark.primefaces. Id of the component to attach the watermark jQuery selector to attach the watermark binding value for forElement null 0 null null Object Integer String String Getting started with Watermark Watermark requires a target of the input component.component.120 Watermark Watermark displays a hint on an input field.component.primefaces.WatermarkRenderer org.primefaces.Watermark org. one way is to use for attribute.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class watermark org.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful