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 Ajax API! 423 423 424 8.2 Creating a New Theme ! 8.2 EL Functions ! 431 431 434 10. Integration with Java EE! 12.4 Theming Tips ! 426 427 428 429 430 9. Javascript API! 7. Utilities ! 9. IDE Support ! 12.3 Push Component ! 6.4.1 PrimeFaces Namespace ! 7.2 Chat! 419 420 420 420 420 421 7.1 Applying a Theme ! 8.1 Dependencies ! 10.PrimeFaces User!s Guide 6.1 RequestContext! 9.2 Configuration! 436 436 437 11.4.2 Push API! 6. Themes ! 8.2 Eclipse ! 9 440 441 441 442 . Portlets ! 10.1 NetBeans ! 12.4 Samples ! 6.1 Counter! 6.3 How Themes Work ! 8.1 Setup ! 6.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component. Alternate textual description. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class button org.primefaces.component org. Style class for the button icon.ButtonRenderer org.Button org.PrimeFaces User!s Guide 3.component. Boolean value to specify the rendering of the component.component.primefaces. Disables button. Value of the component than can be either an EL expression of a literal text.button.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean.Button org. Whether to include page parameters in target URI Identifier of the target page which should be scrolled to. Valid values are LTR and RTL. Used to resolve a navigation case.button.component.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.primefaces. Access key that when pressed transfers focus to button. Direction indication for text that does not inherit directionality. (deprecated: use icon) 35 . Name of the client side widget.primefaces.6 Button Button is an extension to the standard h:button component with skinning capabilities.

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

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

primefaces.component.component org.PrimeFaces User!s Guide 3. localization.7 Calendar Calendar is an input component used to select a date featuring display modes.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.Date Converter/String 38 . When it’s an EL expression.component.primefaces. ajax selection and more.util.calendar. it’s resolved to a converter instance.component.component.Calendar org.primefaces. In case it’s a static text.calendar. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class calendar org.Calendar org. it must refer to a converter id value converter null null java.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.primefaces. paging.CalendarRenderer org.

Sets calendar's minimum visible date Sets calendar's maximum visible date Enables multiple page rendering. Icon of the popup button When enabled.util.TimeZone instance to specify the timezone used for date conversion.PrimeFaces User!s Guide Name immediate Default FALSE Type Boolean Description When set true.util. DateFormat pattern for localization Locale to be used for labels and conversion. Defines how the calendar will be displayed. popup icon is rendered without the button. Name of the client side widget. Disables the calendar when set to 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. Visibility of button panel containing today and done buttons. Message to be displayed when conversion fails. process validations logic is executed at apply request values phase for this component. defaults to TimeZone. Marks component as required A method expression that refers to a method validationg the input A method expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails.TimeZone readOnlyInputText showButtonPanel FALSE FALSE Boolean Boolean 39 .Locale or String String Boolean Boolean java. Enables month/year navigator String or a java.util.getDefault() Makes input text of a popup calendar readonly. Message to be displayed when validation fails.

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

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 pointer button is moved onto input element. Client side callback to execute when input element is double clicked. Number of characters used to determine the width of the 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 a key is released over 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 input element is clicked. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a pointer button is moved away from input element. Client side callback to execute when input element loses focus. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element.

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

43 .PrimeFaces User!s Guide showOn option defines the client side event to display the calendar. This feature is tuned with the pages attribute.date}" mode="popup" ! ! ! showOn="button" popupIconOnly="true" /> Paging Calendar can also be rendered in multiple pages where each page corresponds to one month. Valid values are.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.

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

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

PrimeFaces User!s Guide <p:calendar value="#{dateBean.date}" mode="inline" navigator="true" /> TimePicker TimePicker functionality is enabled by adding time format to your pattern.widget. <p:calendar value="#{dateBean.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.Calendar 46 .date}" pattern=”MM/dd/yyyy HH:mm” /> Client Side API Widget: PrimeFaces.

ui-datepicker-week-end . Style Class .ui-datepicker-next .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 td .ui-datepicker-month .ui-datepicker-title .ui-datepicker .ui-datepicker-table . see the main Skinning section for more information 47 .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 . Following is the list of structural style classes.ui-datepicker-current .ui-datepicker-prev .ui-datepicker-buttonpane .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Maximum boundary value. 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.11. 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 .bar.3 Bar Chart Bar chart visualizes one or more series of data using bars. valid values are “vertical” and “horizontal”.primefaces. Margin of bars.primefaces.component. Style class of the chart. Orientation of bars.chart.PrimeFaces User!s Guide 3.component.BarChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. Minimum boundary value.chart. Position of the legend. Padding of bars.BarChartRenderer org.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class barChart org.component.primefaces. Title of the chart.BarChart org. Enables stacked display of bars.primefaces.BarChart org.chart.component.component org.bar.primefaces.

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

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

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

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

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

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

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

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

component.primefaces. Position of the legend.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.ohlc.OhlcChart org. Style class of the chart.primefaces.chart. Angle of the y-axis ticks. Specifies interactive legend.OhlcChartRenderer org.6 Ohlc Chart An open-high-low-close chart is a type of graph typically used to visualize movements in the price of a financial instrument over time. Angle of the x-axis ticks.chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.chart. 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 .PrimeFaces User!s Guide 3.OhlcChart org.ohlc.11.primefaces.primefaces. Label of the y-axis. Comma separated list of colors in hex format.primefaces.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.component. Title of the chart.component. Label of the x-axis.chart. Enables candle stick display mode.

88.67. public Bean() { model = new OhlcChartModel().5.44)).142.addRecord(new ohlcModel.140.139. OhlcChartSeries(2011. OhlcChartSeries(2010.132.73.chart.7.138. public class Bean { private OhlcChartModel model.97)).68.144.04.18.addRecord(new ohlcModel.129. <p:ohlcChart value="#{bean.79.139.143.9.5)).model}" xaxisLabel=”Year” ! ! yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.136.139.addRecord(new ohlcModel.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” ! ! title=”Ohlc Chart with Candle Stick” /> 74 .135.addRecord(new ohlcModel.66.addRecord(new } //getter } OhlcChartSeries(2007.primefaces.123.31.140.139.134.48)).46.122.OhlcChartModel instance.143. OhlcChartSeries(2008. OhlcChartSeries(2012.01.55.136.81)).53. OhlcChartSeries(2009.02)).124.56.4)).addRecord(new ohlcModel.addRecord(new ohlcModel.124. ! ! ! ! ! ! ! ! <p:ohlcChart value="#{bean.135.57.143.76.121.144.136.135. ohlcModel.135.model.56.82. OhlcChartSeries(2012.PrimeFaces User!s Guide Getting started with OhlcChart OhlcChart is created with an org.

chart. Radius of the outer circle of the internal ring.chart. Position of the legend. Displays ticks around gauge. Number of pixels to offset the label up and down.chart. when set to false component will not be rendered.component.metergauge.11. 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.metergauge. 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 .MeterGaugeChart org. Title of the chart.component.primefaces.chart.primefaces.PrimeFaces User!s Guide 3.component org.MeterGauge org.7 MeterGauge Chart MeterGauge chart visualizes data on a meter gauge display.primefaces.primefaces.component. Specifies interactive legend.MeterGaugeChartRenderer org. Style class of the chart. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class meterGaugeChart org.component. Comma separated list of colors in hex format.primefaces.MeterGaugeChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Single Selection with RadioButton Selection a row with a radio button placed on each row is a common case.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.cars}" selectionMode="multiple" ! ! selection="#{carBean. You can either define this key by using the rowKey attribute or by binding a data model which implements org.id}"> ! <p:column selectionMode="single"/> ! . enable dblClickSelect so that clicking double on a row does the selection.columns </p:dataTable> Multiple Selection with Checkboxes Similar to how radio buttons are enabled.g..model. define a column with selectionMode set as single. <p:dataTable var="car" value="#{carBean..id}" > ! <p:column selectionMode="multiple"/> ! .selecedCars}" ! ! rowKey="#{car.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. ctrl) during selection.SelectableDataModel. define a selection column with a multiple selectionMode. <p:dataTable var="car" value="#{carBean.. DataTable will also provide a selectAll checkbox at column header..id}" > ! . row based selection is enabled by click event.. <p:dataTable var="car" value="#{carBean.primefaces. 128 .cars}" selection="#{carBean. In order to enable this feature.selecedCar}" ! ! ! rowKey="#{car.columns </p:dataTable> Selection on Double Click By default.cars}" selection="#{carBean.selectedCars}" rowKey="#{car..

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

lastYearProfit}% </p:column> <p:column> ! #{sale.PrimeFaces User!s Guide Grouping Grouping is defined by ColumnGroup component used to combine datatable header and footers.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.thisYearProfit}% </p:column> <p:column> ! #{sale.thisYearTotal}$" /> </p:row> </p:columnGroup> </p:dataTable> 130 .lastYearTotal}$" /> ! <p:column footerText="#{tableBean.manufacturer} </p:column> <p:column> ! #{sale. <p:dataTable var="sale" value="#{carBean.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.

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

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

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

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

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} </p:column> <p:column headerText="Color" sortBy="#{car.color}"> ! #{car.model} </p:column> <p:column headerText="Year" sortBy="#{car.year} </p:column> <p:column headerText="Manufacturer" sortBy="#{car.year}"> ! #{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 .manufacturer}" ! ! ! sortOrder="descending"> ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! <p:column headerText="Model" sortBy="#{car.model}"> ! #{car.cars}" sortBy="#{car.manufacturer}"> ! #{car. <p:dataTable var="car" value="#{tableBean.

assists} </p:column> ! <p:columnGroup type="footer"> ! ! <p:row> ! ! ! <p:column footerText="Totals: " style="text-align:right"/> ! ! ! <p:column footerText="#{player. <p:dataTable var="player" value="#{tableBean.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.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.allGoals}" /> ! ! ! <p:column footerText="#{player.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.

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

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

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

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

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

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

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

1 Draggable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class draggable org. 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.dnd.primefaces.Draggable org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget Displays a proxy element instead of actual element. valid values are ‘x’ and ‘y’.component. Specifies drag axis.27.component org.Draggable org.PrimeFaces User!s Guide 3.27 Drag&Drop Drag&Drop utilities of PrimeFaces consists of two components.component.primefaces.primefaces.component. Specifies a draggable that can’t be dropped. 3. when set to false component will not be rendered. 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. Id of the component to add draggable behavior Disables draggable behavior when true.primefaces.component.

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

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

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

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

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

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

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

only first image can be accepted by droppable.jpg" /> <p:draggable for="xavi" scope="midfield"/> <p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" /> <p:droppable for="forwardsonly" /> Skinning hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable. 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. 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.jpg" /> <p:draggable for="messi" scope="forward"/> <p:graphicImage id="xavi" value="barca/xavi_thumb. Following example has two images.

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

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

In case it’s a static text.primefaces. it’s resolved to a converter instance. 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.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class editor org.primefaces.editor. Value of the component than can be either an EL expression of a literal text.Editor org.29 Editor Editor is an input component with rich text editing capabilities.EditorRenderer org.primefaces. When it’s an EL expression.component. it must refer to a converter id.primefaces.component. Boolean value to specify the rendering of the component.component.Editor org. 155 .component.PrimeFaces User!s Guide 3.primefaces.component org.editor.

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

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

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

primefaces.primefaces.Effect org.effect.component.component org.component.effect. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.30 Effect Effect component is based on the jQuery UI effects library.primefaces.primefaces.EffectTag org. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component. 159 .component.EffectRenderer Attributes Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component Boolean value to specify the rendering of the component.effect.primefaces.Effect org. when set to false component will not be rendered. Dom event to attach the event that executes the animation Specifies the name of the animation Component that is animated Speed of the animation in ms Time to wait until running the effect. binding effect event type for speed delay null null null null null 1000 null Object String String String String Integer Integer Getting started with Effect Effect component needs a trigger and target which is effect’s parent by default.PrimeFaces User!s Guide 3. Info Tag Tag Class Component Class Component Type Component Family Renderer Type Renderer Class effect org.primefaces.component.EffectRenderer org.

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

action}" update="messages"/> 161 .value}"> <p:effect type="scale" event="mouseover"> ! <f:param name="percent" value="90"/> </p:effect> </h:outputText> It’s important to provide string options with single quotes. please see the jquery documentation. <h:outputText value="#{bean. Following example animates messages with pulsate effect after ajax request completes.value}"> <p:effect type="blind" event="click"> ! <f:param name="direction" value="'horizontal'" /> </p:effect> </h:outputText> For the full list of configuration parameters for each effect. duration and more. <h:outputText value="#{bean. provide these parameters with the f:param tag.jquery.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.PrimeFaces User!s Guide Effect Configuration Each effect has different parameters for animation like colors. In order to change the configuration of the animation. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class graphicImage org.graphicimage. 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 .component.39 GraphicImage PrimeFaces GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream.component.primefaces.GraphicImage org.primefaces. GraphicImage does all the hard work without the need of a Servlet.component.primefaces.GraphicImageRenderer Attributes Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component org.primefaces.GraphicImage org.graphicimage.GraphicImageRenderer org. 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.PrimeFaces User!s Guide 3. Legacy way to do this is to come up with a Servlet that does the streaming. when set to false component will not be rendered.component.

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

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

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

• 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.jpg" /> How It Works Dynamic image display works as follows.streamedContentValue}. 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. it can also display regular non dynamic images. • 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. retrieves the expression string like #{bean. <p:graphicImage value="barcalogo. As a result there will be 2 requests to display an image. 197 . This is extremely handy to display dynamic images if your image is in a data iteration component like datatable or ui:repeat.PrimeFaces User!s Guide Displaying Regular Images As GraphicImage extends standard graphicImage component. Passing Parameters and Data Iteration You can pass request parameters to the graphicImage via f:param tags. Please note that you cannot use viewscope beans as viewscoped bean is not available in resource loading request.

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

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

ui-growl-title . .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-item-container . } With this setting growl will be located at top left corner.ui-growl { ! left:20px. Style Class .ui-growl-image . Skinning Following is the list of structural style classes. see the main Skinning section for more information. 200 .ui-growl .PrimeFaces User!s Guide Positioning Growl is positioned at top right corner by default.ui-growl-message . position can be controlled with a CSS selector called ui-growl.ui-growl-item .

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

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

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

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

Example below displays messages for each event. <p:idleMonitor timeout="5000" update="messages"> <p:ajax event="idle" listener="#{bean.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.idleListener}" update="msg" /> <p:ajax event="active" listener="#{bean. You can customize this duration with the timeout attribute. idleMonitor waits for 5 minutes (300000 ms) until triggering the onidle event.

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

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

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

Maximum size of the cropper area. Minimum size of the cropper area.jpg <p:imageCropper value="#{cropper.croppedImage}" image="/campnou. Background color of the container. Background opacity of the container Initial coordinates of the cropper area. Context relative path to the image. 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. Name of the client side widget. Message to be displayed when conversion fails. process validations logic is executed at apply request values phase for this component. The cropped area of the original image is used to create a new image.jpg" /> public class Cropper { ! private CroppedImage croppedImage. Aspect ratio of the cropper area.PrimeFaces User!s Guide Name immediate Default FALSE Type Boolean Description When set true. ! ! //getter and setter } 209 . Assuming the image is at %WEBAPP_ROOT%/campnou. required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar image alt aspectRatio minSize maxSize backgroundColor backgroundOpacity initialCoords FALSE null null null null null null null null null null null null 0.6 null Boolean MethodExpr ValueChange Listener String String String String String String Double String String String Double String Getting started with the ImageCropper ImageCropper is an input component and image to be cropped is provided via the image attribute. Message to be displayed when validation fields. this new image can be accessed on the backing bean by setting the value attribute of the image cropper. Alternate text of the image.

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

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

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

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

<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 . Following is the full list. note that values are case sensitive.PrimeFaces User!s Guide Effect Speed The speed is considered in terms of milliseconds and specified via the speed attribute.

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

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

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

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

InputMaskRenderer org.component.component.PrimeFaces User!s Guide 3.component org.primefaces.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputMask org.primefaces.InputMask org.inputmask.component.InputMask org.InputMaskRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.inputmask.47 InputMask InputMask forces an input to fit in a defined mask template. An el expression that maps to a server side UIComponent instance in a backing bean Mask template PlaceHolder in mask template.primefaces. 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 .component.

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

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

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

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

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

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

primefaces. In case it’s a static text. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputTextarea org.InputTextareaRenderer org.primefaces.component. when set to false component will not be rendered.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. process validations logic is executed at apply request values phase for this component. it must refer to a converter id When set true.component.PrimeFaces User!s Guide 3.component. When it’s an EL expression.inputtextarea.inputtextarea.49 InputTextarea InputTextarea is an extension to standard inputTextara with skinning capabilities and auto growing. 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.primefaces.component.component org. 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 .InputTextarea org.primefaces. it’s resolved to a converter instance.InputTextarea org.

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

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

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

PrimeFaces User!s Guide Name required validator valueChangeListener requiredMessage converterMessage validatorMessage password showMode buttonImage buttonImageOnly effect effectDuration layout layoutTemplate keypadOnly promptLabel closeLabel clearLabel backspaceLabel accesskey alt autocomplete dir disabled label lang Default FALSE null null null null null FALSE focus null FALSE fadeIn null qwerty null focus null null null null null null null null FALSE null null Type Boolean MethodExpr MethodExpr String String String Boolean String String boolean String String String String Boolean String String String String String String String String Boolean String String Description Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Makes the input a password field. Label of the close key. Label of the prompt text. Valid values are LTR and RTL. ‘both’ Image for the button. Message to be displayed when conversion fails. Code describing the language used in the generated markup for this component. Controls browser autocomplete behavior. Direction indication for text that does not inherit directionality. Label of the clear key. Effect of the display animation. Message to be displayed when validation fields. Alternate textual description of the input field. Template of the custom layout. ‘focus’. Specifies the showMode. When set to true only image of the button would be displayed. Access key that when pressed transfers focus to the input element. Built-in layout of the keyboard. ‘button’. 230 . Label of the backspace key. Length of the display animation. Specifies displaying a keypad instead of a keyboard. Disables input field A localized user presentable name.

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

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

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

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

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

Element based layout Another use case of layout is the element based layout. update it’s content 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. So following is invalid. This is the default case actually so just ignore fullPage attribute or set it to false. Dimensions Except center layoutUnit. also avoid trying to update layout units because of same reason. <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. avoid using a form that contains layoutunits as generated dom may not be the same. other layout units must have dimensions defined via size option. 236 ." /> ! </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. Layout example below demonstrates creating a split panel implementation.

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

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

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

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

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

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

primefaces. 243 .log.PrimeFaces User!s Guide 3.component.54 Log Log component is a visual console to display logs on JSF pages.Log org.component org. 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.log.primefaces.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.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.LogRenderer org.component.component. when set to false component will not be rendered.

PrimeFaces User!s Guide <p:log /> Log API PrimeFaces uses client side log apis internally. for example you can use log component to see details of an ajax request. </script> 244 . ! PrimeFaces.error(‘Error message’). <script type=”text/javascript”> ! PrimeFaces. ! PrimeFaces. ! PrimeFaces.info(‘Info 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.warn(‘Warning message’).

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

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

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

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

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

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

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

252 .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.PrimeFaces User!s Guide Style Class .ui-menuitem .ui-menuitem-link .ui-menu .ui-menu-list . see the main Skinning section for more information.ui-menuitem-text .

An el expression that maps to a server side UIComponent instance in a backing bean.component.primefaces.component org.MenubarRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.component.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. 253 . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class menubar org. Boolean value to specify the rendering of the component.MenubarRenderer org.primefaces.57 Menubar Menubar is a horizontal navigation component.Menubar org. when set to false component will not be rendered.menubar.Menubar org.component.component.primefaces.PrimeFaces User!s Guide 3.primefaces.menubar.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

. outputPanel component is updated with each ajax request automatically.search}" /> Solution is to use the outputPanel as a placeHolder.PrimeFaces User!s Guide <p:dataTable id="tbl" rendered="#{bean.> //columns </p:dataTable> </p:outputPanel> <p:commandButton update="out" actionListener="#{bean...condition}" .> //columns </p:dataTable> <p:commandButton update="tbl" actionListener="#{bean. Skinning OutputPanel style and styleClass attributes are used to skin the outputPanel. <p:outputPanel id="out"> <p:dataTable id="tbl" rendered="#{bean.condition}" .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. 272 .. Layout OutputPanel has two layout modes. • inline (default): Renders a span • block: Renders a div AutoUpdate When auto update is enabled.

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

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

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

component. close and menu integration.component org.component.panel.primefaces.component.PrimeFaces User!s Guide 3.panel.PanelRenderer org. An el expression that maps to a server side UIComponent instance in a backing bean Header text Footer text Makes panel toggleable.primefaces.66 Panel Panel is a grouping component with content toggle. Speed of toggling in milliseconds Renders a toggleable panel as collapsed. 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 .primefaces.primefaces.PanelRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.Panel org.component.Panel org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panel org.primefaces.

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

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

panelgrid.primefaces.component.PanelGridRenderer org.primefaces.component.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 279 binding null Object .component.67 PanelGrid PanelGrid is an extension to the standard panelGrid component with additional features such as theming and colspan-rowspan.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class panelGrid org.PanelGridRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.PanelGrid org.component org.panelgrid.primefaces.PanelGridRenderer org.PrimeFaces User!s Guide 3.

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

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

it must refer to a converter id When set true.Password org.component.PrimeFaces User!s Guide 3. process validations logic is executed at apply request values phase for this component.component.password.component.primefaces.PasswordRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.PasswordRenderer org.component. In case it’s a static text.primefaces. When it’s an EL expression.primefaces.component org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.Password org.68 Password Password component is an extended version of standard inputSecret component with theme integration and strength indicator.primefaces. 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 .password. 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 password org.

Javascript event handler to be executed when password strength indicator is hidden. Valid values are LTR and RTL.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. Whether or not to display previous value. Name of the client side widget. Disables input field A localized user presentable name. Message to be displayed when validation fields. Code describing the language used in the generated markup for this component. Alternate textual description of the input field. Label of strong password. Javascript event handler to be executed when password strength indicator is shown. Message to be displayed when conversion fails. 283 . Controls browser autocomplete behavior. Access key that when pressed transfers focus to the input element. Label of prompt. Direction indication for text that does not inherit directionality. Label of good password. Label of weak password. Minimum length of a strong password Displays feedback inline rather than using a popup. 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. Enables strength indicator.

Flag indicating that this component will prevent changes by the user. Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is released over input element. Advisory tooltip informaton. Client side callback to execute when input element receives focus. Client side callback to execute when input element loses focus. Style class of the input element. Client side callback to execute when a pointer button is moved away from input element. Inline style of the input element. Client side callback to execute when input element is double clicked. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when a key is released over input element. 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 text within input element is selected by user. 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. Number of characters used to determine the width of the input element. Position of the input element in the tabbing order.PrimeFaces User!s Guide Name maxlength onblur onchange Default null null null Type Integer String String Description Maximum number of characters that may be entered in this field. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Client side callback to execute when input element is clicked.

when enabled (default) a password strength indicator is displayed.password}" inline="true"/> Custom Animations Using onshow and onhide callbacks. Most important attribute is feedback.password}" feedback="true|false" /> public class Bean { ! ! ! ! } private String password. public String getPassword() { return password. } public void setPassword(String password) { this. <p:password value="#{bean. <p:password value="#{mybean.password = password. 285 . if you prefer an inline indicator just enable inline mode.PrimeFaces User!s Guide Getting Started with Password Password is an input component and used just like a standard input text. <p:password value="#{bean.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. you can create your own animation as well. disabling feedback option will make password component behave like standard inputSecret. you can provide custom labels as well. Following password gives feedback in Turkish.} I18N Although all labels are in English by default.

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

When it’s an EL expression. 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 valuechangeevent Message to be displayed when required field validation fails.component.PhotoCam org.PrimeFaces User!s Guide 3. 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 .primefaces. it must refer to a converter id When set true.69 PhotoCam PhotoCam is used to take photos with webcam and send them to the JSF backend model.primefaces.photocam.component.PhotoCamRenderer org.PhotoCamRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. In case it’s a static text.component.primefaces.primefaces. it’s resolved to a converter instance.component org.photocam. 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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class photoCam org. Message to be displayed when conversion fails. Message to be displayed when validation fields.PhotoCam org.component.primefaces.

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

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

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

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

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

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

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

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

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

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

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

ProgressBar org.component org.73 ProgressBar ProgressBar is a process status indicator that can either work purely on client side or interact with server side using ajax. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class propressBar org.progressbar. in ajax mode progress value is retrieved from a backing bean. 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. when set to false component will not be rendered.progressbar.component. 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 .primefaces.primefaces.ProgressBarRenderer org.component.primefaces.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.component. Client side callback to execute when progress ends.component. Interval in seconds to do periodic requests in ajax mode.Progressbar org.primefaces. Inline style of the main container element.primefaces. Style class of the main container element.PrimeFaces User!s Guide 3.

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

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.ui-progressbar-value Applies Main container element of progressbar Value of the progressbar As skinning style classes are global. Following is the list of structural style classes. public void handleComplete() { ! //Add a faces message } //getter-setter <p:progressBar value="#{progressBean.ui-progressbar .widget.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. Style Class . Example below demonstrates how to use this event. see the main Skinning section for more information.handleComplete}" ! ! ! update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces. public class ProgressBean { ! ! ! ! ! } private int progress. 301 .progress}" ajax="true"> ! <p:ajax event="complete" listener="#{progressBean.

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

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

it’s resolved to a converter instance.PrimeFaces User!s Guide 3.RatingRenderer org.Rating org.primefaces.76 Rating Rating component features a star based rating system.component org.component.component. In case it’s a static text. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class rating org. 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 . if immediate is set to false. when true the events will be fired at "apply request values". when set to false component will not be rendered. it must refer to a converter id Boolean value that specifies the lifecycle phase the valueChangeEvents should be processed.primefaces.rating.component.primefaces.Rating org.primefaces. When it’s an EL expression.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.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.rating.

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

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

6.g. Player("Villa".players}" var="player"> ! <p:column> ! ! //UI to select an item e. Player("Puyol".add(new players.jpg".jpg".add(new players. "iniesta. 7.jpg".PrimeFaces User!s Guide Getting started with Ring A collection is required to use the Ring component. "CB")). "messi. "CF")).add(new Player("Messi". ! ! ! ! ! ! ! ! ! ! ! } ! } players. "villa.add(new players. 5. 8. Player("Iniesta". public class RingBean { ! ! ! private List<Player> players. commandLink ! </p:column> </p:ring> Easing Following is the list of available options for easing animation. • • • • • • • 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 . "CF")). 10. "xavi. <p:ring value="#{ringBean. "CM")). "puyol.players}" var="player”> ! <p:graphicImage value="/images/barca/#{player. Player("Xavi".add(new players.jpg".photo}"/> </p:ring> Item Selection A column is required to process item selection from ring properly.jpg". "CM")). public RingBean() { !! players = new ArrayList<Player>(). //getter&setter for players <p:ring value="#{ringBean.

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

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

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

RowExpansion org. 318 .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.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. when set to false component will not be rendered. Info Tag Component Class Component Type Component Family rowExpansion org.component.PrimeFaces User!s Guide 3.82 RowExpansion RowExpansion is a helper component of datatable used to implement expandable rows.rowexpansion.RowExpansion org.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Info Tag Component Class Component Type Component Family Renderer Type Renderer Class sheet org. Name of the client side widget.component. ajax sorting.component org.sheet. Inline style of the container element.sheet. 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 of the component.primefaces.Sheet org.Sheet org. Name of the data iterator. bulk delete/update and more.component.primefaces.component. keyboard navigation.97 Sheet Sheet is an excel-like component to do data manipulation featuring resizable columns. 355 binding value var widgetVar style null null null null null Object Object String String String . horizontal/vertical scrolling.component. multi cell selection with meta/ shift keys.primefaces.PrimeFaces User!s Guide 3.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.primefaces.SheetRenderer org. frozen headers.primefaces.

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

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

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

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

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

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

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

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

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

Client side callback to execute when input element is double clicked. Client side callback to execute when input element loses focus. Valid values are LTR and RTL. Name of the client side widget. Controls browser autocomplete behavior. Message to be displayed when validation fields. Message to be displayed when conversion fails. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Alternate textual description of the input field. Maximum number of characters that may be entered in this field. Disables input field A localized user presentable name. 365 . Client side callback to execute when input element receives focus.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. Direction indication for text that does not inherit directionality. Client side callback to execute when input element is clicked. Client side callback to execute when a key is pressed down over input element. Code describing the language used in the generated markup for this component. 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 a pointer button is moved onto input element.PrimeFaces User!s Guide Name onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect readonly size style styleClass tabindex title Default null null null null null null null null FALSE null null null null null Type String String String String String String String String Boolean Integer String String Integer String Description Client side callback to execute when a key is pressed and released over input element.number}" /> 366 . Client side callback to execute when a pointer button is moved away from input element. public class SpinnerBean { ! ! } private int number. Client side callback to execute when text within input element is selected by user. Inline style of the input element. Getting Started with Spinner Spinner is an input component and used just like a standard input text. Client side callback to execute when a pointer button is 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 released over input element. //getter and setter <p:spinner value="#{spinnerBean. Position of the input element in the tabbing order. Flag indicating that this component will prevent changes by the user. Client side callback to execute when a key is released over input element. Number of characters used to determine the width of the input element. Style class of the input element. Advisory tooltip informaton.

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

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

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

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

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

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

primefaces.primefaces.summaryrow. Getting started with SummaryRow See DataTable section for more information.primefaces.SummaryRow org. 373 .summaryrow.SummaryRow org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class summaryRow org.component.104 SummaryRow SummaryRow is a helper component of datatable used for dynamic grouping.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Method expression to execute before rendering summary row. (e.g.component.SummaryRowRenderer org.component.PrimeFaces User!s Guide 3. to calculate totals).component org. when set to false component will not be rendered.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.component.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component.primefaces.primefaces. binding type styleClass icon expandedIcon collapsedIcon null default null null null null Object String String String String String Getting started with the TreeNode TreeNode is used by Tree and TreeTable components.PrimeFaces 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.114 TreeNode TreeNode is used with Tree component to represent a node in tree. Expanded icon of the node.component.tree. when set to false component will not be rendered.primefaces. Info Tag Component Class Component Type Component Family treeNode org.UITreeNode org. Collapsed icon of the node. refer to sections of these components for more information.UITreeNode org. 400 .

treetable.component. Name of the client side widget.115 TreeTable Treetable is is used for displaying hierarchical data in tabular format.primefaces.primefaces.primefaces. Style class of the container element. Name of the request-scoped variable used to refer each treenode. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class treeTable org.TreeTable org. Selection reference.TreeTableRenderer org. 401 .component.TreeTable org.TreeTableRenderer Attributes Name id rendered binding value var widgetVar style styleClass selection Default null TRUE null null null null null null null Type String Boolean Object Object String String String String Object Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.component.primefaces.treetable. An el expression that maps to a server side UIComponent instance in a backing bean A TreeNode instance as the backing model.PrimeFaces User!s Guide 3. when set to false component will not be rendered.component org.component. Inline style of the container element.

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

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

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

Note that this style class is not applied when watermark uses html5 placeholder if available.showWatermarks()" /> Skinning There’s only one css style class applying watermark which is ‘. <h:inputText id="txt" value="#{bean. This would result in updating bean properties with watermark values. 405 . by default in non-ajax form submissions.PrimeFaces User!s Guide Form Submissions Watermark is set as the text of an input field which shouldn’t be sent to the server when an enclosing for is submitted.ui-watermark’. 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. watermarks are cleared.cleanWatermarks()" ! ! ! ! ! oncomplete="PrimeFaces. you can override this class to bring in your own style.

Boolean value to specify the rendering of the component. Specifies visibility of default step title bar.component.Wizard org.primefaces.component.WizardRenderer Attributes Name id rendered binding step style styleClass flowListener showNavBar showStepStatus Default null TRUE null 0 null null null TRUE TRUE Type String Boolean Object String String String MethodExpr Boolean Boolean Description Unique identifier of the component. 406 . Style class of the main wizard container element. 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.component.Wizard org.primefaces.WizardRenderer org.component org. when set to false component will not be rendered.primefaces.PrimeFaces User!s Guide 3.117 Wizard Wizard provides an ajax enhanced UI to implement a workflow easily in a single page.component. Wizard consists of several child tab components where each tab represents a step in the process. Specifies visibility of default navigator arrows. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class wizard org.primefaces.wizard.primefaces. Server side listener to invoke when wizard attempts to go forward or back.wizard.

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

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

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

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

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

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

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

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

<p:commandButton value="Silent" global="false" /> <p:commandButton value="Notify" global="true" /> 4. 415 . An example with commandButton would be.1.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. set global to false.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PrimeFaces User!s Guide THE END 445 .