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

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

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

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

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

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

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

util. Defines if activating a dynamic tab should load the contents from server again. Client side callback to invoke when an inactive tab is clicked. 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. List to iterate to display dynamic number of tabs. 16 . Defines the toggle mode. Name of the client side widget.PrimeFaces Userʼs Guide Name activeIndex style styleClass onTabChange onTabShow dynamic cache value var multiple widgetVar Default 0 null null null null FALSE TRUE null null FALSE null Type String String String String String Boolean Boolean java. Titles can also be defined with “title” facet.. Controls multiple selection.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. when dynamic option is set true.. <p:accordionPanel> <p:tab title="First Tab Title"> <h:outputText value= "Lorem"/> . To control this behavior use cache option. 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. Client side callback to invoke when a tab gets activated. Inline style of the container element. 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.List String Boolean String Description Index of the active tab or a comma separated string of indexes when multiple mode is on.

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

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

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

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

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

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

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

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

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

Disables input field A localized user presentable name. Code describing the language used in the generated markup for this component. Alternate textual description of the input field. When true. 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 input element receives focus. Maximum number of characters that may be entered in this field. 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 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. Client side callback to execute when a key is pressed and released over input element. 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 . Component(s) to process on query request. Client side callback to execute when input element loses focus. Controls browser autocomplete behavior. 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 and its value has been modified since gaining focus. Client side callback to execute when a key is released over input element. Client side callback to execute when a key is pressed down over input element. Valid values are LTR and RTL. Access key that when pressed transfers focus to 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. public List<String> complete(String query) { List<String> results = new ArrayList<String>(). it requires a value as usual. <p:autoComplete value="#{bean.text}" completeMethod="#{bean. i++) results. Client side callback to execute when a pointer button is released over input element. i < 10. Inline style of the input element. } //getter setter 27 . Since autoComplete is an input component. Number of characters used to determine the width of the input element.complete}" /> public class Bean { } private String text. return results. Client side callback to execute when text within input element is selected by user. Style class of the input element. for (int i = 0.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. Position of the input element in the tabbing order. Flag indicating that this component will prevent changes by the user. Advisory tooltip informaton.

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

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

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

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

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

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

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

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

<p:breadCrumb> <p:menuitem label="Categories" url="#" /> <p:menuitem label="Sports" url="#" /> //more menuitems </p:breadCrumb> 36 .BreadCrumbRenderer org. 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.BreadCrumb org.PrimeFaces Userʼs Guide 3.primefaces.primefaces.BreadCrumb org.component. MenuModel instance to create menus programmatically Style of main container element.component org.component.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class breadCrumb org.BreadCrumbRenderer Attributes Name id rendered binding widgetVar model style styleClass Default null TRUE null null null null null Type String Boolean Object String MenuModel String String Description Unique identifier of the component.breadcrumb. 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.breadcrumb.component.primefaces.component.

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

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

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

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

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

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

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

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

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

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

<p:calendar value="#{dateController. <h:outputScript name=”path_to_your_translations.util. yyyy"/> 47 .MM. Locale attribute can take a locale key as a String or a java.date3}" pattern="EEE.org/display/Components/PrimeFaces+Locales Translation is a simple javascript object. Following is a Turkish calendar. we suggest adding the code to a javascript file and include in your application.Locale instance. dd MMM.date}" locale="tr" navigator="true" showButtonPanel="true"/> To override calculated pattern from locale. d"/> <p:calendar value="#{dateController. http://wiki. M.js” /> <p:calendar value="#{dateController.date1}" pattern="dd. Please contribute to this wiki with your own 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.primefaces. use the pattern option. PrimeFaces Wiki Page for PrimeFacesLocales is a community driven page where you may find the translations you need.date2}" pattern="yy.yyyy"/> <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.

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

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. 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. 49 .date}" pattern=”MM/dd/yyyy HH:mm” /> Advanced Customization Use beforeShowDay javascript callback to customize the look of each date. Following example disabled tuesdays and fridays. <p:calendar value="#{dateBean. <p:calendar value="#{dateBean.PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly.

ui-datepicker-prev .ui-datepicker-month .widget.ui-datepicker-week-end . Following is the list of structural style classes. ''] } Client Side API Widget: PrimeFaces.ui-datepicker-buttonpane Main container Header container Previous month navigator Next month navigator Title Month display Date table Label of weekends Dates belonging to other months Each cell date Button panel 50 Applies .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.ui-datepicker-other-month .   return [(day != 2 && day != 5).ui-datepicker-table .ui-datepicker .PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.getDay().ui-datepicker-title . Style Class .ui-datepicker-next .ui-datepicker-header .Calendar Method getDate() setDate(date) disable() enable() Params date: Date to display Return Type Date void void void Description Return selected date Sets display date Disables calendar Enables calendar Skinning Calendar resides in a container element which style and styleClass options apply.ui-datepicker td .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

12.component.primefaces.chart.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lineChart org. Comma separated list of colors in hex format.component org.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. Minimum X axis value.primefaces.LineChart org.primefaces. Style class of the chart.line.primefaces.component. Maximum X axis value. Minimum Y axis value. Maximum Y axis value. An el expression that maps to a server side UIComponent instance in a backing bean Datasource to be displayed on the chart Name of the client side widget Inline style of the chart.LineChartRenderer org.PrimeFaces Userʼs Guide 3. when set to false component will not be rendered. fall will join point on either side of line.primefaces. Position of the legend. Whether line segments should be broken at null value.2 Line Chart Line chart visualizes one or more series of data in a line graph.LineChart org. 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 .line.chart.component. Title of the chart.chart.component.

Specifies interactive legend.set("2005". Whether to fill under lines.model. Whether to stack series. 120). } public } ChartBean() { model = new CartesianChartModel().PrimeFaces Userʼs Guide Name shadow fill stacked showMarkers fillToZero xaxisLabel yaxisLabel xaxisAngle yaxisAngle enhancedLegend Default TRUE FALSE FALSE TRUE FALSE null null null null TRUE Type Boolean Boolean Boolean Boolean Boolean String String Integer Integer Boolean Description Shows shadow or not. ChartSeries boys = new ChartSeries(). //. boys..set("2005". boys. Getting started with LineChart LineChart is created with an org. girls. Angle of the x-axis ticks.CartesianChartModel instance. Label of the y-axis. 100). public class Bean { private CartesianChartModel model..setLabel("Girls"). girls.setLabel("Boys"). } 66 ..set("2004".chart. model. boys. Label of the x-axis. True will force filled series to fill toward zero. public CartesianChartModel getModel() { return model. ChartSeries girls = new ChartSeries(). //.. girls. model.primefaces. 60).set("2004". 52). Displays markers at data points. Angle of the y-axis ticks.addSeries(girs).addSeries(boys).

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

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

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

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

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

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

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

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

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

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

56.97)).9.136.5)).140.7.135.139.addRecord(new ohlcModel.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.144.76.138.136.57.136.addRecord(new ohlcModel. OhlcChartSeries(2010.04.primefaces.67.143. OhlcChartSeries(2012.56. public class Bean { private OhlcChartModel model.73.addRecord(new ohlcModel.124. OhlcChartSeries(2009.123.OhlcChartModel instance. public Bean() { model = new OhlcChartModel(). OhlcChartSeries(2011.addRecord(new ohlcModel. ohlcModel.135.46.124.81)).53.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 . OhlcChartSeries(2012.132.4)).chart.55.139.model. OhlcChartSeries(2008.5.44)).122.addRecord(new } //getter } OhlcChartSeries(2007.82.addRecord(new ohlcModel.140.139.68.144.31.01.143.121.142.129.66.02)). <p:ohlcChart value="#{bean.48)).139. <p:ohlcChart value="#{bean.134.88.135.18.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.79.135.addRecord(new ohlcModel.143.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

102 .. You can call these functions to display a confirmation from any component like commandButton.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. </p:confirmDialog> Severity Severity defines the icon to display next to the message.hide()"/> <p:commandButton value="Not Yet" onclick="confirmation. Note that header can also be defined using the header attribute or the header facet.hide(). commandLink. show() and hide() functions are used to display and close the dialog respectively." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways. Whether to display confirm dialog on load. 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. <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //.. either via message option or message facet. Getting started with ConfirmDialog ConfirmDialog has a simple client side api.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. menuitem and more.destroyWorld}" update="messages" oncomplete="confirmation. <h:form> <p:commandButton type="button" onclick="cd.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

manufacturer}.model}. Detail content is provided with the facet called "description". to use definition list set type option to "definition".year} <f:facet name="description"> <p:graphicImage value="/images/cars/#{car. Year: #{car. For ordered lists.PrimeFaces Userʼs Guide Item Type itemType defines the bullet type of each item. available values are.cars}" var="car" type="definition"> Model: #{car. following item types are available.jpg"/> </f:facet> </p:dataList> 123 . <p:dataList value="#{carBean. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Client side callback to execute when dialog is hidden. <p:dialog> <h:outputText value="Resistance to PrimeFaces is Futile!" /> //Other content </p:dialog> Show and Hide Showing and hiding the dialog is easy using the client side api.show()" /> <p:commandButton value="Hide" type="button" onclick="dlg. Inline style of the dialog.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. Whether a dialog is minimizable or not. Whether a dialog is maximizable or not. 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. note that by default dialog is not visible. Enables lazy loading of the content with ajax. Text of the footer.hide()" /> 146 . Defines visibility of the header content. Style class of the dialog Effect to use when showing the dialog Effect to use when hiding the dialog Defines where the dialog should be displayed Defines if close icon should be displayed or not Client side callback to execute when dialog is displayed. Getting started with the Dialog Dialog is a panel component containing other components.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor.text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls.widget. subsequent calls do not reinit the editor. Clears the text in editor. • • • • • • • • • • • • • • • • bold italic underline strikethrough subscript superscript font size style color highlight bullets numbering alignleft center alignright • • • • • • • • • • • • • • • • justify undo redo rule image link unlink cut copy paste pastetext print source outdent indent removeFormat Client Side API Widget: PrimeFaces. <p:editor value="#{bean.

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

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

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

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

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

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

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

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

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

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

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

file}"/> </p:commandButton> </h:form> 175 .monitorDownload(showStatus. 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.gif" /> </p:dialog> <p:commandButton value="Download" ajax="false" onclick="PrimeFaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. GraphicImage does all the hard work without the need of a Servlet.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.GraphicImage org.GraphicImageRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.graphicimage. when set to false component will not be rendered.component.primefaces.component. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier.primefaces.PrimeFaces Userʼs Guide 3. Legacy way to do this is to come up with a Servlet that does the streaming.primefaces.GraphicImage org.41 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream.graphicimage. An el expression that maps to a server side UIComponent instance in a backing bean Binary data to stream or context relative path.primefaces.GraphicImageRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class graphicImage org.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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. 246 . Effect speed of the layout transition.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

click event is required to display.component org.PrimeFaces Userʼs Guide 3. When set to false. 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.Menubar org.primefaces.component.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menubar org.MenubarRenderer org. when set to false component will not be rendered.menubar.60 Menubar Menubar is a horizontal navigation component.component.MenubarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component. binding widgetVar model style styleClass autoDisplay null null null null null FALSE Object String MenuModel String String Boolean 263 .primefaces.menubar.Menubar org.primefaces. Name of the client side widget MenuModel instance to create menus programmatically Inline style of menubar Style class of menubar Defines whether the first level of submenus will be displayed on mouseover or not.primefaces.

nest submenus in parent submenus. <p:menubar> <p:menuitem label="Logout" action="#{bean.com" /> </p:submenu> </p:menubar> Nested Menus To create a menubar with a higher depth.com" /> <p:menuitem value="Break" url="http://www.hotmail.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.logout}"/> </p:menubar> 264 . <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.youtube.break.com" /> <p:menuitem value="Yahoo Mail" url="http://mail. <p:menubar> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www.yahoo.PrimeFaces Userʼs Guide Getting started with Menubar Submenus and menuitems as child components are required to compose the menubar.google.com" /> <p:menuitem value="Hotmail" url="http://www.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.component org.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.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean 289 binding null Object .component.PanelGrid org.primefaces.70 PanelGrid PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.primefaces.panelgrid.PrimeFaces Userʼs Guide 3.panelgrid. when set to false component will not be rendered.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org.component.PanelGridRenderer org.PanelGridRenderer org.component.

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

ui-panelgrid-footer Applies Main container element of panelGrid. Style Class .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. Following is the list of structural style classes.ui-panelgrid-header . Header. see the main Skinning section for more information. 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.ui-panelgrid . Footer. As skinning style classes are global.

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

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

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

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

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

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

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

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

Title of remove button. Label of an item. Title of move bottom button. Title of add button. Name of the iterator. Disables the component. Message to be displayed when conversion fails. Message to be displayed when validation fields. Specified if an item can be picked or not. Name of the client side widget. Speed of the animation. Style of the main container. Title of move top button. Title of remove all button. Title of add all button. Value of an item. Specifies visibility of reorder buttons of source list. . Title of move up button. Name of the animation to display. A localized user presentable name.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. Client side callback to execute when an item is transferred from one list to another. Specifies visibility of reorder buttons of target list. Title of move down button. Style class of the main container.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Each item in the list.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.ui-ring-item Main container element. Style Class . Applies 326 .ui-ring .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

PrimeFaces Userʼs Guide THE END 460 .