USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BlockUI org.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class blockUI org.primefaces. 33 .BlockUIRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces.component.blockui. Boolean value to specify the rendering of the 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.PrimeFaces Userʼs Guide 3.component.component.primefaces.blockui.component.5 BlockUI BlockUI is used to block JSF components during ajax processing.BlockUI org.

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

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

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

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

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

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

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

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

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

Minimum boundary for hour selection. Displays days belonging to other months. Minimum boundary for second selection. Year range for the navigator. Minimum boundary for minute selection. Minute steps. default "c-10:c +10" Shows only timepicker without date. Client side callback to execute when input element loses focus. Maximum boundary for hour selection. label lang maxlength onblur null null null null String String Integer String 43 . Second steps. Initial date to display if value is null. Enables selection of days belonging to other months. A localized user presentable name. Maximum boundary for second selection. Maximum number of characters that may be entered in this field. Controls browser autocomplete behavior.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. Valid values are LTR and RTL. Code describing the language used in the generated markup for this component. Maximum boundary for hour selection. Alternate textual description of the input field. Disables weekend columns. Hour steps. Direction indication for text that does not inherit directionality. Access key that when pressed transfers focus to the 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 null null null null null null null String String String String String String String onmousemove null String onmouseout null String onmouseover onmouseup onselect readonly size tabindex title beforeShowDay null null null FALSE null null null null String String String Boolean Integer Integer String String 44 . Client side callback to execute before displaying a date. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when input element is clicked. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when input element is double 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. Client side callback to execute when a key is pressed down over input element. Number of characters used to determine the width of the input element. used to customize date display. Client side callback to execute when a key is released over input element. Client side callback to execute when text within input element is selected by user. Position of the input element in the tabbing order. Advisory tooltip informaton. Client side callback to execute when input element receives focus. Client side callback to execute when a pointer button is moved onto input element. Client side callback to execute when a key is pressed and released over input element.

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

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

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

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

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

ui-datepicker-next .date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date. ''] } Client Side API Widget: PrimeFaces.ui-datepicker-title .ui-datepicker-month .   return [(day != 2 && day != 5).ui-datepicker-table .ui-datepicker-week-end .ui-datepicker td .ui-datepicker .ui-datepicker-prev .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 .Calendar Method getDate() setDate(date) disable() enable() Params date: Date to display Return Type Date void void void Description Return selected date Sets display date Disables calendar Enables calendar Skinning Calendar resides in a container element which style and styleClass options apply.ui-datepicker-header .getDay().PrimeFaces Userʼs Guide <p:calendar value="#{dateBean.widget. Style Class . Following is the list of structural style classes.ui-datepicker-other-month .

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

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

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

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

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

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

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

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

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

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

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.celleditor.component org.component.primefaces.primefaces.component.primefaces.11 CellEditor CellEditor is a helper component of datatable used for incell editing.CellEditor org.celleditor.primefaces.CellEditor org.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.component.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.CellEditorRenderer org. 61 .

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

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

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

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

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

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

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

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

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

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

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

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

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 .chart. Label of the x-axis. Shows shadow or not.chart. Displays labels on buttons. Specifies interactive legend. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class bubbleChart org.primefaces.primefaces. Alpha transparency of a bubble. 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.BubbleChart org.BubbleChart org. Enables gradient fills instead of flat colors.chart.component.PrimeFaces Userʼs Guide 3.component org.bubble.component.bubble. Comma separated list of colors in hex format. Style class of the chart.primefaces.primefaces.component.12.component. Title of the chart.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.primefaces.BubbleChartRenderer org.chart. Position of the legend.5 Bubble Chart BubbleChart visualizes entities that are defined in terms of three distinct numeric values.

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

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

primefaces.chart. Specifies interactive legend. 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.chart.PrimeFaces Userʼs Guide 3. Angle of the y-axis ticks.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. Label of the x-axis.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. Enables candle stick display mode.component.ohlc.primefaces.component.component. Angle of the x-axis ticks.primefaces. Comma separated list of colors in hex format.component org. 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 .chart.OhlcChart org.OhlcChartRenderer org.ohlc.primefaces. Style class of the chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.primefaces.12.OhlcChart org. Label of the y-axis. Position of the legend.component. Title of the chart.

7. public class Bean { private OhlcChartModel model.124.addRecord(new ohlcModel.9. <p:ohlcChart value="#{bean.5.97)).136.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.143.primefaces.136.OhlcChartModel instance. public Bean() { model = new OhlcChartModel(). OhlcChartSeries(2012.68.53.143.model.129.139.76.122.124.123.67.139.addRecord(new ohlcModel.139.4)).135.135.addRecord(new ohlcModel.135.88.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.82.142.143. OhlcChartSeries(2011.73.57.144.48)).140.66.addRecord(new ohlcModel. OhlcChartSeries(2008. OhlcChartSeries(2010.132. ohlcModel.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .44)).139. <p:ohlcChart value="#{bean.18.140.138. OhlcChartSeries(2009.81)).56.addRecord(new ohlcModel.121.addRecord(new ohlcModel.02)).01.55.46.04.135.134.addRecord(new } //getter } OhlcChartSeries(2007.79.136. OhlcChartSeries(2012.144.5)).chart.56.31.

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

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

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

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

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

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

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

public class Bean { } private String color. <p:colorPicker value="#{bean. } public void setColor(String color) { this. } <p:colorPicker value="#{bean.color. Name of the client side widget. Style class of the component. A method binding expression that refers to a method for handling a valuchangeevent. Message to be displayed when conversion fails.color}" mode="inline"/> 86 . Inline style of the component. public String getColor() { return this.color = 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.color}" /> Display Mode ColorPicker has two modes. Getting started with ColorPicker ColorPicker’s value should be a hex string. A method expression that refers to a method for validation the input. valid values are “popup” and “inline”. Message to be displayed when required field validation fails. Display mode. Message to be displayed when validation fields. default mode is popup and other available option is inline.

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

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

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

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

Name of iterator to access a column. 91 .16 Columns Columns is used by datatable to create columns programmatically. Style class of the column.PrimeFaces Userʼs Guide 3.Columns org.primefaces.column.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. when set to false component will not be rendered.component. Inline style of the column.component. An el expression that maps to a server side UIComponent instance in a backing bean Data to represent columns. Name of iterator to access a column index. Info Tag Component Class Component Type Component Family columns org.primefaces.Columns org. binding value var columnIndexVar style styleClass null null null null null null Object Object String String String String Getting Started with Columns See dynamic columns section in datatable documentation for detailed information.

when set to false component will not be rendered.component. valid values are “header” and “footer”.ColumnGroup org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Type of group.primefaces. Info Tag Component Class Component Type Component Family columnGroup org. ColumnGroup org. binding type null null Object String Getting Started with ColumnGroup See grouping section in datatable documentation for detailed information.primefaces.17 ColumnGroup ColumnGroup is used by datatable for column grouping.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. 92 .PrimeFaces Userʼs Guide 3.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.primefaces.primefaces.component org.datalist. Index of the first row to be displayed binding value var rows first null null null null 0 Object Object String Integer Integer 121 .DataListTag org.primefaces.component.DataList org.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataList org.DataList.25 DataList DataList presents a collection of data in list layout with several display types.primefaces.DataListRenderer org.datalist. when set to false component will not be rendered.DataListRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.component. Name of the request-scoped variable used to refer each data.component.

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

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

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

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

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

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

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

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

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

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

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

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

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.thisYearTotal}$" /> </p:row> </p:columnGroup> </p:dataTable> 134 .manufacturer} </p:column> <p:column> #{sale.thisYearProfit}% </p:column> <p:column> #{sale.lastYearTotal}$" /> <p:column footerText="#{tableBean.lastYearSale}$ </p:column> <p:column> #{sale. <p:dataTable var="sale" value="#{carBean.lastYearProfit}% </p:column> <p:column> #{sale.sales}"> <p:columnGroup type="header"> <p:row> <p:column rowspan="3" headerText="Manufacturer" /> <p:column colspan="4" headerText="Sales" /> </p:row> <p:row> <p:column colspan="2" headerText="Sales Count" /> <p:column colspan="2" headerText="Profit" /> </p:row> <p:row> <p:column headerText="Last Year" /> <p:column headerText="This Year" /> <p:column headerText="Last Year" /> <p:column headerText="This Year" /> </p:row> </p:columnGroup> <p:column> #{sale.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

158 .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. <p:graphicImage id="messi" value="barca/messi_thumb. 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. Following example has two images.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. only first image can be accepted by droppable.

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

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

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

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

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

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

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.primefaces. Dom event to attach the event that executes the animation Specifies the name of the animation Component that is animated Speed of the animation in ms Time to wait until running the effect.primefaces.Effect org.EffectTag org. 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.effect.component.primefaces.primefaces.component. 165 . Info Tag Tag Class Component Class Component Type Component Family Renderer Type Renderer Class effect org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component org.component. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.EffectRenderer org.effect.primefaces.PrimeFaces Userʼs Guide 3.effect.32 Effect Effect component is based on the jQuery UI effects library.component.Effect org.component.primefaces. when set to false component will not be rendered.

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

duration and more.value}"> <p:effect type="scale" event="mouseover"> <f:param name="percent" value="90"/> </p:effect> </h:outputText> It’s important to provide string options with single quotes. please see the jquery documentation. provide these parameters with the f:param tag.jquery. <h:outputText value="#{bean. http://docs.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.PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors. In order to change the configuration of the animation.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. <h:outputText value="#{bean.action}" update="messages"/> 167 . Following example animates messages with pulsate effect after ajax request completes.

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

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

" /> </h:panelGrid> </p:fieldset> Legend Legend can be defined in two ways. this is handy to use space efficiently in a layout.jpg" /> <h:outputText value="Francis Ford Coppolas’ legendary . <p:fieldset legend="Simple Fieldset"> <h:panelGrid column="2"> <p:graphicImage value="/images/godfather/1...jpg" /> <h:outputText value="The story begins as Don Vito Corleone ." /> </h:panelGrid> </p:fieldset> 170 . Toggleable Content Clicking on fieldset legend can toggle contents. Set toggleable to true to enable this feature. facet is chosen.. <p:fieldset legend="Toggleable Fieldset" toggleable="true"> <h:panelGrid column="2"> <p:graphicImage value="/images/godfather/2.. 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. <p:fieldset> <f:facet name="legend"> </f:facet> //content </p:fieldset> When both legend attribute and legend facet are present. Use facet way if you need to place custom html other than simple text.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MarkerDragEvent Property marker Default null Type Marker Description Dragged marker instance org.model.primefaces.primefaces.map.map.faces.event.OverlaySelectEvent Property overlay Default null Type Overlay Description Selected overlay instance org.event.PrimeFaces Userʼs Guide org.map.primefaces.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.map.event.FacesEvent.map.event.event.LatLngBounds Property center northEast southWest Default null null null Type LatLng LatLng LatLng Description Center coordinate of the boundary NorthEast coordinate of the boundary SouthWest coordinate of the boundary GMap Event API All classes in event api extends from javax. org.primefaces.primefaces.

primefaces.40 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.GMapInfoWindowTag org. An el expression that maps to a server side UIComponent instance in a backing bean Maximum width of the info window binding maxWidth null null Object Integer Getting started with GMapInfoWindow See GMap section for more information about how gmapInfoWindow is used. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.component.gmap.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. 198 .GMapInfoWindow org.GMapInfoWindow org.primefaces.PrimeFaces Userʼs Guide 3.gmap.primefaces. when set to false component will not be rendered.component.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Getting started with Messages Message usage is exactly same as standard messages. 274 . Style Class ui-messages-{severity} ui-messages-{severity}-summary ui-messages-{severity}-detail ui-messages-{severity}-icon Applies Container element of the message Summary text Detail text Icon of the message. <p:messages /> AutoUpdate When auto update is enabled. ‘error’. messages component is updated with each ajax request automatically. ‘warn’ and error.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. Skinning Message Full list of CSS selectors of message is as follows. {severity} can be ‘info’.

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

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

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

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

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

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

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

282 .list}" /> Note that you won’t need an outputPanel if commandButton has no update attribute specified..> //columns </p:dataTable> </p:outputPanel> <p:commandButton update="out" actionListener="#{bean. • inline (default): Renders a span • block: Renders a div AutoUpdate When auto update is enabled.. Layout OutputPanel has two layout modes. <p:outputPanel id="out"> <p:dataTable id="tbl" rendered="#{bean.condition}" .condition}" . outputPanel component is updated with each ajax request automatically. 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..PrimeFaces Userʼs Guide <p:dataTable id="tbl" rendered="#{bean.> //columns </p:dataTable> <p:commandButton update="tbl" actionListener="#{bean. Skinning OutputPanel style and styleClass attributes are used to skin the outputPanel..

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

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

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

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

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

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

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

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

<p:panelGrid> <p:row> <p:column rowspan="3">AAA</p:column> <p:column colspan="4">BBB</p:column> </p:row> <p:row> <p:column colspan="2">CCC</p:column> <p:column colspan="2">DDD</p:column> </p:row> <p:row> <p:column>EEE</p:column> <p:column>FFF</p:column> <p:column>GGG</p:column> <p:column>HHH</p:column> </p:row> </p:panelGrid> Skinning PanelGrid PanelGrid resides in a main container which style and styleClass attributes apply. Style Class .ui-panelgrid-footer Applies Main container element of panelGrid. 291 . Header. see the main Skinning section for more information. Footer. As skinning style classes are global.PrimeFaces Userʼs Guide Rowspan and Colspan PanelGrid supports rowspan and colspan options as well.ui-panelgrid . in this case row and column markup should be defined manually. Following is the list of structural style classes.ui-panelgrid-header .

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

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

onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title null null null null null null null null null null null null FALSE null null null null null String String String String String String String String String String String String Boolean Integer String String Integer String 294 . Client side callback to execute when text within input element is selected by user. Inline style of the input element. Client side callback to execute when input element is clicked. Client side callback to execute when input element is double clicked. 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. Flag indicating that this component will prevent changes by the user. Style class of the 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 a key is released over input element. Position of the input element in the tabbing order. Advisory tooltip informaton. 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 pointer button is moved onto input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ring.primefaces. Name of the data iterator.82 Ring Ring is a data display component with a circular animation. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ring org.primefaces.component org.ring.primefaces.component.RingRenderer org. Collection to display.RingRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.component.PrimeFaces Userʼs Guide 3.component. Type of easing to use in animation.primefaces.Ring org. binding widgetVar value var style styleClass easing null null null null null null swing Object String Object String String String String 324 .Ring org. when set to false component will not be rendered.component.primefaces. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.selectbooleanbutton. An el expression or a literal text that defines a converter for the component.component.component org.PrimeFaces Userʼs Guide 3.SelectBooleanButtonRenderer org.primefaces. 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.primefaces.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.SelectBooleanButton org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectBooleanButton org.component. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuechangeevent binding value converter null null null Object Object Converter/ String immediate required validator valueChangeListener FALSE FALSE null null Boolean Boolean MethodExpr MethodExpr 341 . it’s resolved to a converter instance. when set to false component will not be rendered.selectbooleanbutton. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.89 SelectBooleanButton SelectBooleanButton is used to select a binary decision with a toggle button.primefaces.component.SelectBooleanButton org. When it’s an EL expression.primefaces.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Id of the input text that the slider will be used for Id of the component to display the slider value.component.component.component.primefaces.PrimeFaces Userʼs Guide 3.primefaces. display modes and skinning.Slider org. when set to false component will not be rendered. Fixed pixel increments that the slider move in Disables or enables the slider.slider.Slider org.101 Slider Slider is used to provide input with various customization options like orientation. Minimum value of the slider Maximum value of the slider Inline style of the container element Style class of the container element Boolean value to enable/disable the animated move when background of slider is clicked Sets the type of the slider.SliderRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.slider. "horizontal" or "vertical".SliderRenderer org. 369 binding for display minValue maxValue style styleClass animate type step disabled null null null 0 100 null null TRUE horizontal 1 FALSE Object String String Integer Integer String String Boolean String Integer Boolean .component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.primefaces.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

subtable.component. An el expression that maps to a server side UIComponent instance in a backing bean Data of the 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. when set to false component will not be rendered.107 SubTable SummaryRow is a helper component of datatable used for grouping. Name of the data iterator.SubTable org.component org.primefaces. 387 .component.primefaces.PrimeFaces Userʼs Guide 3.SubTable org. Getting started with SubTable See DataTable section for more information.subtable.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class subTable org.primefaces.primefaces.SubTableRenderer org.component.

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

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

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

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

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

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

widget.ui-tabs-nav . Following is the list of structural style classes. Class . 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. see the main Skinning section for more information.ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container 394 . 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.TabView.ui-tabs .PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.

111 TagCloud TagCloud displays a collection of tag with different strengths.model}" /> 395 .PrimeFaces Userʼs Guide 3.TagCloud org. Inline style of the container element.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tagCloud org.primefaces.component.TagCloudRenderer org.primefaces.tagcloud. Style class of the container element.component. 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.TagCloud org. <p:tagCloud model="#{timelineBean.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.primefaces.component.component org.component. Backing tag cloud model. 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.tagcloud.

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

Terminal org.primefaces.component.component.primefaces.Terminal org.PrimeFaces Userʼs Guide 3. Primary prompt text.terminal.component org.component.primefaces.terminal. when set to false component will not be rendered. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.TerminalRenderer org.component.TerminalRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF. 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 Name commandHandler widgetVar Default null null Type MethodExpr String Description Method to be called with arguments to process.term. else return command + " not found"."/> <p:dialog widgetVar="dlg" width="600" height="400" header="Terminal"> <p:terminal widgetVar="term" commandHandler="#{terminalBean. <p:terminal commandHandler="#{terminalBean. Getting started with the Terminal A command handler is necessary to interpret commands entered in terminal. use client side api.show(). following example shows how to add focus on a terminal nested inside a dialog. handleCommand method is invoked with the command name and the command arguments as a String array. Name of the client side widget.handleCommand}" width="590px" /> </p:dialog> 398 . } Whenever a command is sent to the server. String[] params) { if(command. Focus To add focus on terminal.toString().equals("date")) return new Date().handleCommand}" /> public class TerminalBean { } public String handleCommand(String command. <p:commandButton type="Show Terminal" type="button" onclick="dlg. else if(command.focus().equals("greet")) return "Hello " + params[0].

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

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

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

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

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

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

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

ui-tooltip as a style class and is styled with global skinning selectors.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 example is as follows. <h:outputLink id="lnk" value="#"> <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> <p:graphicImage value="/images/prime_logo. see main skinning section for more information. 406 .

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

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

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

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

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

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

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

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

primefaces. Collapsed icon of the node.primefaces. when set to false component will not be rendered.component Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.118 TreeNode TreeNode is used with Tree component to represent a node in tree. Info Tag Component Class Component Type Component Family treeNode org. Expanded icon of the node.PrimeFaces Userʼs Guide 3.component.UITreeNode org. 415 . 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.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.tree.primefaces.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful