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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. When it’s an EL expression.component org.AutoComplete org. An el expression or a literal text that defines a converter for the component.AutoCompleteRenderer org.component.primefaces.autocomplete.primefaces.AutoCompleteRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component. it must refer to a converter id.primefaces.AutoComplete org.4 AutoComplete AutoComplete provides live suggestions while an input is being typed.component.PrimeFaces Userʼs Guide 3.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class autoComplete org.primefaces. Value of the component than can be either an EL expression of a literal text. In case it’s a static text.component. An el expression that maps to a server side UIComponent instance in a backing bean. Boolean value to specify the rendering of the component.autocomplete. 24 . it’s resolved to a converter instance.

Defines whether to trigger ajaxStatus or not. Client side callback to execute before ajax request to load suggestions begins. Value of the item. When enabled. A method expression that refers to a method for handling a valuchangeevent. Client side callback to execute after ajax request to load suggestions completes. Message to be displayed when validation fails. Enables dropdown mode when set true. autoComplete only accepts input from the selection list. Method providing suggestions. Name of the client side widget. Effect to use when showing/hiding suggestions. Name of the iterator used in pojo based suggestion. Message to be displayed when required field validation fails. Number of characters to be typed before starting to query. required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar completeMethod var itemLabel itemValue maxResults minQueryLength queryDelay forceSelection onstart oncomplete global scrollHeight effect effectDuration dropdown panelStyle FALSE null null null null null null null null null null unlimited 1 300 FALSE null null TRUE null null 400 FALSE null Boolean MethodExpr MethodExpr String String String String MethodExpr String String String Integer Integer Integer Boolean String String Boolean Integer String Integer Boolean String 25 . Delay to wait in milliseconds before sending each query to the server. Maximum number of results to be displayed. Duration of effect in milliseconds. Message to be displayed when conversion fails. Label of the item. process validations logic is executed at apply request values phase for this component. Defines the height of the items viewport. A method expression that refers to a method validationg the input. Inline style of the items container element. Marks component as required.PrimeFaces Userʼs Guide Name immediate Default FALSE Type Boolean Description When set true.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component org.CalendarRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component An el expression or a literal text that defines a converter for the component.component. ajax selection and more.primefaces.primefaces.Date Converter/ String Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.CalendarRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object java.PrimeFaces Userʼs Guide 3.component.component. paging.8 Calendar Calendar is an input component used to select a date featuring display modes.calendar. When it’s an EL expression.Calendar org.component.Calendar org. it’s resolved to a converter instance.util. In case it’s a static text. it must refer to a converter id When set true.primefaces.primefaces. 41 immediate FALSE Boolean . localization. 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 calendar org.calendar.

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

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

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

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

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 .date}" mode="popup" showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month.date}" mode="popup" showOn="button" /> Popup Icon Only <p:calendar value="#{dateBean. Valid values are. This feature is tuned with the pages attribute. <p:calendar value="#{dateController.

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

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

first one is flag to indicate if date would be displayed as enabled and second parameter is the optional style class to add to date cell. <p:calendar value="#{dateBean. <p:calendar value="#{dateBean. 49 . The function returns an array with two values.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.PrimeFaces Userʼs Guide Navigator Navigator is an easy way to jump between months/years quickly.

date}" beforeShowDay="tuesdaysAndFridaysOnly" /> function tuesdaysAndFridaysDisabled(date) { var day = date.ui-datepicker-next .ui-datepicker-title . Following is the list of structural style classes.ui-datepicker-other-month .getDay().widget.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 .PrimeFaces Userʼs Guide <p:calendar value="#{dateBean. Style Class .ui-datepicker-prev .   return [(day != 2 && day != 5). ''] } Client Side API Widget: PrimeFaces.ui-datepicker td .ui-datepicker-week-end .ui-datepicker-table .ui-datepicker-month .ui-datepicker-header .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-current . 51 . see the main Skinning section for more information.PrimeFaces Userʼs Guide Style Class .ui-datepicker-close Today button Close button Applies As skinning style classes are global.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. <p:lineChart value="#{bean.

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

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

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

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

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

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

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

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

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.

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

primefaces.31. OhlcChartSeries(2011.143.56. OhlcChartSeries(2010.139.135.46.143.143.139.chart.139.123.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .135.135.addRecord(new ohlcModel.addRecord(new ohlcModel.132.55.01. OhlcChartSeries(2012.04.136.144.5)). OhlcChartSeries(2008.135.136. ohlcModel.81)).124.129.134.138.139.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well. public class Bean { private OhlcChartModel model.67.7.122.OhlcChartModel instance.9.136.addRecord(new } //getter } OhlcChartSeries(2007.5.48)).68.140.18.121.66.addRecord(new ohlcModel.model. <p:ohlcChart value="#{bean.02)).53.addRecord(new ohlcModel. public Bean() { model = new OhlcChartModel().4)).142.73.144.76.88. OhlcChartSeries(2012.79.124.140. <p:ohlcChart value="#{bean.addRecord(new ohlcModel.97)).56.57.addRecord(new ohlcModel. OhlcChartSeries(2009.44)).82.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.component org.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities. Inline style of the dashboard container Style class of the dashboard container binding widgetVar model disabled style styleClass null null null FALSE null null Object String Dashboard Model Boolean String String Getting started with Dashboard Dashboard is backed by a DashboardModel and consists of panel components.primefaces. when set to false component will not be rendered.dashboard.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.DashboardRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Dashboard model instance representing the layout of the UI.component.component.dashboard.Dashboard org. Disables reordering feature.Dashboard org.primefaces.PrimeFaces Userʼs Guide 3.primefaces.component.DashboardRenderer org. 107 .

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

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

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

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

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

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

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

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

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

model}"> <h:panelGrid columns="1"> <p:graphicImage value="/images/cars/#{car.2005. As datagrid extends from standard UIData. rows correspond to the number of data to display not the number of rows to render so the actual number of rows to render is rows/columns = 4.manufacturer}. 117 .add(new Car("myModel"."ManufacturerX".cars}" columns="3" rows="12"> <p:column> <p:panel header="#{car.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>(). cars. } <p:dataGrid var="car" value="#{carBean.year}" /> </h:panelGrid> </p:panel> </p:column> </p:dataGrid> This datagrid has 3 columns and 12 rows. public class CarBean { } private List<Car> cars. //add more cars public List<Car> getCars() { return cars."blue")).jpg"/> <h:outputText value="#{car. As a result datagrid is displayed as.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:dataTable var="car" value="#{carBean. in this case data is fetched whenever the scrollbar reaches bottom. <p:dataTable var="car" value="#{carBean. clicking on a collapsed row loads expanded content with ajax. Set liveScroll to enable this option.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..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. live scrolling is necessary to deal with huge data. y and x-y scrolling that are defined by scrollHeight and scrollWidth. Expandable Rows RowToggler and RowExpansion facet are used to implement expandable rows. 136 . //columns </p:dataTable> Scrolling has 3 modes..

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

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

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

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

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

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

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

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

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

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

‘top’.. </p:dialog> Position By default dialog is positioned at center of the viewport and position option is used to change the location of the dialog.> 147 .. • Single string value like ‘center’.> //.> <p:dialog position="200. ‘left’. <p:dialog position="top" ... ‘right’.. 500 • Comma separated position values like ‘top’. Possible values are..50" .PrimeFaces Userʼs Guide Effects There are various effect options to be used when displaying and closing the dialog.. (Use single quotes when using a combination) Some examples are described below.. ‘bottom’ representing the position within viewport.‘right’. Use showEffect and hideEffect options to apply these effects..> <p:dialog position="left.top" . • 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" ..

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. hideStatus)"> <p:fileDownload value="#{fileDownloadController.file}"/> </p:commandButton> </h:form> 175 .monitorDownload(showStatus.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide org.map.primefaces.primefaces. org.event.primefaces.event.OverlaySelectEvent Property overlay Default null Type Overlay Description Selected overlay instance org.model.primefaces.PointSelectEvent Property latLng Default null Type LatLng Description Coordinates of the selected point org.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.event.MarkerDragEvent Property marker Default null Type Marker Description Dragged marker instance org.event.map.faces.FacesEvent.map.primefaces.map.StateChangeEvent Property bounds zoomLevel Default null 0 Type LatLngBounds Integer Description Boundaries of the map Zoom level of the map 197 .event.map.

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

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

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

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

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

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

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

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

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

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

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

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

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

idleMonitor waits for 5 minutes (300000 ms) until triggering the onidle event. 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 . Ajax Behavior Events IdleMonitor provides two ajax behavior events which are idle and active that are fired according to user status changes.PrimeFaces Userʼs Guide Controlling Timeout By default. Example below displays messages for each 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

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

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

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

binding

null

Object

212

PrimeFaces Userʼs Guide

Name widgetVar leftImage rightImage width height style styleClass

Default null null null null null null null

Type String String String String String String String

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

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

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

213

PrimeFaces Userʼs Guide

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

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

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

binding value converter

null null null

Object Object Converter/ String

214

PrimeFaces Userʼs Guide

Name immediate

Default FALSE

Type Boolean

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

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

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

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

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

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

215

PrimeFaces Userʼs Guide

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

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

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

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

216

PrimeFaces Userʼs Guide

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

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

217

PrimeFaces Userʼs Guide

3.47 ImageSwitch
Imageswitch component is a simple image gallery component.

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

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

binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass

null null null 500 3000 TRUE null null

Object String String Integer Integer Boolean String String

PrimeFaces Userʼs Guide

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

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

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

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

219

PrimeFaces Userʼs Guide

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

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

220

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.Log org.Log org.LogRenderer org.log.primefaces.component org.log.component.component.LogRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org. when set to false component will not be rendered.component. 250 . 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.component.PrimeFaces Userʼs Guide 3.56 Log Log component is a visual console to display logs on JSF pages.primefaces.primefaces.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class message org.message.PrimeFaces Userʼs Guide 3.message. Id of the component whose messages to display.MessageRenderer org.component. Boolean value to specify the rendering of the component. Specifies if the summary of the FacesMessage should be displayed. when set to false component will not be rendered. <h:inputText id="txt" value="#{bean.component org.primefaces.component.Message org. An el expression that maps to a server side UIComponent instance in a backing bean. Getting started with Message Message usage is exactly same as standard message.primefaces.Message org.component.component.text}" /> <p:message for="txt" /> 271 . Defines if already rendered messages should be displayed Defines the display mode.primefaces.primefaces.63 Message Message is a pre-skinned extended version of the standard JSF message component. Specifies if the detail of the FacesMessage should be displayed.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 Userʼs Guide Display Mode Message component has three different display modes. ‘error’. • both (default) : Both icon and text are displayed. Skinning Message Full list of CSS selectors of message is as follows. ‘warn’ and error. • icon : Only message severity is displayed and message text is visible as a tooltip. • text : Only message text is displayed. 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’.

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

274 . ‘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. ‘warn’ and error. Skinning Message Full list of CSS selectors of message is as follows. {severity} can be ‘info’. messages component is updated with each ajax request automatically. Getting started with Messages Message usage is exactly same as standard messages. <p:messages /> AutoUpdate When auto update is enabled. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public String getPassword() { return password. <p:password value="#{mybean. } public void setPassword(String password) { this. <p:password value="#{bean.password}" promptLabel="Lütfen şifre giriniz" weakLabel="Zayıf" goodLabel="Orta seviye" strongLabel="Güçlü" feedback= "true"/> Inline Strength Indicator By default strength indicator is shown in an overlay. Following password gives feedback in Turkish. you can provide custom labels as well. When feedback option is enabled a password strength indicator is displayed.password = password.PrimeFaces Userʼs Guide Getting Started with Password Password is an input component and used just like a standard input text. <p:password value="#{bean.} I18N Although all labels are in English by default. 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.password6}" feedback="false" label="Password 2" required="true"/> 295 .password}" inline="true" feedback= "true"/> Confirmation Password confirmation is a common case and password provides an easy way to implement. <p:password id="pwd1" value="#{passwordBean. if you prefer an inline indicator just enable inline mode.password}" feedback="true|false" /> public class Bean { } private String password.

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

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

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

PickListRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.picklist.component. when set to false component will not be rendered.Panel org. Marks component as required binding value converter null null null Object Object Convert er/String immediate FALSE Boolean required FALSE Boolean 299 .component. In case it’s a static text. process validations logic is executed at apply request values phase for this component.picklist.primefaces. When it’s an EL expression.component.primefaces. it must refer to a converter id When set true.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pickList org. it’s resolved to a converter instance.73 PickList PickList is used for transferring data between two different collections.PickListRenderer org.component.PrimeFaces Userʼs Guide 3.component org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces.PickList org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.PrimeFaces Userʼs Guide 3.primefaces.85 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows. 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 Getting Started with RowExpansion See datatable expandable rows section for more information about how rowExpansion is used.component.RowExpansion org.rowexpansion.component.RowExpansion org.component Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component. Info Tag Component Class Component Type Component Family rowExpansion org.primefaces. 329 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

In case it’s a static text. An el expression or a literal text that defines a converter for the component.SelectManyButton Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.92 SelectManyButton SelectManyButton is a multi select component using button UI.component.component.SelectManyButton org.primefaces.selectmanybutton.SelectManyButton org.selectmanybutton. 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 selectManyButton org. When it’s an EL expression. it must refer to a converter id When set true.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.primefaces.component. when set to false component will not be rendered.primefaces.component org. it’s resolved to a converter instance.SelectManyButton org.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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inline style of the component. 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. Layout of the checkboxes. <p:selectOneRadio id="customRadio" value="#{formBean. Note that in custom mode. User presentable name. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. Callback to execute on value change. Message to be displayed when validation fields.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. This is implemented by setting layout option to custom and with standalone radioButton components. valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Disables the component. Name of the client side widget.option}" layout="custom"> <f:selectItem itemLabel="Option 1" itemValue="1" /> <f:selectItem itemLabel="Option 2" itemValue="2" /> <f:selectItem itemLabel="Option 3" itemValue="3" /> </p:selectOneRadio> <h:panelGrid columns="3"> <p:radioButton id="opt1" for="customRadio" itemIndex="0"/> <h:outputLabel for="opt1" value="Option 1" /> <p:spinner /> <p:radioButton id="opt2" for="customRadio" itemIndex="1"/> <h:outputLabel for="opt2" value="Option 2" /> <p:inputText /> <p:radioButton id="opt3" for="customRadio" itemIndex="2"/> <h:outputLabel for="opt3" value="Option 3" /> <p:calendar /> </h:panelGrid> 362 . selectOneRadio itself does not render any output. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

25"/> public class SpinnerBean { } private double number.number}" stepFactor="0. <p:spinner value="#{spinnerBean. After an increment happens a couple of times.PrimeFaces Userʼs Guide Step Factor Other than integers. use min and max options.25. //getter and setter Output of this spinner would be. 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.number}" prefix="$" /> Boundaries In order to restrict the boundary values. <p:spinner value="#{spinnerBean. Prefix and Suffix Prefix and Suffix options enable placing fixed strings on input field. <p:spinner value="#{spinnerBean. Following example uses a stepFactor 0.number}" min="0" max="100"/> 378 . For decimals use the stepFactor attribute to specify stepping amount.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Terminal org.component.primefaces.112 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.component.TerminalRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces. 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.terminal. when set to false component will not be rendered.terminal. Primary prompt text.Terminal org.primefaces.component org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org. 397 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .component.TerminalRenderer org.primefaces.PrimeFaces Userʼs Guide 3.

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

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

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

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

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

binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used. 403 . when set to false component will not be rendered.ToolbarGroup org.primefaces.component. Inline style of the container element.primefaces. Style class of the container element. Info Tag Component Class Component Type Component Family toolbarGroup org.component.primefaces. valid values are left and right.PrimeFaces Userʼs Guide 3. 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.toolbar.115 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

426 .ui-wizard-content . Selector .ui-wizard-navbar . Returns the index of current step.ui-wizard .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. Goes back in flow.PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces.widget.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. Following is the list of structural css classes.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

449 .PrimeFaces Userʼs Guide 9. Returns a boolean value if has any of the given roles or not. This function is useful if you need to work with javascript. Returns the name of the logged in user.show()" /> Page Authorization Function ifGranted(String role) ifAllGranted(String roles) ifAnyGranted(String roles) ifNotGranted(String roles) remoteUser() userPrincipal() Description Returns a boolean value if user has given role or not. Provides the widgetVar of a component. 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. Returns the principial instance of the logged in user.2 EL Functions PrimeFaces provides built-in EL extensions that are helpers to common use cases. 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. Returns a boolean value if has all of the given roles or not.

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

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

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

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

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

springsource. https://jira. SpringSource repository has two samples based on SWF-PrimeFaces. PrimeFaces is suggested by SpringSource as the preferred JSF component suite for SWF applications. CDI and EJBs PrimeFaces fully supports a JAVA EE 6 environment with CDI and EJBs.PrimeFaces Userʼs Guide 11.org/browse/ROO-516 455 . Spring ROO SpringSource provides an official JSF-PrimeFaces Addon. • • • • • Spring Core (JSF Centric JSF-Spring Integration) Spring WebFlow (Spring Centric JSF-Spring Integration) Spring Roo (PrimeFaces Addon) EJBs CDI We’ve created sample applications to demonstrate several technology stacks involving PrimeFaces and JSF at the front layer. a small showcase and booking-faces example. Following frameworks are fully supported. Spring WebFlow We as PrimeFaces team work closely with Spring WebFlow team. 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.

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful