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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.component org.primefaces.CarouselRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.carousel.component.10 Carousel Carousel is a multi purpose component to display a set of data or general content with slide effects.carousel.CarouselRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class carousel org.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean A value expression that refers to a collection Name of the request scoped iterator Number of visible items per page Index of the first element to be displayed Name of the client side widget.component.Carousel org.primefaces.component. 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 . when set to false component will not be rendered.primefaces.primefaces.Carousel org.

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

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

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

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

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

primefaces.component.CellEditor org.PrimeFaces Userʼs Guide 3.component.CellEditorRenderer org.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.11 CellEditor CellEditor is a helper component of datatable used for incell editing.celleditor.component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with CellEditor See inline editing section in datatable documentation for more information about usage. 61 .celleditor.primefaces.primefaces. when set to false component will not be rendered.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.primefaces.component org.

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

model. Displays data on each slice.set("Brand 1". Format of data labels. } <p:pieChart value="#{bean. 540).model}" legendPosition=”w” /> 63 . Specifies interactive legend. public } Bean() { model = new PieChartModel().set("Brand 2".set("Brand 4". model. public PieChartModel getModel() { return model. Getting started with PieChart PieChart is created with an org. public class Bean { } private PieChartModel 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 3".PieChartModel instance. model. model.primefaces. 421).model. 702).chart. 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.

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

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

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

chart.bar.chart.component.BarChartRenderer org. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.primefaces.3 Bar Chart Bar chart visualizes one or more series of data using bars. Maximum boundary value. binding widgetVar value style styleClass title legendPosition barPadding barMargin orientation stacked min max null null null null null null null 8 10 vertical FALSE null null Object String ChartModel String String String String Integer Integer String Boolean Double Double 68 .PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org. Title of the chart.chart. Padding of bars. Orientation of bars.primefaces.primefaces. Enables stacked display of bars. Minimum boundary value.component.component org. Margin of bars.chart. valid values are “vertical” and “horizontal”.12.primefaces.component.BarChart org.component.BarChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.bar.primefaces.BarChart org. Position of the legend. Style class of the chart.

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

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

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

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

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

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

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

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

Enables candle stick display mode.component org. Angle of the y-axis ticks.PrimeFaces Userʼs Guide 3.chart.primefaces.component.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org. Label of the x-axis. Label of the y-axis. Style class of the chart.component.primefaces. Specifies interactive legend.primefaces.primefaces.ohlc.chart. Title of the chart. Position of the legend.primefaces.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.OhlcChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.chart.OhlcChartRenderer org.12. Angle of the x-axis ticks.ohlc.chart.OhlcChart org.OhlcChart org.component. 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 . Comma separated list of colors in hex format.

143. OhlcChartSeries(2012.140.5)).67.76. ohlcModel.primefaces.18. OhlcChartSeries(2011.138.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org. OhlcChartSeries(2012.31.135.124.135.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .129.48)).139. public class Bean { private OhlcChartModel model.139. public Bean() { model = new OhlcChartModel(). OhlcChartSeries(2008.55.123. OhlcChartSeries(2009.02)).model.addRecord(new ohlcModel.7.79.136.140.56.46.143.56.81)). <p:ohlcChart value="#{bean.addRecord(new } //getter } OhlcChartSeries(2007.134.88.144. OhlcChartSeries(2010.57.122.82.142.68.addRecord(new ohlcModel.135.121.53.9.97)).model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well. <p:ohlcChart value="#{bean.136.chart.139.01.144.124.04.136.5.139.addRecord(new ohlcModel.143.4)).addRecord(new ohlcModel.135.addRecord(new ohlcModel.132.66.addRecord(new ohlcModel.OhlcChartModel instance.73.44)).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

when true actions are processed at apply_request_values.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. An actionlistener that’d be processed when link is clicked.component.component.component. Component(s) to process partially instead of whole view. When set to true. when set to true (default).primefaces.commandlink.primefaces.CommandLink org. Specifies the submit mode. when false at invoke_application phase. ajax requests are not queued. Component(s) to be updated with ajax.primefaces.19 CommandLink CommandLink extends standard JSF commandLink with Ajax capabilities. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class commandLink org.primefaces. Client side callback to execute before ajax request is begins. 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.CommandLinkRenderer org.component org. submit would be made with Ajax. 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 .component. Boolean value that determines the phaseId.PrimeFaces Userʼs Guide 3.CommandLink org.primefaces. commandlink. when set to false component will not be rendered.

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

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

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

hide()"/> <p:commandButton value="Not Yet" onclick="confirmation.. <h:form> <p:commandButton type="button" onclick="cd. Note that header can also be defined using the header attribute or the header facet. either via message option or message facet. Whether to display confirm dialog on load.hide(). <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //.destroyWorld}" update="messages" oncomplete="confirmation..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. default severity is alert and the other option is info. Message facet is useful if you need to place custom content instead of simple text. 102 . menuitem and more.PrimeFaces Userʼs Guide Name styleClass closable appendToBody visible Default null TRUE FALSE FALSE Type String Boolean Boolean Boolean Description Style class of the dialog container Defines if close icon should be displayed or not Appends dialog as a child of document body." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways. Getting started with ConfirmDialog ConfirmDialog has a simple client side api. 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. </p:confirmDialog> Severity Severity defines the icon to display next to the message. commandLink.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. 137 .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.cars}"> <f:facet name="header"> In-Cell Editing </f:facet> <p:column headerText="Model"> <p:cellEditor> <f:facet name="output"> <h:outputText value="#{car. row is displayed in editable mode meaning input facets are displayed and output facets are hidden. both options are implemented with ajax.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.PrimeFaces Userʼs Guide Incell Editing Incell editing provides an easy way to display editable data.

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

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

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

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

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

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.DefaultCommandRenderer org.component.g. DefaultCommand solves this problem by normalizing the command(e. There are some ugly workarounds like placing a hidden button and writing javascript for every form in your app. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class defaultCommand org.component.primefaces.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. Browsers tend to behave differently as there doesn’t seem to be a standard and even if a standard exists.component. Example below triggers btn2 when enter key is pressed.DefaultCommand org.primefaces. 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. button or link) to submit the form with on enter key press.primefaces.primefaces.27 DefaultCommand Which command to submit the form with when enter key is pressed a common problem in web apps not just specific to JSF.component.defaultcommand.component org. when set to false component will not be rendered. IE probably will not care about it. 143 .defaultcommand. Note that an input must have focused due to browser nature.primefaces.

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

dialog is visible by default.Dialog org. When enabled.primefaces.component org.component.Dialog org. when set to false component will not be rendered.28 Dialog Dialog is a panel component that can overlay other elements on page.primefaces.primefaces.primefaces.component.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.dialog. 145 binding widgetVar header draggable resizable modal visible width height minWidth null null null TRUE TRUE FALSE FALSE auto auto 150 Object String String Boolean Boolean Boolean Boolean Integer Integer Integer .dialog.primefaces. 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.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dialog org.component.DialogRenderer org. Width of the dialog Height of the dialog Minimum width of a resizable dialog.component.

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

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

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

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

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

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

ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically.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. helper of following panel’s opacity is reduced in dragging. if you need to keep the component at it’s original location. <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. <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. <p:panel id="pnl" header="Draggable Panel"> <h:outputText value="I will be reverted back to my original position" /> </p:panel> <p:draggable for="pnl" revert="true"/> Opacity During dragging. actual component is used as the drag indicator. 152 . opacity option can be used to give visual feedback.

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

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

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

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

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

<p:graphicImage id="messi" value="barca/messi_thumb. Following example has two images.PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable. only first image can be accepted by droppable.jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. Mode fit intersect pointer touch Description draggable should overlap the droppable entirely draggable should overlap the droppable at least 50% pointer of mouse should overlap the droppable droppable should overlap the droppable at any amount Acceptance You can limit which draggables can be dropped onto droppables using scope attribute which a draggable also has.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. 158 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

map. Opacity of the rectangle.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. Opacity of the circle.LatLng Property lat lng Default null null Type double double Description Latitude of the coordinate Longitude of the coordinate 196 .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. Background color of the rectangle.map.primefaces.primefaces.model.primefaces.model. Stroke color of the circle.map.map. Stroke opacity of rectangle.model. org. Description org.Rectangle extends org.Circle extends org.model.PrimeFaces Userʼs Guide Property strokeOpacity strokeWeight fillColor fillOpacity 1 1 Default Type Double Integer String Double Opacity of a line Weight of a line Description null 1 Background color of the polygon Opacity of the polygon org.primefaces. Background color of the circle. Stroke color of the rectangle. Stroke weight of the rectangle. Stroke opacity of circle.model. Stroke weight of the circle.map.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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.PrimeFaces Userʼs Guide Ajax Support Ajax is a built-in feature of hotKeys meaning you can do ajax calls with key combinations.name}" /> </h:panelGrid> <h:outputText id="dsplay" value="Hello: #{bean.

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

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

PrimeFaces Userʼs Guide

3.45 ImageCompare
ImageCompare provides a rich user interface to compare two images.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCompare org.primefaces.component.imagecompare.ImageCompare org.primefaces.component.ImageCompare org.primefaces.component org.primefaces.component.ImageCompareRenderer org.primefaces.component.imagecompare.ImageCompareRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

Description Name of the client side widget. Source of the image placed on the left side Source of the image placed on the right side Width of the images Height of the images Inline style of the container element Style class of the container element

Getting started with ImageCompare ImageCompare is created with two images with same height and width. It is required to set width and height of the images as well.
<p:imageCompare leftImage="xbox.png" rightImage="ps3.png" width="438" height="246"/>

Skinning Both images are placed inside a div container element, style and styleClass attributes apply to this element.

213

PrimeFaces Userʼs Guide

3.46 ImageCropper
ImageCropper allows cropping a certain region of an image. A new image is created containing the cropped area and assigned to a CroppedImage instanced on the server side.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCropper org.primefaces.component. imagecropper.ImageCropper org.primefaces.component.ImageCropper org.primefaces.component org.primefaces.component.ImageCropperRenderer org.primefaces.component.imagecropper.ImageCropperRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

Description When set true, process validations logic is executed at apply request values phase for this component. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Message to be displayed when conversion fails. Message to be displayed when validation fields. Name of the client side widget. Context relative path to the image. Alternate text of the image. Aspect ratio of the cropper area. Minimum size of the cropper area. Maximum size of the cropper area. Background color of the container. Background opacity of the container Initial coordinates of the cropper area.

required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar image alt aspectRatio minSize maxSize backgroundColor backgroundOpacity initialCoords

FALSE null null null null null null null null null null null null 0,6 null

Boolean MethodExpr ValueChange Listener String String String String String String Double String String String Double String

Getting started with the ImageCropper ImageCropper is an input component and image to be cropped is provided via the image attribute. The cropped area of the original image is used to create a new image, this new image can be accessed on the backing bean by setting the value attribute of the image cropper. Assuming the image is at %WEBAPP_ROOT%/campnou.jpg
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" />

public class Cropper { private CroppedImage croppedImage; //getter and setter }

215

PrimeFaces Userʼs Guide

org.primefaces.model.CroppedImage belongs a PrimeFaces API and contains handy information about the crop process. Following table describes CroppedImage properties.
Property originalFileName bytes left right width height Type String byte[] int int int int Description Name of the original file that’s cropped Contents of the cropped area as a byte array Left coordinate Right coordinate Width of the cropped image Height of the cropped image

External Images ImageCropper has the ability to crop external images as well.
<p:imageCropper value="#{cropper.croppedImage}" image="http://primefaces.prime.com.tr/en/images/schema.png"> </p:imageCropper>

Context Relative Path For local images, ImageCropper always requires the image path to be context relative. So to accomplish this simply just add slash ("/path/to/image.png") and imagecropper will recognize it at %WEBAPP_ROOT%/path/to/image.png. Action url relative local images are not supported. Initial Coordinates By default, user action is necessary to initiate the cropper area on an image, you can specify an initial area to display on page load using initialCoords option in x,y,w,h format.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" initialCoords="225,75,300,125"/>

Boundaries minSize and maxSize attributes are control to limit the size of the area to crop.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" minSize="50,100" maxSize="150,200"/>

216

PrimeFaces Userʼs Guide

Saving Images Below is an example to save the cropped image to file system.
<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" /> <p:commandButton value="Crop" actionListener="#{myBean.crop}" />

public class Cropper { private CroppedImage croppedImage; //getter and setter public String crop() { ServletContext servletContext = (ServletContext) FacesContext.getCurrentInstance().getExternalContext().getContext(); String newFileName = servletContext.getRealPath("") + File.separator + "ui" + File.separator + "barca" + File.separator+ croppedImage.getOriginalFileName() + "cropped.jpg"; FileImageOutputStream imageOutput; try { imageOutput = new FileImageOutputStream(new File(newFileName)); imageOutput.write(croppedImage.getBytes(), 0, croppedImage.getBytes().length); imageOutput.close(); } catch (Exception e) { e.printStackTrace(); } return null; } }

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class imageSwitch org.primefaces.component.imageswitch.ImageSwitch org.primefaces.component.ImageSwitch org.primefaces.component org.primefaces.component.ImageSwitchRenderer org.primefaces.component.imageswitch.ImageSwitchRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Name of the effect for transition. Speed of the effect in milliseconds. Slideshow speed in milliseconds. Starts slideshow automatically on page load. Style of the main container. Style class of the main container.
218

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

Getting Started with ImageSwitch ImageSwitch component needs a set of images to display. Provide the image collection as a set of children components.
<p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> <p:graphicImage value="/images/nature1.jpg" /> <p:graphicImage value="/images/nature2.jpg" /> <p:graphicImage value="/images/nature3.jpg" /> <p:graphicImage value="/images/nature4.jpg" /> </p:imageSwitch>

Most of the time, images could be dynamic, ui:repeat is supported to implement this case.
<p:imageSwitch widgetVar="imageswitch"> <ui:repeat value="#{bean.images}" var="image"> <p:graphicImage value="#{image}" /> </ui:repeat> </p:imageSwitch>

Slideshow or Manual ImageSwitch is in slideShow mode by default, if you’d like manual transitions disable slideshow and use client side api to create controls.
<p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> //images </p:imageSwitch> <span onclick="imageswitch.previous();">Previous</span> <span onclick="imageswitch.next();">Next</span>

Client Side API
Method void previous() void next() void startSlideshow() void stopSlideshow() voud pauseSlideshow(); void toggleSlideShow() Description Switches to previous image. Switches to next image. Starts slideshow mode. Stops slideshow mode. Pauses slideshow mode. Toggles slideshow mode.

219

PrimeFaces Userʼs Guide

Effect Speed The speed is considered in terms of milliseconds and specified via the speed attribute.
<p:imageSwitch effect="FlipOut" speed="150" widgetVar="imageswitch" > //set of images </p:imageSwitch>

List of Effects ImageSwitch supports a wide range of transition effects. Following is the full list, note that values are case sensitive. • • • • • • • • • • • • • • • • • • • • • • • • • • • blindX blindY blindZ cover curtainX curtainY fade fadeZoom growX growY none scrollUp scrollDown scrollLeft scrollRight scrollVert shuffle slideX slideY toss turnUp turnDown turnLeft turnRight uncover wipe zoom

220

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.log.56 Log Log component is a visual console to display logs on JSF pages.primefaces.LogRenderer org.component.primefaces.primefaces.component.primefaces.component. 250 .component 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. when set to false component will not be rendered.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 Log Log component is used simply as adding the component to the page.primefaces.component.Log org.log.Log org.

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

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

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

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

1" <p:menuitem value="TV.1" <p:menuitem value="TV.1" <p:menuitem value="TV.3" </p:submenu> <p:submenu label="TV.6.5"> <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.2"> <p:menuitem value="TV.2. Style class of the component.4.2.3"> <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.2" </p:submenu> <p:submenu label="TV.3.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.4.6"> <p:menuitem value="TV.3" </p:submenu> </p:column> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> </p:submenu> //more root items </p:megaMenu> 255 .1.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.1"> <p:menuitem value="TV.1.3" </p:submenu> <p:submenu label="TV.5.6.5.2" </p:submenu> <p:submenu label="TV.3.2" <p:menuitem value="TV.2" <p:menuitem value="TV.1" <p:menuitem value="TV.2.2" <p:menuitem value="TV.1" <p:menuitem value="TV.4"> <p:menuitem value="TV.6.5.1" <p:menuitem value="TV.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

‘error’. Getting started with Messages Message usage is exactly same as standard messages. messages component is updated with each ajax request automatically. 274 . <p:messages /> AutoUpdate When auto update is enabled. ‘warn’ and error. Skinning Message Full list of CSS selectors of message is as follows. {severity} can be ‘info’.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. 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:notificationBar widgetVar="topBar"> //Content </p:notificationBar> 275 .component.component.component. Name of the effect. "normal" or "fast". "fade". when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class notificationBar org.NotificationBarRenderer org.notificationbar.notificationbar. An el expression that maps to a server side UIComponent instance in a backing bean Style of the container element StyleClass of the container element Position of the bar.component org. any content can be placed inside.65 NotificationBar NotificationBar displays a multipurpose fixed positioned panel for notification.NotificatonBar org.PrimeFaces Userʼs Guide 3.NotificationBar org. 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. panel is displayed on page load. "slide" or "none".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. "slow".primefaces.primefaces. Speed of the effect.primefaces. When true. "top" or "bottom".primefaces.component.

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

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

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

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

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

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

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

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

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

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

PanelRenderer org.Panel org.primefaces.primefaces.component org.primefaces.panel.primefaces. Speed of toggling in milliseconds Renders a toggleable panel as collapsed. 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 Header text Footer text Makes panel toggleable.primefaces. close and menu integration. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.component.Panel org.component.PrimeFaces Userʼs Guide 3.panel.69 Panel Panel is a grouping component with content toggle.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. Style of the panel Style class of the panel 286 binding header footer toggleable toggleSpeed collapsed style styleClass null null null FALSE 1000 FALSE null null Object String String Boolean Integer Boolean String String .component.

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

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

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

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

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

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. when set to false component will not be rendered. Marks component as required 292 binding value converter null null null Object Object Converter/ String immediate required FALSE FALSE Boolean boolean .Password org.primefaces. it must refer to a converter id When set true. process validations logic is executed at apply request values phase for this component.component org.Password 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.PasswordRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces.component.primefaces.PasswordRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class password org.component.primefaces.component.PrimeFaces Userʼs Guide 3.password. When it’s an EL expression.component. it’s resolved to a converter instance.password.

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide Skinning PickList resides in a main container which style and styleClass attributes apply.ui-picklist .ui-picklist-button-move-bottom .ui-picklist-list-source .ui-picklist-list-target .ui-picklist-source-controls .ui-picklist-button-add-all .ui-picklist-button-move-down .ui-picklist-button-move-up . Following is the list of structural style classes.ui-picklist-button-move-top .ui-picklist-button .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 . 304 .ui-picklist-button-remove-all . see the main Skinning section for more information.ui-picklist-list .ui-picklist-target-controls .ui-picklist-button-add .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

players}" var="player”> <p:graphicImage value="/images/barca/#{player. public RingBean() { players = new ArrayList<Player>(). } } players. //getter&setter for players <p:ring value="#{ringBean. 5. 8. "CF")). 6. 7. commandLink </p:column> </p:ring> Easing Following is the list of available options for easing animation. Player("Puyol". "villa. "CF")). "puyol.add(new players.players}" var="player"> <p:column> //UI to select an item e. • • • • • • • swing easeInQuad easeOutQuad easeInOutQuad easeInCubic easeOutCubic easeInOutCubic • • • • • • • easeInQuart easeOutQuart easeInOutQuart easeInQuint easeOutQuint easeInOutQuint easeInSine • • • • • • • easeOutSine easeInExpo easeOutExpo easeInOutExpo easeInCirc easeOutCirc easeInOutCirc • • • • • • easeInElastic easeOutElastic easeInOutElastic easeInBack easeOutBack easeInOutBack • easeInBounce • easeOutBounce • easeInOutBounce 325 . Player("Iniesta".jpg".jpg". "messi. Player("Villa".add(new players. "CM")).PrimeFaces Userʼs Guide Getting started with Ring A collection is required to use the Ring component. "xavi. "iniesta.add(new players. 10.photo}"/> </p:ring> Item Selection A column is required to process item selection from ring properly.add(new Player("Messi". public class RingBean { private List<Player> players. <p:ring value="#{ringBean. Player("Xavi".g.jpg". "CB")).jpg".add(new players. "CM")).jpg".

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

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

RowEditor org.component.PrimeFaces Userʼs Guide 3.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowEditor org.primefaces.RowEditorRenderer org.84 RowEditor RowEditor is a helper component for datatable. 328 .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.component.roweditor.primefaces.component.component.primefaces.primefaces. 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. when set to false component will not be rendered.primefaces.RowEditor org.

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

PrimeFaces Userʼs Guide 3.component.rowtoggler.86 RowToggler RowToggler is a helper component for datatable.rowtoggler.primefaces.primefaces.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. when set to false component will not be rendered.RowToggler org.component org.RowTogglerRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.component.primefaces.primefaces.component.RowToggler org.primefaces. 330 .component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See expandable rows section in datatable documentation for more information about usage.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

params:{ ‘param_name1’:’value1’.process:’userForm’ .user. ‘param_name2’:’value2’ } .AjaxRequest({ formId:’userForm’. status) {alert(‘Done’).. . More components </h:form> You can post all the information in form with ajax using.source:’userForm’ .AjaxResponse updates the specified components if any and synchronizes the client side JSF state.process:’userForm’ }). More complex example with additional options.ajax.ajax.oncomplete:function(xhr.} }). PrimeFaces.name}" /> . 440 .update:’msgs’ .ajax. <h:form id="userForm"> <h:inputText id="username" value="#{userBean. PrimeFaces. 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.AjaxRequest({ formId:’userForm’ . PrimeFaces. 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 PrimeFaces.source:’userForm’ .ajax..

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful