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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ajaxStatus org.primefaces. Client side callback to execute when an ajax request fails.AjaxStatusRenderer org.primefaces.ajaxstatus. Client side callback to execute after ajax requests completed succesfully. 21 . Client side callback to execute before ajax requests start. Client side callback to execute after ajax requests complete.primefaces.component. Inline style of the component. Boolean value to specify the rendering of the component.primefaces.component. 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.ajaxstatus.PrimeFaces Userʼs Guide 3.3 AjaxStatus AjaxStatus is a global notifier for ajax requests made by PrimeFaces components.AjaxStatus org.component.AjaxStatusRenderer Attributes Name id rendered binding onstart oncomplete onprestart onsuccess onerror style styleClass widgetVar Default null TRUE null null null null null null null null null String Boolean Object String String String String String String String String Type Description Unique identifier of the component.component org.component. Style class of the component. Name of the client side widget.

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

facetId) Params eventName: Name of status event. 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.AjaxStatus Method bindFacet(eventName. Styling directly applies to a container element which contains the facets. if you’d like to implement advanced cases with scripting you can take advantage of on* callbacks which are the event handler counterparts of the facets.widget.show()" oncomplete="status. 23 . <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. <p:ajaxStatus onstart="status. Provide a fixed width/height to the ajaxStatus to prevent page layout from changing.height:32px" .PrimeFaces Userʼs Guide Custom Events Facets are the declarative way to use. /> Tips • • • • Avoid updating ajaxStatus itself to prevent duplicate facet/callback bindings. <p:ajaxStatus style="width:32px. There is an ajax loading gif bundled with PrimeFaces which you can use. facetId: Element id of facet container eventName: Name of status event.. fn) void Binds a function to an event Skinning AjaxStatus is equipped with style and styleClass..

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Disables the calendar when set to true. Defines how the calendar will be displayed. readOnlyInputText showButtonPanel effect effectDuration showOn FALSE FALSE null normal both Boolean Boolean String String String 42 . Icon of the popup button When enabled.TimeZone instance to specify the timezone used for date conversion.getDefault () Makes input text of a popup calendar readonly. Message to be displayed when conversion fails. Message to be displayed when validation fails. Duration of the effect. defaults to TimeZone.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.util. Visibility of button panel containing today and done buttons. 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. Effect to use when displaying and showing the popup calendar. Sets calendar's minimum visible date Sets calendar's maximum visible date Enables multiple page rendering. popup icon is rendered without the button. Name of the client side widget.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

12 Charts Charts are used to display graphical data.component.PieChart org. Position of the legend. 3.PieChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Gap between slices.12. 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.primefaces. auto computed by default.pie. Title of the chart. Style class of the chart.chart.component.chart.component org.PieChartRenderer org.component.primefaces. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. bar.pie.1 Pie Chart Pie chart displays category-data pairs in a pie graphic. line and more. There’re various chart types like pie.primefaces. Diameter of the pie.chart. 62 binding widgetVar value style styleClass title legendPosition seriesColors diameter sliceMargin fill null null null null null null null null null 0 TRUE Object String ChartModel String String String String String Integer Integer Boolean .component. Render solid slices.PieChart org. Comma separated list of colors in hex format.chart.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model.124.18.138.55.02)).144.132.48)).addRecord(new ohlcModel. ohlcModel. OhlcChartSeries(2008.7.134.79. OhlcChartSeries(2009.53.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.124.136.44)).97)).88.144.135.140.143.142.68.121.73.143.56.143.139.OhlcChartModel instance.addRecord(new ohlcModel.addRecord(new ohlcModel.5)). public Bean() { model = new OhlcChartModel().primefaces.136. OhlcChartSeries(2010.139.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .140.57.5.67.56.76.123.135. OhlcChartSeries(2012.addRecord(new ohlcModel.addRecord(new ohlcModel.139. OhlcChartSeries(2012. <p:ohlcChart value="#{bean.9.66.04.chart.46.01. <p:ohlcChart value="#{bean.31.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.139.4)).135. OhlcChartSeries(2011.82.135.129.122.136.addRecord(new ohlcModel.81)).addRecord(new } //getter } OhlcChartSeries(2007. public class Bean { private OhlcChartModel model.

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

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

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

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

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

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

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

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

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

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

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

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

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

component.component.primefaces.primefaces.primefaces. when set to false component will not be rendered. 92 .17 ColumnGroup ColumnGroup is used by datatable for column grouping. Info Tag Component Class Component Type Component Family columnGroup org.ColumnGroup org. ColumnGroup org. binding type null null Object String Getting Started with ColumnGroup See grouping section in datatable documentation for detailed information.columngroup.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. valid values are “header” and “footer”.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Type of group.

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

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

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

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

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

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

Client side callback to execute when ajax request fails. Character encoding of the resource designated by this hyperlink. Client side callback to execute when link is clicked. Client side callback to execute when a key is pressed and released over link. Client side callback to execute when ajax request succeeds. Client side callback to execute when link is double clicked. 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 link receives focus. Client side callback to execute when a pointer button is moved within link. Client side callback to execute when a pointer button is moved onto link. Client side callback to execute when a pointer button is released over link. 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.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. 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 pointer button is moved away from link. Client side callback to execute when a pointer button is pressed down over link. Defines whether to trigger ajaxStatus or not. Client side callback to execute when a key is released over link. Client side callback to execute when a key is pressed down over link.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

. options to display is provided via rowsPerPageTemplate attribute (e. </p:dataGrid> Paginator Template Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls. dataList and dataTable. " {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropDown}" " {PreviousPageLink} {CurrentPageReport} {NextPageLink}" 118 .{totalPages}. Default is {currentPage} of{totalPages}. Default UI is. Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option. • • • • • • • FirstPageLink LastPageLink PreviousPageLink NextPageLink PageLinks CurrentPageReport RowsPerPageDropDown Note that {RowsPerPageDropDown} has it’s own template. Note that this section applies to dataGrid. "{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. <p:dataGrid var="car" value="#{carBean. rowsPerPageTemplate="9. You can use {currentPage}.15").g.{endRecord} keyword within currentPageReportTemplate.12..{startRecord}.{totalRecords}.cars}" columns="3" rows="12" paginator="true"> . which corresponds to the following template.

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

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

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.PrimeFaces Userʼs Guide 3.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataList org.DataListRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.DataList.primefaces.component.component. Number of rows to display per page.DataListTag org.25 DataList DataList presents a collection of data in list layout with several display types.DataListRenderer org.primefaces.datalist.datalist.component.DataList org. 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. Name of the request-scoped variable used to refer each data.primefaces.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<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. 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.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically. opacity option can be used to give visual feedback. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am dragged on an axis only" /> </p:panel> <p:draggable for="pnl" axis="x or y"/> Clone By default. use a clone helper. 152 . if you need to keep the component at it’s original location. revert option enables the component to move back to it’s original position with an animation. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I am cloned" /> </p:panel> <p:draggable for="pnl" helper="clone"/> Revert When a draggable is not dropped onto a matching droppable.

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

primefaces.primefaces. when set to false component will not be rendered.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Variable name of the client side widget Id of the component to add droppable behavior Disables of enables droppable behavior Style class to apply when an acceptable draggable is dragged over.Droppable org.component.Droppable org.DroppableRenderer org.primefaces.primefaces.29. Selector to define the accepted draggables.primefaces. Client side callback to execute when a draggable is dropped. Id of a UIData component to connect with.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org. binding widgetVar for disabled hoverStyleClass activeStyleClass onDrop accept scope tolerance datasource null null null FALSE null null null null null null null Object String String Boolean String String String String String String String 154 .PrimeFaces Userʼs Guide 3.component.component. Style class to apply when an acceptable draggable is being dragged. Scope key to match draggables and droppables. Specifies the intersection mode to accept a draggable.dnd.dnd.component org.component.

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

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

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

jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. only first image can be accepted by droppable. 158 .PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable. <p:graphicImage id="messi" value="barca/messi_thumb. Following example has two images.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. 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.

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

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

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

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

text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls. <p:editor value="#{bean.widget. subsequent calls do not reinit the editor.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. Clears the text in editor. Saves html text in iframe back to the textarea.PrimeFaces Userʼs Guide Custom Toolbar Toolbar of editor is easy to customize using controls option. .

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

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

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

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

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

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

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

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

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

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

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

file}"/> </p:commandButton> </h:form> 175 .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. hideStatus)"> <p:fileDownload value="#{fileDownloadController.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

LatLngBounds Property center northEast southWest Default null null null Type LatLng LatLng LatLng Description Center coordinate of the boundary NorthEast coordinate of the boundary SouthWest coordinate of the boundary GMap Event API All classes in event api extends from javax.map.map.PointSelectEvent Property latLng Default null Type LatLng Description Coordinates of the selected point org.map.event.event.PrimeFaces Userʼs Guide org.map.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 . org.primefaces.primefaces.primefaces.event.primefaces.model.faces.event.primefaces.FacesEvent.MarkerDragEvent Property marker Default null Type Marker Description Dragged marker instance org.map.

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

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

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

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

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

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

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

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

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

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

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

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

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

Example below displays messages for each event.PrimeFaces Userʼs Guide Controlling Timeout By default. <p:idleMonitor timeout="5000" update="messages"> <p:ajax event="idle" listener="#{bean.idleListener}" update="msg" /> <p:ajax event="active" listener="#{bean. Ajax Behavior Events IdleMonitor provides two ajax behavior events which are idle and active that are fired according to user status changes.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. 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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

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

<p:lightBox iframe="true"> <h:outputLink value="http://www. Client side callback to execute when lightbox is hidden. you can display other JSF content on the page using the lightbox 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.jpg" title="Sopranos 1"> <h:graphicImage value="sopranos/sopranos1_small.PrimeFaces Userʼs Guide Name width heigth iframe visible onHide onShow Default null null FALSE FALSE null null Type String String Boolean Boolean String String Description Width of the overlay in iframe mode. Following lightBox is displayed when any of the links are clicked. Height of the overlay in iframe mode. Simply place your overlay content in the "inline" facet. Clicking the link in the example below will display the panelGrid contents in overlay.org" title="PrimeFaces HomePage"> <h:outputText value="PrimeFaces HomePage"/> </h:outputLink> </p:lightBox> Clicking the outputLink will display PrimeFaces homepage within an iframe.primefaces. Client side callback to execute when lightbox is displayed. Specifies an iframe to display an external url in overlay. 248 . Displays lightbox without requiring any user interaction by default. <p:lightBox> <h:outputLink value="sopranos/sopranos1. Inline Mode Inline mode acts like a modal dialog.

249 . As skinning style classes are global. Content container.ui-lightbox-content .LightBox Method show() hide() Params Return Type void void Displays lightbox.widget. Clicking the link in the example below will display the panelGrid contents in overlay. Loading image.ui-lightbox-nav-left . Previous image navigator.ui-lightbox-content-wrapper .ui-lightbox . Simply place your overlay content in the "inline" facet. Following is the list of structural style classes. Caption element. Next image navigator.ui-lightbox-loading . Content wrapper element.ui-lightbox-nav-right . Style Class . Hides lightbox.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. Description Skinning Lightbox resides in a main container element which style and styleClass options apply. Client Side API Widget: PrimeFaces. see the main Skinning section for more information. you can display other JSF content on the page using the lightbox overlay.ui-lightbox-caption Applies Main container element.

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

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

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

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

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

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

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

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

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

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

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

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

262 .ui-menuitem-link .ui-menu-list .ui-menuitem . see the main Skinning section for more information.PrimeFaces Userʼs Guide Style Class .ui-menuitem-text .ui-menu .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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component. 281 .OutputPanel org. Enables auto update mode if set true. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel org. The problem is although partial output is generated. valid values are inline(span) or block(div).component. When a JSF component is not rendered. An el expression that maps to a server side UIComponent instance in a backing bean Style of the html container element StyleClass of the html container element Layout of the panel.primefaces.component. 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.67 OutputPanel OutputPanel is a panel component with the ability to auto update. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax.primefaces. 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. OutputPanel is useful in this case.primefaces.component. when set to false component will not be rendered.component org.outputpanel.OutputPanel 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. 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.output.OutputPanelRenderer org.PrimeFaces Userʼs Guide 3.

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

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

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

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

primefaces.component.primefaces.component org. close and menu integration. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.Panel org.Panel org.panel.primefaces.component.PanelRenderer org.primefaces.component.panel. 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 .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.component.PrimeFaces Userʼs Guide 3.primefaces. Speed of toggling in milliseconds Renders a toggleable panel as collapsed. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Header text Footer text Makes panel toggleable.69 Panel Panel is a grouping component with content toggle.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

event. Disables component. //Add facesmessage } //getter-setter Client Side API Widget: PrimeFaces. A defined listener will be executed by passing an org. Enables component. <p:rating value="#{ratingBean.star-rating-control .getRating(). Style Class .primefaces.star-rating-on .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 .widget. public void handleRate(RateEvent rateEvent) { int rating = (int) rateEvent. Skinning Following is the list of css classes for star rating.rating-cancel .RateEvent as a parameter.handleRate}" update="msgs" /> </p:rating> <p:messages id="msgs" /> public class RatingBean { } private double rating.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}"> <p:ajax event="rate" listener="#{ratingBean.star-rating .

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org.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.PrimeFaces Userʼs Guide 3. resize helper is displayed as the original element with less opacity. Effect to use in animation. Maximum height boundary in pixels. Minimum width boundary in pixels. Enables animation.primefaces.component.Resizable org.ResizableRenderer org.primefaces. Effect duration of animation. Identifier of the target component to make resizable.resizable.primefaces. Specifies the resize handles.component. Defines if aspectRatio should be kept or not.primefaces.resizable. In ghost mode. Maximum width boundary in pixels. Maximum height boundary in pixels.primefaces. when set to false component will not be rendered.component.Resizable org.component. 320 .81 Resizable Resizable component is used to make another JSF component resizable.component org. Displays proxy element instead of actual element.

Client side callback to execute when resizing begins. Getting started with Resizable Resizable is used by setting for option as the identifier of the target. s.sw. maxWidth. sw and nw as the value. Client side callback to execute after resizing end. There’re 4 attributes for this minWidth. w. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" handles="e. <p:graphicImage id="img" value="campnou. Client side callback to execute during resizing. s. se.jpg" /> <p:resizable for="img" /> Another example is the input fields.ne. Snaps resizing to grid structure. minHeight and maxHeight. e.PrimeFaces Userʼs Guide Name containment grid onStart onResize onStop Default FALSE 1 null null null Type Boolean Integer String String String Description Sets resizable boundaries as the parents size. The valid values for these attributes are numbers in terms of pixels. if users need more space for a textarea. make it resizable by. ne. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" minWidth="20" minHeight="40" maxWidth="50" maxHeight="100"/> Handles Resize handles to display are customize using handles attribute with a combination of n. se". <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.w.n.nw"/> 321 . boundaries need to be specified. Default value is "e.se.

<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.handleResize}"> </p:resizable> 322 . Enabling ghost option displays the element itself with a lower opacity.PrimeFaces Userʼs Guide Visual Feedback Resize helper is the element used to provide visual feedback during resizing. } 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. in addition enabling proxy option adds a css class called . 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"> <p:ajax listener="#{resizeBean.event. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" proxy="true" /> .ResizeEvent instance as a parameter.ui-resizable-proxy which you can override to customize.primefaces.ui-resizable-proxy { border: 2px dotted #00F. "normal" and "fast" as valid values. Animation speed is customized using effectDuration option "slow".

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

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

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

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

component.row.Row org.component. 327 .primefaces.PrimeFaces Userʼs Guide 3.Row org. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See datatable grouping section for more information about how row is used.primefaces. when set to false component will not be rendered.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.83 Row Row is a helper component for datatable.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

101 Slider Slider is used to provide input with various customization options like orientation.component. "horizontal" or "vertical".slider.component.component org.PrimeFaces Userʼs Guide 3.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.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 . display modes and skinning. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.primefaces.component.component.Slider org.Slider org.primefaces.primefaces.primefaces. Minimum value of the slider Maximum value of the slider Inline style of the container element Style class of the container element Boolean value to enable/disable the animated move when background of slider is clicked Sets the type of the slider.slider. Fixed pixel increments that the slider move in Disables or enables the slider. 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 Id of the input text that the slider will be used for Id of the component to display the slider value.

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

number}" /> <p:slider for="number" step="10" /> Animation Sliding is animated by default. <h:inputText id="number" value="#{sliderBean. if you want to turn it of animate attribute set the animate option to false. Following slider can slide between -100 and +100. Boundaries Maximum and minimum boundaries for the sliding is defined using minValue and maxValue attributes. <h:inputText id="number" value="#{sliderBean. vertical sliding is also supported and can be set using the type attribute. <h:inputText id="number" value="#{sliderController.number}" /> <p:slider for="number" minValue="-100" maxValue="100"/> 371 .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" type="vertical" minValue="0" maxValue="200"/> Step Step factor defines the interval between each point during sliding.

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

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

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

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

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

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

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

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

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

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

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

ui-button-text-only .ui-menu .SplitButton Method show() hide() Params Return Type void void Description Displays overlay.ui-splitbutton .ui-splitbutton-menubutton .widget. Style Class . see the main Skinning section for more information.ui-menu-list .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-menuitem-link .ui-button . Button element Dropdown button Button element when icon is not used Label of button Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global.ui-menuitem-text Container element. Hides overlay.ui-button-text .ui-menuitem . 383 .

Info Tag Component Class Component Type Component Family submenu org.component. binding label icon style styleClass null null null null null Object String String String String Getting started with Submenu Please see Menu or Menubar section to find out how submenu is used with the menus.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean.Submenu org.primefaces.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered. Icon of a submenu.105 Submenu Submenu is nested in menu components and represents a sub menu items.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. 384 .submenu. Style class of the submenu.component.primefaces. Boolean value to specify the rendering of the component.Submenu org. see menuitem to see how it is used Inline style of the submenu. Label of the submenu header.

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

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

Getting started with SubTable See DataTable section for more information. An el expression that maps to a server side UIComponent instance in a backing bean Data of the component. when set to false component will not be rendered.component org.SubTableRenderer Attributes Name id rendered binding value var Default null TRUE null null null Type String Boolean Object Object String Description Unique identifier of the component Boolean value to specify the rendering of the component. 387 .PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class subTable org.SubTable org.subtable.subtable.primefaces.107 SubTable SummaryRow is a helper component of datatable used for grouping.component.SubTable org.component.primefaces.component.primefaces.SubTableRenderer org.primefaces.primefaces. Name of the data iterator.component.

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

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

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

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

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

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

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

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

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

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.themeswitcher. Inline style of the component.ThemeSwitcher org.ThemeSwitcher org.component.component org.ThemeSwitcherRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.PrimeFaces Userʼs Guide 3.primefaces.ThemeSwitcherRenderer org. User presentable name. Disables the component.component.primefaces. Duration of the animation in milliseconds. when set to false component will not be rendered. Client side callback to execute on theme change.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class themeSwitcher org.primefaces. Name of the animation.themeswitcher.primefaces.113 ThemeSwitcher ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh. 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.

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

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

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

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

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

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

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. see main skinning section for more information. 406 .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.png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only . An example is as follows.

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

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

tree will render that node as expanded.setExpanded(true) on a particular node. Encapsulated data List of child nodes Parent node Flag indicating whether the node is expanded or not Dynamic Tree Tree is non-dynamic by default and toggling happens on client-side.primefaces. When a node is expanded. In order to enable ajax toggling set dynamic setting to true. this mode is suitable for relatively small datasets and provides fast user interaction. compared to the client toggling. 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. default type name is "default". <p:tree value="#{treeBean. on the other hand <p:treeNode /> tag represents a component of type org. Property type data children parent expanded String Object List<TreeNode> TreeNode Boolean Type Description type of the treeNode name.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 only loads the children of the particular expanded node and send to the client for display.tree.component. On the otherhand it’s not suitable for large data since all the data is sent to the client. 409 . dynamic mode has the advantage of dealing with large data because only the child nodes of the root node is sent to the client initially and whole tree is lazily populated.UITreeNode. Document Tree example in upcoming section demonstrates a sample usage.model. 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.TreeNode instances. For example if you call node.primefaces.

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

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

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

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

ui-tree-node .ui-tree-icon .ui-tree . see the main Skinning section for more information.ui-tree-nodes .ui-tree-node-content .PrimeFaces Userʼs Guide ContextMenu Tree has special integration with context menu. Style Class . Skinning Tree resides in a container element which style and styleClass options apply. 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. you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type. Following is the list of structural style classes.

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

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

root}" var="document"> <p:column> <f:facet name="header"> Name </f:facet> <h:outputText value="#{document. private String type. For an example. model to be displayed is a collection of documents. public class Document { } private String name. Height of scrollable data. setters <p:treeTable value="#{bean. Inline style of the table element. Getting started with the TreeTable Similar to the Tree.model. //getters.type}" /> </p:column> </p:treeTable> 417 .primefaces.PrimeFaces Userʼs Guide Name selectionMode scrollable scrollHeight scrollWidth tableStyle tableStyleClass Default null FALSE null null null null Type String Boolean Integer Integer String String Type of selection mode.TreeNode instance that corresponds to the root node.name}" /> </p:column> <p:column> <f:facet name="header"> Size </f:facet> <h:outputText value="#{document.size}" /> </p:column> <p:column> <f:facet name="header"> Type </f:facet> <h:outputText value="#{document. TreeTable is populated with an org. private String size. Style class of the table element. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. Description Whether or not the data should be scrollable. Width of scrollable data.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful