USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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-items . Highlighted part in suggestions. Applies As skinning style classes are global.ui-autocomplete . 32 . • Increase query delay to avoid unnecessary load to server as a result of user typing fast. see the main Skinning section for more information.ui-autocomplete-query Container element. List of items Each item in the list. Tips • Do not forget to use a converter when working with pojos.ui-autocomplete-panel . Class .ui-autocomplete-input .ui-autocomplete-item . Container of suggestions list.

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

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

BlockUI Method block() unblock() Params Return Type void void Description Blocks the UI. e. Applies As skinning style classes are global. 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. Container for custom content.ui-blockui . 35 .ui-blockui-content Container element.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.g. dialog.widget. see the main Skinning section for more information. Class .

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

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

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

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

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

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

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

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

Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a pointer button is released over input element. 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. 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 input element receives focus. Client side callback to execute when a key is pressed and released over input element. Advisory tooltip informaton. Client side callback to execute when text within input element is selected by user. 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. Client side callback to execute when input element is clicked. Client side callback to execute before displaying a date. Client side callback to execute when a pointer button is moved away from 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 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

jpg"/> <p:graphicImage value="/images/nature2. <p:carousel rows="1" itemStyle="height:200px.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 autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” > <p:graphicImage value="/images/nature1..."/> </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="The story begins as Don Vito ."> <p:tab title="Godfather Part I"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather1.jpg" /> <h:outputText value="After a break of .. for this purpose autoPlayInterval and circular attributes are used." /> </h:panelGrid> </p:tab> <p:tab title="Godfather Part II"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather2.jpg"/> <p:graphicImage value="/images/nature4.. Following carousel displays a collection of images as a slideshow.jpg"/> </p:carousel> Content Display Another use case of carousel is tab based content display.jpg" /> <h:outputText value="Francis Ford Coppola's ..width:600px.." /> </h:panelGrid> </p:tab> </p:carousel> 58 .jpg"/> <p:graphicImage value="/images/nature3.

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

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

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

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

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

here is an example. sliceMargin and diameter.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.

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

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

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

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

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

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

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

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

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.

chart. Title of the chart.PrimeFaces Userʼs Guide 3.chart. Shows shadow or not.primefaces.BubbleChart org.BubbleChart org.primefaces.bubble.component.BubbleChartRenderer org.bubble.component org.primefaces. Enables gradient fills instead of flat colors. Style class of the chart.component. Displays labels on buttons.primefaces. Position of the legend.chart. Comma separated list of colors in hex format.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.component. Specifies interactive legend.chart. 74 binding widgetVar value style styleClass title legendPosition shadow seriesColors enhancedLegend bubbleGradients bubbleAlpha showLabels xaxisLabel null null null null null null null TRUE null TRUE FALSE 70 TRUE null Object String ChartModel String String String String Boolean String Boolean Boolean Integer Boolean String .12. Alpha transparency of a bubble.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. 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. Label of the x-axis.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org.primefaces.

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

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

component. Style class of the chart.component org.primefaces.chart.12. Position of the legend.PrimeFaces Userʼs Guide 3.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. 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 . 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.chart. Label of the y-axis.OhlcChartRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.6 Ohlc Chart An open-high-low-close chart is a type of graph typically used to visualize movements in the price of a financial instrument over time. Specifies interactive legend.OhlcChart org. Comma separated list of colors in hex format.component. Enables candle stick display mode. Title of the chart.primefaces.component.primefaces.chart.ohlc. Label of the x-axis.component. Angle of the x-axis ticks. Angle of the y-axis ticks.OhlcChart org.chart.ohlc.

136.143.44)). OhlcChartSeries(2010.addRecord(new ohlcModel.135.66.9.97)).46. ohlcModel.addRecord(new ohlcModel.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.123.142. <p:ohlcChart value="#{bean. OhlcChartSeries(2009.143.18.4)).140.04.135.135.5.76.addRecord(new ohlcModel.56.5)).79.OhlcChartModel instance.81)).primefaces.addRecord(new ohlcModel.134.136.53.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.144.82.68.124.135. OhlcChartSeries(2012. public class Bean { private OhlcChartModel model.addRecord(new ohlcModel. OhlcChartSeries(2008. OhlcChartSeries(2012.139.139.addRecord(new ohlcModel.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .chart.121.model.139.addRecord(new } //getter } OhlcChartSeries(2007.56.88. <p:ohlcChart value="#{bean.57.31.7.138. public Bean() { model = new OhlcChartModel().129.143.144.140.124. OhlcChartSeries(2011.48)).01.136.55.139.02)).73.67.122.132.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Client side callback to execute when button is double clicked. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when button is clicked. Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when ajax request succeeds. Client side callback to execute when a pointer button is released over button. Client side callback to execute when a key is released over button. StyleClass of the button element. Defines whether to trigger ajaxStatus or not. Client side callback to execute when ajax request is completed. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Access key that when pressed transfers focus to the 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. 94 . Client side callback to execute when text within button is selected by user. Client side callback to execute when a pointer button is pressed down over button. Client side callback to execute when a key is pressed down over button. Client side callback to execute when button loses focus. Client side callback to execute when button receives focus. Client side callback to execute when ajax request fails. Inline style of the button element. Client side callback to execute when a pointer button is moved within button. 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. <p:commandButton value="Save" actionListener="#{bookBean.PrimeFaces Userʼs Guide Name alt dir disabled image label lang tabindex title readonly icon iconPos inline widgetVar Default null null FALSE null null null null null FALSE null left FALSE null Type String String Boolean String String String Integer String Boolean String String String String Description Alternate textual description of the button. Position of the icon. Valid values are LTR and RTL. Getting started with CommandButton CommandButton usage is similar to standard commandButton. Icon of the button as a css class. Advisory tooltip information. <p:commandButton type="reset" value="Reset" /> 95 . Direction indication for text that does not inherit directionality. Style class for the button icon. Disables the button. Position of the button element in the tabbing order. by default commandButton submits its enclosing form with ajax. Name of the client side widget. Used by PrimeFaces mobile only. just resets the form contents.saveBook}" /> public class BookBean { public void saveBook() { //Save book } } Reset Buttons Reset buttons do not submit the form. (deprecated: use icon) A localized user presentable name. Flag indicating that this component will prevent changes by the user.

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

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

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

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

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

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

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

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

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

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

ui-menuitem-text Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global. 106 .ui-menuitem-link . see the main Skinning section for more information.ui-contextmenu . Style Class .PrimeFaces Userʼs Guide Dynamic Menus ContextMenus can be created programmatically as well.ui-menu-list . Skinning ContextMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes. see the dynamic menus part in menu component section for more information and an example.ui-menuitem .

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Dashboard model instance representing the layout of the UI. Disables reordering feature.Dashboard org.dashboard.component. Inline style of the dashboard container Style class of the dashboard container binding widgetVar model disabled style styleClass null null null FALSE null null Object String Dashboard Model Boolean String String Getting started with Dashboard Dashboard is backed by a DashboardModel and consists of panel components.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.primefaces.primefaces.Dashboard org.component.DashboardRenderer org. 107 .PrimeFaces Userʼs Guide 3.primefaces.component 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. when set to false component will not be rendered.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities.primefaces.component.dashboard.primefaces.

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

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

PrimeFaces Userʼs Guide New Widgets Draggable component is used to add new widgets to the dashboard.model}" id="board"> //panels </p:dashboard> <p:panel id="newwidget" /> <p:draggable for="newwidget" helper="clone" dashboard="board" /> Skinning Dashboard resides in a container element which style and styleClass options apply.ui-dashboard-column div. This way you can add new panels from outside of the dashboard. see the main Skinning section for more information.ui-dashboard . 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. 110 . Following is the list of structural style classes. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Mode fit intersect pointer touch Description draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount Acceptance You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has. 158 .jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. only first image can be accepted by droppable. 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.PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable.

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

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

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

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

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

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

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

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. outputLink becomes the trigger for the effect on graphicImage.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.PrimeFaces Userʼs Guide <h:outputText value="#{bean. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 166 . 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. When the link is clicked. Use for option to specify a target.jpg" style="display:none"/> With this setting. List of Effects Following is the list of effects supported by PrimeFaces.

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

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

primefaces.fieldset. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org.component org.component.primefaces.FieldsetRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.FieldsetRenderer org.Fieldset org. Makes content toggleable with animation.component. Style class of the fieldset.fieldset.Fieldset org.primefaces.34 Fieldset Fieldset is a grouping component as an extension to html fieldset.component.primefaces. Title text. Toggle duration in milliseconds. Defines initial visibility state of content. 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 .component.primefaces.PrimeFaces Userʼs Guide 3. Inline style of the fieldset. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.firstname}" /> </h:form> Note that hotkey will not be triggered if there is a focused input on page. 209 . <h:form> <p:hotkey bind="ctrl+shift+s" update="display" /> <h:panelGrid columns="2"> <h:outputLabel for="name" value="Name:" /> <h:inputText id="name" value="#{bean.name}" /> </h:panelGrid> <h:outputText id="dsplay" value="Hello: #{bean.

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

3.49 InputMask
InputMask forces an input to fit in a defined mask template.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputMask org.primefaces.component.inputmask.InputMask org.primefaces.component.InputMask org.primefaces.component org.primefaces.component.InputMaskRenderer org.primefaces.component.inputmask.InputMaskRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Mask template PlaceHolder in mask template. Value of the component than can be either an EL expression of a literal text

binding mask placeHolder value

null null null null

Object Integer String Object

225

PrimeFaces Userʼs Guide

Name converter

Default null

Type Converter/ String

Description An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked.

immediate required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange

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

Boolean Boolean MethodExpr MethodExpr String String String String String String String String Boolean String String Integer String String

onclick ondblclick

null null

String String

226

PrimeFaces Userʼs Guide

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

Default null null null null null null null null null null FALSE null null null null null

Type String String String String String String String String String String Boolean Integer String String Integer String

Description Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton.

Getting Started with InputMask InputMask below enforces input to be in 99/99/9999 date format.
<p:inputMask value="#{bean.field}" mask="99/99/9999" />

Mask Samples Here are more samples based on different masks;
227

PrimeFaces Userʼs Guide
<h:outputText value="Phone: " /> <p:inputMask value="#{bean.phone}" mask="(999) 999-9999"/> <h:outputText value="Phone with Ext: " /> <p:inputMask value="#{bean.phoneExt}" mask="(999) 999-9999? x99999"/> <h:outputText value="SSN: " /> <p:inputMask value="#{bean.ssn}" mask="999-99-9999"/> <h:outputText value="Product Key: " /> <p:inputMask value="#{bean.productKey}" mask="a*-999-a999"/>

Skinning style and styleClass options apply to the displayed input element. As skinning style classes are global, see the main Skinning section for more information.

228

PrimeFaces Userʼs Guide

3.50 InputText
InputText is an extension to standard inputText with skinning capabilities.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputText org.primefaces.component.inputtext.InputText org.primefaces.component.InputText org.primefaces.component org.primefaces.component.InputTextRenderer org.primefaces.component.inputtext.InputTextRender

Attributes
Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails.
229

immediate required validator valueChangeListener requiredMessage

FALSE FALSE null null null

Boolean Boolean Method Expr Method Expr String

PrimeFaces Userʼs Guide

Name converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout

Default null null null null null null null FALSE null null null null null null null null null null null null null null

Type String String String String String String String Boolean String String Integer String String String String String String String String String String String

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

230

PrimeFaces Userʼs Guide

Name onmouseover onmouseup onselect readonly size style styleClass tabindex title type

Default null null null FALSE null null null null null text

Type String String String Boolean Integer String String Integer String String

Description Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when text within input element is selected by user. Flag indicating that this component will prevent changes by the user. Number of characters used to determine the width of the input element. Inline style of the input element. Style class of the input element. Position of the input element in the tabbing order. Advisory tooltip informaton. Input field type.

Getting Started with InputText InputText usage is same as standard inputText;
<p:inputText value="#{bean.propertyName}" />

public class Bean { private String propertyName; } //getter and setter

Skinning style and styleClass options apply to the input element. As skinning style classes are global, see the main Skinning section for more information.

231

PrimeFaces Userʼs Guide

3.51 InputTextarea
InputTextarea is an extension to standard inputTextara with skinning capabilities and auto growing.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class inputTextarea org.primefaces.component.inputtextarea.InputTextarea org.primefaces.component.InputTextarea org.primefaces.component org.primefaces.component.InputTextareaRenderer org.primefaces.component.inputtextarea.InputTextareaRender

Attributes
Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input
232

immediate required validator

FALSE FALSE null

Boolean Boolean Method Expr

PrimeFaces Userʼs Guide

Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar autoResize accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup

Default null null null null null TRUE null null null null FALSE null null null null null null null null null null null

Type Method Expr String String String String Boolean String String String String Boolean String String Integer String String String String String String String String

Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Specifies auto growing when being typed. Access key that when pressed transfers focus to the input element. Alternate textual description of the input field. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Valid values are LTR and RTL. Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element.

233

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

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

PrimeFaces 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

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

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

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

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

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

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

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

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

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

58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together. when set to false component will not be rendered.primefaces.MegaMenuRenderer org.megamenu.component org.component.primefaces.PrimeFaces Userʼs Guide 3.MegaMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.megamenu.MegaMenu org.primefaces.primefaces. 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.component. Name of the client side widget MenuModel instance to create menus programmatically binding widgetVar model null null null Object String MenuModel 254 .MegaMenu org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class megaMenu org.component.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

> //columns </p:dataTable> </p:outputPanel> <p:commandButton update="out" actionListener="#{bean. 282 .condition}" . in this case parent form will be updated partially implicitly making an outputPanel use obselete..list}" /> Note that you won’t need an outputPanel if commandButton has no update attribute specified.> //columns </p:dataTable> <p:commandButton update="tbl" actionListener="#{bean. Layout OutputPanel has two layout modes.condition}" .search}" /> Solution is to use the outputPanel as a placeHolder. outputPanel component is updated with each ajax request automatically. Skinning OutputPanel style and styleClass attributes are used to skin the outputPanel. <p:outputPanel id="out"> <p:dataTable id="tbl" rendered="#{bean. • 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.

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

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

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

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

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

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

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

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

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

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

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

Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a key is pressed down over input element. Position of the input element in the tabbing order. Client side callback to execute when a pointer button is released over 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 input element receives focus.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. Number of characters used to determine the width of the 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 . Style class of the input element. Advisory tooltip informaton. Client side callback to execute when a key is pressed and released over input element. Inline style of the 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 pressed down over input element Client side callback to execute when a pointer button is moved within input element.

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

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

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

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

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

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

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

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

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

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

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

<h:outputText id="txt_count" value="#{counterBean. } Tuning timing By default the periodic interval is 2 seconds. setting global to false will not trigger ajaxStatus. polling starts automatically on page load. public void increment() { count++.count}" /> <p:poll listener="#{counterBean.count. Stops polling when true.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. this is changed with the interval attribute. <h:outputText id="txt_count" value="#{counterBean. } public int getCount() { return this. In autoStart mode. Following poll works every 5 seconds. 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 setCount(int count) { this. to start polling on demand set to false.count = count. Note that poll must be nested inside a form.

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

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

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

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

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

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

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

RadioButton org.component.primefaces. Style class of the container.component org.PrimeFaces Userʼs Guide 3.primefaces. Client side callback to execute on state change.radiobutton. An el expression that maps to a server side UIComponent instance in a backing bean Disabled the component.RadioButton org.78 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts.primefaces.component.primefaces. 314 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.RadioButtonRenderer org.radiobutton.component. Inline style of the component. Index of the selectItem of selectOneRadio.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.component. Id of the selectOneRadio to attach to.primefaces. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 RowExpansion See datatable expandable rows section for more information about how rowExpansion is used.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.RowExpansion org.RowExpansion org.primefaces.rowexpansion.component.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.primefaces. Info Tag Component Class Component Type Component Family rowExpansion org.component. 329 . when set to false component will not be rendered.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces. it’s resolved to a converter instance.SelectOneButtonRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. it must refer to a converter id When set true.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 .PrimeFaces Userʼs Guide 3.SelectOneButton org.primefaces. When it’s an EL expression.component org.component.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.selectonebutton.component.95 SelectOneButton SelectOneButton is an input component to do a single select. process validations logic is executed at apply request values phase for this component.primefaces.selectonebutton.SelectOneButton org. An el expression or a literal text that defines a converter for the component.component. In case it’s a static text. when set to false component will not be rendered.primefaces.

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

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

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

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

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

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

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

primefaces.PrimeFaces Userʼs Guide 3. 361 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener requiredMessage FALSE null null null Boolean MethodExpr MethodExpr String .primefaces.primefaces. When it’s an EL expression.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. process validations logic is executed at apply request values phase for this component. it must refer to a converter id When set true. when set to false component will not be rendered. 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.selectoneradio.SelectOneRadio org.component.SelectOneRadio org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org. In case it’s a static text. it’s resolved to a converter instance.SelectOneRadioRenderer org.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.component org.component.primefaces.primefaces.selectoneradio.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Valid values are LTR and RTL. Name of the client side widget. Code describing the language used in the generated markup for this component. Message to be displayed when validation fields. Stepping factor for each increment and decrement Minimum boundary value Maximum boundary value Prefix of the input Suffix of the input Access key that when pressed transfers focus to the input element. Disables input field A localized user presentable name. Maximum number of characters that may be entered in this field. Client side callback to execute when input element is double clicked. Direction indication for text that does not inherit directionality. Message to be displayed when conversion fails. Client side callback to execute when input element is clicked. Alternate textual description of the input field. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element receives focus. Client side callback to execute when input element loses focus. 376 . Controls browser autocomplete behavior.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar stepFactor min max prefix suffix accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown Default null null null null null 1 null null null null null null null null FALSE null null null null null null null null null Type Method Expr String String String String Double Double Double String String String String String String Boolean String String Integer String String String String String String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Client side callback to execute when a key is pressed down over input element.

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

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

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

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

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

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

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

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

component.primefaces. Boolean value to specify the rendering of the component.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.stack.Stack org. 385 .primefaces.component. MenuModel instance to create menus programmatically Whether to display stack as expanded or not.component. Name of the client side widget.component. An el expression that maps to a server side UIComponent instance in a backing bean.primefaces.primefaces.primefaces. when set to false component will not be rendered. Speed of the animation when opening the stack.StackRenderer Attributes Name id rendered binding icon openSpeed closeSpeed widgetVar model expanded Default null TRUE null null 300 300 null null FALSE Type String Boolean Object String String Integer String MenuModel Boolean Description Unique identifier of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org.Stack org.stack.component org. Speed of the animation when opening the stack. An optional image to contain stacked items.StackRenderer org.PrimeFaces Userʼs Guide 3.

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

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

g. 388 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class summaryRow org.primefaces.component. (e.SummaryRow org.SummaryRow org.primefaces.summaryrow.108 SummaryRow SummaryRow is a helper component of datatable used for dynamic grouping.component org. Getting started with SummaryRow See DataTable section for more information.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. when set to false component will not be rendered.primefaces. to calculate totals).SummaryRowRenderer org.summaryrow.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.PrimeFaces Userʼs Guide 3.primefaces.

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

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

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

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

propertyA}"> <h:outputText value= "#{listItem.More content </p:tab> </p:tabView> Orientations Tabview supports four different orientations mode.list}" var="listItem"> <p:tab title="#{listItem. left. onTabChange is executed when an inactive tab is clicked and onTabShow is executed when an inactive tab becomes active to be shown.. <p:tabView orientation="left"> //tabs </p:tabView> Client Side Callbacks Tabview has two callbacks for client side.propertyB}"/> . index)"> //tabs </p:tabView> function handleTabChange(index) { //index = Index of the new tab } 393 .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. right and bottom. top(default). <p:tabView onTabChange="handleTabChange(event. <p:tabView value="#{bean..

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

420 . However ajax submissions requires a little manual effort. Watermark component is clever enough to handle this case.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> <h:commandButton value="Submit" /> <p:commandButton value="Submit" onclick="PrimeFaces.cleanWatermarks()" oncomplete="PrimeFaces. 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. Note that this style class is not applied when watermark uses html5 placeholder if available. watermarks are cleared. This would result in updating bean properties with watermark values. <h:inputText id="txt" value="#{bean.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful