USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

handleSelect" update="msg" /> </p:autoComplete> <p:messages id=”msg” /> 30 . //.completePlayer}" var="p" itemLabel="#{p. <p:autoComplete value="#{bean.text-align:center"> <p:graphicImage value="/images/barca/#{p.number} </p:column> </p:autoComplete> public class AutoCompleteBean { } private List<Player> selectedPlayers.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.selectedPlayers}" completeMethod="#{autoCompleteBean. you can enable instant ajax selection by using the itemSelect ajax behavior.photo}"/> </p:column> <p:column style="width:80%"> #{p. Example below demonstrates how to display a message about the selected item instantly. Following example demonstrates multiple selection with custom content support.complete}"> <p:ajax event="itemSelect" listener="bean.text}" completeMethod="#{bean..#{p. Ajax Behavior Events Instead of waiting for user to submit the form manually to process the selected item..name}" itemValue="#{p}" converter="player" multiple="true"> <p:column style="width:20%.name} . <p:autoComplete id="advanced" value="#{autoCompleteBean.

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

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

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

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

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

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

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

primefaces.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. Direction indication for text that does not inherit directionality. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class button org. (deprecated: use icon) 38 .component.Button org.component org.ButtonRenderer org. Whether to include page parameters in target URI Identifier of the target page which should be scrolled to.PrimeFaces Userʼs Guide 3. Used to resolve a navigation case.component.primefaces.button. Valid values are LTR and RTL. Access key that when pressed transfers focus to button.7 Button Button is an extension to the standard h:button component with skinning capabilities.component. Style class for the button icon.Button org. Alternate textual description.button.component.primefaces.primefaces.primefaces. Boolean value to specify the rendering of the component. Disables button. An el expression that maps to a server side UIComponent instance in a backing bean. Name of the client side widget. Value of the component than can be either an EL expression of a literal text.

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

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

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

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

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

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

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

date}" pages="3"/> 46 .date}" mode="popup" showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month. Valid values are.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. This feature is tuned with the pages attribute.

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

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

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

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

ui-datepicker-current . 51 . 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 .

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

model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .73.139.04.143. <p:ohlcChart value="#{bean.66.122. public Bean() { model = new OhlcChartModel().55.97)).123.model.139.addRecord(new ohlcModel.88.140.136. ohlcModel.124.9. public class Bean { private OhlcChartModel model.addRecord(new ohlcModel.56.68. OhlcChartSeries(2012.136.143.4)). OhlcChartSeries(2011.139.addRecord(new ohlcModel.chart.18.144.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.addRecord(new } //getter } OhlcChartSeries(2007.139.primefaces.57.138.135.144.48)).02)).134.82.addRecord(new ohlcModel.142.addRecord(new ohlcModel.76.79.31. OhlcChartSeries(2008. OhlcChartSeries(2010.5. OhlcChartSeries(2012.5)).135.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org. <p:ohlcChart value="#{bean.44)).OhlcChartModel instance.143.129.135.136.140.46. OhlcChartSeries(2009.67.135.81)).56.addRecord(new ohlcModel.121.01.124.7.132.53.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public CarBean() { sales = //create a list of BrandSale objects } public List<ManufacturerSale> getSales() { return this.sales..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. //columns </p:dataTable> 135 . <p:dataTable var="car" value="#{carBean.. } Scrolling Scrolling is a way to display data with fixed headers. in order to enable simple scrolling set scrollable option to true.

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

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

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

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

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

event.UnselectEvent org. When a row is being selected. datatable below makes an ajax request when a row is selected.primefaces.PageEvent org.primefaces.event. When a row is edited.primefaces.data. When header checkbox is toggled.ColumnResizeEvent On pagination.event.primefaces.FilterEvent org.event.data.SortEvent org.primefaces. Fired For example.event. When a column is being selected.model}"> <p:ajax event=”rowSelect” update=”another_component” /> //columns </p:dataTable> 141 .SelectEvent org.primefaces.primefaces.event.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.data. <p:dataTable var="car" value="#{carBean.RowEditEvent org. On filtering. Event page sort filter rowSelect rowUnselect rowEdit colResize toggleSelect colReorder Listener Parameter org. When a row is being unselected.event. When a column is sorted.

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

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

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

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

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

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

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

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

Draggable and Droppable.PrimeFaces Userʼs Guide 3.component org.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.29.primefaces. Id of the component to add draggable behavior Disables draggable behavior when true.component. valid values are ‘x’ and ‘y’.component.dnd.primefaces.Draggable org.primefaces.dnd.primefaces.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.component.Draggable org. Specifies drag axis. Specifies a draggable that can’t be dropped.component. 3. 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.DraggableRenderer org. 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 . when set to false component will not be rendered.primefaces.

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

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

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

Specifies the intersection mode to accept a draggable. when set to false component will not be rendered. Scope key to match draggables and droppables.component.dnd. Client side callback to execute when a draggable is dropped.DroppableRenderer org.primefaces.component.29. Style class to apply when an acceptable draggable is being dragged.PrimeFaces Userʼs Guide 3.primefaces.component org. Selector to define the accepted draggables.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org.component.Droppable org. Id of a UIData component to connect with.primefaces.dnd.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 .Droppable org.primefaces. 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.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.

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

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

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

only first image can be accepted by droppable.PrimeFaces Userʼs Guide Tolerance There are four different tolerance modes that define the way of accepting a draggable. Following example has two images. <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.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb.jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. 158 .

component. bottom or top. 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. Maximum width of items.component org. Distance to enlarge.component.dock.primefaces.DockRenderer org.component.Dock org. when set to false component will not be rendered.dock.30 Dock Dock component mimics the well known dock interface of Mac OS X. Name of the client side widget. Horizontal alignment.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. 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 .component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.primefaces.Dock org.primefaces.PrimeFaces Userʼs Guide 3.primefaces.primefaces. Initial width of items.

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

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

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

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

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

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

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

Following example animates messages with pulsate effect after ajax request completes.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. duration and more.action}" update="messages"/> 167 . <h:outputText value="#{bean.value}"> <p:effect type="blind" event="click"> <f:param name="direction" value="'horizontal'" /> </p:effect> </h:outputText> For the full list of configuration parameters for each effect.jquery.value}"> <p:effect type="scale" event="mouseover"> <f:param name="percent" value="90"/> </p:effect> </h:outputText> It’s important to provide string options with single quotes. http://docs. provide these parameters with the f:param tag. <p:messages id="messages"> <p:effect type="pulsate" event="load" delay=”500”> <f:param name="mode" value="'show'" /> </p:effect> </p:messages> <p:commandButton value="Save" actionListener="#{bean. <h:outputText value="#{bean. please see the jquery documentation.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Stroke weight of the rectangle.Rectangle extends org. Background color of the rectangle.Overlay Property bounds strokeColor strokeOpacity strokeWeight fillColor fillOpacity Default null null 1 1 null 1 Type LatLngBounds String Double Integer String Double Description Boundaries of the rectangle.primefaces. Background color of the circle.model.PrimeFaces Userʼs Guide Property strokeOpacity strokeWeight fillColor fillOpacity 1 1 Default Type Double Integer String Double Opacity of a line Weight of a line Description null 1 Background color of the polygon Opacity of the polygon org. Stroke color of the circle. Opacity of the circle.primefaces.model.primefaces.Circle extends org.LatLng Property lat lng Default null null Type double double Description Latitude of the coordinate Longitude of the coordinate 196 .map. org.model. Stroke weight of the circle. Stroke color of the rectangle.model. Description org.Overlay Property center radius strokeColor strokeOpacity strokeWeight fillColor fillOpacity Default null null null 1 1 null 1 Type LatLng Double String Double Integer String Double Center of the circle Radius of the circle.map.model. Stroke opacity of circle.map.primefaces. Opacity of the rectangle.primefaces.map.map. Stroke opacity of rectangle.

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

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

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

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

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

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

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

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

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

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

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

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

209 .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. Following form can be submitted with the ctrl+shift+s combination.name}" /> </h:panelGrid> <h:outputText id="dsplay" value="Hello: #{bean. <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.

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

Example below displays messages for each event. 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. 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 .idleListener}" update="msg" /> <p:ajax event="active" listener="#{bean.PrimeFaces Userʼs Guide Controlling Timeout By default. <p:idleMonitor timeout="5000" update="messages"> <p:ajax event="idle" listener="#{bean.

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding mask placeHolder value

null null null null

Object Integer String Object

225

PrimeFaces Userʼs Guide

Name converter

Default null

Type Converter/ String

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

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

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

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

onclick ondblclick

null null

String String

226

PrimeFaces Userʼs Guide

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

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

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

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

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

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

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

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

228

PrimeFaces Userʼs Guide

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

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

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

immediate required validator valueChangeListener requiredMessage

FALSE FALSE null null null

Boolean Boolean Method Expr Method Expr String

PrimeFaces Userʼs Guide

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

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

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

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

230

PrimeFaces Userʼs Guide

Name onmouseover onmouseup onselect readonly size style styleClass tabindex title type

Default null null null FALSE null null null null null text

Type String String String Boolean Integer String String Integer String String

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

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

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

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

231

PrimeFaces Userʼs Guide

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

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

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

immediate required validator

FALSE FALSE null

Boolean Boolean Method Expr

PrimeFaces Userʼs Guide

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

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

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

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

233

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

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

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

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

250 .primefaces.LogRenderer org.primefaces.primefaces.component.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. when set to false component will not be rendered.primefaces.log.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.PrimeFaces Userʼs Guide 3.Log org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.primefaces.component.56 Log Log component is a visual console to display logs on JSF pages.component.component org.log.

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

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

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

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

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

see the main Skinning section for more information. see the dynamic menus part in menu component section for more information and an example. Following is the list of structural style classes.ui-megamenu . <p:megaMenu> //submenus <p:menuitem label="Logout" action="#{bean.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. List container Each menu item Anchor element in a link item Text element in an item As skinning style classes are global.ui-menu-list . <p:column> <strong>Sopranos</strong> <p:graphicImage value="/images/sopranos/sopranos1. Style Class .jpg" width="200"/> </p:column> Root Menuitem MegaMenu supports menuitem as root menu options as well. Following example allows a root menubar item to execute an action to logout the user. 256 .ui-menuitem .ui-menuitem-text Applies Container element of menubar.ui-menuitem-link . Skinning MegaMenu resides in a main container which style and styleClass attributes apply.

Corner of menu to align with trigger element.component.menu.Menu org.component org. 257 . A menu model instance to create menu programmatically.PrimeFaces Userʼs Guide 3.Menu org.MenuRenderer Attributes Name id rendered binding widgetVar model trigger my Default null TRUE null null null null null Type String Boolean Object String MenuModel String String Description Unique identifier of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menu org.component.primefaces. ipod style sliding and overlays. Boolean value to specify the rendering of the component.primefaces.primefaces.component. Id of component whose click event will show the dynamic positioned menu.59 Menu Menu is a navigation component with various customized modes like multi tiers. 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.MenuRenderer org.component. Name of the client side widget.menu.primefaces.

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

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

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

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

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

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

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

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

when set to false component will not be rendered.component.menubutton.MenuButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.MenuButtonRenderer org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menuButton org.component.MenuButton org.primefaces.PrimeFaces Userʼs Guide 3. Boolean value to specify the rendering of the component.component org.component.menubutton.component. 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 .61 MenuButton MenuButton displays different commands in a popup menu.MenuButton org.primefaces. Label of the button Style of the main container element Style class of the main container element Name of the client side widget MenuModel instance to create menus programmatically Disables or enables the button.primefaces.primefaces.

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

el.component. An el expression that maps to a server side UIComponent instance in a backing bean. 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. when set to false component will not be rendered.el.component.MethodE xpression javax.component.PrimeFaces Userʼs Guide 3. 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. Info Tag Tag Class Component Class Component Type Component Family menuItem org. When true.menuitem.MenuItem org.primefaces. Url to be navigated when menuitem is clicked Target type of url navigation Style of the menuitem label StyleClass of the menuitem label Javascript event handler for click event When set to true.MenuItem org. ajax requests are not queued.primefaces.primefaces. action of this menuitem is processed after apply request phase.primefaces.62 MenuItem MenuItem is used by various menu components of PrimeFaces. Boolean value to specify the rendering of the component. Component id(s) to process partially instead of whole view.MenuItemTag org.MethodE xpression Boolean String String String String String Boolean String 268 .menuitem. Action to be invoked when menuitem is clicked.

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

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

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

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

component.primefaces.MessagesRenderer org.Messages org.MessagesRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component. only facesmessages with no clientIds are displayed. Specifies if the detail of the FacesMessages should be displayed.64 Messages Messages is a pre-skinned extended version of the standard JSF messages component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class messages org.component. when set to false component will not be rendered.primefaces. Specifies if the summary of the FacesMessages should be displayed. When true.component org.PrimeFaces Userʼs Guide 3.primefaces. Boolean value to specify the rendering of the component.primefaces.messages.messages.Messages org.component.primefaces. 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.component.

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

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

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

OrderListRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.OrderList org.component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class orderList org.primefaces.primefaces.orderlist.OrderListRenderer org.OrderList org.component.primefaces.PrimeFaces Userʼs Guide 3.primefaces.primefaces. binding value null null Object Object 277 .component org. transition effects and pojo support.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering.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.

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

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

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

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

in this case parent form will be updated partially implicitly making an outputPanel use obselete.. Layout OutputPanel has two layout modes..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.condition}" .. • inline (default): Renders a span • block: Renders a div AutoUpdate When auto update is enabled.condition}" .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. outputPanel component is updated with each ajax request automatically. 282 . <p:outputPanel id="out"> <p:dataTable id="tbl" rendered="#{bean.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RadioButton org.primefaces.RadioButton org.primefaces.component org. Style class of the container. when set to false component will not be rendered.radiobutton.78 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts. binding disabled itemIndex onchange for style styleClass null FALSE null null null null null Object Boolean Integer String String String String Getting started with RadioButton See custom layout part in SelectOneRadio section for more information.component.component.primefaces. Id of the selectOneRadio to attach to. Index of the selectItem of selectOneRadio. Client side callback to execute on state change.PrimeFaces Userʼs Guide 3.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.RadioButtonRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. 314 .RadioButtonRenderer org.primefaces. Inline style of the component. An el expression that maps to a server side UIComponent instance in a backing bean Disabled the component.component.component.radiobutton.

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

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

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

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

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

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

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

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

ne Proxy helper element for visual feedback Applies 323 . ui)" /> function handleStop(event. <h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" onStop="handleStop(event.ui-resizable-proxy Element that is resizable Handle element Particular handle element identified by handlekey like e.helper = helper element as a jQuery object //ui. int height = event. ui) { //ui.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.size = width height of current size } Skinning Style Class .ui-resizable-handle . onResize and onStop. s.ui-resizable-handle-{handlekey} . All of these callbacks receive two parameters that provide various information about resize event. left position before resizing //ui.originalSize = width.positon = top. onStart.getHeight().ui-resizable . height before resizing //ui. left after resizing //ui.getWidth().

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

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

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

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

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

rowexpansion.RowExpansion org. 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.RowExpansion org.primefaces.component. 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. 329 .85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows. Info Tag Component Class Component Type Component Family rowExpansion org.primefaces.PrimeFaces Userʼs Guide 3.component.

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

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

Specifies visibility of header content. higher the value shorter the height is The view type to use. Determines the time-text that will be displayed on each event. Content of right side of header.TimeZone instance to specify the timezone used for date conversion. 'agendaWeek'. 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. events are draggable. Content of left side of header. Determines the time-text that will be displayed on the vertical axis of the agenda views.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 . If ommitted. initialDate null Object showWeekends style styleClass draggable resizable showHeader leftHeaderTemplate centerHeaderTemplate rightHeaderTemplate TRUE null null TRUE TRUE TRUE prev. When true. Content of center of header. String or a java. Maximum time to display in a day view. First hour to display in day view. next today title month. agendaDay TRUE 30 6 null null null Boolean String String Boolean Boolean Boolean String String String allDaySlot slotMinutes firstHour minTime maxTime axisFormat Boolean Integer Integer String String String Determines if all-day slot will be displayed in agendaWeek or agendaDay views Interval in minutes in an hour to create a slot. 'agendaDay'. Minimum time to display in a day view. possible values are 'month'.util. agendaWeek. 'basicDay' The initial date that is used when schedule loads. events are resizable. 'basicWeek'.

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

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

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

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

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

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

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

ui-scrollpanel-container . Horizontal scrollbar. Vertical scrollbar.height:200px"> //any content </p:scrollPanel> Native ScrollBars By default. width and height must be defined. see the main Skinning section for more information. scrollPanel displays theme aware scrollbars. As skinning style classes are global. Handle of a scrollbar Applies 340 . setting mode option to native displays browser scrollbars. <p:scrollPanel style="width:250px. Style Class .ui-scrollpanel-vbar .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.ui-scrollpanel .ui-scrollpanel-handle Main container element.ui-scrollpanel-hbar . <p:scrollPanel style="width:250px. Following is the list of structural style classes. Overflow container.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 . Each item in the list. Style Class .ui-selectonemenu-items Main container. Label of the component. Skinning SelectOneMenu resides in a container element that style and styleClass attributes apply.ui-selectonemenu-trigger . Items list.ui-selectonemenu-items . Following is the list of structural style classes. Set editable option to true to use this feature. As skinning style classes are global. Applies 360 . Container of dropdown icon. see the main Skinning section for more information.

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

Callback to execute on value change. Disables the component. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). 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. Message to be displayed when validation fields. 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. Layout of the checkboxes. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. <p:selectOneRadio id="customRadio" value="#{formBean. 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 . selectOneRadio itself does not render any output. User presentable name. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. Inline style of the component.

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

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

height:20px" /> Special Separators Separator can be used inside other components such as menu and toolbar as well. <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. 365 .PrimeFaces Userʼs Guide Dimensions Separator renders a <hr /> tag which style and styleClass options apply. Class . Following is the list of structural style classes. style and styleClass options can be used to style the separator.ui-separator Separator element Applies As skinning style classes are global. see the main Skinning section for more information.

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

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

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

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

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

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

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

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

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

primefaces.primefaces. 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.Spinner org.SpinnerRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component. valueChange Events are fired in "process validations" phase Marks component as required A method binding expression that refers to a method validationg the input immediate FALSE Boolean required validator FALSE null Boolean Method Expr 375 .component.component. when set to false component will not be rendered.SpinnerRenderer org.component.primefaces.Spinner org. when true the events will be fired at "apply request values".spinner.primefaces.spinner.component.component org.PrimeFaces Userʼs Guide 3.103 Spinner Spinner is an input component to provide a numerical input via increment and decrement buttons. 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. In case it’s a static text. it’s resolved to a converter instance.primefaces. if immediate is set to false.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces.component.Terminal org.component.primefaces.TerminalRenderer org.terminal.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.primefaces.component.Terminal org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.PrimeFaces Userʼs Guide 3. 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.terminal.TerminalRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org.component. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load. Primary prompt text.

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

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

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

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

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

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

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

so following is same.password}" /> <p:tooltip for="pwd" value="Only numbers"/> <h:inputSecret id="pwd" value="#{myBean. Getting started with the Tooltip Tooltip is used by attaching it to a target component. <h:inputSecret id="pwd" value="#{myBean. Inline style of the tooltip. If you need to change this behaviour use the showEvent and hideEvent feature. Style class of the tooltip. • • • • • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate scale shake size slide 405 . Tooltip below is displayed when the input gets the focus and hidden with onblur.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. Tooltip value can also be retrieved from target’s title.PrimeFaces Userʼs Guide Name for style styleClass Default null null null Type String String String Description Id of the component to attach the tooltip. <h:inputSecret id="pwd" value="#{myBean.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 Html Content Another powerful feature of tooltip is the ability to display custom content as a tooltip not just plain texts. see main skinning section for more information. An example is as follows. 406 .png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only .ui-tooltip as a style class and is styled with global skinning selectors. <h:outputLink id="lnk" value="#"> <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> <p:graphicImage value="/images/prime_logo.

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

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

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

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

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

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

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

Style Class .ui-tree-node-content .ui-tree-node .ui-tree-nodes . see the main Skinning section for more information. you can even match different context menus with different tree nodes using nodeType option of context menu that matches the tree node type. Skinning Tree resides in a container element which style and styleClass options apply.ui-tree-icon . Following is the list of structural style classes.ui-tree . 414 .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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. ROLE_READER’)}" /> <p:commandButton rendered="#{p:ifAnyGranted(‘ROLE_ADMIN.

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful