USER’S GUIDE 3.

2

Author
Çağatay Çivici

PrimeFaces Userʼs Guide

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

Çağatay Çivici

2

PrimeFaces Userʼs Guide

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

11 12
12 12

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

13
13 14 14 14

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

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

PrimeFaces Userʼs Guide

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

71 74 77 79 81 82 83

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

PrimeFaces Userʼs Guide

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

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

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

427
427
427 427 429 430

4.2 Partial Processing!
4.2.1 Partial Validation!
8

431
431

PrimeFaces Userʼs Guide

4.2.2 Keywords! 4.2.3 Using Ids!

432 432

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

433 434
434 435 435 435
435 436

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

438
438 439

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

441
442 443 444 445

9. Utilities!
9.1 RequestContext! 9.2 EL Functions!

446
446 449

10. Portlets!
10.1 Dependencies! 10.2 Configuration!
9

451
451 452

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-autocomplete .ui-autocomplete-panel . Container of suggestions list.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-query Container element. Class . List of items Each item in the list. Applies As skinning style classes are global.ui-autocomplete-input . Input field.ui-autocomplete-items . Tips • Do not forget to use a converter when working with pojos. 32 . Highlighted part in suggestions. see the main Skinning section for more information.ui-autocomplete-item . • Increase query delay to avoid unnecessary load to server as a result of user typing fast.

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

PrimeFaces Userʼs Guide Name trigger block Default null null Type String String Description Identifier of the component(s) to bind.gif"/> </p:blockUI> 34 . Identifier of the component to block. ajax requests whose source is trigger components will block the ui onstart and unblock oncomplete. <p:blockUI block="pnl" trigger="saveBtn.cars}" paginator="true" rows="10"> <p:column> <f:facet name="header"> <h:outputText value="Model" /> </f:facet> <h:outputText value="#{car. Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received. <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. With the special ajax integration. <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.deleteBtn. 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.

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

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

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

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

Client side callback to execute when a key is pressed down over button. Client side callback to execute when button is double clicked. Client side callback to execute when button receives focus. Client side callback to execute when button is clicked. Advisory tooltip informaton. Position in the tabbing order. 39 . Client side callback to execute when a pointer button is moved onto button. Makes button read only. 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. Resource to link directly to implement anchor behavior. Client side callback to execute when a key is pressed and released over button. Icon of the button. Client side callback to execute when button loses focus. Client side callback to execute when a pointer button is pressed down over button. Position of the button icon. Style class of the button. Client side callback to execute when a pointer button is moved within button Client side callback to execute when a pointer button is moved away from button. Client side callback to execute when button loses focus and its value has been modified since gaining focus. Inline style of the button. Client side callback to execute when a pointer button is released over button.

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

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

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

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

Client side callback to execute when input element receives focus. 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 key is pressed down 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 input element is clicked. 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 . Advisory tooltip informaton. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when a key is pressed and released over input element. Flag indicating that this component will prevent changes by the user. Client side callback to execute before displaying a date. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a key is released over input element. Position of the input element in the tabbing order. used to customize date display. Number of characters used to determine the width of the input element. Client side callback to execute when input element is double clicked.

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

date}" mode="popup" showOn="button" /> Popup Icon Only <p:calendar value="#{dateBean.date}" mode="popup" showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month. <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. • focus: When input field receives focus • button: When popup button is clicked • both: Both focus and button cases Popup Button <p:calendar value="#{dateBean.date}" pages="3"/> 46 . Valid values are.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

140.44)).addRecord(new ohlcModel.7.122.97)). OhlcChartSeries(2010.02)). OhlcChartSeries(2008. public Bean() { model = new OhlcChartModel().5.135.OhlcChartModel instance.144.addRecord(new ohlcModel.5)). OhlcChartSeries(2012.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.143.134.04. <p:ohlcChart value="#{bean.addRecord(new ohlcModel.addRecord(new ohlcModel.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well. OhlcChartSeries(2012.79.67.addRecord(new ohlcModel.139.73.82.46.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .66.139.48)).124.addRecord(new ohlcModel.81)).68.121.123.139.addRecord(new } //getter } OhlcChartSeries(2007.135.144.model.53. OhlcChartSeries(2009.9.88. ohlcModel.136.135.55.136.01.142.56.140. public class Bean { private OhlcChartModel model. OhlcChartSeries(2011.136. <p:ohlcChart value="#{bean.31.143.124.56.129.139.4)).57.chart.135.138.18.132.primefaces.143.76.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Text to be displayed in body. when set to false component will not be rendered. 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. Skinning.ConfirmDialog org.confirmdialog. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. Width of the dialog in pixels Width of the dialog in pixels Inline style of the dialog container.PrimeFaces Userʼs Guide 3. Text for the header.20 ConfirmDialog ConfirmDialog is a replacement to the legacy javascript confirmation box.primefaces. 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 .component 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.ConfirmDialog org.component.component.primefaces.primefaces.component.primefaces. Message severity for the displayed icon.confirmdialog.component.

. You can call these functions to display a confirmation from any component like commandButton.hide()"/> <p:commandButton value="Not Yet" onclick="confirmation. either via message option or message facet. menuitem and more.destroyWorld}" update="messages" oncomplete="confirmation. show() and hide() functions are used to display and close the dialog respectively. Whether to display confirm dialog on load. Getting started with ConfirmDialog ConfirmDialog has a simple client side api. commandLink. <p:confirmDialog widgetVar="cd" header=”Confirm”> <f:facet name="message"> <h:outputText value="Are you sure?" /> </f:facet> //.PrimeFaces Userʼs Guide Name styleClass closable appendToBody visible Default null TRUE FALSE FALSE Type String Boolean Boolean Boolean Description Style class of the dialog container Defines if close icon should be displayed or not Appends dialog as a child of document body. Note that header can also be defined using the header attribute or the header facet. Message facet is useful if you need to place custom content instead of simple text. </p:confirmDialog> Severity Severity defines the icon to display next to the message. <h:form> <p:commandButton type="button" onclick="cd.hide()." type="button" /> </p:confirmDialog> </h:form> Message Message can be defined in two ways.show()" /> <p:confirmDialog message="Are you sure about destroying the world?" header="Initiating destroy process" severity="alert" widgetVar="cd"> <p:commandButton value="Yes Sure" actionListener="#{buttonBean. 102 . default severity is alert and the other option is info..

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

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

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

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

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

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

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

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

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

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

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

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

component. when set to false component will not be rendered. 115 .primefaces.DataGrid org.datagrid.PrimeFaces Userʼs Guide 3.DataGridRenderer org.component org.component.primefaces.primefaces.primefaces.primefaces.DataGrid org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataGrid org.DataGridRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.24 DataGrid DataGrid displays a collection of data in a grid layout.component.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. Enables pagination. String model. Inline style of the datagrid. Name of the request-scoped variable used to refer each data. Template of the rowsPerPage dropdown. datalist and datatable examples. Template of the paginator. Style class of the datagrid. 116 . Number of rows to display per page. int year. Maximum number of page links to display. Name of the iterator to refer each row index. style styleClass rowIndexVar null null null String String String Getting started with the DataGrid A list of cars will be used throughout the datagrid. Template of the currentPageReport UI.. Number of columns in grid. Defines if paginator should be hidden if total data count is less than number of rows per page. String color. String manufacturer. Index of the first row to be displayed Name of the client side widget. public class Car { } private private private private . Position of the paginator..

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

lastYearTotal}$" /> <p:column footerText="#{tableBean.lastYearProfit}% </p:column> <p:column> #{sale.lastYearSale}$ </p:column> <p:column> #{sale.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.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.thisYearSale}$ </p:column> <p:columnGroup type="footer"> <p:row> <p:column colspan="3" style="text-align:right" footerText="Totals:"/> <p:column footerText="#{tableBean.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Saves html text in iframe back to the textarea.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. • • • • • • • • • • • • • • • • 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.Editor Method init() saveHTML() clear() Params Return Type void void void 163 Description Initializes a lazy editor. Clears the text in editor.text}" controls="bold italic underline strikethrough" /> Here is the full list of all available controls.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.Focus.focus..primefaces.Focus org..FocusRenderer org.primefaces. Minimum severity level to be used when finding the first invalid component binding for context minSeverity null null null error Object String String String Getting started with Focus By default focus will find the first enabled and visible input component on page and apply focus. /> <h:inputText .. 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org. Input component can be any element such as input.component org.PrimeFaces Userʼs Guide 3.primefaces.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..component. textarea and select.focus.FocusTag org.37 Focus Focus is a utility component that makes it easy to manage the element focus on a JSF page.component. /> <h:selectOneMenu ..component. when set to false component will not be rendered. /> 182 .component.primefaces. <p:focus /> <p:inputText .

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.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.Marker extends org.map.model.primefaces.map.PrimeFaces Userʼs Guide org.primefaces.model.primefaces.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.Polygon extends org.model.primefaces.Polyline extends org.map.primefaces.map.map.model. shadow image is not displayed Defines visibility of the marker org.map.model.model.map. generated and used internally Data represented in marker Z-Index of the overlay org.Overlay Property id data zindex Default null null null Type String Object Integer Description Id of the overlay.model.

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

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

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

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

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

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

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

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

primefaces.component.component org.growl.primefaces.primefaces.Growl org.component.GrowlRenderer org.GrowlRenderer Attributes Name id rendered null TRUE Default Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.growl. 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. Specifies if the detail of message should be displayed. only facesmessages without clientids are displayed.42 Growl Growl is based on the Mac’s growl notification widget and used to display FacesMessages in an overlay. Duration in milliseconds to display non-sticky messages. Specifies auto update mode. 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class growl org.primefaces. When true.primefaces. Specifies if the summary of message should be displayed.PrimeFaces Userʼs Guide 3.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

‘warn’ and error.PrimeFaces Userʼs Guide Name redisplay autoUpdate Default TRUE FALSE Type Boolean Boolean Description Defines if already rendered messages should be displayed Enables auto update mode if set true. 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. 274 . <p:messages /> AutoUpdate When auto update is enabled. messages component is updated with each ajax request automatically. {severity} can be ‘info’. ‘error’. Getting started with Messages Message usage is exactly same as standard messages. Skinning Message Full list of CSS selectors of message is as follows.

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

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

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

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

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

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

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

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

component org.primefaces. binding widgetVar style styleClass for null null null null null Object String String String String 283 .component.primefaces.overlaypanel.68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content.component.component. Style class of the panel. Inline style of the panel.primefaces.OverlayPanelRenderer org. Identifier of the target component to attach the panel.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. 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 overlayPanel org.PrimeFaces Userʼs Guide 3.component.primefaces.OverlayPanel org.primefaces. when set to false component will not be rendered.overlaypanel.OverlayPanelRenderer org.

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

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

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

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

ui-panel-title . 288 . Style Class .. <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. an icon to display the menu is placed at top-right corner. <f:facet name="options"> <p:menu> //Menuitems </p:menu> </f:facet> </p:panel> Skinning Panel Panel resides in a main container which style and styleClass attributes apply.ui-panel-titlebar-icon . This feature is enabled by defining a menu component and defining it as the options facet.ui-panel . see the main Skinning section for more information.ui-panel-footer Applies Main container element of panel Header container Header text Option icon in header Panel content Panel footer As skinning style classes are global.ui-panel-titlebar . Following is the list of structural style classes..ui-panel-content .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Callback to execute on value change. Skinning SelectOneButton resides in a main container which style and styleClass attributes apply. Style class of the container. Message to be displayed when validation fields. As skinning style classes are global. Message to be displayed when conversion fails. Getting started with SelectOneButton SelectOneButton usage is same as selectOneRadio component. Style Class . Disables the component.ui-selectonebutton Main container element. buttons just replace the radios.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. Applies 354 . Name of the client side widget. User presentable name. see the main Skinning section for more information. Following is the list of structural style classes. Inline style of 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 .component.component org.component. In case it’s a static text.SelectOneListbox org. when set to false component will not be rendered. process validations logic is executed at apply request values phase for this component.selectonelistbox.PrimeFaces Userʼs Guide 3.SelectOneListbox org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.SelectOneListboxRenderer org.component.primefaces. An el expression or a literal text that defines a converter for the component.primefaces.component. When it’s an EL expression.primefaces.primefaces. it’s resolved to a converter instance.primefaces.SelectOneListBoxRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org. it must refer to a converter id When set true.96 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox with theme integration.selectonelistbox.

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

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

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

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

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

SelectOneRadio org.PrimeFaces Userʼs Guide 3.SelectOneRadioRenderer org.SelectOneRadio 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.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org.98 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.SelectOneRadioRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression or a literal text that defines a converter for the component. when set to false component will not be rendered.selectoneradio. In case it’s a static text.selectoneradio.primefaces.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.primefaces. 361 binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator valueChangeListener requiredMessage FALSE null null null Boolean MethodExpr MethodExpr String .primefaces. it must refer to a converter id When set true.component org.component.component.primefaces.component. When it’s an EL expression. it’s resolved to a converter instance.

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

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

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

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

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

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

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

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

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

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

All of these callbacks receive two parameters. ui) { //ui. onSlide and onSlideEnd. public int getNumber() { return number. slide event and the ui object containing information about the event. } public void onSlideEnd(SlideEndEvent event) { int value = event.number}" /> <p:slider for="number" onSlideEnd="handleSlideEnd(event. onSlideStart. //add faces message } 372 . <h:inputText id="number" value="#{sliderBean.getValue(). } public void setNumber(int number) { this. <h:inputText id="number" value="#{sliderBean. If you have a listener defined.primefaces.onSlideEnd}" update="msgs" /> </p:slider> <p:messages id="msgs" /> public class SliderBean { } private int number.number}" /> <p:slider for="number"> <p:ajax event="slideEnd" listener="#{sliderBean.number = number. ui)"/> function handleSlideEnd(event.value = Current value of slider } Ajax Behavior Events Slider provides one ajax behavior event called slideEnd that is fired when the slide completes. it will be called by passing org.event.SlideEndEvent instance.helper = Handle element of slider //ui. 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.

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

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

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

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

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

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.25"/> public class SpinnerBean { } private double number. Following example uses a stepFactor 0. For decimals use the stepFactor attribute to specify stepping amount.PrimeFaces Userʼs Guide Step Factor Other than integers. use min and max options. <p:spinner value="#{spinnerBean. <p:spinner value="#{spinnerBean. <p:spinner value="#{spinnerBean. spinner also support decimals so the fractional part can be controller with spinner as well. Note that you would need to use a converter to avoid conversion errors since prefix/suffix will also be posted.25.number}" min="0" max="100"/> 378 .number}" stepFactor="0. //getter and setter Output of this spinner would be.

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

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

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

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

Button element Dropdown button Button element when icon is not used Label of button Container element of menu List container Each menu item Anchor element in a link item Text element in an item Applies As skinning style classes are global.ui-menu .widget. Hides overlay.ui-button-text .ui-button . Following is the list of structural style classes.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.ui-button-text-only . Style Class .ui-menuitem-link . Skinning SplitButton renders a container element which style and styleClass applies.ui-menuitem-text Container element.ui-splitbutton-menubutton .SplitButton Method show() hide() Params Return Type void void Description Displays overlay. 383 .ui-splitbutton .ui-menuitem .ui-menu-list . see the main Skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. Duration of the animation in milliseconds. Client side callback to execute on theme change. User presentable name.ThemeSwitcher org.ThemeSwitcher org.component org. Inline style of the component.primefaces.component. Name of the animation.ThemeSwitcherRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Disables the component.113 ThemeSwitcher ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh. 399 binding widgetVar effect effectDuration disabled label onchange style null null blind 400 FALSE null null null Object String String Integer Boolean String String String .component.primefaces.primefaces.themeswitcher.component.primefaces.themeswitcher.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.ThemeSwitcherRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class themeSwitcher org.

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

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

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

An el expression that maps to a server side UIComponent instance in a backing bean Defines the alignment within toolbar.ToolbarGroup org.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. valid values are left and right. 403 . when set to false component will not be rendered. Style class of the container element. Info Tag Component Class Component Type Component Family toolbarGroup org.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders.toolbar. binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used.ToolbarGroup org.PrimeFaces Userʼs Guide 3. Inline style of the container element.primefaces.component.primefaces.primefaces.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 .primefaces.component. it’s resolved to a converter instance.component org.component. events. In case it’s a static text.TooltipRenderer org. Event hiding the tooltip. Effect to be used for displaying.116 Tooltip Tooltip goes beyond the legacy html title attribute by providing custom effects.primefaces. it must refer to a converter id Name of the client side widget.Tooltip org.tooltip.component. html content and advance theme support. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.component.primefaces. Event displaying the tooltip.TooltipRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tooltip org.primefaces.primefaces. Effect to be used for hiding.tooltip. When it’s an EL expression.Tooltip org.

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

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

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

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

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

name}" /> </p:treeNode> <p:treeNode type="picture" icon="ui-icon ui-icon-image"> <h:outputText value="#{doc. Suppose you’re using tree to visualize a company with different departments and different employees. <p:tree value="#{bean.name}" /> </p:treeNode> <p:treeNode type="mp3" icon="ui-icon ui-icon-video"> <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. video). 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. Following example demonstrates a document explorer. 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. files each having a different formats (music. or a document tree with various folders.PrimeFaces Userʼs Guide Multiple TreeNode Types It’s a common requirement to display different TreeNode types with a different UI (eg icon). In order to solve this. To begin with here is the final output.

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

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

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

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

when set to false component will not be rendered.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Type of the tree node Style class to apply a particular tree node type Icon of the node.PrimeFaces Userʼs Guide 3.UITreeNode org. Info Tag Component Class Component Type Component Family treeNode org. Expanded icon of the node.primefaces.tree. refer to sections of these components for more information.component. 415 .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.UITreeNode org.118 TreeNode TreeNode is used with Tree component to represent a node in tree. Collapsed icon of the node.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.

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

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

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

120 Watermark Watermark displays a hint on an input field. 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. Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.watermark.component org.WatermarkRenderer 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 Text of watermark.component.primefaces.primefaces.primefaces. <h:inputText id="txt" value="#{bean.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class watermark org.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> 419 .component. when set to false component will not be rendered.watermark.Watermark org.component.component.WatermarkRenderer org.Watermark org. one way is to use for attribute.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .