USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Label of the item. Inline style of the items container element. Value of the item. Message to be displayed when required field validation fails. Name of the client side widget. Method providing suggestions. Client side callback to execute before ajax request to load suggestions begins. Message to be displayed when validation fails. process validations logic is executed at apply request values phase for this component. Enables dropdown mode when set true. Delay to wait in milliseconds before sending each query to the server. Marks component as required. Effect to use when showing/hiding suggestions. A method expression that refers to a method validationg the input. Maximum number of results to be displayed. A method expression that refers to a method for handling a valuchangeevent. autoComplete only accepts input from the selection list.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true. Duration of effect in milliseconds. Message to be displayed when conversion fails. Client side callback to execute after ajax request to load suggestions completes. Defines the height of the items viewport. Defines whether to trigger ajaxStatus or not. required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar completeMethod var itemLabel itemValue maxResults minQueryLength queryDelay forceSelection onstart oncomplete global scrollHeight effect effectDuration dropdown panelStyle FALSE null null null null null null null null null null unlimited 1 300 FALSE null null TRUE null null 400 FALSE null Boolean MethodExpr MethodExpr String String String String MethodExpr String String String Integer Integer Integer Boolean String String Boolean Integer String Integer Boolean String 25 . Number of characters to be typed before starting to query. Name of the iterator used in pojo based suggestion. When enabled.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly.date}" mode="inline" navigator="true" /> TimePicker TimePicker functionality is enabled by adding time format to your pattern. Following example disabled tuesdays and fridays. The function returns an array with two values. <p:calendar value="#{dateBean. first one is flag to indicate if date would be displayed as enabled and second parameter is the optional style class to add to date cell.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.primefaces.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. valid values are “vertical” and “horizontal”. Position of the legend.primefaces.BarChart org.component.primefaces.component org.12.bar. Style class of the chart.BarChart 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.chart.BarChartRenderer org. Padding of bars.primefaces. Margin of bars. Enables stacked display of bars. Title of the chart.component.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 .PrimeFaces Userʼs Guide 3. Minimum boundary value.chart.chart.component. Maximum boundary value.chart. Orientation of bars.bar.component.

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

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

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

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

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

BubbleChart org. Comma separated list of colors in hex format.PrimeFaces Userʼs Guide 3. Label of the x-axis. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.primefaces.bubble.component.primefaces.primefaces.component. Alpha transparency of a bubble.chart.component.primefaces.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values. 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 .component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org. Enables gradient fills instead of flat colors.chart.bubble. Displays labels on buttons.BubbleChart org.component org.chart.chart. Title of the chart. Style class of the chart.primefaces.12.BubbleChartRenderer org. Specifies interactive legend. Position of the legend. Shows shadow or not.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.

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

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

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

143.81)). public class Bean { private OhlcChartModel model.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.142.66. OhlcChartSeries(2008.4)).04.88.55.chart.18.addRecord(new ohlcModel.01.5.31.addRecord(new } //getter } OhlcChartSeries(2007. <p:ohlcChart value="#{bean.46.7.addRecord(new ohlcModel.48)).136.134.135.addRecord(new ohlcModel.121.129.136.144.44)).model.79.primefaces.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .73. OhlcChartSeries(2009. ohlcModel.addRecord(new ohlcModel.135.68.56.122.5)).140.53.139.97)).140.135.02)).OhlcChartModel instance.124. <p:ohlcChart value="#{bean.57.139.136.addRecord(new ohlcModel.138.139.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.67.9.143.135.143.82.124. OhlcChartSeries(2011.144.76.123. OhlcChartSeries(2012.139. public Bean() { model = new OhlcChartModel(). OhlcChartSeries(2010.56.132. OhlcChartSeries(2012.addRecord(new ohlcModel.

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

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

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

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

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

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

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

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

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

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

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

Note As column is a reused component. 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. Specifies resizable feature at column level. see documentation of components that use a column. 90 .PrimeFaces Userʼs Guide Name disabledSelection filterMaxLength resizable Default FALSE null TRUE Type Boolean Integer Boolean Description Disables row selection. not all attributes of column are implemented by the components that use column. Getting Started with Column As column is a reused component.

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

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

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

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

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

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

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

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

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

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. Type of resource referenced by the link. public class BookBean { public void saveBook() { //Save book } } <p:commandLink actionListener="#{bookBean. 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. circle and poly.saveBook}"> <h:outputText value="Save" /> </p:commandLink> Skinning CommandLink renders an html anchor element that style and styleClass attributes apply.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. Shape of hot spot on the screen. Valid values are LTR and RTL. rect. Advisory tooltip information. valid values are default. A reverse link from the anchor specified by this link to the current document. 100 . values are provided by a space-separated list of link types. difference is form is submitted with ajax by default. Position of the button element in the tabbing order. values are provided by a space-separated list of link types.

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class 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. 104 . Getting started with ContextMenu ContextMenu is created with menuitems.component.component.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.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. when set to false component will not be rendered.primefaces. right-click on anywhere on page will display the menu.primefaces. Optional for attribute defines which component the contextMenu is attached to.contextmenu. When for is not defined.ContextMenuRenderer org.21 ContextMenu ContextMenu provides an overlay menu displayed on mouse right-click event.ContextMenu org.primefaces.primefaces.ContextMenu org.contextmenu. contextMenu is attached to the page meaning.component org.component.primefaces.

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

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

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

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

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

This way you can add new panels from outside of the dashboard.ui-dashboard . 110 . Here is an example based on a different theme. Tips • Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets. Following is the list of structural style classes.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. see the main Skinning section for more information. Style Class . <p:dashboard model="#{dashboardBean.ui-state-hover Applies Container element of dashboard Each column in dashboard Placeholder As skinning style classes are global.PrimeFaces Userʼs Guide New Widgets Draggable component is used to add new widgets to the dashboard.ui-dashboard-column div.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

randomPrice}$ </p:column> </p:summaryRow> </p:dataTable> 139 .year} </p:column> <p:column headerText="Manufacturer" sortBy="#{car.year}"> #{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.color} </p:column> <p:summaryRow> <p:column colspan="3" style="text-align:right"> Total: </p:column> <p:column> #{tableBean.manufacturer}" sortOrder="descending"> <p:column headerText="Model" sortBy="#{car.manufacturer} </p:column> <p:column headerText="Color" sortBy="#{car. <p:dataTable var="car" value="#{tableBean.manufacturer}"> #{car.model} </p:column> <p:column headerText="Year" sortBy="#{car.model}"> #{car.cars}" sortBy="#{car.color}"> #{car.

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

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

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

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

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

When enabled.component.Dialog org. dialog is visible by default.DialogRenderer org.primefaces.Dialog 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.DialogRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.primefaces.primefaces.dialog. 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 . when set to false component will not be rendered.component.component.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.component org.primefaces.dialog. Width of the dialog Height of the dialog Minimum width of a resizable dialog.28 Dialog Dialog is a panel component that can overlay other elements on page.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class editor org.EditorRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component. 161 . Value of the component than can be either an EL expression of a literal text.editor. it must refer to a converter id.31 Editor Editor is an input component with rich text editing capabilities.Editor org.EditorRenderer org. it’s resolved to a converter instance.component.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean. When it’s an EL expression.component.primefaces.primefaces.component org.PrimeFaces Userʼs Guide 3. An el expression or a literal text that defines a converter for the component.component.editor.Editor org.primefaces. Boolean value to specify the rendering of the component.primefaces. In case it’s a static text.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

when set to false component will not be rendered.primefaces..focus.. /> <h:inputText .Focus org. /> 182 .component. /> <h:selectOneMenu .Focus.37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.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 org..PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Specifies the exact component to set focus The root component to start first input search.FocusRenderer org.primefaces.component. <p:focus /> <p:inputText .. Input component can be any element such as input.component.primefaces.primefaces.focus.FocusTag org..component. textarea and select. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

LatLng Property lat lng Default null null Type double double Description Latitude of the coordinate Longitude of the coordinate 196 .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. Description org.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. Stroke opacity of rectangle.Circle extends org. Opacity of the circle. Stroke color of the rectangle.Rectangle extends org.primefaces.primefaces.primefaces. Stroke weight of the circle. Stroke color of the circle.primefaces.model.map. Background color of the rectangle. Stroke opacity of circle.map.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. Background color of the circle.model.model.map.model.map.model. org.map. Stroke weight of the rectangle. Opacity of the rectangle.

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

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. 198 .GMapInfoWindow org.primefaces.primefaces.40 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.GMapInfoWindow org.component.primefaces.primefaces.gmap.component. when set to false component will not be rendered.GMapInfoWindowTag org. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.component.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.gmap.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.PrimeFaces Userʼs Guide Ajax Behavior Events Inplace editing is enabled via editor option. } public void handleSave() { //add faces message with update text value } //getter-setter <p:inplace editor="true"> <p:ajax event="save" listener="#{inplaceBean. //getter-setter } <p:inplace editor="true"> <h:inputText value="#{inplaceBean.handleSave}" update="msgs" /> <h:inputText value="#{inplaceBean.Inplace Method show() hide() Params Return Type void void Description Shows content and hides display element. Shows display element and hides content. public class InplaceBean { private String text. 223 .text}" /> </p:inplace> <p:growl id="msgs" /> Client Side API Widget: PrimeFaces.

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

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

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

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

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

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

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.primefaces.LightBoxRenderer org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.LightBox org. other JSF components and external urls.component lightbox.primefaces.LightBox org. Style of the container element not the overlay element. multimedia content.component.component org. 247 .component. Style class of the container element not the overlay element.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lightBox org.lightbox. when set to false component will not be rendered.primefaces.PrimeFaces Userʼs Guide 3.55 LightBox Lightbox features a powerful overlay that can display images.

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

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

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

PrimeFaces.error(‘Error message’).info(‘Info message’). PrimeFaces.debug(‘Debug 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.PrimeFaces Userʼs Guide <p:log /> Log API PrimeFaces uses client side log apis internally.warn(‘Warning message’). for example you can use log component to see details of an ajax request. <script type=”text/javascript”> PrimeFaces. </script> 251 .

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

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

An el expression that maps to a server side UIComponent instance in a backing bean.component.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 .component.primefaces.primefaces.component.MegaMenuRenderer org. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.MegaMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces.58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together.component org.MegaMenu org.MegaMenu org.component.megamenu.primefaces.megamenu.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

..barca { background: url(barca_logo. } 270 .png) no-repeat. width:16px. /> Custom Icons <p:menuitem icon="barca" . /> ... height:16px.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 org. Specifies if the summary of the FacesMessage should be displayed. <h:inputText id="txt" value="#{bean.primefaces.component.Message org.component.63 Message Message is a pre-skinned extended version of the standard JSF message component.message.Message org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class message org.primefaces.message.text}" /> <p:message for="txt" /> 271 .primefaces. Id of the component whose messages to display.PrimeFaces Userʼs Guide 3.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. Getting started with Message Message usage is exactly same as standard message. Defines if already rendered messages should be displayed Defines the display mode. when set to false component will not be rendered. Boolean value to specify the rendering of the component.component.primefaces. Specifies if the detail of the FacesMessage should be displayed.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

This feature is enabled by defining a menu component and defining it as the options facet. <p:panel closable="true"> //Child components here.ui-panel-title ..ui-panel . 288 . <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. Following is the list of structural style classes..ui-panel-content .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. 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-titlebar . see the main Skinning section for more information. Style Class .ui-panel-titlebar-icon .

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

firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname: *" /> <p:inputText id="surname" value="#{bean.surname}" label="Surname"/> <f:facet name="footer"> <p:commandButton type="button" value="Save" icon="ui-icon-check" /> </f:facet> </p:panelGrid> 290 . Style class of the panel.surname}" label="Surname"/> </p:panelGrid> Header and Footer PanelGrid provides facets for header and footer content. <p:panelGrid columns="2"> <h:outputLabel for="firstname" value="Firstname:" /> <p:inputText id="firstname" value="#{bean. 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.firstname}" label="Firstname" /> <h:outputLabel for="surname" value="Surname:" /> <p:inputText id="surname" value="#{bean. Comma separated list of column style classes. Inline style 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Following rating consists of 10 stars. if you need less or more stars use the stars attribute. Number of stars to display Disabled user interaction Client side callback to execute when rate happens. <p:rating value="#{ratingBean. Number of Stars Default number of stars is 5. Getting Started with Rating Rating is an input component that takes a double variable as it’s value. set disabled to true. Message to be displayed when validation fields.rating}" /> When the enclosing form is submitted value of the rating will be assigned to the rating variable. //getter-setter <p:rating value="#{ratingBean. public class RatingBean { } private double rating. Message to be displayed when conversion fails.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stars disabled onRate Default null null null null null 5 FALSE null Type MethodExpr String String String String Integer Boolean String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. 316 . Name of the client side widget.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.

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

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

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

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

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

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

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

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

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

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

row.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.PrimeFaces Userʼs Guide 3.83 Row Row is a helper component for datatable. 327 .Row org.component. Info Tag Component Class Component Type Component Family row 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 datatable grouping section for more information about how row is used. when set to false component will not be rendered.Row org.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component. it’s resolved to a converter instance.SelectOneListbox org.primefaces. When it’s an EL expression.component. In case it’s a static text.PrimeFaces Userʼs Guide 3. 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.primefaces.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org.SelectOneListboxRenderer org.component. when set to false component will not be rendered.selectonelistbox. 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.component.primefaces.primefaces.SelectOneListbox org.selectonelistbox. Marks component as required A method expression that refers to a method validationg the input binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 355 .component org.primefaces.96 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox with theme integration.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Height of the space. Inline style 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. Style class of the spacer.component.primefaces.primefaces.PrimeFaces Userʼs Guide 3.primefaces.component. Width of the space.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Advisory tooltip informaton. 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. when set to false component will not be rendered.spacer.spacer.component org.SpacerRenderer org.primefaces.102 Spacer Spacer is used to put spaces between elements.Spacer org.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. 374 .Spacer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spacer org.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.component.spinner. when true the events will be fired at "apply request values".103 Spinner Spinner is an input component to provide a numerical input via increment and decrement buttons.PrimeFaces Userʼs Guide 3.primefaces.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 immediate FALSE Boolean required validator FALSE null Boolean Method Expr 375 .component org.Spinner org.component.component. In case it’s a static text.primefaces.SpinnerRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component.spinner.Spinner org.primefaces.SpinnerRenderer org. When it’s an EL expression. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spinner org. when set to false component will not be rendered. if immediate is set to false. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed.component.

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

public class SpinnerBean { } private int number. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a pointer button is moved onto input element.PrimeFaces Userʼs Guide Name onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null null null null null null FALSE null null null null null Type String String String String String String String String Boolean Integer String String Integer String Description Client side callback to execute when a key is pressed and released over input element. Advisory tooltip informaton.number}" /> 377 . //getter and setter <p:spinner value="#{spinnerBean. Position of the input element in the tabbing order. Client side callback to execute when a pointer button is moved away from input element. Inline style of the input element. Client side callback to execute when a key is released over input element. Style class of the input element. Getting Started with Spinner Spinner is an input component and used just like a standard input text. Number of characters used to determine the width of the input element.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.ui-tabs . see the main Skinning section for more information.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. Class .widget.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.

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

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

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

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

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

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

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

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

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

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

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

<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 . 406 . see main skinning section for more information. An example is as follows.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.ui-tooltip as a style class and is styled with global skinning selectors.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. 433 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ROLE_READER’)}" /> <p:commandButton rendered="#{p:ifAnyGranted(‘ROLE_ADMIN. ROLE_EDITOR’)}" /> <p:commandButton rendered="#{p:ifNotGranted(‘ROLE_GUEST’)}" /> <h:outputText value="Welcome: #{p:remoteUser}" /> 450 .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.

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .