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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:dataTable id="dataTable" var="car" value="#{tableBean.PrimeFaces Userʼs Guide Name trigger block Default null null Type String String Description Identifier of the component(s) to bind. Identifier of the component to block.gif"/> </p:blockUI> 34 . With the special ajax integration. <p:blockUI block="pnl" trigger="saveBtn.model}" /> </p:column> //more columns </p:dataTable> <p:blockUI block="dataTable" trigger="dataTable"> LOADING<br /> <p:graphicImage value="/images/ajax-loader. Getting Started with BlockUI BlockUI requires trigger and block attributes to be defined.deleteBtn. Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received. place the content inside the blockUI.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. ajax requests whose source is trigger components will block the ui onstart and unblock oncomplete. <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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-datepicker-next .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.ui-datepicker-header .ui-datepicker .getDay().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 . ''] } Client Side API Widget: PrimeFaces.widget.ui-datepicker-title .   return [(day != 2 && day != 5). Style Class .ui-datepicker-month .ui-datepicker-table .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. Following is the list of structural style classes.ui-datepicker-week-end .ui-datepicker-prev .ui-datepicker-other-month .ui-datepicker td .

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

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

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

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

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

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

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

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

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

Tips • Carousel is a NamingContainer.ui-carousel-viewport .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 . Each item. 60 .ui-carousel-button .ui-carousel-prev-button . Each page link of paginator.PrimeFaces Userʼs Guide Style Class .ui-carousel-page-link . As skinning style classes are global. make sure you reference components outside of carousel properly following conventions.ui-carousel-next-button . see the main Skinning section for more information.

when set to false component will not be rendered.component.CellEditor org.primefaces.primefaces.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.component.CellEditorRenderer org.component. 61 .primefaces.component org.celleditor.11 CellEditor CellEditor is a helper component of datatable used for incell editing.PrimeFaces Userʼs Guide 3.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.CellEditor org.primefaces.CellEditorRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.celleditor.

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

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

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

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

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

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

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

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

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

chart.donut.component. Shows shadow or not.primefaces. Displays data on each slice.component. Style class of the chart. Title of the chart.chart.donut. Render solid slices. Position of the legend.component org.component.12. 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.primefaces. Gap between slices. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.chart.primefaces. Format of data labels.4 Donut Chart DonutChart is a combination of pie charts.DonutChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.primefaces.DonutChart org.DonutChart org. Specifies interactive legend.primefaces. Comma separated list of colors in hex format. when set to false component will not be rendered.chart.DonutChartRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class donutChart org.

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

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

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

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

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

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

82. public class Bean { private OhlcChartModel model.135.144. ohlcModel.04.addRecord(new ohlcModel.chart.76.139.136.56.5.55.143. OhlcChartSeries(2008.addRecord(new ohlcModel. OhlcChartSeries(2012. OhlcChartSeries(2010.121.addRecord(new ohlcModel.56.136.4)).81)).46.135.139.138.135. OhlcChartSeries(2009.57.44)).79.9.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.5)).primefaces. <p:ohlcChart value="#{bean.addRecord(new } //getter } OhlcChartSeries(2007.143.7.addRecord(new ohlcModel.123.01.132.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org. OhlcChartSeries(2012.139.68.88.model. public Bean() { model = new OhlcChartModel().129.18.136.135.31.140.124.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .addRecord(new ohlcModel.67.144.OhlcChartModel instance.134.124.122. OhlcChartSeries(2011. <p:ohlcChart value="#{bean.66.73.143.02)).139.142.53.addRecord(new ohlcModel.48)).97)).140.

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

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

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

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

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

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

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

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

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

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

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

Getting Started with Column As column is a reused component. 90 . 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. Datatable's resizableColumns must be enabled to use this option. Specifies resizable feature at column level. for example filterBy is only used by datatable whereas sortBy is used by datatable and sheet.PrimeFaces Userʼs Guide Name disabledSelection filterMaxLength resizable Default FALSE null TRUE Type Boolean Integer Boolean Description Disables row selection.

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

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

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

Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when button loses focus. Client side callback to execute when a pointer button is released over button. Client side callback to execute when button is clicked. Client side callback to execute when text within button is selected by user. Client side callback to execute when a pointer button is moved onto button. Client side callback to execute when a pointer button is moved within button. Client side callback to execute when a key is pressed down over button. Client side callback to execute when ajax request fails. Client side callback to execute when ajax request is completed. Client side callback to execute when button receives focus. Defines whether to trigger ajaxStatus or not.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 pointer button is pressed down over button. Access key that when pressed transfers focus to the button. 94 . Client side callback to execute when a key is released over button. StyleClass of the button element. Client side callback to execute when ajax request succeeds. Inline style of the button element. Client side callback to execute when a key is pressed and released over button. Client side callback to execute when button is double clicked. Client side callback to execute when button loses focus and its value has been modified since gaining focus.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

model.DefaultDashboardModel is the default implementation) Method void removeWidget(String widgetId) List<String> getWidgets() int getWidgetCount() String getWidget(int index) void addWidget(String widgetId) void addWidget(int index.DashboardColumn (org.primefaces.model.DefaultDashboardModel is the default implementation) Method void addColumn(DashboardColumn column) List<DashboardColumn> getColumns() int getColumnCount() DashboardColumn getColumn(int index) void transferWidget(DashboardColumn from.primefaces. String widgetId) void reorderWidget(int index. String widgetId.DashboardModel (org.model. org.model.primefaces. DashboardColumn to.map. 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.map.PrimeFaces Userʼs Guide Dashboard Model API org. 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.

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-datagrid-row . see DataTable lazy loading section. Following is the list of structural style classes.widget. Tips • DataGrid supports lazy loading data via LazyDataModel.ui-datagrid-column Main container element Content container.DataGrid Method getPaginator() Params Return Type Paginator Description Returns the paginator widget. 120 . see the main Skinning section for more information. 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. Class .ui-datagrid-content .ui-datagrid .ui-datagrid-data .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<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. 152 . actual component is used as the drag indicator.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="pnl" header="Draggable Panel"> <h:outputText value="I am dragged on an axis only" /> </p:panel> <p:draggable for="pnl" axis="x or y"/> Clone By default. opacity option can be used to give visual feedback. <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. use a clone helper. 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. if you need to keep the component at it’s original location.ui-panel-titlebar"/> Drag Axis Dragging can be limited to either horizontally or vertically.

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

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

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

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

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

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

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

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

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

Message to be displayed when required field validation fails.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true.text}" /> 162 . A method expression that refers to a method for handling a valuchangeevent. process validations logic is executed at apply request values phase for this component. Message to be displayed when conversion fails. Inline style of the editor container. Name of the client side widget. 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. Message to be displayed when validation fails. Marks component as required. public class Bean { private String text. Client side callback to execute when editor data changes. Style class of the editor container. //getter and setter <p:editor value="#{bean. List of controls to customize toolbar. Disables editor. Width of the editor. Height of the 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. Saves html text in iframe back to the textarea.text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls. Clears the text in editor. .Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor. subsequent calls do not reinit the editor.widget.PrimeFaces Userʼs Guide Custom Toolbar Toolbar of editor is easy to customize using controls option. <p:editor value="#{bean.

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org.component org.component.primefaces. Makes content toggleable with animation.primefaces.component. Style class of the fieldset.primefaces. Toggle duration in milliseconds.FieldsetRenderer org. Defines initial visibility state of content. Inline style of the fieldset. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.Fieldset org. when set to false component will not be rendered.primefaces.component. Title text.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.Fieldset org.component. 169 binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null null null null null FALSE 500 FALSE Object String String String String Boolean Integer Boolean .PrimeFaces Userʼs Guide 3.34 Fieldset Fieldset is a grouping component as an extension to html fieldset.primefaces.fieldset.

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

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

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

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

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

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

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

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

public class FileBean { } private UploadedFile file.handleFileUpload}" /> 178 .webapp. FileUploadListener is the way to access the uploaded files. <p:fileUpload fileUploadListener="#{fileBean. when a file is uploaded defined fileUploadListener is processed with a FileUploadEvent as the parameter.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.UploadedFile. //getter-setter Advanced File Upload Default mode of fileupload is advanced that provides a richer UI. FileUpload filter should map to Faces Servlet.model. <filter> <filter-name>PrimeFaces FileUpload Filter</filter-name> <filter-class> org. <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.filter. In this case.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.maps.google. 2.122893" zoom="15" type="terrain" style="width:600px.MapModel (org. <p:gmap center="41. http://code.html GMap API org.map. var gmap = yourWidgetVar.primefaces.getMap(). Alternatively setting disableDefaultUI to true will remove all controls at once.map.model. Finds an overlay by it’s unique id 194 Description .com/apis/maps/documentation/javascript/reference. //gmap is a google.Map instance Full map api is provided at. use provided getMap() method.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.381542.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.model.

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

primefaces. Background color of the rectangle. Background color of the circle. Stroke opacity of rectangle.model. Stroke weight of the rectangle.model. Opacity of the circle.model. Stroke opacity of circle.primefaces.model.map. Opacity of the rectangle.Overlay Property bounds strokeColor strokeOpacity strokeWeight fillColor fillOpacity Default null null 1 1 null 1 Type LatLngBounds String Double Integer String Double Description Boundaries of the rectangle.primefaces.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. org.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.Circle extends org.map. Description org. Stroke weight of the circle.model.map.primefaces.map.primefaces.PrimeFaces Userʼs Guide Property strokeOpacity strokeWeight fillColor fillOpacity 1 1 Default Type Double Integer String Double Opacity of a line Weight of a line Description null 1 Background color of the polygon Opacity of the polygon org. Stroke color of the circle.map.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

primefaces.PrimeFaces Userʼs Guide 3.component.primefaces. 250 .component.component org. when set to false component will not be rendered.primefaces.Log org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.log.log.Log org.component.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. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting started with Log Log component is used simply as adding the component to the page.primefaces.56 Log Log component is a visual console to display logs on JSF pages.primefaces.LogRenderer org.component.

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

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

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

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

<p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.1.5.1" <p:menuitem value="TV.2.3" </p:submenu> <p:submenu label="TV.1" <p:menuitem value="TV. Style class of the component.2" <p:menuitem value="TV.2" <p:menuitem value="TV.4"> <p:menuitem value="TV.4.5.3. Getting Started with MegaMenu Layout of MegaMenu is grid based and root items require columns as children to define each section in a grid.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 .1" <p:menuitem value="TV.2" <p:menuitem value="TV.1" <p:menuitem value="TV.2" </p:submenu> <p:submenu label="TV.4.2.5"> <p:menuitem value="TV.1"> <p:menuitem value="TV.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.6.5.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.2.3" </p:submenu> <p:submenu label="TV.2"> <p:menuitem value="TV.1.6"> <p:menuitem value="TV.3"> <p:menuitem value="TV.1" <p:menuitem value="TV.6.6.1" <p:menuitem value="TV.2" </p:submenu> <p:submenu label="TV.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

messages component is updated with each ajax request automatically.PrimeFaces Userʼs Guide Name redisplay autoUpdate Default TRUE FALSE Type Boolean Boolean Description Defines if already rendered messages should be displayed Enables auto update mode if set true. ‘error’. Style Class ui-messages-{severity} ui-messages-{severity}-summary ui-messages-{severity}-detail ui-messages-{severity}-icon Applies Container element of the message Summary text Detail text Icon of the message. Getting started with Messages Message usage is exactly same as standard messages. {severity} can be ‘info’. Skinning Message Full list of CSS selectors of message is as follows. 274 . <p:messages /> AutoUpdate When auto update is enabled. ‘warn’ and error.

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

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

component.primefaces.component.PrimeFaces Userʼs Guide 3.OrderListRenderer org. binding value null null Object Object 277 .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.component org.primefaces.primefaces.component.orderlist.primefaces. transition effects and pojo support.OrderList org.primefaces.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering. when set to false component will not be rendered.orderlist. 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 orderList org.OrderList org.component.

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

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

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

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

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

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

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

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

panel. when set to false component will not be rendered.component. Speed of toggling in milliseconds Renders a toggleable panel as collapsed.Panel org. close and menu integration.primefaces.Panel org.component.panel. Style of the panel Style class of the panel 286 binding header footer toggleable toggleSpeed collapsed style styleClass null null null FALSE 1000 FALSE null null Object String String Boolean Integer Boolean String String .primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.69 Panel Panel is a grouping component with content toggle.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.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean Header text Footer text Makes panel toggleable.primefaces.component org.component.PrimeFaces Userʼs Guide 3.

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

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

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

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

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

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

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

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

When feedback option is enabled a password strength indicator is displayed. if you prefer an inline indicator just enable inline mode.password}" inline="true" feedback= "true"/> Confirmation Password confirmation is a common case and password provides an easy way to implement. <p:password value="#{bean. <p:password id="pwd1" value="#{passwordBean.PrimeFaces Userʼs Guide Getting Started with Password Password is an input component and used just like a standard input text. <p:password value="#{bean. public String getPassword() { return password.password6}" feedback="false" match="pwd2" label="Password 1" required="true"/> <p:password id="pwd2" value="#{passwordBean. you can provide custom labels as well.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. The other password component’s id should be used to define the match option. } public void setPassword(String password) { this.password}" feedback="true|false" /> public class Bean { } private String password.} I18N Although all labels are in English by default.password6}" feedback="false" label="Password 2" required="true"/> 295 . Following password gives feedback in Turkish. <p:password value="#{mybean.password = password.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Inline style of the component. Note that in custom mode. Callback to execute on value change. <p:selectOneRadio id="customRadio" value="#{formBean.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. onchange style styleClass null null null String String String Getting started with SelectOneRadio SelectOneRadio usage is same as the standard one. User presentable name. This is implemented by setting layout option to custom and with standalone radioButton components. Layout of the checkboxes. Message to be displayed when validation fields. Disables the component. selectOneRadio itself does not render any output. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. Name of the client side widget. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page.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 component should be placed above any radioButton that points to the selectOneRadio. Applies 363 .ui-selectoneradio . Radio button icon. Style Class .PrimeFaces Userʼs Guide RadioButton’s for attribute should refer to a selectOneRadio component and itemIndex points to the index of the selectItem. Skinning SelectOneRadio resides in a main container which style and styleClass attributes apply. When using custom layout option. Container of a radio button. Following is the list of structural style classes. As skinning style classes are global.ui-radiobutton . Container of radio button icon.ui-radiobutton-icon Main container element. see the main Skinning section for more information.ui-radiobutton-box .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Valid values are LTR and RTL. Name of the client side widget. Icon of the button as a css class. In example below. Flag indicating that this component will prevent changes by the user.PrimeFaces Userʼs Guide Name onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos widgetVar Default null null null null FALSE null null null null null FALSE null left null Type String String String String Boolean String String String Integer String Boolean String String String Description Client side callback to execute when text within button is selected by user. Style class for the button icon. Disables the button. Direction indication for text that does not inherit directionality.org" icon="ui-icon-extlink"/> </p:splitButton> 382 . Alternate textual description of the button. Additional commands are placed inside the component and displayed in an overlay. Advisory tooltip information. Code describing the language used in the generated markup for this component. clicking the save button invokes save method of the bean and updates messages. Getting started with SplitButton SplitButton usage is similar to a regular commandButton. (deprecated: use icon) A localized user presentable name. Nested options defined as menuitems do ajax. Position of the icon.update}" update="messages" icon="ui-icon-arrowrefresh-1-w"/> <p:menuitem value="Delete" actionListener="#{buttonBean. Access key that when pressed transfers focus to the button. <p:splitButton value="Save" actionListener="#{buttonBean.save}" update="messages" icon="ui-icon-disk"> <p:menuitem value="Update" actionListener="#{buttonBean.primefaces. Position of the button element in the tabbing order.delete}" ajax="false" icon="ui-icon-close"/> <p:separator /> <p:menuitem value="Homepage" url="http://www. non-ajax requests as well as regular navigation to an external url.

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

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

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

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

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

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

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

Index of the active tab.TabView org. dynamic content loading with ajax and content transition effects. Duration of the transition effect.TabViewRenderer 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 tabView org.TabViewRenderer org.component.primefaces.tabview. Enables lazy loading of inactive tabs.component.primefaces.TabView org. tabview. when set to false component will not be rendered. Name of the transition effect.component.component.primefaces. Variable name of the client side widget.primefaces. Boolean value to specify the rendering of the component.component org. An el expression that maps to a server side UIComponent instance in a backing bean.110 TabView TabView is a tabbed panel component featuring client side tabs. binding widgetVar activeIndex effect effectDuration dynamic null null 0 null null FALSE Object String Integer String String Boolean 390 .PrimeFaces Userʼs Guide 3.

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

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

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

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. Method select(index) selectTab(index) Params index: Index of tab to display index: Index of tab to display Return Type void void Description Activates tab with given index (Deprecated.widget. Following is the list of structural style classes.ui-tabs-nav .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.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. Class .TabView.ui-tabs .

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

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

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

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

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

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

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

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

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

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

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tree org.primefaces.Tree org.117 Tree Tree is is used for displaying hierarchical data and creating site navigations.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.component org.TreeRenderer org.component.primefaces. when set to false component will not be rendered. 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.primefaces.Tree org.component. A TreeNode instance as the backing model. When set to true expanded nodes will be kept in memory.component.primefaces.primefaces.tree.component.tree.

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

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

Following example demonstrates a document explorer. video). 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. <p:tree value="#{bean. 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).name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <h:outputText value="#{doc.name}" /> </p:treeNode> <p:treeNode type="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc.name}"/> </p:treeNode> <p:treeNode type="document" icon="ui-icon ui-icon-document"> <h:outputText value="#{doc. Suppose you’re using tree to visualize a company with different departments and different employees. In order to solve this. To begin with here is the final output. 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 . or a document tree with various folders.root}" var="doc"> <p:treeNode expandedIcon="ui-icon ui-icon-folder-open" collapsedIcon="ui-icon ui-icon-folder-collapsed"> <h:outputText value="#{doc.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful