You are on page 1of 445

USER’S GUIDE 3.

1

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 BreadCrumb ! 3.6 Button ! 3.7 Calendar! 3.8 Captcha ! 3.9 Carousel! 3.10 CellEditor! 3.11 Charts !
3.11.1 Pie Chart! 3.11.2 Line Chart! 3.11.3 Bar Chart! 3.11.4 Donut Chart!
3

15
15 19 21 24 33 35 38 48 51 57 58
58 61 64 67

PrimeFaces User!s Guide

3.11.5 Bubble Chart! 3.11.6 Ohlc Chart! 3.11.7 MeterGauge Chart! 3.11.8 Skinning Charts! 3.11.9 Ajax Behavior Events ! 3.11.10 Charting Tips!

70 73 75 77 78 79

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

80 81 85 87 88 89 94 97 100 103 108 111 117 121 139 144
144 148

3.28 Dock ! 3.29 Editor!
4

153 155

PrimeFaces User!s Guide

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

159 162 163 167 170 176 178 181 192 193 198 201 204 206 208 212 215 219 223 226 229 234 238 240 243

PrimeFaces User!s Guide

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

245 247 253 256 258 261 263 265 267 271 273 276 279 282 287 289 295 298 299 302 303 304 307 309 313

PrimeFaces User!s Guide

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

316 317 318 319 320 328 330 332 334 336 338 340 342 344 346 350 353 355 358 363 364 369 370 372 373

PrimeFaces User!s Guide

3.105 Tab! 3.106 TabView ! 3.107 TagCloud ! 3.108 Terminal! 3.109 ThemeSwitcher! 3.110 Toolbar! 3.111 ToolbarGroup! 3.112 Tooltip! 3.113 Tree ! 3.114 TreeNode ! 3.115 TreeTable ! 3.116 Watermark! 3.117 Wizard!

374 375 380 382 384 386 388 389 392 400 401 404 406

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 !

412
412
412 412 414 415

4.2 Partial Processing !
4.2.1 Partial Validation! 4.2.2 Keywords ! 4.2.3 Using Ids!

416
416 417 417

5. PrimeFaces Mobile ! 6. PrimeFaces Push!
8

418 419

2 Push API! 6.4 Samples ! 6.1 Setup ! 6. Utilities ! 9.4.1 Counter! 6. Integration with Java EE! 12.1 RequestContext! 9.2 Eclipse ! 9 440 441 441 442 .2 Chat! 419 420 420 420 420 421 7.3 How Themes Work ! 8.4 Theming Tips ! 426 427 428 429 430 9.2 Ajax API! 423 423 424 8. Portlets ! 10. Themes ! 8.2 EL Functions ! 431 431 434 10.PrimeFaces User!s Guide 6.1 NetBeans ! 12.2 Creating a New Theme ! 8.1 PrimeFaces Namespace ! 7.4.3 Push Component ! 6.1 Dependencies ! 10.1 Applying a Theme ! 8. IDE Support ! 12. Javascript API! 7.2 Configuration! 436 436 437 11.

Project Resources ! 14.PrimeFaces User!s Guide 13. FAQ! 443 444 10 .

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

QA&Test Deniz Silahçılar . one jar. a Turkish software development company specialized in Agile and Java EE consulting. • Lightweight. PrimeFaces Team members are full time engineers at Prime Teknoloji.Mentor 12 .PrimeFaces User!s Guide 1. 1. • Large. Introduction 1. • • • • • • • Ça!atay Çivici .Core Developer / QA&Test Mustafa Da"gın .Core Developer / QA&Test Yi!it Darçın .2 Prime Teknoloji PrimeFaces is maintained by Prime Teknoloji.Architect and Lead Developer Levent Günay . • Mobile UI kit to create mobile web applications for handheld devices. • Built-in Ajax based on standard JSF 2.Core Developer / QA&Test Basri Kahveci .QA&Test Cenk Çivici . • Developed with "passion" from application developers to application developers. • 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. • Extensive documentation. vibrant and active user community. zero-configuration and no required dependencies. Charts and many more). Dialog. • Rich set of components (HtmlEditor. AutoComplete.0 Ajax APIs. • Ajax Push support via websockets.

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

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

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

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

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

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

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

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

component.AjaxStatusRenderer Attributes Name id rendered binding onstart oncomplete onprestart onsuccess onerror style styleClass widgetVar Default null TRUE null null null null null null null null null String Boolean Object String String String String String String String String Type Description Unique identifier of the component. Client side callback to execute after ajax requests completed succesfully.component.primefaces.ajaxstatus. Boolean value to specify the rendering of the component. Client side callback to execute before ajax requests start.AjaxStatus org.AjaxStatus org.ajaxstatus. Style class of the component.primefaces.primefaces. 21 .PrimeFaces User!s Guide 3.AjaxStatusRenderer org.component. Name of the client side widget.primefaces.3 AjaxStatus AjaxStatus is a global notifier for ajax requests made by PrimeFaces components. Inline style of the component.component org. Client side callback to execute after ajax requests complete. Client side callback to execute when an ajax request fails.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ajaxStatus org. 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.

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

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

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

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

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

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

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

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

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

. <p:autoComplete value="#{bean.event.event. 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. Your listener(if defined) will be invoked with an org.Unselect instance is passed to a listener if defined.. itemUnselect event is provided for multiple autocomplete when an item is removed by clicking the remove icon. In this case org.text}" completeMethod="#{bean. "Item:" + item). } .AutoComplete Method search(value) close() disable() enable() deactivate() activate() Params value: keyword for search Return Type void void void void void void Description Initiates a search with given value Hides suggested items menu Disables the input field Enables the input field Deactivates search behavior Activates search behavior 31 .primefaces.PrimeFaces User!s Guide public class Bean { ! ! ! ! ! } public void handleSelect(SelectEvent event) { ! Object item = event.complete}" ! onstart="handleStart(request)" oncomplete="handleComplete(response)" /> onstart callback gets a request parameter and oncomplete gets a response parameter.primefaces. mouseover in addition to itemSelect. focus. Client Side API Widget: PrimeFaces. For example request is the query string and response is the xhr request sent under the hood.widget. ! FacesMessage msg = new FacesMessage("Selected".getObject().Select instance that contains a reference to the selected item. these parameters contain useful information. Similarly.

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

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

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

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

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

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

paging.7 Calendar Calendar is an input component used to select a date featuring display modes. localization.CalendarRenderer org.component.PrimeFaces User!s Guide 3.component.component org.primefaces.CalendarRenderer Attributes Name id rendered binding Default null TRUE null String Boolean Object Type Description Unique identifier of the component Boolean value to specify the rendering of the component. it must refer to a converter id value converter null null java. it’s resolved to a converter instance.Calendar org.calendar.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component An el expression or a literal text that defines a converter for the component.calendar.util. When it’s an EL expression. In case it’s a static text.primefaces.Date Converter/String 38 .Calendar org.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class calendar org.component. ajax selection and more.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 valuchangeevent Message to be displayed when required field validation fails. Sets calendar's minimum visible date Sets calendar's maximum visible date Enables multiple page rendering.PrimeFaces User!s Guide Name immediate Default FALSE Type Boolean Description When set true. required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar mindate maxdate pages disabled mode pattern locale popupIcon popupIconOnly navigator timeZone FALSE null null null null null null null null int FALSE popup MM/dd/ yyyy null null FALSE FALSE null Boolean MethodExpr MethodExpr String String String String Date or String Date or String 1 Boolean String String java. Message to be displayed when validation fails.util. Visibility of button panel containing today and done buttons. Name of the client side widget. DateFormat pattern for localization Locale to be used for labels and conversion. popup icon is rendered without the button. Icon of the popup button When enabled.TimeZone readOnlyInputText showButtonPanel FALSE FALSE Boolean Boolean 39 .TimeZone instance to specify the timezone used for date conversion. process validations logic is executed at apply request values phase for this component. Disables the calendar when set to true. defaults to TimeZone. Message to be displayed when conversion fails. Enables month/year navigator String or a java.Locale or String String Boolean Boolean java. Defines how the calendar will be displayed.getDefault() Makes input text of a popup calendar readonly.util.util.

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

Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when input element is double clicked. onclick ondblclick onfocus onkeydown onkeypress null null null null null String String String String String onkeyup onmousedown null null String String onmousemove null String onmouseout null String onmouseover null String onmouseup null String onselect readonly size null FALSE null String Boolean Integer 41 . Client side callback to execute when a key is pressed and released over input element. Flag indicating that this component will prevent changes by the user. Client side callback to execute 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 moved onto input element. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a key is pressed down over input element.PrimeFaces User!s Guide Name maxlength onblur onchange Default null null null Integer String String Type 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 is clicked. Client side callback to execute when input element receives focus. Client side callback to execute when a pointer button is moved away from input element. Number of characters used to determine the width of the input element.

popup (default) and inline.date}" mode="popup" /> 42 . Getting Started with Calendar Value of the calendar should be a java. Advisory tooltip informaton.PrimeFaces User!s Guide Name tabindex title Default null null Integer String Type Description Position of the input element in the tabbing order.util. Inline <p:calendar value="#{dateBean.Date.date}"/> public class DateBean { ! ! } private Date date. //Getter and Setter Display Modes Calendar has two main display modes. <p:calendar value="#{dateBean.date}" mode="inline" /> Popup <p:calendar value="#{dateBean.

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

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

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

date}" pattern=”MM/dd/yyyy HH:mm” /> Client Side API Widget: PrimeFaces.date}" mode="inline" ! mindate="07/10/2010" maxdate="07/15/2010"/> Navigator Navigator is an easy way to jump between months/years quickly. <p:calendar value="#{dateBean. <p:calendar value="#{dateBean.widget.date}" mode="inline" navigator="true" /> TimePicker TimePicker functionality is enabled by adding time format to your pattern.PrimeFaces User!s Guide <p:calendar value="#{dateBean.Calendar 46 .

see the main Skinning section for more information 47 .ui-datepicker-buttonpane .ui-datepicker-current .ui-datepicker-next .ui-datepicker td .ui-datepicker-header .PrimeFaces User!s Guide Method getDate() setDate(date) disable() enable() Params date: Date to display - Return Type Date void void void Description Return selected date Sets display date Disables calendar Enables calendar Skinning Calendar resides in a container element which style and styleClass options apply.ui-datepicker-title .ui-datepicker-month . Following is the list of structural style classes. Style Class .ui-datepicker-week-end .ui-datepicker .ui-datepicker-table .ui-datepicker-close 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 Today button Close button Applies As skinning style classes are global.ui-datepicker-other-month .ui-datepicker-prev .

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

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

com/recaptcha/learnmore to learn more about how reCaptcha works. • Enable secure option to support https otherwise browsers will give warnings.captcha. • See http://www.PrimeFaces User!s Guide Themes Captcha features following built-in themes for look and feel customization.google.captcha. Below is a captcha with Turkish text. 50 . Summary Detail primefaces. • • • • red (default) white blackglass clean Themes are applied via the theme attribute.INVALID primefaces. <p:captcha theme="white"/> Languages Text instructions displayed on captcha is customized with the language attribute. Corresponding keys are.INVALID_detail Tips • Use label option to provide readable error messages in case validation fails. <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.

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

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

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

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

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

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

primefaces. when set to false component will not be rendered.primefaces.PrimeFaces User!s Guide 3.primefaces.component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object Getting Started with CellEditor See inline editing section in datatable documentation for more information about usage.CellEditorRenderer org.component org. 57 .celleditor.primefaces.10 CellEditor CellEditor is a helper component of datatable used for incell editing.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class cellEditor org.celleditor.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.component.component.CellEditor org.CellEditor org.

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

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

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

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

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

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

Orientation of bars.component.component.BarChartRenderer org. Title of the chart.BarChart org.bar.PrimeFaces User!s Guide 3.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.bar. Maximum boundary value.chart. valid values are “vertical” and “horizontal”.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org.component.primefaces.11. Margin of bars.BarChart org. Padding of bars.component.chart. binding widgetVar value style styleClass title legendPosition barPadding barMargin orientation stacked min max null null null null null null null 8 10 vertical FALSE null null Object String ChartModel String String String String Integer Integer String Boolean Double Double 64 .chart.primefaces.3 Bar Chart Bar chart visualizes one or more series of data using bars. Position of the legend. Minimum boundary value. Enables stacked display of bars. 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.primefaces.primefaces.component org.chart. Style class of the chart.

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

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

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

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

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

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

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

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” /> 72 . <p:bubbleChart value="#{bean.

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

82.addRecord(new ohlcModel.144.chart.model}" xaxisLabel=”Year” ! ! yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.139.135. OhlcChartSeries(2010.144. ! ! ! ! ! ! ! ! <p:ohlcChart value="#{bean.addRecord(new ohlcModel. OhlcChartSeries(2008.76.124. public class Bean { private OhlcChartModel model.7.model.132.73.OhlcChartModel instance.97)).addRecord(new ohlcModel.129.135. public Bean() { model = new OhlcChartModel().PrimeFaces User!s Guide Getting started with OhlcChart OhlcChart is created with an org.121.135.88. OhlcChartSeries(2012. ohlcModel.addRecord(new } //getter } OhlcChartSeries(2007.addRecord(new ohlcModel.9.53. <p:ohlcChart value="#{bean.5)). OhlcChartSeries(2011.143.primefaces.55.31.139.18.56.142.67.addRecord(new ohlcModel.143.134.57.124.68.135.44)).56.48)).5.140.139.addRecord(new ohlcModel. OhlcChartSeries(2012.122.79.136.46.138. OhlcChartSeries(2009.136.04.140.66.81)).model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” ! ! title=”Ohlc Chart with Candle Stick” /> 74 .139.01.02)).143.4)).123.136.

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

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

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

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

11.PrimeFaces User!s Guide 3. jFreeChart If you like to use static image charts instead of canvas based charts. 79 . Note that static images charts are not rich as PrimeFaces chart components and you need to know about jFreeChart apis to create the charts. 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 uner the hood with support for IE.

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

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

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

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

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

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

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

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

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

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

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

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

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

ui-button-text Button element Button element when icon is not used Label of button Applies As skinning style classes are global.ui-button .widget.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. Style Class . see the main Skinning section for more information. Following is the list of structural style classes.ui-button-text-only . 93 .

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

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

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

Width of the dialog in pixels Width of the dialog in pixels Inline style of the dialog container.component. Message severity for the displayed icon.component. when set to false component will not be rendered.primefaces.PrimeFaces User!s Guide 3.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. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.ConfirmDialog org.confirmdialog.ConfirmDialog org.primefaces. Text for the header.ConfirmDialogRenderer org. Skinning. 97 binding widgetVar message header severity width height style null null null null null auto auto null Object String String String String Integer Integer String . customization and avoiding popup blockers are notable advantages over classic javascript confirmation.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class confirmDialog org.primefaces.confirmdialog.19 ConfirmDialog ConfirmDialog is a replacement to the legacy javascript confirmation box.primefaces.component org. Text to be displayed in body.component.

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

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

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

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

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

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

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

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

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

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

PrimeFaces User!s Guide

3.22 DataExporter
DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel, pdf, csv and xml. Info
Tag Tag Class ActionListener Class dataExporter org.primefaces.component.export.DataExporterTag org.primefaces.component.export.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","pdf","csv", "xml" Id of the datatable whose data to export. Filename of the generated export file, defaults to datatable id. 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. PostProcessor for the exported document. Character encoding to use When enabled, only selection would be exported.

Getting Started with DataExporter DataExporter is nested in a UICommand component such as commandButton or commandLink. For pdf exporting itext and for xls exporting poi libraries are required in the classpath. Target must point to a PrimeFaces Datatable. Assume the table to be exported is defined as;
<p:dataTable id="tableId" ...> ! //columns </p:dataTable>

108

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, if you’d like export only the data displayed on current page, set pageOnly to true.
<p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/>

Excluding Columns In case you need one or more columns to be ignored use exludeColumns option. Exporter below ignores first column, to exclude more than one column define the indexes as a comma separated string (excludeColumns="0,2,6").
<p:dataExporter type="pdf" target="tableId" excludeColumns="0"/>

Monitor Status DataExport is a non-ajax process so ajaxStatus component cannot apply. See FileDownload Monitor Status section to find out how monitor export process. Same solution applies to data export as well.
109

PrimeFaces User!s Guide

Pre and Post Processors Processors are handy to customize the exported document (e.g. add logo, caption ...). PreProcessors are executed before the data is exported and PostProcessors are processed after data is included in the document. Processors are simple java methods taking the document as a parameter. Change Excel Table Header First example of processors changes the background color of the exported excel’s headers.
<h:commandButton value="Export as XLS"> ! <p:dataExporter type="xls" target="tableId" fileName="cars" ! ! ! ! postProcessor="#{bean.postProcessXLS}"/> </h:commandButton>

public void postProcessXLS(Object document) { ! HSSFWorkbook wb = (HSSFWorkbook) document; ! HSSFSheet sheet = wb.getSheetAt(0); ! HSSFRow header = sheet.getRow(0); ! HSSFCellStyle cellStyle = wb.createCellStyle(); ! cellStyle.setFillForegroundColor(HSSFColor.GREEN.index); ! cellStyle.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND); ! ! ! for(int i=0; i < header.getPhysicalNumberOfCells();i++) { ! ! header.getCell(i).setCellStyle(cellStyle); ! } }

Add Logo to PDF This example adds a logo to the PDF before exporting begins.
<h:commandButton value="Export as PDF"> ! <p:dataExporter type="xls" target="tableId" fileName="cars" ! preProcessor="#{bean.preProcessPDF}"/> </h:commandButton>

public void preProcessPDF(Object document) throws IOException, ! ! ! ! BadElementException, DocumentException { ! Document pdf = (Document) document; ! ServletContext servletContext = (ServletContext) FacesContext.getCurrentInstance().getExternalContext().getContext(); ! String logo = servletContext.getRealPath("") + File.separator + "images" + File.separator + "prime_logo.png";! ! pdf.add(Image.getInstance(logo)); }

110

PrimeFaces User!s Guide

3.23 DataGrid
DataGrid displays a collection of data in a grid layout.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class dataGrid org.primefaces.component.datagrid.DataGrid org.primefaces.component.DataGrid org.primefaces.component org.primefaces.component.DataGridRenderer org.primefaces.component.datagrid.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, when set to false component will not be rendered.

111

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

style styleClass rowIndexVar

null null null

String String String

Getting started with the DataGrid A list of cars will be used throughout the datagrid, datalist and datatable examples.
public class Car { ! ! ! ! ! } private private private private ... String model; int year; String manufacturer; String color;

112

PrimeFaces User!s Guide

The code for CarBean that would be used to bind the datagrid to the car list.
public class CarBean { ! ! ! ! ! ! ! ! ! } private List<Car> cars; public ! ! ! } CarBean() { cars = new ArrayList<Car>(); cars.add(new Car("myModel",2005,"ManufacturerX","blue")); //add more cars

public List<Car> getCars() { ! return cars; }

<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12"> ! ! ! ! ! ! <p:column> ! <p:panel header="#{car.model}"> ! <h:panelGrid columns="1"> ! ! <p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/> ! ! ! ! ! ! ! ! ! <h:outputText value="#{car.year}" /> ! ! </h:panelGrid> ! </p:panel> ! </p:column> </p:dataGrid>

This datagrid has 3 columns and 12 rows. As datagrid extends from standard UIData, rows correspond to the number of data to display not the number of rows to render so the actual number of rows to render is rows/columns = 4. As a result datagrid is displayed as;

113

PrimeFaces User!s Guide

Ajax Pagination DataGrid has a built-in paginator that is enabled by setting paginator option to true.
<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12" ! paginator="true">! ! ! ! ! ... </p:dataGrid>

Paginator Template Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls. Note that this section applies to dataGrid, dataList and dataTable. • • • • • • • FirstPageLink LastPageLink PreviousPageLink NextPageLink PageLinks CurrentPageReport RowsPerPageDropDown

Note that {RowsPerPageDropDown} has it’s own template, options to display is provided via rowsPerPageTemplate attribute (e.g. rowsPerPageTemplate="9,12,15"). Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option. You can use {currentPage},{totalPages},{totalRecords},{startRecord},{endRecord} keyword within currentPageReportTemplate. Default is {currentPage} of{totalPages}. Default UI is;

which corresponds to the following template. "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}" Here are more examples based on different templates; " {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropDown}"

" {PreviousPageLink} {CurrentPageReport} {NextPageLink}"

114

PrimeFaces User!s Guide

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

! ! ! ! ! ! ! !

</h:form>

public class CarBean { ! ! ! } private List<Car> cars; private Car selectedCar; //getters and setters

115

PrimeFaces User!s Guide

Client Side API Widget: PrimeFaces.widget.DataGrid
Method getPaginator() Params Return Type Paginator Description Returns the paginator widget.

Skinning DataGrid resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;
Class .ui-datagrid .ui-datagrid-content .ui-datagrid-data .ui-datagrid-row .ui-datagrid-column Main container element Content container. Table element containing data A row in grid A column in grid Applies

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

116

PrimeFaces User!s Guide

3.24 DataList
DataList presents a collection of data in list layout with several display types.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class dataList org.primefaces.component.datalist.DataList org.primefaces.component.DataList.DataListTag org.primefaces.component org.primefaces.component.DataListRenderer org.primefaces.component.datalist.DataListRenderer

Attributes
Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Data to display. Name of the request-scoped variable used to refer each data. Number of rows to display per page. Index of the first row to be displayed Type of the list, valid values are "unordered", "ordered" and "definition".

binding value var rows first type

null null null null 0 unordered

Object Object String Integer Integer String

117

PrimeFaces User!s Guide

Name itemType widgetVar paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible

Default null null FALSE null null null 10 both TRUE

Type String String boolean String String String Integer String Boolean

Description Specifies the list item type. Name of the client side widget. Enables pagination. Template of the paginator. Template of the rowsPerPage dropdown. Template of the currentPageReport UI. Maximum number of page links to display. Position of the paginator. Defines if paginator should be hidden if total data count is less than number of rows per page. Inline style of the main container. Style class of the main container. Name of the iterator to refer each row index.

style styleClass rowIndexVar

null Null null

String String String

Getting started with the DataList Since DataList is a data iteration component, it renders it’s children for each data represented with var option. See itemType section for more information about the possible values.
<p:dataList value="#{carBean.cars}" var="car" itemType="disc"> ! #{car.manufacturer}, #{car.year} </p:dataList>

Ordered Lists DataList displays the data in unordered format by default, if you’d like to use ordered display set type option to "ordered".
<p:dataList value="#{carBean.cars}" var="car" type="ordered"> ! #{car.manufacturer}, #{car.year} </p:dataList>

Item Type itemType defines the bullet type of each item. For ordered lists, following item types are available;
118

PrimeFaces User!s Guide

A

a

i

And for unordered lists, available values are; disc circle square

Definition Lists Third type of dataList is definition lists that display inline description for each item, to use definition list set type option to "definition". Detail content is provided with the facet called "description".
<p:dataList value="#{carBean.cars}" var="car" type="definition"> ! Model: #{car.model}, Year: #{car.year} ! <f:facet name="description"> ! ! <p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/> ! </f:facet> </p:dataList>

119

PrimeFaces User!s Guide

Ajax Pagination DataList has a built-in paginator that is enabled by setting paginator option to true.
<p:dataList value="#{carBean.cars}" var="car" paginator="true" rows="10"> ! #{car.manufacturer}, #{car.year} </p:dataList>

Pagination configuration and usage is same as dataGrid, see pagination section in dataGrid documentation for more information and examples. Selecting Data Data selection can be implemented same as in dataGrid, see selecting data section in dataGrid documentation for more information and examples. Client Side API Widget: PrimeFaces.widget.DataList
Method getPaginator() Params Return Type Paginator Description Returns the paginator widget.

Skinning DataList resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;
Class .ui-datalist .ui-datalist-content .ui-datalist-data .ui-datalist-item Main container element Content container Data container Each item in list Applies

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

120

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

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

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

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

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

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

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

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

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

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

.sales. <p:dataTable var="car" value="#{carBean. define a fixed height in pixels and set a fixed width to each column..cars}" scrollable="true" ! ! ! ! scrollHeight="150"> ! ! ! <p:column style="width:100px" . 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. } Scrolling Scrolling is a way to display data with fixed headers.PrimeFaces User!s Guide public class CarBean { ! ! ! ! ! ! ! } private List<Manufacturer> sales. ! //columns </p:dataTable> 131 .

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

model}"/> </f:facet> </p:cellEditor>! </p:column> //more columns with cell editors <p:column> ! <p:rowEditor /> </p:column> ! ! ! ! ! ! ! </p:dataTable> When pencil icon is clicked. both options are implemented with ajax. Clicking tick icon only saves that particular row and cancel icon reverts the changes.model}" /> </f:facet> <f:facet name="input"> <h:inputText value="#{car.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. 133 . See ajax behavior events section for more information about cell edit event. <p:dataTable var="car" value="#{carBean. p:cellEditor is used to define the cell editor of a particular column and p:rowEditor is used to toggle edit/view displays of a row.PrimeFaces User!s Guide Incell Editing Incell editing provides an easy way to display editable data.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Style class to apply when an acceptable draggable is being dragged.primefaces.27.component. when set to false component will not be rendered.primefaces.primefaces.dnd.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org. Specifies the intersection mode to accept a draggable.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. Selector to define the accepted draggables.PrimeFaces User!s Guide 3. Id of a UIData component to connect with. 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 148 .dnd.Droppable org. Client side callback to execute when a draggable is dropped.component org. Scope key to match draggables and droppables.DroppableRenderer org.primefaces.component.Droppable org.component. An el expression that maps to a server side UIComponent instance in a backing bean Variable name of the client side widget Id of the component to add droppable behavior Disables of enables droppable behavior Style class to apply when an acceptable draggable is dragged over.primefaces.

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

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

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

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

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

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

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

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

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

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

159 . binding effect event type for speed delay null null null null null 1000 null Object String String String String Integer Integer Getting started with Effect Effect component needs a trigger and target which is effect’s parent by default.component.primefaces.Effect org.30 Effect Effect component is based on the jQuery UI effects library.component org.primefaces.effect. 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 User!s Guide 3.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.Effect org.primefaces.EffectRenderer org.component.effect. Info Tag Tag Class Component Class Component Type Component Family Renderer Type Renderer Class effect org.component.primefaces.primefaces.EffectRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.EffectTag org. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.effect.component.

jpg" style="display:none"/> With this setting. Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly. initially hidden graphicImage comes up with a fade effect. When the link is clicked. Use for option to specify a target. outputLink becomes the trigger for the effect on graphicImage. List of Effects Following is the list of effects supported by PrimeFaces.PrimeFaces User!s Guide <h:outputText value="#{bean. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 160 .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. <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.

In order to change the configuration of the animation. duration and more. <h:outputText value="#{bean.com/UI/Effects Effect on Load Effects can also be applied to any JSF component when page is loaded for the first time or after an ajax request is completed by using load as the event name. please see the jquery documentation.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. http://docs. <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. <h:outputText value="#{bean.jquery.action}" update="messages"/> 161 . provide these parameters with the f:param tag. Following example animates messages with pulsate effect after ajax request completes.

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

FieldsetRenderer org. Title text.primefaces.component.component org. Makes content toggleable with animation.Fieldset org.component.32 Fieldset Fieldset is a grouping component as an extension to html fieldset.Fieldset org.PrimeFaces User!s Guide 3.primefaces.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class fieldset org.fieldset. when set to false component will not be rendered. Inline style of the fieldset.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.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.fieldset. Defines initial visibility state of content. Style class of the fieldset.primefaces.component. Toggle duration in milliseconds. 163 binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null null null null null FALSE 500 FALSE Object String String String String Boolean Integer Boolean .

<p:fieldset> ! <f:facet name="legend"> ! </f:facet> ! //content </p:fieldset> When both legend attribute and legend facet are present.jpg" /> ! ! <h:outputText value="The story begins as Don Vito Corleone . Set toggleable to true to enable this feature.. facet is chosen.." /> ! </h:panelGrid> </p:fieldset> 164 .PrimeFaces User!s Guide Getting started with Fieldset Fieldset is used as a container component for its children. this is handy to use space efficiently in a layout. 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="Toggleable Fieldset" toggleable="true"> ! <h:panelGrid column="2"> ! ! <p:graphicImage value="/images/godfather/2. with legend attribute as in example above or using legend facet. <p:fieldset legend="Simple Fieldset"> ! <h:panelGrid column="2"> ! ! <p:graphicImage value="/images/godfather/1.jpg" /> ! ! <h:outputText value="Francis Ford Coppolas’ legendary ." /> ! </h:panelGrid> </p:fieldset> Legend Legend can be defined in two ways...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.879703.add(new LatLng(36. Polygon polygon = new Polygon().add(new LatLng(36.706707)).map.883707.689216)).model.add(new LatLng(36.PrimeFaces User!s Guide public class MapBean { private MapModel model.Polygon.primefaces.model. polyline.381542. polyline.getPaths(). <p:gmap center="41.model.667648)). polyline. polyline.model}"/> 184 . public MapBean() { model = new DefaultMapModel().add(new LatLng(36.add(new LatLng(36. Polygons A polygon is represented by org.model.getPaths(). 30.879466. <p:gmap center="41.map. polyline.879466. model.getPaths().getPaths(). 37.667648)).885233.883707.model}"/> public class MapBean { private MapModel model.height:400px" model="#{mapBean.381542.height:400px" model="#{mapBean. 30. 30. polyline. 30.706707)).getPaths(). polyline.addOverlay(polygon). }! public MapModel getModel() { return this.702323)).getPaths(). } }! ! ! ! ! ! ! ! Circles A circle is represented by org. }! public MapModel getModel() { return this. Polyline polyline = new Polyline().add(new LatLng(36.add(new LatLng(36.getPaths(). 30. } }! ! ! ! ! ! ! ! ! 30.Circle.122893" zoom="15" type="hybrid" ! ! style="width:600px.primefaces. public MapBean() { model = new DefaultMapModel().addOverlay(polyline). 2.122893" zoom="15" type="hybrid" ! ! style="width:600px.689216)). model.879703.

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

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

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

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

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

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

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

when set to false component will not be rendered.primefaces. Info Tag Tag Class Component Class Component Type Component Family gmapInfoWindow org.primefaces.38 GMapInfoWindow GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.primefaces.GMapInfoWindow org.gmap.component.gmap.PrimeFaces User!s Guide 3.primefaces.component.GMapInfoWindowTag org.GMapInfoWindow org.component. 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. 192 .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.

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

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

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

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

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

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

<p:growl sticky="true" /> If growl is not working in sticky mode. Simply place growl anywhere on your page. Note that if you enable autoUpdate. Image of the error messages. Specifies auto update mode. Image of the fatal messages. since messages are displayed as an overlay. the location of growl in JSF page does not matter. Image of the info messages. <p:growl id="messages"/> <p:commandButton value="Submit" update="messages" /> 199 . it’s also possible to tune the duration of displaying messages.PrimeFaces User!s Guide Name warnIcon infoIcon errorIcon fatalIcon autoUpdate null null null null Default Type String String String String Boolean Description Image of the warning messages. FALSE Getting Started with Growl Growl usage is similar to standard h:messages component. <p:growl /> Lifetime of messages By default each message will be displayed for 6000 ms and then hidden. <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. A message can be made sticky meaning it’ll never be hidden automatically. Following growl will display the messages for 5 seconds and then fade-out. growl will be updated automatically with each ajax request anyway.

.ui-growl-message p Applies Main container element of growl Container of messages Container of a message Severity icon Text message container Summary of the message Detail of the message As skinning style classes are global.ui-growl-message .ui-growl-image . see the main Skinning section for more information.PrimeFaces User!s Guide Positioning Growl is positioned at top right corner by default.ui-growl-title .ui-growl-item . Skinning Following is the list of structural style classes.ui-growl-item-container .ui-growl . } With this setting growl will be located at top left corner. position can be controlled with a CSS selector called ui-growl. 200 .ui-growl { ! left:20px. Style Class .

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCompare org.component. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object 206 .primefaces.ImageCompareRenderer org.primefaces.component.component.primefaces.component.PrimeFaces User!s Guide 3. when set to false component will not be rendered.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.ImageCompare org.component org.imagecompare.ImageCompare org.primefaces.imagecompare.primefaces.43 ImageCompare ImageCompare provides a rich user interface to compare two images.

<p:imageCompare leftImage="xbox. 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.png" ! ! ! width="438" height="246"/> Skinning Both images are placed inside a div container element.png" rightImage="ps3. 207 . style and styleClass attributes apply to this element. It is required to set width and height of the images as well.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.

In case it’s a static text. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.ImageCropper org.ImageCropperRenderer org. A new image is created containing the cropped area and assigned to a CroppedImage instanced on the server side.44 ImageCropper ImageCropper allows cropping a certain region of an image. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCropper org.primefaces.component. imagecropper. it’s resolved to a converter instance.PrimeFaces User!s Guide 3.primefaces.ImageCropper org.component.component.primefaces. When it’s an EL expression. it must refer to a converter id binding value converter null null null Object Object Converter/ String 208 .component org.component.primefaces.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.primefaces.imagecropper. when set to false component will not be rendered.

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. Name of the client side widget.PrimeFaces User!s Guide Name immediate Default FALSE Type Boolean Description When set true. Alternate text of the image. Maximum size 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. Context relative path to the image. Message to be displayed when conversion fails. process validations logic is executed at apply request values phase for this component.croppedImage}" image="/campnou. The cropped area of the original image is used to create a new image. Message to be displayed when validation fields.jpg <p:imageCropper value="#{cropper. Minimum size of the cropper area. Assuming the image is at %WEBAPP_ROOT%/campnou. ! ! //getter and setter } 209 . Background opacity of the container Initial coordinates of the cropper area. this new image can be accessed on the backing bean by setting the value attribute of the image cropper. 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. Background color of the container. Aspect ratio of the cropper area.jpg" /> public class Cropper { ! private CroppedImage croppedImage.

200"/> 210 .125"/> Boundaries minSize and maxSize attributes are control to limit the size of the area to crop. 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.300.com. <p:imageCropper value="#{cropper. Action url relative local images are not supported. Initial Coordinates By default.croppedImage}" image="/campnou.y.png. you can specify an initial area to display on page load using initialCoords option in x.jpg" ! ! minSize="50.w. user action is necessary to initiate the cropper area on an image.tr/en/images/schema.croppedImage}" image="/campnou. <p:imageCropper value="#{cropper. <p:imageCropper value="#{cropper.primefaces.h format.75. So to accomplish this simply just add slash ("/path/to/image.100" maxSize="150.model. ImageCropper always requires the image path to be context relative.PrimeFaces User!s Guide org.png"> </p:imageCropper> Context Relative Path For local images. Following table describes CroppedImage properties.prime.jpg" ! ! initialCoords="225.png") and imagecropper will recognize it at %WEBAPP_ROOT%/path/to/image.CroppedImage belongs a PrimeFaces API and contains handy information about the crop process.croppedImage}" ! ! image="http://primefaces.

! ! //getter and setter ! public String crop() { ! ! ServletContext servletContext = (ServletContext) FacesContext. 0. ! ! try { ! ! ! imageOutput = new FileImageOutputStream(new File(newFileName)).getRealPath("") + File.getOriginalFileName() + "cropped.write(croppedImage. ! ! ! imageOutput. ! ! String newFileName = servletContext.jpg".getCurrentInstance().jpg" /> <p:commandButton value="Crop" actionListener="#{myBean.length).separator + "ui" + File.printStackTrace().getExternalContext().separator + "barca" + File.croppedImage}" image="/campnou. ! } } 211 .getBytes().crop}" /> public class Cropper { ! ! private CroppedImage croppedImage.separator+ croppedImage. ! ! } ! ! return null.getContext(). ! ! ! ! FileImageOutputStream imageOutput. ! ! ! imageOutput.PrimeFaces User!s Guide Saving Images Below is an example to save the cropped image to file system. <p:imageCropper value="#{cropper.close(). ! ! } catch (Exception e) { ! ! ! e. croppedImage.getBytes().

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class imageSwitch org.component.primefaces.component.component.primefaces.ImageSwitch org. Style of the main container. when set to false component will not be rendered. Name of the effect for transition.imageswitch.primefaces. Speed of the effect in milliseconds. 212 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. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.ImageSwitchRenderer org. Slideshow speed in milliseconds.ImageSwitch org.45 ImageSwitch Imageswitch component is a simple image gallery component.primefaces.PrimeFaces User!s Guide 3.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.component org. Style class of the main container.component.imageswitch. Starts slideshow automatically on page load.

PrimeFaces User!s Guide Getting Started with ImageSwitch ImageSwitch component needs a set of images to display.jpg" /> ! <p:graphicImage value="/images/nature2. 213 .next(). <p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> ! <p:graphicImage value="/images/nature1. Pauses slideshow mode. <p:imageSwitch widgetVar="imageswitch"> ! <ui:repeat value="#{bean. if you’d like manual transitions disable slideshow and use client side api to create controls. Starts slideshow mode. void toggleSlideShow() Description Switches to previous image. <p:imageSwitch effect="FlyIn" widgetVar="imageswitch"> ! //images </p:imageSwitch> <span onclick="imageswitch. ui:repeat is supported to implement this case. Stops slideshow mode.images}" var="image"> ! ! <p:graphicImage value="#{image}" /> ! </ui:repeat> </p:imageSwitch> Slideshow or Manual ImageSwitch is in slideShow mode by default. Switches to next image.jpg" /> ! <p:graphicImage value="/images/nature4.previous().">Previous</span> <span onclick="imageswitch.jpg" /> </p:imageSwitch> Most of the time. Toggles slideshow mode.">Next</span> Client Side API Method void previous() void next() void startSlideshow() void stopSlideshow() voud pauseSlideshow().jpg" /> ! <p:graphicImage value="/images/nature3. Provide the image collection as a set of children components. images could be dynamic.

PrimeFaces User!s Guide Effect Speed The speed is considered in terms of milliseconds and specified via the speed attribute. Following is the full list. <p:imageSwitch effect="FlipOut" speed="150" widgetVar="imageswitch" > ! //set of images </p:imageSwitch> List of Effects ImageSwitch supports a wide range of transition effects. • • • • • • • • • • • • • • • • • • • • • • • • • • • 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 214 . note that values are case sensitive.

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

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

! //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.handleSave}" update="msgs" /> ! <h:inputText value="#{inplaceBean.widget.Inplace Method show() hide() Params Return Type void void Description Shows content and hides display element.PrimeFaces User!s Guide Ajax Behavior Events Inplace editing is enabled via editor option.text}" /> </p:inplace> <p:growl id="msgs" /> Client Side API Widget: PrimeFaces. public class InplaceBean { ! ! private String text. Shows display element and hides content. ! ! ! ! } public void handleSave() { ! //add faces message with update text value } //getter-setter <p:inplace editor="true"> ! <p:ajax event="save" listener="#{inplaceBean. public class InplaceBean { ! ! private String text. 217 .

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

An el expression that maps to a server side UIComponent instance in a backing bean Mask template PlaceHolder in mask template.primefaces.component. when set to false component will not be rendered. 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 219 .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.InputMask org.47 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.InputMask org.component org.primefaces.InputMaskRenderer org.component.inputmask.component.primefaces.component.inputmask.primefaces.PrimeFaces User!s Guide 3.primefaces.

PrimeFaces User!s Guide Name converter Default null Type Converter/ String Description An el expression or a literal text that defines a converter for the component. In case it’s a static text. Client side callback to execute when input element loses focus. Controls browser autocomplete behavior. Valid values are LTR and RTL. Disables input field A localized user presentable name. it’s resolved to a converter instance. 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. Code describing the language used in the generated markup for this component. 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 220 . Client side callback to execute when input element is clicked. Access key that when pressed transfers focus to the input element. Client side callback to execute when input element is double clicked. When it’s an EL expression. Alternate textual description of the input field. Message to be displayed when conversion fails. Maximum number of characters that may be entered in this field. it must refer to a converter id When set true. Direction indication for text that does not inherit directionality. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Message to be displayed when validation fields. Name of the client side widget.

Advisory tooltip informaton. Inline style of the input element. Client side callback to execute when a pointer button is released over input element.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 pointer button is moved onto input element.field}" mask="99/99/9999" /> Mask Samples Here are more samples based on different masks. Client side callback to execute when a key is pressed down over input element. 221 . 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. Position of the input element in the tabbing order. Getting Started with InputMask InputMask below enforces input to be in 99/99/9999 date format. Flag indicating that this component will prevent changes by the user. Client side callback to execute when text within input element is selected by user. 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 and released over input element. Number of characters used to determine the width of the input element. <p:inputMask value="#{bean.

PrimeFaces User!s Guide <h:outputText value="Phone: " /> <p:inputMask value="#{bean. As skinning style classes are global.phoneExt}" mask="(999) 999-9999? x99999"/> ! ! ! ! ! ! <h:outputText value="SSN: " /> <p:inputMask value="#{bean. 222 . see the main Skinning section for more information.ssn}" mask="999-99-9999"/> ! ! ! ! ! ! <h:outputText value="Product Key: " /> <p:inputMask value="#{bean.phone}" mask="(999) 999-9999"/> ! ! ! ! ! ! <h:outputText value="Phone with Ext: " /> <p:inputMask value="#{bean.productKey}" mask="a*-999-a999"/> Skinning style and styleClass options apply to the displayed input element.

component. it’s resolved to a converter instance.primefaces.component.InputText org.InputTextRenderer org. When it’s an EL expression.InputText org.inputtext.component org. when set to false component will not be rendered. 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.inputtext. it must refer to a converter id When set true.component.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces. In case it’s a static text.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.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputText org.component.48 InputText InputText is an extension to standard inputText with skinning capabilities. 223 immediate required validator valueChangeListener requiredMessage FALSE FALSE null null null Boolean Boolean Method Expr Method Expr String .PrimeFaces User!s Guide 3. process validations logic is executed at apply request values phase for this component.primefaces.

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

Flag indicating that this component will prevent changes by the user.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. Input field type. Number of characters used to determine the width of the input element. Getting Started with InputText InputText usage is same as standard inputText. Advisory tooltip informaton. <p:inputText value="#{bean. As skinning style classes are global. Style class of the input element.propertyName}" /> public class Bean { ! ! private String propertyName. Client side callback to execute when a pointer button is released over input element. Position of the input element in the tabbing order. see the main Skinning section for more information. Client side callback to execute when text within input element is selected by user. ! } //getter and setter Skinning style and styleClass options apply to the input element. Inline style of the input element. 225 .

component.49 InputTextarea InputTextarea is an extension to standard inputTextara with skinning capabilities and auto growing. When it’s an EL expression.component org.component. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.InputTextarea org. it’s resolved to a converter instance.component. it must refer to a converter id When set true.InputTextarea org. when set to false component will not be rendered.primefaces.component.primefaces. In case it’s a static text.InputTextareaRenderer org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputTextarea org.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.primefaces.primefaces. Marks component as required A method binding expression that refers to a method validationg the input 226 immediate required validator FALSE FALSE null Boolean Boolean Method Expr .PrimeFaces User!s Guide 3.inputtextarea.inputtextarea.primefaces. process validations logic is executed at apply request values phase for this component.

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

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

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

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

Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when a key is released over input element. Client side callback to execute when input element is clicked. 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 released over input element. 231 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 . Client side callback to execute when input element is double clicked. Position of the input element in the tabbing order. Client side callback to execute when input element receives focus. Style class of the input element. Client side callback to execute when a pointer button is moved onto input element. Advisory tooltip informaton. Number of characters used to determine the width of the input element. Flag indicating that this component will prevent changes by the user. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a key is pressed down over input element.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 a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Inline style of the input element. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when input element loses focus.

value}" /> Built-in Layouts There’re a couple of built-in keyboard layouts these are ‘qwerty’.value}" ! layout="custom" ! layoutTemplate="prime-back. For example keyboard below has the alphabetic layout. by default when the input gets the focus a keyboard is displayed. <p:keyboard value="#{bean. <p:keyboard value="#{bean. ‘qwertyBasic’ and ‘alphabetic’. <p:keyboard value="#{bean. Getting Started with Keyboard Keyboard is used just like a simple inputText.value}" layout="alphabetic"/> Custom Layouts Keyboard has a very flexible layout mechanism allowing you to come up with your own layout.rocks-close"/> Another example. 232 .PrimeFaces User!s Guide Name widgetVar Default null Type String Description Name of the client side widget.faces-clear.

when the button is clicked the keyboard is shown. • • • • • • • 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".value}" ! layout="custom" ! layoutTemplate="create-space-your-close. if you only need the numbers use the keypad mode. ‘both’. Keypad By default keyboard displays whole keys.owntemplate-shift.value}" showMode="button"/> Button can also be customized using the buttonImage and buttonImageOnly attributes. 233 . This is customized using the showMode feature which accept values ‘focus’. ‘button’. Keyboard below displays a button next to the input field.value}" keypadOnly="true"/> ShowMode There’re a couple of different ways to display the keyboard. <p:keyboard value="#{bean.easily-spacespacebar"/> A layout template basically consists of built-in keys and your own keys.PrimeFaces User!s Guide <p:keyboard value="#{bean. by default keyboard is shown once input field receives the focus. Following is the list of all built-in keys. <p:keyboard value="#{bean. Use dash to seperate each member in layout and use commas to create a new row.

component. Specifies whether layout should span all page or not.component org.primefaces.PrimeFaces User!s Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class layout org.51 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.primefaces.Layout org.layout.layout.component. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.Layout org.primefaces. when set to false component will not be rendered.primefaces.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.component. 234 .component.primefaces.LayoutRenderer org.

Client side callback to execute when a layout unit is toggled. you can either use it for a full page layout or for a specific region in your page. Title label of the collapse button. following is a simple full page layout with all possible units. this is only applicable to element based layouts. Title label of the close button. this is only applicable to element based layouts. Full Page Layout Layout has two modes. Style class to apply to container element. This model is visualized in the schema below. Title label of the expand button. left. Title label of the resize button. 235 . Client side callback to execute when a layout unit is resized. This setting is controlled with the fullPage attribute which is false by default. The regions in a layout are defined by layoutUnits. Getting started with Layout Layout is based on a borderLayout model that consists of 5 different layout units which are top. Client side callback to execute when a layout unit is closed.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. center. right and bottom. Note that you can place any content in each layout unit.

This is the default case actually so just ignore fullPage attribute or set it to false. <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." /> ! </p:layoutUnit> ! <p:layoutUnit position="south" size="100"> ! ! <h:outputText value="Bottom content.PrimeFaces User!s Guide <p:layout fullPage="true"> ! <p:layoutUnit position="north" size="50"> ! ! <h:outputText value="Top content. also avoid trying to update layout units because of same reason. Layout example below demonstrates creating a split panel implementation. Element based layout Another use case of layout is the element based layout." /> ! </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. 236 . So following is invalid. Dimensions Except center layoutUnit. update it’s content instead. other layout units must have dimensions defined via size option.

Style Class .CloseEvent org.event.ui-layout-doc .event. When a unit is closed.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.primefaces. By binding this persisted information to the collapsed attribute of the layout unit layout will be rendered as the user left it last time.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> </p:layout> Ajax Behavior Events Layout provides custom ajax behavior events for each layout state change. Event toggle close resize Listener Parameter org.ResizeEvent Fired When a unit is expanded or collapsed.primefaces.ToggleEvent org.event. When a unit is resized. For example if a layout unit is collapsed. 237 . Skinning Following is the list of structural style classes.PrimeFaces User!s Guide <p:layout style="width:400px. you can update this data using ajax event listeners provided by layout.ui-layout-unit .ui-layout . Stateful Layout Making layout stateful would be easy.ui-layout-{position} .primefaces. once you create your data to store the user preference. see the main Skinning section for more information.ui-layout-unit-header . you can save and persist this information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.PrimeFaces User!s Guide 3. Boolean value to specify the rendering of the component.component.component.Menubar org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menubar org.Menubar org. when set to false component will not be rendered.primefaces.primefaces. 253 .MenubarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.primefaces.57 Menubar Menubar is a horizontal navigation component.component.component.menubar.MenubarRenderer org.menubar.primefaces. Name of the client side widget MenuModel instance to create menus programmatically Inline style of menubar Style class of menubar binding widgetVar model style styleClass null null null null null Object String MenuModel String String Getting started with Menubar Submenus and menuitems as child components are required to compose the menubar.component org. An el expression that maps to a server side UIComponent instance in a backing bean.

<p:menubar> ! //submenus ! <p:menuitem label="Logout" action="#{bean.yahoo.google.hotmail.com" /> ! </p:submenu> ! <p:submenu label="Videos"> ! ! <p:menuitem value="Youtube" url="http://www.com" /> ! ! <p:menuitem value="Hotmail" url="http://www.com" /> ! ! <p:menuitem value="Yahoo Mail" url="http://mail.PrimeFaces User!s Guide <p:menubar> ! <p:submenu label="Mail"> ! ! <p:menuitem value="Gmail" url="http://www.youtube. nest submenus in parent submenus.logout}"/> </p:menubar> 254 . <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. Following example allows a root menubar item to execute an action to logout the user.com" /> ! ! <p:menuitem value="Break" url="http://www.break.com" /> ! </p:submenu> </p:menubar> Nested Menus To create a menubar with a higher depth.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces User!s Guide 3.component.panelgrid.primefaces.primefaces.component.primefaces.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean 279 binding null Object .component.component org.PanelGridRenderer org.67 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.PanelGrid org.primefaces.PanelGridRenderer org.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org. when set to false component will not be rendered.

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

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

when set to false component will not be rendered.Password org.component.68 Password Password component is an extended version of standard inputSecret component with theme integration and strength indicator. process validations logic is executed at apply request values phase for this component. it’s resolved to a converter instance.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.Password org. 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 MethodBinding 282 .component.PasswordRenderer org.password.component.password.PrimeFaces User!s Guide 3.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class password org. In case it’s a static text.component org.component.primefaces.primefaces. it must refer to a converter id When set true.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 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.

Minimum length of a strong password Displays feedback inline rather than using a popup. Code describing the language used in the generated markup for this component. Alternate textual description of the input field. Javascript event handler to be executed when password strength indicator is hidden. Label of weak password. Javascript event handler to be executed when password strength indicator is shown. Message to be displayed when validation fields. Label of strong password. level weakLabel goodLabel strongLabel onshow onhide redisplay match widgetVar accesskey alt autocomplete dir disabled label lang Integer String String String String String Boolean String String String String String String Boolean String String Level of security. Message to be displayed when conversion fails. Controls browser autocomplete behavior. Label of prompt. Access key that when pressed transfers focus to the input element. Disables input field A localized user presentable name. Name of the client side widget. Direction indication for text that does not inherit directionality. Whether or not to display previous value. Enables strength indicator. 283 .PrimeFaces User!s Guide Name valueChangeListener requiredMessage converterMessage validatorMessage feedback minLength inline promptLabel Default null null null null FALSE 8 FALSE Please enter a password 1 Weak Good String null null FALSE null null null null null null FALSE null null Type MethodExpr String String String Boolean Integer boolean String Description A method binding expression that refers to a method for handling a valuechangeevent Message to be displayed when required field validation fails. Label of good password. Valid values are LTR and RTL.

Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when input element is double clicked. Client side callback to execute when a pointer button is released over input element. Position of the input element in the tabbing order. Advisory tooltip informaton. Inline style of the input element. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a key is released over input element. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when a pointer button is moved onto input element. Style class of the input element. Client side callback to execute when input element is clicked.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 a key is pressed and released over input element. Number of characters used to determine the width of the input element. Client side callback to execute when input element receives focus. Flag indicating that this component will prevent changes by the user. Client side callback to execute when text within input element is selected by user. 284 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 . Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element loses focus.

you can provide custom labels as well. public String getPassword() { return password.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.password = password. <p:password value="#{bean. Following password gives feedback in Turkish. when enabled (default) a password strength indicator is displayed. if you prefer an inline indicator just enable inline mode.password}" promptLabel="Lütfen "ifre giriniz" ! weakLabel="Zayıf" goodLabel="Orta seviye" strongLabel="Güçlü" /> Inline Strength Indicator By default strength indicator is shown in an overlay.password}" inline="true"/> Custom Animations Using onshow and onhide callbacks. 285 . <p:password value="#{mybean.password}" feedback="true|false" /> public class Bean { ! ! ! ! } private String password.} I18N Although all labels are in English by default. <p:password value="#{bean. Most important attribute is feedback. you can create your own animation as well. disabling feedback option will make password component behave like standard inputSecret.

fadeIn("slow"). ! } </script> Confirmation Password confirmation is a common case and password provides an easy way to implement. Feedback text of strength indicator.password6}" feedback="false" ! match="pwd2" label="Password 1" required="true"/> <p:password id="pwd2" value="#{passwordBean.fadeOut("slow"). <p:password id="pwd1" value="#{passwordBean. Visual bar of strength indicator. <script type="text/javascript"> ! function fadein(input. container) { ! ! container. Name .password6}" feedback="false" ! label="Password 2" required="true"/> Skinning Password Skinning selectors for password is as follows. input and container. input is the actual input element of password and container is the strength indicator element.jpassword . 286 .jpassword-meter . ! } ! function fadeout(input.PrimeFaces User!s Guide <p:password value="#{mybean.jpassword-info Applies Container element of strength indicator. Each callback takes two parameters. The other password component’s id should be used to define the match option.password}" inline="true" ! onshow="fadein" onhide="fadeout"/> This examples uses jQuery api for fadeIn and fadeOut effects. container) { ! ! container.

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:progressBar widgetVar="pb" /> <p:commandButton value="Start" type="button" onclick="start()" /> <p:commandButton value="Cancel" type="button" onclick="cancel()" /> <script type="text/javascript"> ! function start() { ! ! this. //getter and setter 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.getValue() + 10).progressInterval = setInterval(function(){ ! ! ! pb.setValue(pbClient.progressInterval). ! ! }. In order to set a different value. in this case the value defined on a managed bean is retrieved peridically and used to update the progress. ! ! pb. "client"(default) or "ajax". <p:progressBar interval="5000" /> 300 .setValue(0). <p:progressBar ajax="true" value="#{progressBean. use the interval attribute. ! } </script> Ajax Progress Ajax mode is enabled by setting ajax attribute to true. 2000).PrimeFaces User!s Guide Getting started with the ProgressBar ProgressBar has two modes. Following is a pure client side progressBar.progress}" /> public class ProgressBean { ! ! } private int progress. ! } ! ! function cancel() { ! ! clearInterval(this.

Style Class . public class ProgressBean { ! ! ! ! ! } private int progress.PrimeFaces User!s Guide Ajax Behavior Events ProgressBar provides complete as the default and only ajax behavior event that is fired when the progress is completed. Following is the list of structural style classes. public void handleComplete() { ! //Add a faces message } //getter-setter <p:progressBar value="#{progressBean.ui-progressbar-value Applies Main container element of progressbar Value of the progressbar As skinning style classes are global. Example below demonstrates how to use this event. 301 .ui-progressbar .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 Skinning ProgressBar resides in a main container which style and styleClass attributes apply. see the main Skinning section for more information.progress}" ajax="true"> ! <p:ajax event="complete" listener="#{progressBean.widget.handleComplete}" ! ! ! update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces.

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

component. Id of the selectOneRadio to attach to.radiobutton.RadioButtonRenderer org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Disabled the component.primefaces.component.75 RadioButton RadioButton is a helper component of SelectOneRadio to implement custom layouts. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class radioButton org.component. when set to false component will not be rendered.RadioButton org. binding disabled itemIndex onchange for style styleClass null FALSE null null null null null Object Boolean Integer String String String String Getting started with RadioButton See custom layout part in SelectOneRadio section for more information.radiobutton. Client side callback to execute on state change.primefaces. Inline style of the component.primefaces.component.RadioButton org. 303 . Style class of the container.component org.PrimeFaces User!s Guide 3.primefaces. Index of the selectItem of selectOneRadio.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.

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

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

PrimeFaces User!s Guide

Ajax Behavior Events Rating provides default and only rate event as an ajax behavior. A defined listener will be executed by passing an org.primefaces.event.RateEvent as a parameter.
<p:rating value="#{ratingBean.rating}"> ! <p:ajax event="rate" listener="#{ratingBean.handleRate}" update="msgs" /> </p:rating> <p:messages id="msgs" />

public class RatingBean { ! ! ! ! ! ! ! } private double rating; public void handleRate(RateEvent rateEvent) { ! int rating = (int) rateEvent.getRating();! ! //Add facesmessage } //getter-setter

Client Side API Widget: PrimeFaces.widget.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. Disables component. Enables component.

Skinning Following is the list of css classes for star rating;
Style Class .star-rating-control .rating-cancel .star-rating .star-rating-on .star-rating-hover Applies Main container element of progressbar Value of the progressbar Default star Active star Hover star
306

PrimeFaces User!s Guide

3.77 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.primefaces.component.remotecommand.RemoteCommand org.primefaces.component.RemoteCommand org.primefaces.component org.primefaces.component.RemoteCommandRenderer org.primefaces.component.remotecommand.RemoteCommandRenderer

Attributes
Name id rendered binding action actionListener immediate Default null TRUE null null null FALSE Type String Boolea Object MethodExpr MethodExpr Boolean Description Unique identifier of the component. 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 A method expression that’d be processed in the partial request caused by uiajax. An actionlistener that’d be processed in the partial request caused by uiajax. Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase. Name of the command When set to true, ajax requests are not queued. Component(s) to process partially instead of whole view. Component(s) to update with ajax. Javascript handler to execute before ajax request is begins. Javascript handler to execute when ajax request is completed. Javascript handler to execute when ajax request succeeds. Javascript handler to execute when ajax request fails.
307

name async process update onstart oncomplete onsuccess onerror

null FALSE null null null null null null

String Boolean String String String String String String

PrimeFaces User!s Guide

Name global autoRun

Default TRUE FALSE

Type Boolean Boolean

Description Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. When enabled command is executed on page load.

Getting started with RemoteCommand RemoteCommand is used by invoking the command from your javascript code.
<p:remoteCommand name="increment" actionListener="#{counter.increment}" ! out="count" /> <h:outputText id="count" value="#{counter.count}" />

<script type="text/javascript"> ! function customfunction() { ! ! //your custom code ! ! ! } </script> increment();!! //makes a remote call

That’s it whenever you execute your custom javascript function(eg customfunction()), a remote call will be made, 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;
increment({param1:’val1’, param2:’val2’});

Run on Load If you’d like to run the command on page load, set autoRun to true.

308

PrimeFaces User!s Guide

3.78 Resizable
Resizable component is used to make another JSF component resizable. Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class resizable org.primefaces.component.resizable.Resizable org.primefaces.component.Resizable org.primefaces.component org.primefaces.component.ResizableRenderer org.primefaces.component.resizable.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, 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. Identifier of the target component to make resizable. Defines if aspectRatio should be kept or not. Displays proxy element instead of actual element. Specifies the resize handles. In ghost mode, resize helper is displayed as the original element with less opacity. Enables animation. Effect to use in animation. Effect duration of animation. Maximum width boundary in pixels. Maximum height boundary in pixels. Minimum width boundary in pixels. Maximum height boundary in pixels.
309

PrimeFaces User!s Guide

Name containment grid onStart onResize onStop

Default FALSE 1 null null null

Type Boolean Integer String String String

Description Sets resizable boundaries as the parents size. Snaps resizing to grid structure. Client side callback to execute when resizing begins. Client side callback to execute during resizing. Client side callback to execute after resizing end.

Getting started with Resizable Resizable is used by setting for option as the identifier of the target.
<p:graphicImage id="img" value="campnou.jpg" /> <p:resizable for="img" />

Another example is the input fields, if users need more space for a textarea, make it resizable by;
<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, boundaries need to be specified. There’re 4 attributes for this minWidth, maxWidth, minHeight and maxHeight. 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" minWidth="20" minHeight="40" maxWidth="50" maxHeight="100"/>

Handles Resize handles to display are customize using handles attribute with a combination of n, e, s, w, ne, se, sw and nw as the value. Default value is "e, s, se".
<h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" handles="e,w,n,se,sw,ne,nw"/>

310

PrimeFaces User!s Guide

Visual Feedback Resize helper is the element used to provide visual feedback during resizing. By default actual element itself is the helper and two options are available to customize the way feedback is provided. Enabling ghost option displays the element itself with a lower opacity, in addition enabling proxy option adds a css class called .ui-resizable-proxy which you can override to customize.
<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; }

Effects Resizing can be animated using animate option and setting an effect name. Animation speed is customized using effectDuration option "slow", "normal" and "fast" as valid values.
<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;
• • • • • • • 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. In case you have a listener defined, it will be called by passing an org.primefaces.event.ResizeEvent instance as a parameter.
<h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area"> <p:ajax listener="#{resizeBean.handleResize}"> </p:resizable>

!

311

PrimeFaces User!s Guide

public class ResizeBean { ! ! ! ! } public void handleResize(ResizeEvent event) { ! int width = event.getWidth(); ! int height = event.getHeight(); }

Client Side Callbacks Resizable has three client side callbacks you can use to hook-in your javascript; onStart, onResize and onStop. All of these callbacks receive two parameters that provide various information about resize event.
<h:inputTextarea id="area" value="Resize me if you need more space" /> <p:resizable for="area" onStop="handleStop(event, ui)" />

function handleStop(event, ui) { ! //ui.helper = helper element as a jQuery object ! //ui.originalPosition = top, left position before resizing ! //ui.originalSize = width, height before resizing ! //ui.positon = top, left after resizing ! //ui.size = width height of current size }

Skinning
Style Class .ui-resizable .ui-resizable-handle .ui-resizable-handle-{handlekey} .ui-resizable-proxy Element that is resizable Handle element Particular handle element identified by handlekey like e, s, ne Proxy helper element for visual feedback Applies

312

PrimeFaces User!s Guide

3.79 Ring
Ring is a data display component with a circular animation.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class ring org.primefaces.component.ring.Ring org.primefaces.component.Ring org.primefaces.component org.primefaces.component.RingRenderer org.primefaces.component.ring.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, 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. Collection to display. Name of the data iterator. Inline style of the container element. Style class of the container element. Type of easing to use in animation.

binding widgetVar value var style styleClass easing

null null null null null null swing

Object String Object String String String String

313

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

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

when set to false component will not be rendered.component.primefaces.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.primefaces.component. 316 .row. 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.PrimeFaces User!s Guide 3.primefaces. Info Tag Component Class Component Type Component Family row org.80 Row Row is a helper component for datatable.Row org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

it’s resolved to a converter instance.SelectCheckboxMenuRenderer org.selectcheckboxmenu.component. In case it’s a static text. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List.component.primefaces.primefaces.primefaces. process validations logic is executed at apply request values phase for this component.SelectCheckboxMenuRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectCheckboxMenu org. 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.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 334 .PrimeFaces User!s Guide 3.component. When it’s an EL expression.88 SelectChecboxMenu SelectCheckboxMenu is a multi select component that displays options in an overlay.primefaces.SelectCheckboxMenu org.component org.selectcheckboxmenu.SelectCheckboxMenu org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. Inline style of the component. Layout of the checkboxes.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. PrimeFaces SelectOneMenu on the other hand provides a flexible layout option so that radio buttons can be located anywhere on the page. Note that in custom mode. Name of the client side widget. <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> 351 . valid values are “lineDirection”(horizontal) and “pageDirection”(vertical). Disables the component. Style class of the container. selectOneRadio itself does not render any output. Custom Layout Standard selectOneRadio component only supports horizontal and vertical rendering of the radio buttons with a strict table markup. Callback to execute on value change. Message to be displayed when validation fields. User presentable name.

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

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

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

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

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

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

primefaces. display modes and skinning.Slider org.component org.98 Slider Slider is used to provide input with various customization options like orientation.Slider org. 358 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 .component. Fixed pixel increments that the slider move in Disables or enables the slider. 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.primefaces. when set to false component will not be rendered.slider.primefaces.primefaces.component.component.slider. "horizontal" or "vertical". An el expression that maps to a server side UIComponent instance in a backing bean Id of the input text that the slider will be used for Id of the component to display the slider value.SliderRenderer org.PrimeFaces User!s Guide 3.primefaces.SliderRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class slider org.

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

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

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

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

spacer.primefaces.component org. Height of the space.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class spacer org.component. Style class of the spacer.primefaces. Width of the space. 363 .spacer.Spacer org.component.Spacer org.99 Spacer Spacer is used to put spaces between elements.PrimeFaces User!s Guide 3. 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. An el expression that maps to a server side UIComponent instance in a backing bean Advisory tooltip informaton. Spacer in this example separates this text <p:spacer width="100" height="10"> and ! ! <p:spacer width="100" height="10"> this text.SpacerRenderer org.component.primefaces.component.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. when set to false component will not be rendered. Inline style of the spacer.

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

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

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

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

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

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.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.Submenu org. An el expression that maps to a server side UIComponent instance in a backing bean.Submenu org. Label of the submenu header.primefaces. Icon of a submenu.component. Info Tag Component Class Component Type Component Family submenu org. Style class of the submenu. Boolean value to specify the rendering of the component.primefaces.PrimeFaces User!s Guide 3.primefaces. 369 .submenu.component. see menuitem to see how it is used Inline style of the submenu.101 Submenu Submenu is nested in menu components and represents a sub menu items.

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

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

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

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

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

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

PrimeFaces User!s Guide

Name cache

Default TRUE

Type Boolean

Description When tab contents are lazy loaded by ajax toggleMode, caching only retrieves the tab contents once and subsequent toggles of a cached tab does not communicate with server. If caching is turned off, tab contents are reloaded from server each time tab is clicked. Client side callback to execute when a tab is clicked. Client side callback to execute when a tab is shown. Inline style of the main container. Style class of the main container. Name of iterator to refer an item in collection. Collection model to display dynamic tabs. Orientation of tab headers.

onTabChange onTabShow style styleClass var value orientation

null null null null null null top

String String String String String Object String

Getting started with the TabView TabView requires one more child tab components to display.
<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, non-dynamic (default) and dynamic. By default, all tab contents are rendered to the client, on the other hand in dynamic mode, only the active tab contents are rendered and when an inactive tab header is selected, content is loaded with ajax. Dynamic mode is handy in reducing page size, since inactive tabs are lazy loaded, pages will load faster. To enable dynamic loading, simply set dynamic option to true.

376

PrimeFaces User!s Guide
<p:tabView dynamic="true"> ! //tabs </p:tabView>

Content Caching Dynamically loaded tabs cache their contents by default, by doing so, reactivating a tab doesn’t result in an ajax request since contents are cached. If you want to reload content of a tab each time a tab is selected, turn off caching by cache to false. Effects Content transition effects are controlled with effect and effectDuration attributes. EffectDuration specifies the speed of the effect, slow, normal (default) and fast are the valid options.
<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. Here is an example of a tabChange behavior implementation;
<p:tabView> ! <p:ajax event=”tabChange” listener=”#{bean.onChange}” /> ! //tabs </p:tabView>

public void onChange(TabChangeEvent event) { ! //Tab activeTab = event.getTab(); ! //... }

Your listener(if defined) will be invoked with an org.primefaces.event.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself. For tabClose event, listener will be passed an instance of org.primefaces.event.TabCloseEvent.

377

PrimeFaces User!s Guide

Dynamic Number of Tabs When the tabs to display are not static, use the built-in iteration feature similar to ui:repeat.
<p:tabView value="#{bean.list}" var="listItem"> ! <p:tab title="#{listItem.propertyA}"> ! ! <h:outputText value= "#{listItem.propertyB}"/> ! ! ...More content ! </p:tab> </p:tabView>

Orientations Tabview supports four different orientations mode, top(default), left, right and bottom.
<p:tabView orientation="left"> ! //tabs </p:tabView>!

Client Side Callbacks Tabview has two callbacks for client side. onTabChange is executed when an inactive tab is clicked and onTabShow is executed when an inactive tab becomes active to be shown.
<p:tabView onTabChange="handleTabChange(event, index)"> ! //tabs </p:tabView> function handleTabChange(index) { ! //index = Index of the new tab }!

378

PrimeFaces User!s Guide

Client Side API Widget: PrimeFaces.widget.TabView.
Method select(index) selectTab(index) Params index: Index of tab to display index: Index of tab to display Return Type void void Description Activates tab with given index (Deprecated, use select instead) Activates tab with given index Disables tab with given index Enables tab with given index Removes tab with given index Returns the number of tabs Returns index of current tab

disable(index) enable(index) remove(index) getLength() getActiveIndex()

index: Index of tab to disable index: Index of tab to enable index: Index of tab to remove -

void void void Number Number

Skinning As skinning style classes are global, see the main Skinning section for more information. Following is the list of structural style classes.
Class .ui-tabs .ui-tabs-nav .ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container

379

PrimeFaces User!s Guide

3.107 TagCloud
TagCloud displays a collection of tag with different strengths.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class tagCloud org.primefaces.component.tagcloud.TagCloud org.primefaces.component.TagCloud org.primefaces.component org.primefaces.component.TagCloudRenderer org.primefaces.component.tagcloud.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, 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. Backing tag cloud model. Inline style of the container element. Style class of the container element.

binding widgetVar model style styleClass

null null null null null

Object String TagCloudModel String String

Getting started with the TagCloud TagCloud requires a backend TagCloud model to display.
<p:tagCloud model="#{timelineBean.model}" />

380

PrimeFaces User!s Guide
public class TagCloudBean { private TagCloudModel model; public TagCloudBean() { model = new DefaultTagCloudModel(); model.addTag(new DefaultTagCloudItem("Transformers", "#", 1)); //more } //getter }

!

TagCloud API org.primefaces.model.tagcloud.TagCloudModel
Method List<TagCLoudItem> getTags() void addTag(TagCloudItem item) void removeTag(TagCloudItem item) void clear() Returns all tags in model. Adds a tag. Removes a tag. Removes all tags. Description

PrimeFaces provides org.primefaces.model.tagcloud.DefaultTagCloudModel as the default implementation. org.primefaces.model.tagcloud.TagCloudItem
Method String getLabel() String getUrl() int getStrength() Returns label of the tag. Returns url of the tag. Returns strength of the tag between 1 and 5. Description

PrimeFaces provides org.primefaces.model.tagcloud.DefaultTagCloudItem as the default implementation. Skinning TagCloud resides in a container element that style and styleClass attributes apply. .ui-tagcloud applies to main container and .ui-tagcloud-strength-[1,5] applies to each tag. As skinning style classes are global, see the main Skinning section for more information.

381

PrimeFaces User!s Guide

3.108 Terminal
Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.primefaces.component.terminal.Terminal org.primefaces.component.Terminal org.primefaces.component org.primefaces.component.TerminalRenderer org.primefaces.component.terminal.TerminalRenderer

Attributes
Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load. Primary prompt text.
382

binding width height welcomeMessage prompt

null null null null prime $

Object String String String String

PrimeFaces User!s Guide

Name commandHandler widgetVar

Default null null

Type MethodExpr String

Description Method to be called with arguments to process. Name of the client side widget.

Getting started with the Terminal A command handler is necessary to interpret commands entered in terminal.
<p:terminal commandHandler="#{terminalBean.handleCommand}" />

public class TerminalBean { ! ! ! ! ! ! ! ! } public String handleCommand(String command, String[] params) { ! if(command.equals("greet")) ! ! return "Hello " + params[0]; ! else if(command.equals("date")) ! ! return new Date().toString(); ! else ! ! return command + " not found"; }

Whenever a command is sent to the server, handleCommand method is invoked with the command name and the command arguments as a String array. Focus To add focus on terminal, use client side api, following example shows how to add focus on a terminal nested inside a dialog;
<p:commandButton type="Show Terminal" type="button" ! ! onclick="dlg.show();term.focus();"/> <p:dialog widgetVar="dlg" width="600" height="400" header="Terminal"> <p:terminal widgetVar="term" ! ! ! commandHandler="#{terminalBean.handleCommand}" width="590px" /> </p:dialog>

383

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

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

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

ui-toolbar . see the main Skinning section for more information. Style Class .ui-toolbar .PrimeFaces User!s Guide Any number of components can be placed inside toolbarGroups.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. 387 . <p:toolbar> ! <p:toolbarGroup align="left"> ! ! <p:commandButton type="push" value="New" image="ui-icon-document" /> ! ! <p:commandButton type="push" value="Open" image="ui-icon-folder-open"/> ! ! ! ! ! ! ! <p:separator /> ! <p:commandButton type="push" title="Save" image="ui-icon-disk"/> ! <p:commandButton type="push" title="Delete" image="ui-icon-trash"/> ! <p:commandButton type="push" title="Print" image="ui-icon-print"/> </p:toolbarGroup> <p:divider /> ! <p:toolbarGroup align="right"> ! ! <p:menuButton value="Navigate"> ! ! ! <p:menuitem value="Home" url="#" /> ! ! ! <p:menuitem value="Logout" url="#" /> ! ! </p:menuButton> ! </p:toolbarGroup> </p:toolbar> Skinning Toolbar resides in a container element which style and styleClass options apply.ui-toolbar-group-left .ui-separator . Here is an example. Following is the list of structural style classes.

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

primefaces. it’s resolved to a converter instance.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class tooltip org. it must refer to a converter id Name of the client side widget. when set to false component will not be rendered. When it’s an EL expression.primefaces. In case it’s a static text.component.tooltip.tooltip. 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.TooltipRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org. Effect to be used for hiding. events.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 389 .PrimeFaces User!s Guide 3. Event hiding the tooltip.112 Tooltip Tooltip goes beyond the legacy html title attribute by providing custom effects.component.primefaces.Tooltip org.Tooltip org.TooltipRenderer org. Event displaying the tooltip. Effect to be used for displaying. html content and advance theme support.primefaces.

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

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.ui-tooltip as a style class and is styled with global skinning selectors. <h:outputLink id="lnk" value="#"> ! <h:outputText value="PrimeFaces Home" /> </h:outputLink> <p:tooltip for="lnk"> ! <p:graphicImage value="/images/prime_logo.png" /> ! <h:outputText value="Visit PrimeFaces Home" /> </p:tooltip> Skinning Tooltip has only . 391 . see main skinning section for more information.

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

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

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

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

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

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

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

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

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

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

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

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

component. one way is to use for attribute. 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.primefaces.component org.component.primefaces.primefaces.watermark. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class watermark org.component.WatermarkRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component.primefaces. <h:inputText id="txt" value="#{bean. Boolean value to specify the rendering of the component. when set to false component will not be rendered.Watermark org.component. An el expression that maps to a server side UIComponent instance in a backing bean Text of watermark.WatermarkRenderer org.watermark.Watermark org.searchKeyword}" /> <p:watermark for="txt" value="Search with a keyword" /> 404 .116 Watermark Watermark displays a hint on an input field.primefaces.PrimeFaces User!s Guide 3.

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

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

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

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

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

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

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

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

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

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

set global to false.1. 415 . An example with commandButton would be.4 Bits&Pieces PrimeFaces Ajax Javascript API See the javascript section to learn more about the PrimeFaces Javascript Ajax API.PrimeFaces User!s Guide 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.

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

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

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

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

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

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

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

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

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

update:’msgs’ ! ! ! .AjaxResponse updates the specified components if any and synchronizes the client side JSF state.AjaxRequest({ ! ! formId:’userForm’ ! ! . ! ! ! ! ‘param_name2’:’value2’ ! ! ! } ! ! ! . status) {alert(‘Done’).}! ! ! ! }). More complex example with additional options.name}" /> ! .ajax. 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.oncomplete:function(xhr.source:’userForm’ ! ! .params:{ ! ! ! ! ‘param_name1’:’value1’. PrimeFaces. <h:form id="userForm"> ! <h:inputText id="username" value="#{userBean. 425 . We highly recommend using p:remoteComponent instead of low level javascript api as it generates the same with much less effort and less possibility to do an error.. More components </h:form> You can post all the information in form with ajax using.ajax.ajax.source:’userForm’ ! ! .process:’userForm’ ! }).ajax. ! ! ! .AjaxResponse PrimeFaces. PrimeFaces.process:’userForm’ ! ! ! .AjaxRequest({ ! ! ! formId:’userForm’.user.. PrimeFaces.

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

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

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

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

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

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

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

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

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. 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. 434 . Returns the principial instance of the logged in user.PrimeFaces User!s Guide 9. Returns a boolean value if has any of the given roles or not. This function is useful if you need to work with javascript. Returns the name of the logged in user.show()" /> Page Authorization Function ifGranted(String role) ifAllGranted(String roles) ifAnyGranted(String roles) ifNotGranted(String roles) remoteUser() userPrincipal() Description Returns a boolean value if user has given role or not. Returns a boolean value if has all of the given roles or not. WidgetVar <p:dialog id="dlg"> ! //contents </p:dialog> <p:commandButton type="button" value="Show" onclick="#{p:widgetVar(‘dlg’)}. Provides the widgetVar of a component.

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

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

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

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

org/1999/xhtml" xmlns:h="http://java.prime.amount}" /> <h:outputText value="Bet:" /> <h:inputText 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. 439 .tr/ui"> <h:head></h:head> <h:form> <h:panelGrid id="grid" columns="2" cellpadding="10px"> <f:facet name="header"> <p:messages id="messages" /> </f:facet> <h:outputText value="Total Amount: " /> <h:outputText value="#{gambitController.com.w3.xhtml <f:view xmlns="http://www.sun.com/jsf/core" xmlns:ui="http://java.sun.sun.bet}" /> <p:commandButton value="RED" ! actionListener="#{gambitController.com/jsf/facelets" xmlns:p="http://primefaces.com/jsf/html" xmlns:f="http://java.PrimeFaces User!s Guide edit.

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

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

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

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

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

PrimeFaces User!s Guide THE END 445 .