USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. 49 . 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.date}" pattern=”MM/dd/yyyy HH:mm” /> Advanced Customization Use beforeShowDay javascript callback to customize the look of each date. <p:calendar value="#{dateBean.

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

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

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

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

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

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

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

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

jpg"/> </p:carousel> Content Display Another use case of carousel is tab based content display.jpg"/> <p:graphicImage value="/images/nature2.." /> </h:panelGrid> </p:tab> </p:carousel> 58 .jpg"/> <p:graphicImage value="/images/nature3."> <p:tab title="Godfather Part I"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather1.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 III"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather3. <p:carousel autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” > <p:graphicImage value="/images/nature1.jpg"/> <p:graphicImage value="/images/nature4.jpg" /> <h:outputText value="After a break of .width:600px.jpg" /> <h:outputText value="The story begins as Don Vito . <p:carousel rows="1" itemStyle="height:200px..jpg" /> <h:outputText value="Francis Ford Coppola's .. Following carousel displays a collection of images as a slideshow..." /> </h:panelGrid> </p:tab> <p:tab title="Godfather Part II"> <h:panelGrid columns="2" cellpadding="10"> <p:graphicImage value="/images/godfather/godfather2.. for this purpose autoPlayInterval and circular attributes are used.

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

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

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

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

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

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

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

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

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

component.bar.chart.12. Minimum boundary value.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org. Enables stacked display 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.primefaces. Margin of bars. Padding of bars.primefaces. valid values are “vertical” and “horizontal”.3 Bar Chart Bar chart visualizes one or more series of data using bars.bar.BarChart org.component org.PrimeFaces Userʼs Guide 3. Orientation of bars. 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 .BarChart org.component. when set to false component will not be rendered An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. Position of the legend.component. Style class of the chart.component.chart.BarChartRenderer org. Title of the chart. Maximum boundary value.chart.primefaces.primefaces.primefaces.

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

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

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

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

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

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

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

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

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

4)).143.81)).55.addRecord(new ohlcModel.139.82.44)).addRecord(new ohlcModel.135.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.76.addRecord(new ohlcModel.01.135. OhlcChartSeries(2012.31.139.136.18. <p:ohlcChart value="#{bean.5. OhlcChartSeries(2008.143.02)). OhlcChartSeries(2009.124.144.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .132.121.7.53.124.46.56.136.primefaces.135.chart.142.140. public Bean() { model = new OhlcChartModel().model.56. ohlcModel.OhlcChartModel instance.addRecord(new ohlcModel.134.9.66.123.addRecord(new ohlcModel.67.138.144.addRecord(new ohlcModel. <p:ohlcChart value="#{bean.48)). OhlcChartSeries(2011.88.136.73.04.135.129.122.139.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org. OhlcChartSeries(2012. public class Bean { private OhlcChartModel model.140.143.addRecord(new } //getter } OhlcChartSeries(2007.139.5)).79.68.97)). OhlcChartSeries(2010.57.

primefaces.component.MeterGaugeChartRenderer org. Number of pixels to offset the label up and down.primefaces.7 MeterGauge Chart MeterGauge chart visualizes data on a meter gauge display.chart. Comma separated list of colors in hex format.12. Radius of the outer circle of the internal ring. Style class of the chart.PrimeFaces Userʼs Guide 3.component. binding widgetVar value style styleClass title legendPosition seriesColors enhancedLegend showTickLabels labelHeightAdjust intervalOuterRadius null null null null null null null null TRUE TRUE -25 85 Object String ChartModel String String String String String Boolean Boolean Integer Integer 79 .MeterGauge org.component. Specifies interactive legend.chart. when set to false component will not be rendered.metergauge. Title of the chart.MeterGaugeChart org. Position of the legend.primefaces.primefaces.component. 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 org. Displays ticks around gauge.chart.primefaces.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class meterGaugeChart org.metergauge.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.

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

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

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

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

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

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

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

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

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

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

Maximum number of characters for an input filter. see documentation of components that use a column. 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. for example filterBy is only used by datatable whereas sortBy is used by datatable and sheet. Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option. 90 . not all attributes of column are implemented by the components that use column. Note As column is a reused component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Getting started with the DataTable We will be using the same Car and CarBean classes described in DataGrid section.color}" /> </p:column> </p:dataTable> Header and Footer Both datatable itself and columns can have headers and footers. <p:dataTable var="car" value="#{carBean.model}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Year" /> </f:facet> <h:outputText value="#{car.cars}"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car. 127 . 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.year}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Manufacturer" /> </f:facet> <h:outputText value="#{car.manufacturer}" /> </p:column> <p:column> <f:facet name="header"> <h:outputText value="Color" /> </f:facet> <h:outputText value="#{car.

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

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

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

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

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

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

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

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

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

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

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

model} </p:column> <p:column headerText="Year" sortBy="#{car.randomPrice}$ </p:column> </p:summaryRow> </p:dataTable> 139 .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.year}"> #{car.manufacturer}" sortOrder="descending"> <p:column headerText="Model" sortBy="#{car.manufacturer}"> #{car.model}"> #{car.cars}" sortBy="#{car.color}"> #{car.year} </p:column> <p:column headerText="Manufacturer" sortBy="#{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.

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

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

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

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

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

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

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

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

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

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

3.primefaces. Constraints dragging within the boundaries of containment element Helper element to display when dragging Reverts draggable to it’s original position when not dropped onto a valid droppable Draggable will snap to edge of near elements binding widgetVar proxy dragOnly for disabled axis containment helper revert snap null null FALSE FALSE null FALSE null null null FALSE FALSE Object String Boolean Boolean String Boolean String String String Boolean Boolean 150 .primefaces. valid values are ‘x’ and ‘y’.dnd. Id of the component to add draggable behavior Disables draggable behavior when true. 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.dnd.PrimeFaces Userʼs Guide 3.component.DraggableRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Specifies drag axis. when set to false component will not be rendered. Specifies a draggable that can’t be dropped.component.1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org.Draggable org.component org. Draggable and Droppable.component.DraggableRenderer org.Draggable org.component.29.primefaces.primefaces.29 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-fieldset-legend . 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.PrimeFaces Userʼs Guide Style Class .ui-fieldset-toggler Applies Legend of fieldset when fieldset is toggleable Toggle icon on fieldset As skinning style classes are global. 172 .ui-fieldset-toggleable . see the main Skinning section for more information.ui-fieldset .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

Speed of the effect.primefaces. Effect to be used when toggling.inplace.primefaces.component. Prevents hidden content to be shown.component. 221 binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor null null null null fade normal FALSE null null FALSE Object String String String String String Boolean String String Boolean . 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. Label to be shown in display mode when value is empty. Style class of the main container element.primefaces. Inline style of the main container element.InplaceRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3. Label to be shown in display mode.component org.Inplace org. display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.InplaceRenderer org.component.Inplace org.48 Inplace Inplace provides easy inplace editing and inline content display.primefaces. Inplace consists of two members. when set to false component will not be rendered.primefaces.component.inplace. Specifies the editor mode.

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

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

Cancel button. Save button.ui-inplace-save . Editor controls container. Triggers an ajax request to revert inplace input.ui-inplace-content .ui-inplace-disabled . As skinning style classes are global. Style Class .ui-inplace . Skinning Inplace resides in a main container element which style and styleClass options apply. Following is the list of structural style classes. 224 . Inline content. Main container element when disabled.ui-inplace-editor . Triggers an ajax request to process inplace input.ui-inplace-cancel Applies Main container element.ui-inplace-display . 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. see the main Skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. 281 .primefaces. 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.67 OutputPanel OutputPanel is a panel component with the ability to auto update. 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. When a JSF component is not rendered. the markup on page cannot be updated since it doesn’t exist.OutputPanel org.primefaces.primefaces.component.OutputPanel org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class outputPanel 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 Style of the html container element StyleClass of the html container element Layout of the panel.component.PrimeFaces Userʼs Guide 3.outputpanel. The problem is although partial output is generated. OutputPanel is useful in this case.primefaces. binding style styleClass layout autoUpdate null null null inline FALSE Object String String String Boolean AjaxRendered Due to the nature of ajax.output.component. Enables auto update mode if set true. valid values are inline(span) or block(div).OutputPanelRenderer org.primefaces.component org.component. it is much simpler to update an existing element on page rather than inserting a new element to the dom.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.primefaces. 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 .behavior.PrimeFaces Userʼs Guide 3.Printer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Behavior Class printer org. Examples below demonstrates how to print a simple output text or a particular image on page. not the whole page.75 Printer Printer allows sending a specific JSF component to the printer. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Id of the component to print. <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.progressbar. in ajax mode progress value is retrieved from a backing bean.component org.primefaces.primefaces.PrimeFaces Userʼs Guide 3.progressbar. when set to false component will not be rendered.ProgressBarRenderer org.component.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.primefaces.component.primefaces. 309 binding widgetVar value disabled ajax interval null null 0 FALSE FALSE 3000 Object String Integer Boolean Boolean Integer . 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.Progressbar org.76 ProgressBar ProgressBar is a process status indicator that can either work purely on client side or interact with server side using ajax.primefaces. Interval in seconds to do periodic requests in ajax mode.

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

progress}" ajax="true"> <p:ajax event="complete" listener="#{progressBean.handleComplete}" update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces. public void handleComplete() { //Add a faces message } //getter-setter <p:progressBar value="#{progressBean. Example below demonstrates how to use this event.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. use the interval attribute.widget. <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. 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 .

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

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

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

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

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

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

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

setting global to false will not trigger ajaxStatus. actionListener is processed and output text is updated.increment}" out="count" /> <h:outputText id="count" value="#{counter. a remote call will be made. Passing Parameters Remote command can send dynamic parameters in the following way. <p:remoteCommand name="increment" actionListener="#{counter. 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.count}" /> <script type="text/javascript"> function customfunction() { //your custom code } </script> increment(). increment({param1:’val1’. //makes a remote call That’s it whenever you execute your custom javascript function(eg customfunction()). Run on Load If you’d like to run the command on page load. 319 . param2:’val2’}). When enabled command is executed on page load. Getting started with RemoteCommand RemoteCommand is used by invoking the command from your javascript code. Note that remoteCommand must be nested inside a form.

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

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

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

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

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

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

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

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

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

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

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

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

Minimum time to display in a day view. Content of right side of header.TimeZone instance to specify the timezone used for date conversion. When true. next today title month. 'basicWeek'. events are resizable.PrimeFaces Userʼs Guide Name aspectRatio view Default null month Type Float String Description Ratio of calendar width to height. 'basicDay' The initial date that is used when schedule loads. events are draggable. Determines the time-text that will be displayed on each event. If ommitted. Specifies visibility of header content. Maximum time to display in a day view. First hour to display in day view. Content of left side of header. initialDate null Object showWeekends style styleClass draggable resizable showHeader leftHeaderTemplate centerHeaderTemplate rightHeaderTemplate TRUE null null TRUE TRUE TRUE prev. agendaDay TRUE 30 6 null null null Boolean String String Boolean Boolean Boolean String String String allDaySlot slotMinutes firstHour minTime maxTime axisFormat Boolean Integer Integer String String String Determines if all-day slot will be displayed in agendaWeek or agendaDay views Interval in minutes in an hour to create a slot. 'agendaWeek'. agendaWeek.util. 'agendaDay'. timeFormat timeZone null null String Object 332 . possible values are 'month'. the schedule starts on the current date Specifies inclusion Saturday/Sunday columns in any of the views Style of the main container element of schedule Style class of the main container element of schedule When true. Determines the time-text that will be displayed on the vertical axis of the agenda views. Content of center of header. String or a java. higher the value shorter the height is The view type to use.

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

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

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

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

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

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

component. Scrollbar display mode.primefaces.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.component.primefaces. Style class of the container element. 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 Inline style of the container element.ScrollPanel org.88 ScrollPanel ScrollPanel is used to display overflowed content with theme aware scrollbars instead of native browsers scrollbars. binding style styleClass mode null null null default Object String String String 339 .ScrollPanelRenderer org.component org.scrollpanel.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class scrollPanel org.component.scrollpanel.ScrollPanel org.PrimeFaces Userʼs Guide 3. valid values are default and native.

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

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

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

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

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

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

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

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

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

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

ui-selectmanycheckbox . Message to be displayed when conversion fails. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Container of checkbox icon. Layout of the checkboxes. Inline style of the component. Style class of the container. onchange style styleClass null null null String String String Getting started with SelectManyCheckbox SelectManyCheckbox usage is same as the standard one. Container of a checkbox.ui-chkbox-box . Name of the client side widget. User presentable name. Message to be displayed when validation fields. Callback to execute on value change.PrimeFaces Userʼs Guide Name requiredMessage converterMessage validatorMessage widgetVar disabled label layout Default null null null null FALSE null lineDirection Type String String String String Boolean String String Description Message to be displayed when required field validation fails. Following is the list of structural style classes. Style Class . Disables the component. Checkbox icon.ui-chkbox . Skinning SelectManyCheckbox resides in a main container which style and styleClass attributes apply. As skinning style classes are global.ui-chkbox-icon Main container element. see the main Skinning section for more information. Applies 350 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

onSlide and onSlideEnd. public int getNumber() { return number. Example below adds a message and displays it using growl component when slide ends.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. All of these callbacks receive two parameters. ui)"/> function handleSlideEnd(event. <h:inputText id="number" value="#{sliderBean. <h:inputText id="number" value="#{sliderBean.event. slide event and the ui object containing information about the event.number}" /> <p:slider for="number"> <p:ajax event="slideEnd" listener="#{sliderBean. } public void setNumber(int number) { this.helper = Handle element of slider //ui.number}" /> <p:slider for="number" onSlideEnd="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.getValue(). ui) { //ui.primefaces. //add faces message } 372 . If you have a listener defined.number = number.SlideEndEvent instance. it will be called by passing org.

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

component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spacer org. when set to false component will not be rendered.spacer.spacer.102 Spacer Spacer is used to put spaces between elements. Width of the space.component 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.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. 374 . Height of the space.component. Style class of the spacer.primefaces.Spacer org.component.SpacerRenderer org.PrimeFaces Userʼs Guide 3.primefaces. Inline style of the spacer.Spacer org.component.primefaces. 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.

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

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

Advisory tooltip informaton. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when a pointer button is moved onto input element. public class SpinnerBean { } private int number. Getting Started with Spinner Spinner is an input component and used just like a standard input text.number}" /> 377 . Flag indicating that this component will prevent changes by the user.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. Position of the input element in the tabbing order. Style class of the input element. Number of characters used to determine the width of the input element. //getter and setter <p:spinner value="#{spinnerBean. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Inline style of the input element. Client side callback to execute when a key is released over input element. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.primefaces.component org. when set to false component will not be rendered.primefaces.Terminal org. Primary prompt text.Terminal org.component.primefaces.component.terminal.primefaces. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .component.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.component.PrimeFaces Userʼs Guide 3.TerminalRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.primefaces.terminal.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.html 441 . 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.PrimeFaces Userʼs Guide 8.org/themes. http://www.

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

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

ui-widget-header .ui-widget-header also that defines the panel colors also applies to the panel header. dimensions and positioning.ui-state-default . PrimeFaces separates structural css from skinning css. 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-widget-content . 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. Highlighted elements. An element to represent an icon. Selector . mostly they only define colors.ui-state-active .ui-state-disabled .3 How Themes Work Powered by ThemeRoller. padding. to change the color of a panel header you don’t need to about this class as . Skinning CSS Skinning defines the look and feel properties like colors. display type. 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. most important of these are. 444 . border colors. background images.PrimeFaces Userʼs Guide 8.ui-state-highlight .ui-widget .ui-state-hover .ui-panel-titlebar structural class.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful