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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces. 24 . 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.AutoCompleteRenderer Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Converter/ String Description Unique identifier of the component.component.autocomplete.primefaces.component.AutoComplete org. An el expression or a literal text that defines a converter for the component.component org.component.4 AutoComplete AutoComplete provides live suggestions while an input is being typed.autocomplete.AutoComplete org. 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 autoComplete org. it’s resolved to a converter instance.primefaces.AutoCompleteRenderer org.PrimeFaces Userʼs Guide 3. When it’s an EL expression. In case it’s a static text. it must refer to a converter id.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.component.carousel.primefaces.primefaces.Carousel org.Carousel org.CarouselRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class carousel org.component.CarouselRenderer org.component.primefaces.component org.10 Carousel Carousel is a multi purpose component to display a set of data or general content with slide effects.carousel.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean A value expression that refers to a collection Name of the request scoped iterator Number of visible items per page Index of the first element to be displayed Name of the client side widget. 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 .

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

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

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

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

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

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

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

model}" legendPosition=”w” /> 63 . Specifies interactive legend. 540). Displays data on each slice.set("Brand 3". model.set("Brand 2". } <p:pieChart value="#{bean. 325). Format of data labels.primefaces. model.model. public class Bean { } private PieChartModel model. model. public PieChartModel getModel() { return model. 702).chart.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. public } Bean() { model = new PieChartModel().PieChartModel instance.set("Brand 1".set("Brand 4". Getting started with PieChart PieChart is created with an org. 421).

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

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

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

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

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

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

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

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

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

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

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

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

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

Label of the x-axis.component org.chart.chart. Label of the y-axis.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 Name of the client side widget Datasource to be displayed on the chart Inline style of the chart.OhlcChartRenderer org.6 Ohlc Chart An open-high-low-close chart is a type of graph typically used to visualize movements in the price of a financial instrument over time.ohlc. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.PrimeFaces Userʼs Guide 3. Angle of the x-axis ticks. Position of the legend. Style class of the chart. Title of the chart. Specifies interactive legend. Angle of the y-axis ticks.component.chart.OhlcChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.chart.ohlc. Enables candle stick display mode.primefaces.OhlcChart org.OhlcChart org. Comma separated list of colors in hex format.primefaces.component.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 .12.

143. OhlcChartSeries(2009.chart.142. OhlcChartSeries(2008.addRecord(new ohlcModel. ohlcModel.143.addRecord(new ohlcModel.81)).addRecord(new ohlcModel.144.123.53.135. public Bean() { model = new OhlcChartModel().135.136.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.139.addRecord(new } //getter } OhlcChartSeries(2007.134.124.model.124.46.144.68.143.7.140. OhlcChartSeries(2012.76.5)).addRecord(new ohlcModel.18.132.31.140.57.56.66.139.44)).addRecord(new ohlcModel.04.136.01.138.OhlcChartModel instance.135.56. OhlcChartSeries(2010.129.5. <p:ohlcChart value="#{bean.addRecord(new ohlcModel.73.02)).79.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 78 .9. public class Bean { private OhlcChartModel model.primefaces.55.136.121.97)).135.82.139.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.48)). OhlcChartSeries(2012.88.122.139.67.4)). <p:ohlcChart value="#{bean. OhlcChartSeries(2011.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dashboard org.primefaces.Dashboard org.component.PrimeFaces Userʼs Guide 3.22 Dashboard Dashboard provides a portal like layout with drag&drop based reorder capabilities.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. 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.DashboardRenderer org.primefaces.dashboard.Dashboard org.component. Disables reordering feature.primefaces.primefaces.primefaces.dashboard. 107 .component.component. when set to false component will not be rendered.component org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Position of the paginator. Unique identifier of a row. Template of the currentPageReport UI. Enables live scrolling. Template of the paginator. Inline style of the table element.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”. Event to invoke filtering for input filters. 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 . Defines if paginator should be hidden if total data count is less than number of rows per page. Scroll viewport height. Inline style of the component. Name of iterator to refer each row index. Client side callback to execute before expansion. Enables row selection on double click. Enables row selection. Scroll viewport width. Style class for each row. Enables column resizing. Number of rows to load on live scroll. valid values are “single” and “multiple”. Maximum number of page links to display. Template of the rowsPerPage dropdown. Property to be used for default sorting. Style class of the table element. Reference to the selection data. Style class of the component. Makes data scrollable with fixed header. scrollable scrollHeight scrollWidth selectionMode selection rowIndexVar emptyMessage style styleClass dblClickSelect liveScroll rowStyleClass onExpandStart resizableColumns sortBy sortOrder scrollRows rowKey tableStyle tableStyleClass filterEvent FALSE null null null null null No records found. Text to display when there is no data to display.

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

Pagination DataTable has a built-in ajax based paginator that is enabled by setting paginator option to true.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..cars}"> <p:column sortBy="#{car. <p:dataTable var="car" value="#{carBean.cars)} cars. </f:facet> </p:dataTable> headerText and footerText attributes on column are handy shortcuts for header and footer facets that just display plain texts.model}" /> </p:column> .cars}"> <f:facet name="header"> List of Cars </f:facet> <p:column> <f:facet name="header"> Model </f:facet> #{car. <p:dataTable var="car" value="#{carBean.year} </p:column> //more columns <f:facet name="header"> In total there are #{fn:length(carBean..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.more columns </p:dataTable> 128 . see pagination section in dataGrid documentation for more information about customization.

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

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

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

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

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

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

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

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

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

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

manufacturer}"> #{car.model} </p:column> <p:column headerText="Year" sortBy="#{car. <p:dataTable var="car" value="#{tableBean.year}"> #{car.manufacturer} </p:column> <p:column headerText="Color" sortBy="#{car.color} </p:column> <p:summaryRow> <p:column colspan="3" style="text-align:right"> Total: </p:column> <p:column> #{tableBean.manufacturer}" sortOrder="descending"> <p:column headerText="Model" sortBy="#{car.cars}" sortBy="#{car.year} </p:column> <p:column headerText="Manufacturer" sortBy="#{car.randomPrice}$ </p:column> </p:summaryRow> </p:dataTable> 139 .model}"> #{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.color}"> #{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.stats}"> <f:facet name="header"> #{player.PrimeFaces Userʼs Guide SubTable SubTable is a helper component to display nested collections.allGoals}" /> <p:column footerText="#{player.name} </f:facet> <p:column> #{stats.allAssists}" /> </p:row> </p:columnGroup> </p:subTable> </p:dataTable> 140 . <p:dataTable var="player" value="#{tableBean.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. Example below displays a collection of players and a subtable for the stats collection of each player.season} </p:column> <p:column> #{stats.

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

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

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

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

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

Inline style of the dialog.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 minimizable or not. Enables lazy loading of the content with ajax.hide()" /> 146 . Whether a dialog is maximizable or not. Client side callback to execute when dialog is hidden.PrimeFaces Userʼs Guide Name minHeight style styleClass showEffect hideEffect position closable onShow onHide appendToBody showHeader footer dynamic minimizable maximizable Default 0 null null null null null TRUE null null FALSE TRUE null FALSE FALSE FALSE Type Integer String String String String String Boolean String String Boolean Boolean String Boolean Boolean Boolean Description Minimum height of a resizable dialog. Style class of the dialog Effect to use when showing the dialog Effect to use when hiding the dialog Defines where the dialog should be displayed Defines if close icon should be displayed or not Client side callback to execute when dialog is displayed. Appends dialog as a child of document body. Text of the footer. Getting started with the Dialog Dialog is a panel component containing other components. Defines visibility of the header content. <p:dialog header="Header Text" widgetVar="dlg"> //Content </p:dialog> <p:commandButton value="Show" type="button" onclick="dlg. note that by default dialog is not visible.

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

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

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

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

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

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

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

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

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

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

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

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

component org. bottom or top. An el expression that maps to a server side UIComponent instance in a backing bean MenuModel instance to create menus programmatically Position of the dock.primefaces.30 Dock Dock component mimics the well known dock interface of Mac OS X.component.primefaces. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dock org.primefaces.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.primefaces.dock.PrimeFaces Userʼs Guide 3.primefaces.Dock org.Dock org. 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 . Horizontal alignment. Initial width of items.component. Maximum width of items.component.DockRenderer org. Distance to enlarge. Name of the client side widget.component.dock.

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

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

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

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

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

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

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

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

FeedReader org. <p:feedReader value="http://rss.title}" style="font-weight: bold"/> <h:outputText value="#{feed.33 FeedReader FeedReader is used to display content from a feed.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.feedreader.component.component.FeedReaderRenderer org.com/rss/sports" var="feed"> <h:outputText value="#{feed.PrimeFaces Userʼs Guide 3.primefaces.value}" escape="false"/> <p:separator /> <f:facet name="error"> Something went wrong.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean URL of the feed.feedreader. </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.FeedReader org.primefaces. Number of items to display. 168 . Iterator to refer each item in feed.component.yahoo. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class feedReader org.component org.primefaces.news.description. when set to false component will not be rendered.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class gmap org.primefaces.gmap.PrimeFaces Userʼs Guide 3. Boolean value to specify the rendering of the component.primefaces. binding widgetVar null null Object String 187 .gmap.GMap org.component.primefaces.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. Name of the client side widget.39 GMap GMap is a map component integrated with Google Maps API V3.component.primefaces.component.primefaces.GmapRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.Gmap org.GmapRenderer org.component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

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

236

PrimeFaces Userʼs Guide

Name maxlength onblur onchange

Default null null null

Type Integer String String

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

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

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

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

PrimeFaces Userʼs Guide

Name widgetVar

Default null

Type String

Description Name of the client side widget.

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

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

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

Another example;

238

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

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

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

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

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

PrimeFaces Userʼs Guide

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

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

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

240

PrimeFaces Userʼs Guide

Name style styleClass onResize onClose onToggle resizeTitle collapseTitle expandTitle closeTitle

Default null null null null null null null null null

Type String String String String String String String String String

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

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

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

241

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

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

</p:layout>

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

PrimeFaces Userʼs Guide

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

</p:layout>

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

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

243

PrimeFaces Userʼs Guide

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

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

244

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

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

primefaces.primefaces. 247 . multimedia content.LightBoxRenderer org.component.primefaces.LightBox org.component. Style class of the container element not the overlay element. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lightBox org. Style of the container element not the overlay element. other JSF components and external urls. 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.PrimeFaces Userʼs Guide 3.component lightbox.primefaces.LightBoxRenderer Attributes Name id rendered binding widgetVar style styleClass Default null TRUE null null null null Type String Boolean Object String String String Description Unique identifier of the component Boolean value to specify the rendering of the component.component org.lightbox.55 LightBox Lightbox features a powerful overlay that can display images.component.primefaces.LightBox org.

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

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

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

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

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

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

An el expression that maps to a server side UIComponent instance in a backing bean.megamenu.component org.component.MegaMenuRenderer 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 megaMenu org.MegaMenuRenderer org.megamenu.58 MegaMenu MegaMenu is a horizontal navigation component that displays submenus together.MegaMenu org.component. Name of the client side widget MenuModel instance to create menus programmatically binding widgetVar model null null null Object String MenuModel 254 .primefaces.primefaces. when set to false component will not be rendered.primefaces.component. Boolean value to specify the rendering of the component.MegaMenu org.primefaces.primefaces.PrimeFaces Userʼs Guide 3.component.

2"> <p:menuitem value="TV.3" </p:submenu> <p:submenu label="TV.1"> <p:menuitem value="TV.1" <p:menuitem value="TV.2.1" <p:menuitem value="TV.3. Style class of the component.3" </p:submenu> <p:submenu label="TV.2" <p:menuitem value="TV.1" <p:menuitem value="TV.1" <p:menuitem value="TV. <p:megaMenu> <p:submenu label="TV" icon="ui-icon-check"> <p:column> <p:submenu label="TV.4.6.2" </p:submenu> </p:column> <p:column> <p:submenu label="TV.2.1.5.2" </p:submenu> <p:submenu label="TV.5.6.1" <p:menuitem value="TV.2" <p:menuitem value="TV.4.6"> <p:menuitem value="TV.2" <p:menuitem value="TV.4"> <p:menuitem value="TV.1" <p:menuitem value="TV.3.5"> <p:menuitem value="TV.PrimeFaces Userʼs Guide Name style styleClass Default null null Type String String Description Inline style of the component.6.2.3" </p:submenu> </p:column> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> url="#" /> </p:submenu> //more root items </p:megaMenu> 255 .3"> <p:menuitem value="TV.5.1.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class orderList org. transition effects and pojo support.component. binding value null null Object Object 277 .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.66 OrderList OrderList is used to sort a collection featuring drag&drop based reordering.component.OrderListRenderer org.primefaces.orderlist.primefaces.component.OrderList org.primefaces.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 referring to a List.component org.orderlist.OrderList org.component. when set to false component will not be rendered.

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

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

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

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

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

OverlayPanelRenderer org.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class overlayPanel org.primefaces.component.primefaces. binding widgetVar style styleClass for null null null null null Object String String String String 283 . An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.primefaces.OverlayPanelRenderer org.component.component.primefaces. Inline style of the panel.68 OverlayPanel OverlayPanel is a generic panel component that can be displayed on top of other content.component org. when set to false component will not be rendered. Identifier of the target component to attach the panel. Style class of the panel.component.overlaypanel.overlaypanel.primefaces.OverlayPanel 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

not the whole page. An el expression that maps to a server side UIComponent instance in a backing bean Id of the component to print.behavior. Examples below demonstrates how to print a simple output text or a particular image on page. 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.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.PrimeFaces Userʼs Guide 3.primefaces.jpg" /> 308 .component. when set to false component will not be rendered.

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

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

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

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

Client side callback to execute when data is pushed. Client Side API of PrimeFaces.primefaces. Connects to the channel. Connects to channel on page load when enabled.PushRenderer org. 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.primefaces. Getting Started with the Push See chapter 6.component.component.push.primefaces. "PrimeFaces Push" for detailed information.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. Disconnects from channel.component.primefaces.Push org.component.primefaces. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Unique channel name of the connection between subscriber and the server.widget.PrimeFaces Userʼs Guide 3.push.component org.77 Push Push component is an agent that creates a channel between the server and the client. Client side callback to execute when connection is closed. 313 .Push org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3.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.RowToggler org.component org.component. when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with Row See expandable rows section in datatable documentation for more information about usage.rowtoggler.component.primefaces. 330 .primefaces.RowTogglerRenderer org.RowToggler org.86 RowToggler RowToggler is a helper component for datatable.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rowToggler org.rowtoggler.primefaces.component.primefaces.

Schedule org.component.primefaces org.component.Schedule org.primefaces.schedule.Locale instance binding widgetVar value locale null null null null Object String Object Object 331 .component. An org.primefaces. can be String or a java. iCal like JSF component to manage events.model.schedule.ScheduleModel instance representing the backed model Locale for localization.ScheduleRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces.util. 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 schedule org. when set to false component will not be rendered.primefaces.ScheduleRenderer org.component.PrimeFaces Userʼs Guide 3.87 Schedule Schedule provides an Outlook Calendar.

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.SelectCheckboxMenuRenderer org.component. when set to false component will not be rendered.selectcheckboxmenu.SelectCheckboxMenu org.component org.component. In case it’s a static text.primefaces. process validations logic is executed at apply request values phase for this component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. it must refer to a converter id When set true. 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 345 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectCheckboxMenu org.SelectCheckboxMenu org.primefaces.component. When it’s an EL expression.91 SelectChecboxMenu SelectCheckboxMenu is a multi select component that displays options in an overlay.PrimeFaces Userʼs Guide 3.primefaces.primefaces. it’s resolved to a converter instance.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.selectcheckboxmenu.

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3. when set to false component will not be rendered. it’s resolved to a converter instance.primefaces.SelectOneListbox org.selectonelistbox.SelectOneListbox org. When it’s an EL expression. In case it’s a static text.96 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox 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.component. 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 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 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org.selectonelistbox.primefaces.primefaces.component. An el expression or a literal text that defines a converter for the component.component org.primefaces.SelectOneListboxRenderer org.primefaces.component.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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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" step="10" /> Animation Sliding is animated by default.PrimeFaces Userʼs Guide Vertical Slider By default slider’s orientation is horizontal. <h:inputText id="number" value="#{sliderBean. Following slider can slide between -100 and +100.number}" /> <p:slider for="number" minValue="-100" maxValue="100"/> 371 .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. Default value is one and it is customized using step option. if you want to turn it of animate attribute set the animate option to false. <h:inputText id="number" value="#{sliderController.

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

PrimeFaces Userʼs Guide Client Side API Widget: PrimeFaces. 373 . Class .ui-slider .widget. These attributes are handy to specify the dimensions of the slider.ui-slider-horizontal .ui-slider-vertical .Slider Method getValue() setValue(value) disable() enable() Params value: Value to set index: Index of tab to disable index: Index of tab to enable Return Type Number void void void Description Returns the current value Updates slider value with provided one. Disables slider.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. Following is the list of structural style classes. Enables slider. see the main Skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

primefaces. when set to false component will not be rendered.component.StackRenderer org. Speed of the animation when opening the stack.Stack org. An el expression that maps to a server side UIComponent instance in a backing bean. Name of the client side widget. Boolean value to specify the rendering of the component.primefaces.primefaces. MenuModel instance to create menus programmatically Whether to display stack as expanded or not.component.stack. An optional image to contain stacked items. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class stack org. 385 .PrimeFaces Userʼs Guide 3.component org. Speed of the animation when opening the stack.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.106 Stack Stack is a navigation component that mimics the stacks feature in Mac OS X.component.primefaces.Stack org.component.primefaces.stack.

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces. Duration of the animation in milliseconds.ThemeSwitcher org.themeswitcher. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component. 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.component org. 399 binding widgetVar effect effectDuration disabled label onchange style null null blind 400 FALSE null null null Object String String Integer Boolean String String String . Disables the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class themeSwitcher org. when set to false component will not be rendered.113 ThemeSwitcher ThemeSwitcher enables switching PrimeFaces themes on the fly with no page refresh.component. Name of the animation. User presentable name.component.component.primefaces.ThemeSwitcher org.themeswitcher. Inline style of the component.ThemeSwitcherRenderer org.primefaces.PrimeFaces Userʼs Guide 3.primefaces.

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

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

Here is an example. 402 . <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. Following is the list of structural style classes.ui-toolbar . Style Class .PrimeFaces Userʼs Guide Any number of components can be placed inside toolbarGroups.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. Additionally p:separator component can be used to separate items in toolbar.ui-toolbar . see the main Skinning section for more information.ui-separator .

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

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

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

406 .png" /> <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only .ui-tooltip as a style class and is styled with global skinning selectors. 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.PrimeFaces Userʼs Guide Html Content Another powerful feature of tooltip is the ability to display custom content as a tooltip not just plain texts. An example is as follows.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

meaning if there is an ajaxStatus component present on page. 430 . 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. An example with commandButton would be.1.PrimeFaces Userʼs Guide Global vs Non-Global By default ajax requests are global.4 Bits&Pieces PrimeFaces Ajax Javascript API See the javascript section to learn more about the PrimeFaces Javascript Ajax API. set global to false. it is triggered.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide THE END 460 .

Sign up to vote on this title
UsefulNot useful