USER’S GUIDE 3.

0

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!

10 11
11 11

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

12
12 13 13 13

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

14
14 18 20 23 31 34 37 47 50 56 57
57 60 63 66

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!

69 72 74 76 77 78

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!

79 80 84 86 87 88 93 96 99 102 107 110 116 120 138 143
143 147

3.28 Dock! 3.29 Editor!
4

152 154

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

158 161 162 166 168 174 176 179 190 191 196 199 202 204 206 210 213 217 221 224 228 233 237 239 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 Panel! 3.66 Password! 3.67 PickList! 3.68 Poll! 3.69 Printer! 3.70 ProgressBar! 3.71 Push! 3.72 RadioButton! 3.73 Rating! 3.74 RemoteCommand! 3.75 Resizable! 3.76 Ring! 3.77 Row! 3.78 RowEditor! 3.79 RowExpansion!
6

245 247 253 256 258 261 263 265 267 271 273 276 281 287 290 291 294 295 296 299 301 305 308 309 310

PrimeFaces Userʼs Guide

3.80 RowToggler! 3.81 Schedule ! 3.82 ScrollPanel! 3.83 SelectBooleanCheckbox! 3.84 SelectManyCheckbox! 3.85 SelectOneListbox! 3.86 SelectOneMenu! 3.87 SelectOneRadio ! 3.88 SelectManyMenu! 3.89 Separator! 3.90 Sheet! 3.91 Slider! 3.92 Spacer! 3.93 Spinner! 3.94 Submenu! 3.95 Stack! 3.96 SubTable! 3.97 SummaryRow! 3.98 Tab! 3.99 TabView! 3.100 TagCloud! 3.101 Terminal! 3.102 ThemeSwitcher! 3.103 Timeline ! 3.104 Toolbar!
7

311 312 320 322 324 326 328 332 335 337 339 342 347 348 353 354 356 357 358 359 363 365 367 369 372

PrimeFaces Userʼs Guide

3.105 ToolbarGroup! 3.106 Tooltip! 3.107 Tree! 3.108 TreeNode! 3.109 TreeTable! 3.110 Watermark! 3.111 Wizard!

374 375 378 386 387 390 392

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!

398
398
398 398 401 401

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

402
402 403 403

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

404 405
405 406 406 406
406 407

8

2 Creating a New Theme ! 8. Integration with Java EE! 12.2 EL Functions! 417 417 420 10.4 Theming Tips! 412 413 414 415 416 9.1 PrimeFaces Namespace! 7. Utilities! 9.PrimeFaces Userʼs Guide 7. Themes! 8.1 RequestContext! 9.1 Applying a Theme ! 8. IDE Support ! 12.2 Eclipse! 426 427 427 428 13.2 Ajax API! 409 409 410 8.1 NetBeans! 12. Project Resources! 14. Portlets! 10. Javascript API! 7.3 How Themes Work! 8.2 Configuration! 422 422 423 11. FAQ! 429 430 9 .1 Dependencies! 10.

JSFDays. the founder and project lead of PrimeFaces and PMC member of open source JSF implementation Apache MyFaces. Ç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. JSFSummit. he has trained over 300 developers on Java EE technologies mainly JSF. Jazoon. W-JAX.About the Author Çağatay Çivici is a member of JavaServer Faces Expert Group. JAX. the company he cofounded in Turkey.x and JPA. . Con-Fess and many local events such as JUGs. Çağatay is currently working as a principal consultant for Prime Teknoloji. Spring. EJB 3. As an experienced trainer.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

} .PrimeFaces Userʼs Guide Ajax Behavior Events Instead of waiting for user to submit the form manually to process the selected item..complete}"> <p:ajax event="itemSelect" listener="bean.AutoComplete Method search(value) close() Params value: keyword for search 29 Return Type void void Description Initiates a search with given value Hides suggested items menu .complete}" onstart="handleStart(request)" oncomplete="handleComplete(response)" /> onstart callback gets a request parameter and oncomplete gets a response parameter. these parameters contain useful information. Your listener(if defined) will be invoked with an org.getObject().widget.. <p:autoComplete value="#{bean. "Item:" + item). you can enable instant ajax selection by using the itemSelect ajax behavior.text}" completeMethod="#{bean. Note that autoComplete also supports events inherited from regular input text such as blur.handleSelect" update="msg" /> </p:autoComplete> <p:messages id=”msg” /> public class Bean { } public void handleSelect(SelectEvent event) { Object item = event. focus.primefaces. FacesMessage msg = new FacesMessage("Selected". Client Side Callbacks onstart and oncomplete are used to execute custom javascript before and after an ajax request to load suggestions.event. Client Side API Widget: PrimeFaces. mouseover in addition to itemSelect.Select instance that contains a reference to the selected item. For example request is the query string and response is the xhr request sent under the hood. <p:autoComplete value="#{bean. Example below demonstrates how to display a message about the selected item instantly.text}" completeMethod="#{bean.

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

primefaces.BreadCrumbRenderer org.primefaces.component. Initial collapse effect duration in milliseconds.BreadCrumb org.component. Preview width of a collapsed menuitem. Collapse effect duration in milliseconds.PrimeFaces Userʼs Guide 3. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class breadCrumb org. widgetVar model expandedEndItems expandedBeginningItems expandEffectDuration collapseEffectDuration initialCollapseEffectDuration previewWidth null null 1 1 800 500 600 5 String MenuModel Integer Integer Integer Integer Integer Integer 31 . Boolean value to specify the rendering of the component.primefaces.5 BreadCrumb Breadcrumb is a navigation component that provides contextual information about page hierarchy in the workflow. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. MenuModel instance to create menus programmatically Number of expanded menutitems at the end.component.component org.primefaces.breadcrumb.BreadCrumbRenderer Attributes Name id rendered binding Default null TRUE null Type String Boolean Object Description Unique identifier of the component.BreadCrumb org. Number of expanded menuitems at begining. Expanded effect duration in milliseconds.breadcrumb.component.primefaces.

<p:breadCrumb> <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem <p:menuitem </p:breadCrumb> label="Categories" url="#" /> label="Sports" url="#" /> label="Football" url="#" /> label="Countries" url="#" /> label="Spain" url="#" /> label="F. see the dynamic menus part in menu component section for more information and an example. breadcrumb can collapse/expand menuitems on mouseover.PrimeFaces Userʼs Guide Name preview style styleClass Default FALSE null null Type Boolean String String Description Specifies preview mode.C. if you have limited space and many menuitems. <p:breadCrumb preview="true"> <p:menuitem label="Categories" url="#" /> <p:menuitem label="Sports" url="#" /> <p:menuitem label="Football" url="#" /> <p:menuitem label="Countries" url="#" /> <p:menuitem label="Spain" url="#" /> <p:menuitem label="F.C. when set to false menuitems will not collapse. Style class of main container Getting Started with BreadCrumb Steps are defined as child menuitem components in breadcrumb. Style of main container element. Barcelona" url="#" /> label="Squad" url="#" /> label="Lionel Messi" url="#" /> Preview By default all menuitems are expanded. Barcelona" url="#" /> <p:menuitem label="Squad" url="#" /> <p:menuitem label="Lionel Messi" url="#" /> </p:breadCrumb> Dynamic Menus Menus can be created programmatically as well. previewWidth attribute defines the reveal amount in pixels. 32 .

Each menuitem label.ui-breadcrumb .PrimeFaces Userʼs Guide Animation Configuration Duration of effects can be customized using several attributes.ui-breadcrumb-chevron Applies Main breadcrumb container element. if it is defined. see the main Skinning section for more information. In this case. As skinning style classes are global.ui-menu-item-text . Seperator of menuitems. • url option is the key for a menuitem.ui-breadcrumb . it will work as a simple link. If you’d like to use menuitem to execute command with or without ajax.ui-breadcrumb . Tips • If there is a dynamic flow. Skinning Breadcrumb resides in a container element that style and styleClass options apply.ui-menu-item-link . Each menuitem. 33 . • Breadcrumb can do ajax/non-ajax action requests as well since p:menuitem has this option. do not define the url option. breadcrumb must be nested in a form. Following is the list of structural style classes. use model option instead of creating declarative p:menuitem components and bind your MenuModel representing the state of the flow. Here’s an example. <p:breadCrumb preview="true" expandEffectDuration="1000" collapseEffectDuration="1000" initialCollapseEffectDuration="1000"> Durations are defined in milliseconds. Style Class .

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

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

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

component org.component.CalendarRenderer org.Calendar org. it must refer to a converter id value converter null null java.calendar.calendar.primefaces.PrimeFaces Userʼs Guide 3.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. ajax selection and more. localization.primefaces.Calendar org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component An el expression or a literal text that defines a converter for the component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class calendar org.component. In case it’s a static text. it’s resolved to a converter instance.primefaces. paging.primefaces.component.component.Date Converter/String 37 . When it’s an EL expression.7 Calendar Calendar is an input component used to select a date featuring display modes.primefaces.util.

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

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

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.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 pointer button is moved away from input element. Flag indicating that this component will prevent changes by the user. 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 40 . Client side callback to execute when a pointer button is released over input element. Client side callback to execute when input element receives focus. Number of characters used to determine the width of the input element. Client side callback to execute when a key is pressed down over input element. Client side callback to execute when input element loses focus. Client side callback to execute when input element is clicked. Client side callback to execute when text within input element is selected by user. Client side callback to execute when a key is pressed and released over input element. Client side callback to execute when input element is double clicked. Client side callback to execute when a key is released over input element. Client side callback to execute when a pointer button is moved onto input element.

Getting Started with Calendar Value of the calendar should be a java.date}" mode="inline" /> Popup <p:calendar value="#{dateBean.util. popup (default) and inline. <p:calendar value="#{dateBean.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="popup" /> 41 . Inline <p:calendar value="#{dateBean. //Getter and Setter Display Modes Calendar has two main display modes.date}"/> public class DateBean { } private Date date. Advisory tooltip informaton.Date.

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

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

Date Ranges Using mindate and maxdate options.PrimeFaces Userʼs Guide Effects Various effects can be used when showing and hiding the popup calendar.Date. If you define a method as a listener.date}"> <p:ajax event=”dateSelect” listener=”#{bean. 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. options are. keyup and more.handleDateSelect}” update=”msg” /> </p:calendar> <p:messages id="msg" /> public void handleDateSelect(DateSelectEvent event) { Date date = event.util. selectable dates can be restricted.DateSelectEvent instance. it will be invoked by passing an org. 44 . calendar also supports regular ajax behavior events like blur. //Add facesmessage } In popup mode.event.primefaces.getDate().

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

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

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

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

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

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

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

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

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

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

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

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

component.PieChart org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class pieChart org. line and more. Gap between slices. Render solid slices.chart. There’re various chart types like pie.PieChart org.component org.primefaces. Title of the chart.chart.chart.pie. 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. Comma separated list of colors in hex format. Style class of the chart. Diameter of the pie. auto computed by default.chart. when set to false component will not be rendered.11.primefaces. 57 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 .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.11 Charts Charts are used to display graphical data. bar.PieChartRenderer org. Position of the legend.1 Pie Chart Pie chart displays category-data pairs in a pie graphic.PrimeFaces Userʼs Guide 3.pie.component.component. 3.primefaces.primefaces.component.

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

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

2 Line Chart Line chart visualizes one or more series of data in a line graph.chart. Position of the legend. when set to false component will not be rendered.primefaces.LineChart org. Style class of the chart. Comma separated list of colors in hex format.line.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. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class lineChart org.chart.component. Title of the chart. fall will join point on either side of line.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.11.chart. binding value widgetVar style styleClass title legendPosition minY maxY minX maxX breakOnNull seriesColors null null null null null null null null null null null FALSE null Object ChartModel String String String String String Double Double Double Double Boolean String 60 .primefaces.primefaces.component org.LineChartRenderer org.component.primefaces.LineChart org.line. Minimum Y axis value.PrimeFaces Userʼs Guide 3. Minimum X axis value.component.primefaces. Maximum X axis value. Maximum Y axis value.chart. Whether line segments should be broken at null value.

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

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

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

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

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

Title of the chart.11.DonutChartRenderer org. when set to false component will not be rendered.4 Donut Chart DonutChart is a combination of pie charts.chart.DonutChart org. Specifies interactive legend.component.component org. Style class of the chart.chart.component.component.DonutChart org.primefaces. Format of data labels.primefaces.chart. Position of the legend. Gap between slices.primefaces.donut. 66 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 . Displays data on each slice.DonutChartRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.donut. 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 donutChart org.chart. Render solid slices. Comma separated list of colors in hex format.PrimeFaces Userʼs Guide 3. Shows shadow or not.component.primefaces.

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

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

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

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

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

chart.chart. Style class of the chart.primefaces. Specifies interactive legend.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. Enables candle stick display mode. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class ohlcChart org.OhlcChart org. Position of the legend.ohlc.OhlcChart org.OhlcChartRenderer 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 Name of the client side widget Datasource to be displayed on the chart Inline style of the chart. Comma separated list of colors in hex format. Label of the x-axis. Angle of the y-axis ticks.component. Angle of the x-axis ticks.component.component org.primefaces.11. Label of the y-axis.chart.ohlc.primefaces.component. Title of the chart. 72 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.primefaces.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.chart.

139.143.123.model}" xaxisLabel=”Sector” yaxisLabel=”Index Value” title=”Ohlc Chart with Candle Stick” /> 73 .addRecord(new ohlcModel.7.53.44)). OhlcChartSeries(2010.136.88.81)).82.135.68.142. public Bean() { model = new OhlcChartModel().122.57.136.79.addRecord(new ohlcModel.97)).136.143. <p:ohlcChart value="#{bean.04.56.46.9.18.model}" xaxisLabel=”Year” yaxisLabel=”Price Change $K/Unit” title=”Sample Ohlc Chart”/> CandleStick OhlcChart can display data in candle stick format as well.55.135.135. OhlcChartSeries(2012.144.PrimeFaces Userʼs Guide Getting started with OhlcChart OhlcChart is created with an org.addRecord(new } //getter } OhlcChartSeries(2007.56.76.addRecord(new ohlcModel.01.5)). ohlcModel.144.73.02)).primefaces.addRecord(new ohlcModel.addRecord(new ohlcModel.140.model.140.129.chart.139.48)).124. OhlcChartSeries(2008.5.132.4)). OhlcChartSeries(2012.121.addRecord(new ohlcModel. OhlcChartSeries(2011.139.124.139.135.134.138. OhlcChartSeries(2009.OhlcChartModel instance. public class Bean { private OhlcChartModel model.66.31.143. <p:ohlcChart value="#{bean.67.

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

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

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

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

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

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

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

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

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

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

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

Note As column is a reused component. for example filterBy is only used by datatable whereas sortBy is used by datatable and sheet. see documentation of components that use a column. Maximum number of characters for an input filter. Specifies resizable feature at column level. Getting Started with Column 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. 85 . not all attributes of column are implemented by the components that use column. Datatable's resizableColumns must be enabled to use this option.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<p:dataTable id="tableId" . "xml" Id of the datatable whose data to export.> //columns </p:dataTable> 107 .22 DataExporter DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel. 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.primefaces.export. csv and xml.component.PrimeFaces Userʼs Guide 3.DataExporterTag org. Assume the table to be exported is defined as. pdf.component."pdf"..primefaces."csv".DataExporter Attributes Name type target fileName pageOnly excludeColumns preProcessor postProcessor encoding selectionOnly Default null null null FALSE null null null UTF-8 FALSE Type String String String String String MethodExpr MethodExpr Boolean Boolean Description Export type: "xls". PostProcessor for the exported document. Getting Started with DataExporter DataExporter is nested in a UICommand component such as commandButton or commandLink. Target must point to a PrimeFaces Datatable.export. only selection would be exported. defaults to datatable id. For pdf exporting itext and for xls exporting poi libraries are required in the classpath. Filename of the generated export file.. Info Tag Tag Class ActionListener Class dataExporter org. Character encoding to use When enabled.

Exporter below ignores first column.2. if you’d like export only the data displayed on current page.6"). <p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/> Excluding Columns In case you need one or more columns to be ignored use exludeColumns option. to exclude more than one column define the indexes as a comma separated string (excludeColumns="0. <p:dataExporter type="pdf" target="tableId" excludeColumns="0"/> 108 . set pageOnly to true.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.

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

23 DataGrid DataGrid displays a collection of data in a grid layout.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.component. when set to false component will not be rendered. 110 .component.DataGrid org.primefaces.datagrid.primefaces.PrimeFaces Userʼs Guide 3.DataGridRenderer org.component.datagrid.component org.primefaces.DataGrid org.primefaces.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class dataGrid org.

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

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

15"). "{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}" Here are more examples based on different templates. 113 .12. " {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink} {RowsPerPageDropDown}" " {PreviousPageLink} {CurrentPageReport} {NextPageLink}" Paginator Position Paginator can be positoned using paginatorPosition attribute in three different locations. "top".. "bottom" or "both" (default). <p:dataGrid var="car" value="#{carBean. which corresponds to the following template. rowsPerPageTemplate="9.g. </p:dataGrid> Paginator Template Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls. • • • • • • • FirstPageLink LastPageLink PreviousPageLink NextPageLink PageLinks CurrentPageReport RowsPerPageDropDown Note that {RowsPerPageDropDown} has it’s own template.PrimeFaces Userʼs Guide Ajax Pagination DataGrid has a built-in paginator that is enabled by setting paginator option to true. Default UI is. options to display is provided via rowsPerPageTemplate attribute (e.cars}" columns="3" rows="12" paginator="true"> ..

private Car selectedCar.cars}" columns="3" rows="12"> <p:column> <p:panel header="#{car. Here is an example to demonstrate how to select data from datagrid and display within a dialog with ajax.model}"> <p:commandLink update="carForm:display" oncomplete="dlg. 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.DataGrid Method getPaginator() Params Return Type Paginator Description Returns the paginator widget.show()"> <f:setPropertyActionListener value="#{car}" target="#{carBean.selectedCar}" <h:outputText value="#{car.PrimeFaces Userʼs Guide Selecting Data Selection of data displayed in datagrid is very similar to row selection in datatable.jpg"/> </f:facet> <h:outputText value="Model:" /> <h:outputText value="#{carBean. 114 .selectedCar.year}" /> //more selectedCar properties </h:panelGrid> </p:dialog> </h:form> public class CarBean { } private List<Car> cars. //getters and setters Client Side API Widget: PrimeFaces.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}. <h:form id="carForm"> <p:dataGrid var="car" value="#{carBean.widget.

Class .ui-datagrid-row . 115 . Table element containing data A row in grid A column in grid Applies As skinning style classes are global.PrimeFaces Userʼs Guide Skinning DataGrid resides in a main div container which style and styleClass attributes apply. see the main Skinning section for more information.ui-datagrid-column Main container element Content container.ui-datagrid . Following is the list of structural style classes.ui-datagrid-data .ui-datagrid-content .

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

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

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

<p:dataList value="#{carBean.ui-datalist-content . 119 . see the main Skinning section for more information.widget.ui-datalist-data . #{car.year} </p:dataList> Pagination configuration and usage is same as dataGrid. Client Side API Widget: PrimeFaces.ui-datalist-item Main container element Content container Data container Each item in list Applies As skinning style classes are global.manufacturer}. Skinning DataList resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes. see selecting data section in dataGrid documentation for more information and examples. see pagination section in dataGrid documentation for more information and examples.PrimeFaces Userʼs Guide Ajax Pagination DataList has a built-in paginator that is enabled by setting paginator option to true. Class . Selecting Data Data selection can be implemented same as in dataGrid.ui-datalist .cars}" var="car" paginator="true" rows="10"> #{car.DataList Method getPaginator() Params Return Type Paginator Description Returns the paginator widget.

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

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

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

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

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

Following is an advanced filtering datatable with these options demonstrated. this is implemented by calling client side api method called filter().manufacturerOptions}" filterMatchMode="exact"> <h:outputText value="#{car.color}" headerText="Color" filterMatchMode="endsWith"> <h:outputText value="#{car.manufacturer}" headerText="Manufacturer" filterOptions="#{carBean. important part is to specify the id of the input text as globalFilter which is a reserved identifier for datatable. 125 .year}" headerText="Year" footerText="startsWith"> <h:outputText value="#{car.manufacturer}" /> </p:column> <p:column filterBy="#{car.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.PrimeFaces Userʼs Guide Filtering is triggered with keyup event and filter inputs can be styled using filterStyle .model}" /> </p:column> <p:column filterBy="#{car. 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. filterStyleClass attributes. filterMatchMode defines the built-in matcher which is startsWith by default.filter()" /> </p:outputPanel> </f:facet> <p:column filterBy="#{car. <p:dataTable var="car" value="#{carBean. In addition.year}" /> </p:column> <p:column filterBy="#{car.model}" headerText="Model" filterMatchMode="contains"> <h:outputText value="#{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. private Car[] selectedCars. public class CarBean { } private List<Car> cars. public } CarBean() { cars = new ArrayList<Car>()."blue")).add(new Car("myModel". 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.columns </p:dataTable> Single Selection with Row Click Previous method works when the button is clicked. private Car selectedCar. <p:dataTable var="car" value="#{carBean."ManufacturerX".selectedCar}" /> </p:commandButton> </p:column> . <p:dataTable var="car" value="#{carBean. if you’d like to enable selection wherever the row is clicked. cars.selectedCar}" rowKey="#{car.PrimeFaces Userʼs Guide Row Selection There are several ways to select row(s) from datatable..columns </p:dataTable> 126 ..2005. Selected row can be set to a server side instance by passing as a parameter if you are using EL 2.cars}" selectionMode="single" selection="#{carBean. use selectionMode option..cars}"> <p:column> <p:commandButton value="Select"> <f:setPropertyActionListener value="#{car}" target="#{carBean.id}"> .2 or using f:setPropertyActionListener..

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

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

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

PrimeFaces Userʼs Guide public class CarBean { } private List<Manufacturer> sales.. in order to enable simple scrolling set scrollable option to true. } 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..sales. public CarBean() { sales = //create a list of BrandSale objects } public List<ManufacturerSale> getSales() { return this.cars}" scrollable="true" scrollHeight="150"> <p:column style="width:100px" . //columns </p:dataTable> 130 . <p:dataTable var="car" value="#{carBean.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

component. Id of a UIData component to connect with. Specifies the intersection mode to accept a draggable. 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 147 . Scope key to match draggables and droppables.PrimeFaces Userʼs Guide 3. 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.2 Droppable Info Tag Component Class Component Type Component Family Renderer Type Renderer Class droppable org. when set to false component will not be rendered.Droppable org. Style class to apply when an acceptable draggable is being dragged.component.primefaces.primefaces.component.dnd.component. Selector to define the accepted draggables. Client side callback to execute when a draggable is dropped.primefaces.Droppable org.DroppableRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.dnd.component org.primefaces.primefaces.27.DroppableRenderer org.

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

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

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

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

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

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

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

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

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

ui-editor-message Main container. Button groups.ui-editor . Popup overlays. Selects all text in editor. Overlays to provide input.ui-editor-group . Color picker. Description Adds cursor focus to edit area. Applies Editor is not integrated with ThemeRoller as there is only one icon set for the controls.ui-editor-popup . 157 .ui-editor-button . Each button. Skinning Following is the list of structural style classes. 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 . Style Class . Overlays displaying a message.ui-editor-toolbar .ui-editor-disabled .ui-editor-prompt .ui-editor-color . Returns selected text as HTML. Returns selected text in plain format.ui-editor-list . Dropdown lists. Disabled editor controls. Disables editing. Divider to separate buttons.

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

value}"> <p:effect type="pulsate" event="click" /> </h:outputText> Effect Target There may be cases where you want to display an effect on another target on the same page while keeping the parent as the trigger. <h:outputLink id="lnk" value="#"> <h:outputText value="Show the Barca Temple" /> <p:effect type="appear" event="click" for="img" /> </h:outputLink> <p:graphicImage id="img" value="/ui/barca/campnou. List of Effects Following is the list of effects supported by PrimeFaces. outputLink becomes the trigger for the effect on graphicImage. Use for option to specify a target. • • • • • • • • • • • • • • blind clip drop explode fold puff slide scale bounce highlight pulsate shake size transfer 159 .jpg" style="display:none"/> With this setting. Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly. When the link is clicked. initially hidden graphicImage comes up with a fade effect.PrimeFaces Userʼs Guide <h:outputText value="#{bean.

<h:outputText value="#{bean. <h:outputText value="#{bean. provide these parameters with the f:param tag.value}"> <p:effect type="blind" event="click"> <f:param name="direction" value="'horizontal'" /> </p:effect> </h:outputText> For the full list of configuration parameters for each effect. http://docs. please see the jquery documentation. duration and more. Following example animates messages with pulsate effect after ajax request completes.action}" update="messages"/> 160 . <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. In order to change the configuration of the animation.PrimeFaces Userʼs Guide Effect Configuration Each effect has different parameters for animation like colors.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.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.component. <p:feedReader value="http://rss.feedreader.FeedReader org.primefaces.yahoo.value}" escape="false"/> <p:separator /> </p:feedReader> Note that you need the ROME library in your classpath to make feedreader work.com/rss/sports" var="feed"> <h:outputText value="#{feed. An el expression that maps to a server side UIComponent instance in a backing bean URL of the feed.component.component.FeedReaderRenderer org.title}" style="font-weight: bold"/> <h:outputText value="#{feed.31 FeedReader FeedReader is used to display content from a 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.feedreader.news.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class feedReader org. Iterator to refer each item in feed.primefaces. when set to false component will not be rendered.primefaces.FeedReader org.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.description.primefaces.PrimeFaces Userʼs Guide 3. Number of items to display.component. 161 .

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

. <p:fieldset 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.jpg" /> <h:outputText value="The story begins as Don Vito Corleone ..jpg" /> <h:outputText value="Francis Ford Coppolas’ legendary ." /> </h:panelGrid> </p:fieldset> Legend Legend can be defined in two ways. facet is chosen. Toggleable Content Clicking on fieldset legend can toggle contents. this is handy to use space efficiently in a layout. Set toggleable to true to enable this feature. with legend attribute as in example above or using legend facet. Use facet way if you need to place custom html other than simple text." /> </h:panelGrid> </p:fieldset> 163 .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.

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

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

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

gif" /> </h:commandLink> If you’d like to use PrimeFaces commandButton and commandLink.gif" /> </p:commandLink> ContentDisposition By default. <h:commandLink value="Download"> <p:fileDownload value="#{fileBean.file}"/> <h:graphicImage value="pdficon. <p:commandButton value="Download" ajax="false"> <p:fileDownload value="#{fileBean. 167 . content is displayed as an attachment with a download dialog box. another alternative is the inline mode. Note that content disposition is not part of the http standard although it is widely implemented.file}"/> <h:graphicImage value="pdficon. in this case browser will try to open the file internally without a prompt. disable ajax option as fileDownload requires a full page refresh to present the file.file}" /> </p:commandButton> <p:commandLink value="Download" ajax="false"> <p:fileDownload value="#{fileBean.PrimeFaces Userʼs Guide <h:commandButton value="Download"> <p:fileDownload value="#{fileBean.file}" /> </h:commandButton> Similarly a more graphical presentation would be to use a commandlink with an image.

PrimeFaces Userʼs Guide

3.34 FileUpload
FileUpload goes beyond the browser input type="file" functionality and features an html5 powered rich solution with graceful degradation for legacy browsers.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class fileUpload org.primefaces.component.fileupload.FileUpload org.primefaces.component.FileUpload org.primefaces.component org.primefaces.component.FileUploadRenderer org.primefaces.component.fileupload.FileUploadRenderer

Attributes
Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component. Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean. Value of the component than can be either an EL expression of a literal text. An el expression or a literal text that defines a converter for the component. When it’s an EL expression, it’s resolved to a converter instance. In case it’s a static text, it must refer to a converter id. When set true, process validations logic is executed at apply request values phase for this component. Marks component as required. A method expression that refers to a method validationg the input.
168

binding value converter

null null null

Object Object Converter/ String

immediate required validator

FALSE FALSE null

Boolean Boolean MethodExpr

PrimeFaces Userʼs Guide

Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar update process fileUploadListener multiple auto label allowTypes sizeLimit fileLimit showButtons style styleClass mode uploadLabel cancelLabel invalidSizeMessage invalidFileMessage fileLimitMessage dragDropSupport onstart oncomplete disabled

Default null null null null null null null null FALSE FALSE Choose null null null TRUE null null advanced Upload Cancel null null null TRUE null null FALSE

Type MethodExpr String String String String String String MethodExpr Boolean Boolean String String Integer Integer Boolean String String String String String String String String Boolean String String Boolean

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

169

PrimeFaces Userʼs Guide

Getting started with FileUpload First thing to do is to configure the fileupload filter which parses the multipart request. FileUpload filter should map to Faces Servlet.
<filter> <filter-name>PrimeFaces FileUpload Filter</filter-name> <filter-class> org.primefaces.webapp.filter.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.
<h:form enctype="multipart/form-data"> <p:fileUpload value="#{fileBean.file}" mode="simple" /> <p:commandButton value="Submit" ajax="false"/> </h:form>

import org.primefaces.model.UploadedFile; public class FileBean { } private UploadedFile file; //getter-setter

Advanced File Upload Default mode of fileupload is advanced that provides a richer UI. In this case, FileUploadListener is the way to access the uploaded files, when a file is uploaded defined fileUploadListener is processed with a FileUploadEvent as the parameter.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" />

170

PrimeFaces Userʼs Guide
public class FileBean { } public void handleFileUpload(FileUploadEvent event) { UploadedFile file = event.getFile(); //application code }

Multiple Uploads Multiple uploads can be enabled using the multiple attribute. This way multiple files can be selected and uploaded together.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" multiple="true" />

Auto Upload Default behavior requires users to trigger the upload process, you can change this way by setting auto to true. Auto uploads are triggered as soon as files are selected from the dialog.
<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. FileUpload is equipped with the update attribute for this purpose. Following example displays a "File Uploaded" message using the growl component after file upload.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" update="msg" /> <p:growl id="msg" />

public class FileBean { } public void handleFileUpload(FileUploadEvent event) { //add facesmessage to display with growl //application code }

171

PrimeFaces Userʼs Guide

File Filters Users can be restricted to only select the file types you’ve configured, example below demonstrates how to accept images only.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" allowTypes="/(\.|\/)(gif|jpe?g|png)$/" description="Select Images"/>

Size Limit Most of the time you might need to restrict the file upload size, this is as simple as setting the sizeLimit configuration. Following fileUpload limits the size to 1000 bytes for each file.
<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" sizeLimit="1000" />

Skinning FileUpload FileUpload resides in a container element which style and styleClass options apply. Following is the list of structural style classes;
Class .ui-fileupload .fileupload-buttonbar .fileinput-button .ui-fileupload start .ui-fileupload cancel fileupload-content Main container element Button bar. Browse button. Upload button. Cancel button. Content container. Applies

As skinning style classes are global, see the main Skinning section for more information. Browser Compatibility Rich upload functionality like dragdrop from filesystem, multi uploads, progress tracking requires browsers that implement HTML5 features so advanced mode might behave differently across browsers and gracefully degrade for legacy browsers like IE. It is also suggested to offer simple upload mode to the users of your application as a fallback. Filter Configuration FileUpload filter’s default settings can be configured with init parameters. Two configuration options exist, threshold size and temporary file upload location.
172

PrimeFaces Userʼs Guide

Parameter Name thresholdSize uploadDirectory

Description Maximum file size in bytes to keep uploaded files in memory. If a file exceeds this limit, it’ll be temporarily written to disk. Disk repository path to keep temporary files that exceeds the threshold size. By default it is System.getProperty("java.io.tmpdir")

An example configuration below defined thresholdSize to be 50kb and uploads to user’s temporary folder.
<filter> <filter-name>PrimeFaces FileUpload Filter</filter-name> <filter-class> org.primefaces.webapp.filter.FileUploadFilter </filter-class> <init-param> <param-name>thresholdSize</param-name> <param-value>51200</param-value> </init-param> <init-param> <param-name>uploadDirectory</param-name> <param-value>/Users/primefaces/temp</param-value> </init-param> </filter>

Note that uploadDirectory is used internally, you should implement the logic to save the file contents yourself in your backing bean. Tips • Multiple advanced uploaders in same form is not supported at the moment.

173

PrimeFaces Userʼs Guide

3.35 Focus
Focus is a utility component that makes it easy to manage the element focus on a JSF page. Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class focus org.primefaces.component.focus.Focus org.primefaces.component.Focus.FocusTag org.primefaces.component org.primefaces.component.FocusRenderer org.primefaces.component.focus.FocusRenderer

Attributes
Name id rendered Default null TRUE Type String boolean Description Unique identifier of the component Boolean value to specify the rendering of the component, when set to false component will not be rendered. 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. 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. Input component can be any element such as input, textarea and select.
<p:focus /> <p:inputText ... /> <h:inputText ... /> <h:selectOneMenu ... />

174

PrimeFaces Userʼs Guide

Following is a simple example;
<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.firstname}" required="true" label="Firstname" /> <p:message for="firstname" /> <h:outputLabel for="surname" value="Surname: *" /> <h:inputText id="surname" value="#{pprBean.surname}" required="true" label="Surname"/> <p:message for="surname" /> </h:panelGrid> <p:commandButton value="Submit" update="panel" actionListener="#{pprBean.savePerson}" /> </p:panel> </h:form>

When this page initially opens, input text with id "firstname" will receive focus as it is the first input component. Validation Aware Another useful feature of focus is that when validations fail, first invalid component will receive a focus. So in previous example if firstname field is valid but surname field has no input, a validation error will be raised for surname, in this case focus will be set on surname field implicitly. Note that for this feature to work on ajax requests, you need to update p:focus component as well. Explicit Focus Additionally, using for attribute focus can be set explicitly on an input component which is useful when using a dialog.
<p:focus for="text"/> <h:inputText id="text" value="{bean.value}" />

175

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

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

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

when set to false component will not be rendered.GmapRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component.component.primefaces.component. Boolean value to specify the rendering of the component.primefaces.component.PrimeFaces Userʼs Guide 3.GMap org.primefaces.gmap. binding widgetVar null null Object String 179 .gmap. Name of the client side widget.component org.primefaces.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.primefaces.Gmap org.GmapRenderer org.component. An el expression that maps to a server side UIComponent instance in a backing bean.

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

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

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

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

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

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

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

primefaces.primefaces.Overlay Property paths strokeColor Default null null List String Type List of coordinates Color of a line 187 Description .Marker extends org.primefaces.Overlay Property paths strokeColor strokeOpacity strokeWeight Default null null 1 1 List String Double Integer Type List of coordinates Color of a line Opacity of a line Width of a line Description org.model.model.model.primefaces.Polyline extends org.map.map.Overlay Property title latlng icon shadow cursor draggable clickable flat visible Default null null null null pointer FALSE TRUE FALSE TRUE Type String LatLng String String String Boolean Boolean Boolean Boolean Description Text to display on rollover Location of the marker Icon of the foreground Shadow image of the marker Cursor to display on rollover Defines if marker can be dragged Defines if marker can be dragged If enabled.map. generated and used internally Data represented in marker Z-Index of the overlay org.map.model. shadow image is not displayed Defines visibility of the marker org.PrimeFaces Userʼs Guide org.primefaces.model.model.primefaces.map.map.map.Overlay Property id data zindex Default null null null Type String Object Integer Description Id of the overlay.Polygon extends org.model.primefaces.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.firstname}" /> </h:form> Note that hotkey will not be triggered if there is a focused input on page.name}" /> </h:panelGrid> <h:outputText id="dsplay" value="Hello: #{bean. <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. 201 .

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

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

ImageCompare org.primefaces.imagecompare.imagecompare. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class imageCompare org.primefaces. when set to false component will not be rendered.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean binding null Object 204 .component.ImageCompareRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.ImageCompare org.component.component.PrimeFaces Userʼs Guide 3.43 ImageCompare ImageCompare provides a rich user interface to compare two images.primefaces.component.component org.ImageCompareRenderer org.primefaces.

style and styleClass attributes apply to this element.png" rightImage="ps3. <p:imageCompare leftImage="xbox. It is required to set width and height of the images as well. Source of the image placed on the left side Source of the image placed on the right side Width of the images Height of the images Inline style of the container element Style class of the container element Getting started with ImageCompare ImageCompare is created with two images with same height and width.png" width="438" height="246"/> Skinning Both images are placed inside a div container element.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. 205 .

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

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

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

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

45 ImageSwitch Imageswitch component is a simple image gallery component.ImageSwitch org. Style of the main container.imageswitch.component.component.primefaces. Slideshow speed in milliseconds.imageswitch.primefaces. Starts slideshow automatically on page load.component.primefaces.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.component org. Style class of the main container.primefaces. Speed of the effect in milliseconds.ImageSwitch org. Name of the effect for transition.component.primefaces.ImageSwitchRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered. 210 binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass null null null 500 3000 TRUE null null Object String String Integer Integer Boolean String String . Info Tag Component Class Component Type Component Family Renderer Type Renderer Class imageSwitch org.ImageSwitchRenderer org.

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

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

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

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

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

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

PrimeFaces Userʼs Guide 3. when set to false component will not be rendered.InputMaskRenderer org.InputMask org. 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 217 .primefaces.component.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.component.primefaces.primefaces.component.inputmask.47 InputMask InputMask forces an input to fit in a defined mask template.InputMask org.primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Mask template PlaceHolder in mask template.primefaces.component org. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputMask org.component.inputmask.

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

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

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

process validations logic is executed at apply request values phase for this component.primefaces.48 InputText InputText is an extension to standard inputText with skinning capabilities. when set to false component will not be rendered.component org. it must refer to a converter id When set true. it’s resolved to a converter instance. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputText 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. Marks component as required A method binding expression that refers to a method validationg the input A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails.InputText org.primefaces.primefaces.InputTextRenderer org.component.primefaces. In case it’s a static text.InputTextRender Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component.PrimeFaces Userʼs Guide 3.component. 221 immediate required validator valueChangeListener requiredMessage FALSE FALSE null null null Boolean Boolean Method Expr Method Expr String .primefaces.InputText org.inputtext. When it’s an EL expression.component.component.inputtext.

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

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

primefaces. Marks component as required A method binding expression that refers to a method validationg the input 224 immediate required validator FALSE FALSE null Boolean Boolean Method Expr .InputTextarea org.component org. it’s resolved to a converter instance.primefaces.component. When it’s an EL expression.component.primefaces. process validations logic is executed at apply request values phase for this component.component.InputTextarea org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.primefaces.inputtextarea. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class inputTextarea org.primefaces.InputTextareaRenderer org. it must refer to a converter id When set true. In case it’s a static text.49 InputTextarea InputTextarea is an extension to standard inputTextara with skinning capabilities and auto growing.inputtextarea.InputTextareaRender Attributes Name id rendered binding value converter Default null TRUE null null null Type String Boolean Object Object Convert er/String Description Unique identifier of the component Boolean value to specify the rendering of the component.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.

225 . Message to be displayed when conversion fails. Valid values are LTR and RTL. Maximum height to grow automatically. Controls browser autocomplete behavior. Sets the maximum number of characters allowed. Client side callback to execute when input element loses focus and its value has been modified since gaining focus. Code describing the language used in the generated markup for this component. Client side callback to execute when input element is clicked. Speed of the grow animation in milliseconds. Specifies auto growing when being typed. Client side callback to execute when input element receives focus. Access key that when pressed transfers focus to the input element. Message to be displayed when validation fields. Maximum number of characters that may be entered in this field. Client side callback to execute when input element is double clicked. Alternate textual description of the input field.PrimeFaces Userʼs Guide Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar autoResize maxHeight maxLength effectDuration accesskey alt autocomplete dir disabled label lang maxlength onblur onchange onclick ondblclick onfocus onkeydown Default null null null null null TRUE 500 null 200 null null null null FALSE null null null null null null null null null Type Method Expr String String String String Boolean Integer Integer Integer String String String String Boolean String String Integer String String String String String String Description A method binding expression that refers to a method for handling a valuchangeevent Message to be displayed when required field validation fails. Client side callback to execute when a key is pressed down over input element. Name of the client side widget. Direction indication for text that does not inherit directionality. Disables input field A localized user presentable name. Client side callback to execute when input element loses focus.

Client side callback to execute when a pointer button is pressed down over input element Client side callback to execute when a pointer button is moved within input element. Client side callback to execute when a pointer button is released over input element. Client side callback to execute when a pointer button is moved away from input element. } //getter and setter 226 . Inline style of the input element. Position of the input element in the tabbing order. Getting Started with InputTextarea InputTextarea usage is same as standard inputTextarea.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.propertyName}" /> public class Bean { private String propertyName. Client side callback to execute when a pointer button is moved onto input element. Advisory tooltip informaton. Client side callback to execute when a key is released over input element. Number of characters used to determine the width of the input element. Flag indicating that this component will prevent changes by the user. <p:inputTextarea value="#{bean. Client side callback to execute when text within input element is selected by user. Style class of the input element.

see the main Skinning section for more information. textarea can grow automatically. Use autoResize option to turn on/off this feature. As skinning style classes are global. 227 .PrimeFaces Userʼs Guide AutoResize When textarea is being typed. if content height exceeds the allocated space. Skinning style and styleClass options apply to the textarea element.

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

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

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

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

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

component org.component. 233 .LayoutRenderer Attributes Name id rendered binding widgetVar fullPage Default null TRUE null null FALSE Type String Boolean Object String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component. when set to false component will not be rendered.LayoutRenderer org.component.Layout org.51 Layout Layout component features a highly customizable borderLayout model making it very easy to create complex layouts even if you’re not familiar with web design.component.primefaces.layout. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class layout org. Specifies whether layout should span all page or not. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget.Layout org.primefaces.primefaces.component.primefaces.layout.PrimeFaces Userʼs Guide 3.primefaces.

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

Element based layout Another use case of layout is the element based layout. avoid using a form that contains layoutunits as generated dom may not be the same." /> </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. So following is invalid. other layout units must have dimensions defined via size option. Dimensions Except center layoutUnit. <p:layout fullPage="true"> <h:form> <p:layoutUnit position="west" size="100"> h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> </h:form> </p:layout> A layout unit must have it’s own form instead." /> </p:layoutUnit> <p:layoutUnit position="south" size="100"> <h:outputText value="Bottom content.PrimeFaces Userʼs Guide <p:layout fullPage="true"> <p:layoutUnit position="north" size="50"> <h:outputText value="Top content. Layout example below demonstrates creating a split panel implementation. This is the default case actually so just ignore fullPage attribute or set it to false. also avoid trying to update layout units because of same reason. update it’s content instead. 235 .

ui-layout-{position} . you can update this data using ajax event listeners provided by layout.event. 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. 236 . When a unit is resized.primefaces. Stateful Layout Making layout stateful would be easy.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. For example if a layout unit is collapsed. once you create your data to store the user preference.CloseEvent org. Skinning Following is the list of structural style classes.ToggleEvent org. Event toggle close resize Listener Parameter org.primefaces. When a unit is closed.ui-layout-doc .ui-layout . you can save and persist this information. see the main Skinning section for more information.ui-layout-unit .height:200px"> <p:layoutUnit position="west" size="100"> <h:outputText value="Left Pane" /> </p:layoutUnit> <p:layoutUnit position="center"> <h:outputText value="Right Pane" /> </p:layoutUnit> </p:layout> Ajax Behavior Events Layout provides custom ajax behavior events for each layout state change.event.event.ResizeEvent Fired When a unit is expanded or collapsed. Style Class .primefaces.ui-layout-unit-header .

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

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. 238 . Getting started with LayoutUnit See layout component documentation for more information regarding the usage of layoutUnits.

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

Level of overlay opacity between 0 and 1. Width of the overlay.jpg/> </h:outputLink> //more </p:lightBox> 240 . <p:lightBox> <h:outputLink value="sopranos/sopranos1. Name of the transition effect. When true clicking outside of overlay will close lightbox. Speed for slideshow in milliseconds. Speed of the transition effect in milliseconds. Valid values are 'elastic'. Displays lightbox without requiring any user interaction by default.PrimeFaces Userʼs Guide Name styleClass widgetVar transition speed width heigth iframe opacity visible slideshow slideshowSpeed slideshowStartText slideshowStopText slideshowAuto currentTemplate overlayClose group Default null null elastic 350 null null FALSE 0.85 FALSE FALSE 2500 null null TRUE null TRUE TRUE Type String String String Integer String String Boolean Double Boolean Boolean Integer String String Boolean String Boolean Boolean Description Style class of the container element not the overlay element. Following lightBox is displayed when any of the links are clicked.jpg" title="Sopranos 1"> <h:graphicImage value="sopranos/sopranos1_small. Default is "{current} of {total}". Displays lightbox without requiring any user interaction by default. Label of slideshow stop text. Name of the client side widget. Images The images displayed in the lightBox need to be nested as child outputLink components.'fade' and 'none'. Height of the overlay. by default children belong to same group and switching is enabled. Text template for current image display like "1 of 3". Starts slideshow automatically. Specifies an iframe to display an external url in overlay. Label of slideshow start text. Defines grouping.

primefaces.org" HomePage"> <h:outputText value="PrimeFaces HomePage"/> </h:outputLink> </p:lightBox> title="PrimeFaces Clicking the outputLink will display PrimeFaces homepage within an iframe. following lightbox displays the PrimeFaces homepage when the link inside is clicked. IFrame Mode LightBox also has the ability to display iframes inside the page overlay.PrimeFaces Userʼs Guide Output of this lightbox is. <p:lightBox iframe="true" width="80%" height="80%"> <h:outputLink value="http://www. 241 .

jpg" title="Sopranos 1"> <h:graphicImage value="sopranos/sopranos1_small. <p:lightBox slideshow="true" slideshowSpeed="2000" slideshowStartText="Start" slideshowStopText="Stop"> <h:outputLink value="sopranos/sopranos1. you can display other JSF content on the page using the lightbox overlay.. Clicking the link in the example below will display the panelGrid contents in overlay.jpg" /> <h:outputText style="color:#FFFFFF" value="Messi is an unusual player." /> </h:panelGrid> </f:facet> </p:lightBox> SlideShow If you want to use lightbox images as a slideshow. <p:lightBox width="50%" height="50%"> <h:outputLink value="#" title="Leo Messi" > <h:outputText value="The Messiah"/> </h:outputLink> <f:facet name="inline"> <h:panelGrid columns="2"> <h:graphicImage value="barca/messi..jpg/> </h:outputLink> <h:outputLink value="sopranos/sopranos2. turn slideshow setting to true..PrimeFaces Userʼs Guide Inline Mode Inline mode acts like a modal panel. Simply place your overlay content in the "inline" facet.jpg /> </h:outputLink> </p:lightBox> 242 .jpg" title="Sopranos 2"> <h:graphicImage value="sopranos/sopranos2_small...

component. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class log org.component.Log org. <p:log /> 243 .primefaces.primefaces.primefaces.primefaces.log.component.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 binding null Object Getting started with Log Log component is used simply as adding the component to the page.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.Log org.log.PrimeFaces Userʼs Guide 3.primefaces.component.54 Log Log component is a visual console to display logs on JSF pages.LogRenderer org.

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

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

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

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

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

break.com" /> <p:menuitem value="Yahoo Mail" url="http://mail.com" /> </p:submenu> <p:submenu label="Social Networks"> <p:menuitem value="Facebook" url="http://www. "static" and "dynamic".PrimeFaces Userʼs Guide Submenus are used to group menuitems.google.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.com" /> <p:menuitem value="Break" url="http://www.facebook.com" /> <p:menuitem value="MySpace" url="http://www. • • • • left right bottom top 249 .youtube. <p:menu> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www.com" /> <p:menuitem value="Hotmail" 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="Metacafe" url="http://www.hotmail.metacafe.com" /> </p:submenu> </p:menu> Overlay Menu Menu can be positioned on a page in two ways.yahoo.myspace. Location of menu on page will be relative to the trigger and defined by my and at options that take combination of four values. 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.

.primefaces.submenus and menuitems </p:menu> Plain Tiered Sliding (iPod) Ajax and Non-Ajax Actions As menu uses menuitems.save}" update="comp"/> <p:menuitem value="Update" actionListener="#{bean.update}" ajax="false"/> <p:menuitem value="Navigate" url="http://www. <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. tiered and sliding.org"/> </p:submenu> </p:menu> 250 . See menuitem documentation for more information about the capabilities. <p:menu type="plain|tiered|sliding"> ..submenus and menuitems </p:menu> <p:commandButton id="btn" value="Show Menu" type="button"/> Menu Types Menu has three different types.PrimeFaces Userʼs Guide For example. <p:menu> <p:submenu label="Options"> <p:menuitem value="Save" actionListener="#{bean.. plain..

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

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

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

PrimeFaces Userʼs Guide
<p:menubar> <p:submenu label="Mail"> <p:menuitem value="Gmail" url="http://www.google.com" /> <p:menuitem value="Hotmail" url="http://www.hotmail.com" /> <p:menuitem value="Yahoo Mail" url="http://mail.yahoo.com" /> </p:submenu> <p:submenu label="Videos"> <p:menuitem value="Youtube" url="http://www.youtube.com" /> <p:menuitem value="Break" url="http://www.break.com" /> </p:submenu> </p:menubar>

Nested Menus To create a menubar with a higher depth, nest submenus in parent submenus.
<p:menubar> <p:submenu label="File"> <p:submenu label="New"> <p:menuitem value="Project" url="#"/> <p:menuitem value="Other" url="#"/> </p:submenu> <p:menuitem value="Open" url="#"></p:menuitem> <p:menuitem value="Quit" url="#"></p:menuitem> </p:submenu> <p:submenu label="Edit"> <p:menuitem value="Undo" url="#"></p:menuitem> <p:menuitem value="Redo" url="#"></p:menuitem> </p:submenu> <p:submenu label="Help"> <p:menuitem label="Contents" url="#" /> <p:submenu label="Search"> <p:submenu label="Text"> <p:menuitem value="Workspace" url="#" /> </p:submenu> <p:menuitem value="File" url="#" /> </p:submenu> </p:submenu> </p:menubar>

Root Menuitem Menubar supports menuitem as root menu options as well; Following example allows a root menubar item to execute an action to logout the user.
<p:menubar> //submenus <p:menuitem label="Logout" action="#{bean.logout}"/> </p:menubar>

254

PrimeFaces Userʼs Guide

Ajax and Non-Ajax Actions As menu uses menuitems, it is easy to invoke actions with or without ajax as well as navigation. See menuitem documentation for more information about the capabilities.
<p:menubar> <p:submenu label="Options"> <p:menuitem value="Save" actionListener="#{bean.save}" update="comp"/> <p:menuitem value="Update" actionListener="#{bean.update}" ajax="false"/> <p:menuitem value="Navigate" url="http://www.primefaces.org"/> </p:submenu> </p:menubar>

Dynamic Menus Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example. Skinning Menubar resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;
Style Class .ui-menubar .ui-menu-list .ui-menuitem .ui-menuitem-link .ui-menuitem-text Applies Container element of menubar. List container Each menu item Anchor element in a link item Text element in an item

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

255

PrimeFaces Userʼs Guide

3.58 MenuButton
MenuButton displays different commands in a popup menu.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class menuButton org.primefaces.component.menubutton.MenuButton org.primefaces.component.MenuButton org.primefaces.component org.primefaces.component.MenuButtonRenderer org.primefaces.component.menubutton.MenuButtonRenderer

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

binding value style styleClass widgetVar model disabled

null null null null null null FALSE

Object String String String String MenuModel Boolean

256

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, second one does the similar but without ajax and third one is used for redirect purposes.
<p:menuButton value="Options"> <p:menuitem value="Save" actionListener="#{bean.save}" update="comp" /> <p:menuitem value="Update" actionListener="#{bean.update}" ajax="false" /> <p:menuitem value="Go Home" url="/home.jsf" /> </p:menuButton>

Dynamic Menus Menus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example. Skinning MenuButton resides in a main container which style and styleClass attributes apply. As skinning style classes are global, see the main Skinning section for more information. Following is the list of structural style classes;
Style Class .ui-menu .ui-menu-list .ui-menuitem .ui-menuitem-link .ui-menuitem-text .ui-button .ui-button-text Applies Container element of menu. List container Each menu item Anchor element in a link item Text element in an item Button element Label of button

257

PrimeFaces Userʼs Guide

3.59 MenuItem
MenuItem is used by various menu components of PrimeFaces. Info
Tag Tag Class Component Class Component Type Component Family menuItem org.primefaces.component.menuitem.MenuItemTag org.primefaces.component.menuitem.MenuItem org.primefaces.component.MenuItem org.primefaces.component

Attributes
Name id rendered Default null TRUE String Boolean Type Description Unique identifier of the component. Boolean value to specify the rendering of the component, when set to false component will not be rendered. An el expression that maps to a server side UIComponent instance in a backing bean. Label of the menuitem Action listener to be invoked when menuitem is clicked. Action to be invoked when menuitem is clicked. When true, action of this menuitem is processed after apply request phase. 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, ajax requests are not queued. Component id(s) to process partially instead of whole view.

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.el.MethodE xpression javax.el.MethodE xpression Boolean String String String String String Boolean String

258

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. Disables the menuitem. 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. Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. Specifies submit mode. Path of the menuitem image.

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. • • • • • • Menu MenuBar Breadcrumb Dock Stack MenuButton

Note that some attributes of menuitem might not be supported by these menu components. Refer to the specific component documentation for more information. Navigation vs Action Menuitem has two use cases, 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. This is decided by url attribute, if it is present menuitem does a GET request, if not parent form is posted. Icons There are two ways to specify an icon of a menuitem, you can either use bundled icons within PrimeFaces or provide your own via css.

259

PrimeFaces Userʼs Guide

ThemeRoller Icons
<p:menuitem icon="ui-icon ui-icon-disk" ... />

Custom Icons
<p:menuitem icon="barca" ... />

.barca { background: url(barca_logo.png) no-repeat; height:16px; width:16px; }

260

PrimeFaces Userʼs Guide

3.60 Message
Message is a pre-skinned extended version of the standard JSF message component.

Info
Tag Component Class Component Type Component Family Renderer Type Renderer Class message org.primefaces.component.message.Message org.primefaces.component.Message org.primefaces.component org.primefaces.component.MessageRenderer org.primefaces.component.message.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. 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. Specifies if the summary of the FacesMessage should be displayed. Specifies if the detail of the FacesMessage should be displayed. Id of the component whose messages to display. Defines if already rendered messages should be displayed Defines the display mode.

Getting started with Message Message usage is exactly same as standard message.
<h:inputText id="txt" value="#{bean.text}" /> <p:message for="txt" />

261

PrimeFaces Userʼs Guide

Display Mode Message component has three different display modes; • text : Only message text is displayed. • icon : Only message severity is displayed and message text is visible as a tooltip. • both (default) : Both icon and text are displayed. Skinning Message Full list of CSS selectors of message is as follows; Style Class ui-message-{severity} ui-message-{severity}-summary ui-message-{severity}-info Applies Container element of the message Summary text Detail text

{severity} can be ‘info’, ‘error’, ‘warn’ and error.

262

PrimeFaces Userʼs Guide

3.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.component.messages.Messages org.primefaces.component.Messages org.primefaces.component org.primefaces.component.MessagesRenderer org.primefaces.component.messages.MessagesRenderer

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. Specifies if the summary of the FacesMessages should be displayed. Specifies if the detail of the FacesMessages should be displayed. When true, only facesmessages with no clientIds are displayed.
263

binding showSummary showDetail globalOnly

null FALSE TRUE FALSE

Object Boolean Boolean String

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

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

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

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

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

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

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

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

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

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

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

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

primefaces.primefaces.primefaces. when set to false component will not be rendered.component org.password. process validations logic is executed at apply request values phase for this component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class password org. it must refer to a converter id When set true.component.Password org. it’s resolved to a converter instance.PasswordRenderer org.Password org. When it’s an EL expression.component.66 Password Password component is an extended version of standard inputSecret component with theme integration and strength indicator.primefaces.component.PrimeFaces Userʼs Guide 3. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component.password. 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 276 .component. In case it’s a static text.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.

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

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

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

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

primefaces. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component than can be either an EL expression of a literal text An el expression or a literal text that defines a converter for the component. In case it’s a static text.PrimeFaces Userʼs Guide 3.primefaces.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 pickList org.picklist.picklist.67 PickList PickList is used for transferring data between two different collections.PickListRenderer org.primefaces. Marks component as required binding value converter null null null Object Object Convert er/String immediate FALSE Boolean required FALSE Boolean 281 . when set to false component will not be rendered.primefaces. it must refer to a converter id When set true.primefaces.component org. When it’s an EL expression. it’s resolved to a converter instance.component.PickListRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Panel org.PickList org.component.component.

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

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

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

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

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

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

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

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

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

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

<p:progressBar interval="5000" /> 292 .setValue(0). //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. Following is a pure client side progressBar. pb. }.setValue(pbClient.getValue() + 10). In order to set a different value. <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. use the interval attribute.progressInterval). } function cancel() { clearInterval(this. "client"(default) or "ajax".progress}" /> public class ProgressBean { } private int progress.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.progressInterval = setInterval(function(){ pb. <p:progressBar ajax="true" value="#{progressBean. 2000). in this case the value defined on a managed bean is retrieved peridically and used to update the progress.

public void handleComplete() { //Add a faces message } //getter-setter <p:progressBar value="#{progressBean.ProgressBar Method getValue() setValue(value) start() cancel() Params value: Value to display Return Type Number void void void Description Returns current value Sets current value Starts ajax progress bar Stops ajax progress bar Skinning ProgressBar resides in a main container which style and styleClass attributes apply.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. see the main Skinning section for more information.ui-progressbar-value Applies Main container element of progressbar Value of the progressbar As skinning style classes are global. Style Class . Example below demonstrates how to use this event. Following is the list of structural style classes.widget. public class ProgressBean { } private int progress.progress}" ajax="true"> <p:ajax event="complete" listener="#{progressBean.handleComplete}" update="messages" /> </p:progressBar> <p:growl id="messages" /> Client Side API Widget: PrimeFaces.ui-progressbar . 293 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

primefaces. it must refer to a converter id When set true.SelectOneListboxRenderer org.SelectOneListbox org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. An el expression or a literal text that defines a converter for the component.component.selectonelistbox. 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. When it’s an EL expression.SelectOneListbox org.PrimeFaces Userʼs Guide 3.component. Marks component as required A method expression that refers to a method validationg the input binding value converter null null null Object Object Converter/ String immediate FALSE Boolean required validator FALSE null Boolean MethodExpr 326 .SelectOneListBoxRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.primefaces.primefaces.selectonelistbox.component. when set to false component will not be rendered.component.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneListbox org.primefaces.85 SelectOneListbox SelectOneListbox is an extended version of the standard SelectOneListbox with theme integration.component org.

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

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

Duration of toggle animation in milliseconds. Name of the toggle animation. Name of the item iterator. Message to be displayed when validation fields. User presentable name. Style class of the container. Callback to execute on value change. Inline style of the component. Tabindex of the input. • • • • • • • • • blind bounce clip drop explode fold highlight puff pulsate 329 . Message to be displayed when conversion fails. default effect is blind and following options are available for effect attribute.PrimeFaces Userʼs Guide Name validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar effect effectDuration disabled label onchange style styleClass var height tabindex Default null null null null null null blind 400 FALSE null null null null null auto null Type MethodExpr MethodExpr String String String String String Integer Boolean String String String String String Integer String 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. Getting started with SelectOneMenu Basic SelectOneMenu usage is same as the standard one. Name of the client side widget. Effects An animation is executed to show and hide the overlay menu. Disables the component. Height of the overlay.

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

ui-selectonemenu-trigger . Container of dropdown icon.ui-selectonemenu-items . Applies 331 . see the main Skinning section for more information. As skinning style classes are global. Following is the list of structural style classes. Items list.ui-selectonemenu-items Main container.ui-selectonemenu . Style Class .ui-selectonemenu-label . Label of the component.PrimeFaces Userʼs Guide Skinning SelectOneMenu resides in a container element that style and styleClass attributes apply. Each item in the 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 org. it’s resolved to a converter instance. it must refer to a converter id When set true.primefaces.primefaces.87 SelectOneRadio SelectOneRadio is an extended version of the standard SelectOneRadio with theme integration.selectoneradio.primefaces. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3. 332 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 . process validations logic is executed at apply request values phase for this component.component.SelectOneRadioRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.component.selectoneradio. An el expression or a literal text that defines a converter for the component.component.SelectOneRadio org. An el expression that maps to a server side UIComponent instance in a backing bean Value of the component referring to a List. In case it’s a static text. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class selectOneRadio org.primefaces. When it’s an EL expression.SelectOneRadio org.primefaces.component.SelectOneRadioRenderer org.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

.primefaces. Here is an example of a tabChange behavior implementation. <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.propertyA}"> <h:outputText value= "#{listItem. } Your listener(if defined) will be invoked with an org. If you want to reload content of a tab each time a tab is selected.getTab(). <p:tabView> <p:ajax event=”tabChange” listener=”#{bean. Dynamic Number of Tabs When the tabs to display are not static.propertyB}"/> . normal (default) and fast are the valid options.event.PrimeFaces Userʼs Guide Content Caching Dynamically loaded tabs cache their contents by default.TabChangeEvent instance that contains a reference to the new active tab and the accordion panel itself. <p:tabView value=”#{bean. by doing so.. //.. turn off caching by cache to false.list}” var=”listItem”> <p:tab title="#{listItem. For tabClose event.onChange}” /> </p:tabView> public void onChange(TabChangeEvent event) { //Tab activeTab = event.event. use the built-in iteration feature similar to ui:repeat.More content </p:tab> </p:tabView> 361 . slow. listener will be passed an instance of org.TabCloseEvent. EffectDuration specifies the speed of the effect. Effects Content transition effects are controlled with effect and effectDuration attributes. reactivating a tab doesn’t result in an ajax request since contents are cached..primefaces.

widget. Class .ui-tabs-panel Applies Main tabview container element Main container of tab headers Each tab container 362 .ui-tabs .TabView.PrimeFaces Userʼs Guide Client Side Callbacks Tabview has two callbacks for client side. index)"> //tabs </p:tabView> function handleTabChange(index) { //index = Index of the new tab } Client Side API Widget: PrimeFaces. use select instead) Activates tab with given index Disables tab with given index Enables tab with given index Removes tab with given index Returns the number of tabs Returns index of current tab disable(index) enable(index) remove(index) getLength() getActiveIndex() index: Index of tab to disable index: Index of tab to enable index: Index of tab to remove - void void void Number Number Skinning As skinning style classes are global.ui-tabs-nav . onTabChange is executed when an inactive tab is clicked and onTabShow is executed when an inactive tab becomes active to be shown. 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. Following is the list of structural style classes. <p:tabView onTabChange="handleTabChange(event. see the main Skinning section for more information.

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

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

365 binding width height welcomeMessage prompt null null null null prime $ Object String String String String .Terminal org.component.terminal. An el expression that maps to a server side UIComponent instance in a backing bean Width of the terminal Height of the terminal Welcome message to be displayed on initial load.Terminal org. Primary prompt text.terminal.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class terminal org.component. when set to false component will not be rendered.PrimeFaces Userʼs Guide 3.TerminalRenderer org.primefaces.component.101 Terminal Terminal is an ajax powered web based terminal that brings desktop terminals to JSF.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.component.primefaces.primefaces.component org.

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

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

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

PrimeFaces Userʼs Guide 3.util.primefaces.component.timeline.component org. 369 binding widgetVar value null null null Object String java. An el expression that maps to a server side UIComponent instance in a backing bean Name of the client side widget. when set to false component will not be rendered.component.List .Timeline org.primefaces.component.103 Timeline Timeline visualizes temporal data.TimelineRenderer Attributes Name id rendered Default null TRUE Type String Boolean Description Unique identifier of the component Boolean value to specify the rendering of the component.Timeline org.TimelineRenderer org.timeline.component.primefaces. A list representing the backed model.primefaces.primefaces. Info Tag Component Class Component Type Component Family Renderer Type Renderer Class timeline org.

setFocusDate(calendar. "PrimeFaces 0.2. } //getter of model } <p:timeline value="#{timelineBean. Calendar calendar = Calendar.add(primefaces). null.setInitialZoom(37). 29). 26). calendar. primefaces.set(2010.set(2008. "/images/timeline/orange. "/images/timeline/green. 9. "/images/timeline/blue.set(2009.addEvent(new DefaultTimelineEvent("First Release".0 Released". 29). calendar.getTime(). model.2. Getting started with the Timeline Backing model is a list of timelines each containing timeline events.png")).getTime()).0/2. primefaces.png")). 15). calendar. Maximum zoom level. primefaces. null. Style class of the container element. DefaultTimeLine primefaces = new DefaultTimeLine("primefaces". calendar. 1. calendar.addEvent(new DefaultTimelineEvent("1. 1. calendar.model}" style="height:300px"/> 370 .set(2011. "PrimeFaces begins".png")).1 Milestone". 14).getInstance().getTime().png")). null.PrimeFaces Userʼs Guide Name style styleClass minZoom maxZoom zoomable Default null null 1 50 TRUE Type String String Integer Integer Boolean Description Inline style of the container element. "/images/timeline/black. "PrimeFaces 1.addEvent(new DefaultTimelineEvent("Project start".set(2008.0/2. primefaces. Minimum zoom level.1 Released". calendar. "PrimeFaces History"). 1. calendar. Specifies visibility of the zoom control. public class TimelineBean { private List<Timeline> model. 9.getTime().getTime(). null.addEvent(new DefaultTimelineEvent("2. "PrimeFaces 2. calendar.0 Milestone".0 Released". primefaces. public TimelineBean() { model = new ArrayList<Timeline>(). primefaces.8.

this specifies indicator size.model. As skinning style classes are global. Importance of the event. org. Initial date on timeline to focus. Returns all events. Initial zoom level on timeline. PrimeFaces provides org.model.timeline. Description PrimeFaces provides org. Returns description of the event to display in popup.TimelineEvent Method String getTitle() String getDescription() Date getStartDate() Date getEndDate() int getImportance() String getIcon() Returns title of the event.Timeline Method String getTitle() Date getFocusDate() int getInitialZoom() void addEvent(TimelineEvent e) boolean deleteEvent(TimelineEvent e) List<TimelineEvent> getEvents() Description Returns title of the timeline.model. see the main Skinning section for more information.timeline. 371 . Removes an event.primefaces.DefaultTimelineEvent as the default implementation. Start date of the event. Adds an event. End date of the event.DefaultTimeline as the default implementation.PrimeFaces Userʼs Guide Timeline API org.timeline.primefaces.timeline.primefaces.model. Icon of the event. Skinning Timeline resides in a container element that style and styleClass attributes apply.primefaces.

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

Style Class . <p:toolbar> <p:toolbarGroup align="left"> <p:commandButton type="push" value="New" image="ui-icon-document" /> <p:commandButton type="push" value="Open" image="ui-icon-folder-open"/> <p:separator /> <p:commandButton type="push" title="Save" image="ui-icon-disk"/> <p:commandButton type="push" title="Delete" image="ui-icon-trash"/> <p:commandButton type="push" title="Print" image="ui-icon-print"/> </p:toolbarGroup> <p:divider /> <p:toolbarGroup align="right"> <p:menuButton value="Navigate"> <p:menuitem value="Home" url="#" /> <p:menuitem value="Logout" url="#" /> </p:menuButton> </p:toolbarGroup> </p:toolbar> Skinning Toolbar resides in a container element which style and styleClass options apply.ui-toolbar-group-right Main container Divider in a toolbar Left toolbarGroup container Right toolbarGroup container Applies As skinning style classes are global. Additionally p:separator component can be used to separate items in toolbar.PrimeFaces Userʼs Guide Any number of components can be placed inside toolbarGroups. see the main Skinning section for more information.ui-toolbar . Here is an example.ui-separator .ui-toolbar-group-left .ui-toolbar . 373 . Following is the list of structural style classes.

PrimeFaces Userʼs Guide 3.105 ToolbarGroup ToolbarbarGroup is a helper component for Toolbar component to define placeholders. An el expression that maps to a server side UIComponent instance in a backing bean Defines the alignment within toolbar. Inline style of the container element.toolbar. Info Tag Component Class Component Type Component Family toolbarGroup org.component.component.primefaces. binding align style styleClass null null null null Object String String String Getting Started with the ToolbarGroup See toolbar documentation for more information about how Toolbar Group is used.ToolbarGroup org. 374 . valid values are left and right. when set to false component will not be rendered.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. Style class of the container element.primefaces.ToolbarGroup org.

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

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

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

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

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

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

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

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

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

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

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

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

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

Getting started with the TreeTable Similar to the Tree. TreeNode API has a hierarchical data structure and represents the data to be populated in tree. Inline style of the table element. Height of scrollable data. private String type.TreeNode instance that corresponds to the root node. public class Document { } private String name.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. model to be displayed is a collection of documents. Style class of the table element.type}" /> </p:column> </p:treeTable> 388 . For an example. //getters. Width of scrollable data. setters <p:treeTable value="#{bean.primefaces. private String size.name}" /> </p:column> <p:column> <f:facet name="header"> Size </f:facet> <h:outputText value="#{document.root}" var="document"> <p:column> <f:facet name="header"> Name </f:facet> <h:outputText value="#{document. TreeTable is populated with an org.model. Description Whether or not the data should be scrollable.

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

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

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

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

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

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

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

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

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

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

g. <h:form id="form1"> <p:commandButton update="form2:display" /> </h:form> <h:form id="form2"> <h:outputText id="display" value="#{bean.value}"/> </h:form> 399 .PrimeFaces Userʼs Guide <h:form prependId="false"> <p:commandButton update="display" /> <h:outputText id="display" value="#{bean.value}"/> </h:form> Different NamingContainers If your page has different naming containers (e. note that this uses same search algorithm as standard JSF 2 implementation. Following is the suggested way using separator char as a prefix. 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. two forms). <h:form id="form1"> <p:commandButton update=":form2:display" /> </h:form> <h:form id="form2"> <h:outputText id="display" value="#{bean.value}"/> </h:form> Using absolute clientIds will also work as a PrimeFaces extension however we might remove it in a future release to align with JSF spec. <h:form id="myform"> <p:commandButton update="myform:display" /> <h:outputText id="display" value="#{bean.value}"/> </h:form> ClientId It is also possible to define the client id of the component to update.

value}"/> </h:form> Keywords can also be used together with explicit ids.value2}"/> </h:form> Keywords There are a couple of reserved keywords which serve as helpers. Comma <h:form> <p:commandButton update="display1. <h:form> <p:commandButton update="@form" /> <h:outputText value="#{bean. whitespace or even both. display" is also supported.display2" /> <h:outputText id="display1" value="#{bean.PrimeFaces Userʼs Guide Multiple Components Multiple Components to update can be specified with providing a list of ids separated by a comma. Example below updates the whole form.value1}"/> <h:outputText id="display2" value="#{bean. so update="@form.value1}"/> <h:outputText id="display2" value="#{bean. Keyword @this @parent @form @none Description Component that triggers the PPR is updated Parent of the PPR trigger is updated.value2}"/> </h:form> WhiteSpace <h:form> <p:commandButton update="display1 display2" /> <h:outputText id="display1" value="#{bean. 400 . Encapsulating form of the PPR trigger is updated PPR does not change the DOM with ajax response.

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

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

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

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

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

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

username + ": " + message).4.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."). } </script> When the button is clicked. private String username. JSF button invokes the increment method and RequestContext API forwards the pushed data to the counter channel of the push server.increment}" /> </h:form> <p:push onmessage="handleMessage" channel="counter" /> <script type="text/javascript"> function handleMessage(evt.getCurrentInstance().PrimeFaces Userʼs Guide <h:form> <h:outputText value="#{globalCounter.push("chat". public void send(ActionEvent event) { RequestContext.html(data). username + " has logged in. data) { $('. then push server forwards this data to all subscribers.push("chat". 6.2 Chat Chat is a simple p2p messaging implementation. RequestContext. public class ChatBean implements Serializable { } private String message. } public void login(ActionEvent event) { loggedIn = true. } //getters&setters 407 . private boolean loggedIn.getCurrentInstance().display').

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

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

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

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

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

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

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

PrimeFaces Userʼs Guide

8.3 How Themes Work
Powered by ThemeRoller, PrimeFaces separates structural css from skinning css. Structural CSS These style classes define the skeleton of the components and include css properties such as margin, padding, display type, dimensions and positioning. Skinning CSS Skinning defines the look and feel properties like colors, border colors, background images. Skinning Selectors ThemeRoller features a couple of skinning selectors, most important of these are;
Selector .ui-widget .ui-widget-header .ui-widget-content .ui-state-default .ui-state-hover .ui-state-active .ui-state-disabled .ui-state-highlight .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. Highlighted elements. An element to represent an icon. Applies

These classes are not aware of structural css like margins and paddings, mostly they only define colors. 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. For example Panel component’s header section has the .ui-panel-titlebar structural class, to change the color of a panel header you don’t need to about this class as .ui-widget-header also that defines the panel colors also applies to the panel header.

415

PrimeFaces Userʼs Guide

8.4 Theming Tips
• Default font size of themes might be bigger than expected, to change the font-size of PrimeFaces components globally, use the .ui-widget style class. An example of smaller fonts;
.ui-widget, .ui-widget .ui-widget { font-size: 90% !important; }

• When creating your own theme with themeroller tool, select one of the pre-designed themes that is close to the color scheme you want and customize that to save time. • If you are using Apache Trinidad or JBoss RichFaces, PrimeFaces Theme Gallery includes Trinidad’s Casablanca and RichFaces’s BlueSky theme. You can use these themes to make PrimeFaces look like Trinidad or RichFaces components during migration. • To change the style of a particular component instead of all components of same type use namespacing, example below demonstrates how to change header of all panels.
.ui-panel-titlebar { //css }

or
.ui-paneltitlebar.ui-widget-header { //css }

To apply css on a particular panel;
<p:panel styleClass="custom"> ... </p:panel>

.custom .ui-panel-titlebar { //css }

• Set primefaces.THEME_FORMS context parameter to false if you’d like to disable theming on input field components such as p:inputText, p:inputTextarea.

416

PrimeFaces Userʼs Guide

9. Utilities
9.1 RequestContext
RequestContext is a simple utility that provides useful goodies such as adding parameters to ajax callback functions. RequestContext can be obtained similarly to FacesContext.
RequestContext requestContext = RequestContext.getCurrentInstance();

RequestContext API
Method isAjaxRequest() addCallBackParam(String name, Object value) addPartialUpdateTarget(String target); execute(String script) Description Returns a boolean value if current request is a PrimeFaces ajax request. Adds parameters to ajax callbacks like oncomplete. Specifies component(s) to update at runtime. Executes script after ajax request completes.

Callback Parameters There may be cases where you need values from backing beans in ajax callbacks. Suppose you have a form in a p:dialog and when the user ends interaction with form, you need to hide the dialog or if there’re any validation errors, dialog needs to stay open. Callback Parameters are serialized to JSON and provided as an argument in ajax callbacks.
<p:commandButton actionListener="#{bean.validate}" oncomplete="handleComplete(xhr, status, args)" />

public void validate() { //isValid = calculate isValid RequestContext requestContext = RequestContext.getCurrentInstance(); requestContext.addCallbackParam("isValid", true or false); }

417

PrimeFaces Userʼs Guide

isValid parameter will be available in handleComplete callback as;
<script type="text/javascript"> function handleComplete(xhr, status, args) { var isValid = args.isValid; if(isValid) dialog.hide(); } </script>

You can add as many callback parameters as you want with addCallbackParam API. Each parameter is serialized as JSON and accessible through args parameter so pojos are also supported just like primitive values. Following example sends a pojo called User that has properties like firstname and lastname to the client.
public void validate() { //isValid = calculate isValid RequestContext requestContext = RequestContext.getCurrentInstance(); requestContext.addCallbackParam("isValid", true or false); requestContext.addCallbackParam("user", user); }

<script type="text/javascript"> function handleComplete(xhr, status, args) { var firstname = args.user.firstname; var lastname = args.user.lastname; } </script>

Default validationFailed By default validationFailed callback parameter is added implicitly if JSF validation fails. Runtime Partial Update Configuration There may be cases where you need to define which component(s) to update at runtime rather than specifying it declaratively at compile time. addPartialUpdateTarget method is added to handle this case. In example below, button actionListener decides which part of the page to update on-the-fly.
<p:commandButton value="Save" actionListener="#{bean.save}" /> <p:panel id="panel"> ... </p:panel> <p:dataTable id="table"> ... </p:panel>

418

PrimeFaces Userʼs Guide
public void save() { //boolean outcome = ... RequestContext requestContext = RequestContext.getCurrentInstance(); if(outcome) requestContext.addPartialUpdateTarget("panel"); else requestContext.addPartialUpdateTarget("table"); }

When the save button is clicked, depending on the outcome, you can either configure the datatable or the panel to be updated with ajax response. Execute Javascript RequestContext provides a way to execute javascript when the ajax request completes, this approach is easier compared to passing callback params and execute conditional javascript. Example below hides the dialog when ajax request completes;
public void save() { RequestContext requestContext = RequestContext.getCurrentInstance(); requestContext.execute(“dialog.hide()”); }

419

PrimeFaces Userʼs Guide

9.2 EL Functions
PrimeFaces provides built-in EL extensions that are helpers to common use cases. Common Functions Function component(‘id’) widgetVar(‘id’) Component
<h:form id="form1"> <h:inputText id="name" /> </h:form> //#{p:component(‘name’)} returns ‘form1:name’

Description Returns clientId of the component with provided server id parameter. This function is useful if you need to work with javascript. Provides the widgetVar of a component.

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. Returns a boolean value if has any of the given roles or not. Returns a boolean value if has all of the given roles or not. Returns the name of the logged in user. Returns the principial instance of the logged in user.

420

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

421

PrimeFaces Userʼs Guide

10. Portlets
PrimeFaces supports portlet environments based on JSF 2 and Portlet 2 APIs. A portlet bridge is necessary to run a JSF application as a portlet and we've tested the bridge from portletfaces project. A kickstart example is available at PrimeFaces examples repository;
http://primefaces.googlecode.com/svn/examples/trunk/prime-portlet

10.1 Dependencies
Only necessary dependency compared to a regular PrimeFaces application is the JSF bridge, 2.0.1 is the latest version of portletfaces at the time of writing. Here's maven dependencies configuration from portlet sample.
<dependencies> <dependency> <groupId>javax.faces</groupId> <artifactId>jsf-api</artifactId> <version>2.0</version> </dependency> <dependency> <groupId>com.sun.faces</groupId> <artifactId>jsf-impl</artifactId> <version>2.0.4-b09</version> </dependency> <dependency> <groupId>org.primefaces</groupId> <artifactId>primefaces</artifactId> <version>2.2</version> </dependency> <dependency> <groupId>javax.portlet</groupId> <artifactId>portlet-api</artifactId> <version>2.0</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.portletfaces</groupId> <artifactId>portletfaces-bridge</artifactId> <version>2.0.1</version> </dependency> </dependencies>

422

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

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

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

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

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

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

PrimeFaces Userʼs Guide 13. http://wiki.primefaces.org Social Networks You can follow PrimeFaces on twitter using @primefaces and join the Facebook group. taglib docs.org Source Code PrimeFaces source is at google code subversion repository.google. 429 . http://code.primefaces. http://code. wiki and more please visit. Forum is public to everyone and registration is required to do a post. http://www. http://forum.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.primefaces.google. for additional documentation like apidocs.html Support Forum PrimeFaces discussions take place at the support forum. Please use the forum before creating an issue instead.org/documentation.com/p/primefaces/issues/list WIKI PrimeFaces Wiki is a community driven additional documentation resource.

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

PrimeFaces Userʼs Guide THE END 431 .

Sign up to vote on this title
UsefulNot useful