PMC member of open source JSF implementation Apache MyFaces. He is a recognized speaker in international conferences including JavaOne, SpringOne, Jazoon, JAX, W-JAX, JSFSummit,

JSFDays, Con-Fess and many local events such as JUGs.

Çağatay is also an author and technical reviewer of a couple books regarding web application development with Java and JSF. As an experienced trainer, he has trained over 300 developers on

Java EE technologies mainly JSF, Spring, EJB 3.x and JPA.

Çağatay is also known as Optimus Prime in JavaServer Faces Community.

PrimeFaces User’s Guide

1. Introduction

1.1 What is PrimeFaces?

PrimeFaces is an open source JSF component suite with various extensions.

• Rich set of components (HtmlEditor, Dialog, AutoComplete, Charts and many more).

• Built-in Ajax based on standard JSF 2.0 Ajax APIs.

• Lightweight, one jar, zero-configuration and no required dependencies.

• Push support via Atmosphere Framework.

• Mobile UI kit to create mobile web applications.

• Skinning Framework with 35+ built-in themes and support for visual theme designer tool.

• Extensive documentation.

• Large, vibrant and active user community.

• Developed with "passion" from application developers to application developers.

PrimeFaces User’s Guide

2. Setup

2.1 Download

PrimeFaces has a single jar called primefaces-{version}.jar. There are two ways to download this jar, you can either download from PrimeFaces homepage or if you are a maven user you can define it as a dependency.

Download Manually

Three different artifacts are available for each PrimeFaces version, binary, sources and bundle.

Bundle contains binary, sources and javadocs.

http://www.primefaces.org/downloads

Download with Maven

Group id is org.primefaces and artifact id is primefaces.

<groupId>org.primefaces</groupId>

<artifactId>primefaces</artifactId>

</dependency>

PrimeFaces User’s Guide

2.2 Dependencies

PrimeFaces only requires a JAVA 5+ runtime and a JSF 2.x implementation as mandatory dependencies. There’re some optional libraries for certain features. Licenses of all dependencies and any 3rd part work incorporated are compatible with the PrimeFaces Licenses.

Dependency

JSF runtime itext apache poi rome commons-fileupload commons-io atmosphere

1.0

1.3

2.2

2.1.3

Version *

2.0, 2.1 or 2.2

2.1.7

3.7

Type

Required

Optional

Description

Apache MyFaces or Oracle Mojarra

DataExporter (PDF).

DataExporter (Excel).

FeedReader.

FileUpload

PrimeFaces Push

* Listed versions are tested and known to be working with PrimeFaces, other versions of these dependencies may also work but not tested.

JSF Runtime

PrimeFaces 5.0 supports JSF 2.0, 2.1 and 2.2 runtimes at the same time using feature detection and by not having compile time dependency to a specific version. As a result some features are only available depending on the runtime.

A good example for runtime compatibility is the passthrough attributes, a JSF 2.2 specific feature to display dynamic attributes. In following page, pass through attribute placeholder only gets rendered if the runtime is JSF 2.2.

<!DOCTYPE html>

<h:head>

</h:head>

<h:body>

<p:inputText value="#{bean.value}" pt:placeholder="Watermark here"/>

</h:body>

</html>

PrimeFaces User’s Guide

2.3 Configuration

PrimeFaces does not require any mandatory configuration and follows configuration by exception pattern of Java EE. Here is the list of all configuration options defined with a contex-param such as;

<context-param>

<param-name>primefaces.THEME</param-name>

<param-value>bootstrap</param-value>

</context-param>

THEME mobile.THEME

PUSH_SERVER_URL

SUBMIT

DIR

RESET_VALUES

SECRET

Name Default aristo null

Description

Theme of the application.

Theme of the mobile application.

ltr

0 null full

Custom server url for PrimeFaces Push.

Defines ajax submit mode, full or partial.

Defines orientation, ltr or rtl.

When enabled, ajax updated inputs are reset first.

primefaces Secret key to encrypt-decrypt value expressions exposed in rendering StreamedContents.

CLIENT_SIDE_VALIDATION 0

UPLOADER auto

TRANSFORM_METADATA false

Controls client side validatation.

Defines uploader mode; auto, native or commons.

Transforms bean validation metadata to html attributes.

2.4 Hello World

Once you have added the primefaces jar to your classpath, you need to add the PrimeFaces namespace to your page to begin using the components. Here is a simple page like test.xhtml;

<!DOCTYPE html>

<h:head></h:head>

<h:body>

<p:editor />

</h:body>

</html>

When you run this page through Faces Servlet mapping e.g. *.jsf, you should see a rich text editor when you run the page with test.jsf.

PrimeFaces User’s Guide

3. Component Suite

3.1 AccordionPanel

AccordionPanel is a container component that displays content in stacked format.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class accordionPanel org.primefaces.component.accordionpanel.Accordionpanel

org.primefaces.component.AccordionPanel

org.primefaces.component

org.primefaces.component.AccordionPanelRenderer

org.primefaces.component.accordionpanel.AccordionPanelRenderer

Attributes

Name id rendered binding activeIndex

Default null true null

Type

String boolean

Object false String

Description

Unique identifier of the component

Boolean value to specify the rendering of the component.

An EL expression that maps to a server side

UIComponent instance in a backing bean.

Index of the active tab or a comma separated string of indexes when multiple mode is on.

Name style styleClass onTabChange onTabShow dynamic cache value var multiple dir prependId widgetVar null null false ltr true

Default null null null null false true null

Type

String

Boolean

List

String

Boolean

String

Boolean

String

PrimeFaces User’s Guide

Description

Inline style of the container element.

Style class of the container element.

Client side callback to invoke when an inactive tab is clicked.

Client side callback to invoke when a tab gets activated.

Defines the toggle mode.

Defines if activating a dynamic tab should load the contents from server again.

List to iterate to display dynamic number of tabs.

Name of iterator to use in a dynamic number of tabs.

Controls multiple selection.

Defines text direction, valid values are ltr and rtl.

AccordionPanel is a naming container thus prepends its id to its children by default, a false value turns this behavior off except for dynamic tabs.

Name of the client side widget.

Getting Started with Accordion Panel

Accordion panel consists of one or more tabs and each tab can group any content. Titles can also be defined with “title” facet.

<p:accordionPanel>

<p:tab title="First Tab Title">

<h:outputText value= "Lorem"/>

...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, when dynamic option is set true, only active tab contents will be rendered to the client side and clicking an inactive tab header will do an ajax request to load the tab contents.

This feature is useful to reduce bandwidth and speed up page loading time. By default activating a previously loaded dynamic tab does not initiate a request to load the contents again as tab is cached.

To control this behavior use cache option.

PrimeFaces User’s Guide

<p:accordionPanel dynamic="true">

//..tabs

</p:accordionPanel>

Client Side Callbacks

onTabChange is called before a tab is shown and onTabShow is called after. Both receive container element of the tab to show as the parameter.

<p:accordionPanel onTabChange="handleChange(panel)">

//..tabs

</p:accordionPanel>

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

<p:accordionPanel>

<p:ajax event=”tabChange” listener=”#{bean.onChange}” />

</p:accordionPanel> public void onChange(TabChangeEvent event) {

//Tab activeTab = event.getTab();

//...

}

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

Dynamic Number of Tabs

When the tabs to display are not static, use the built-in iteration feature similar to ui:repeat.

<p:accordionPanel value=”#{bean.list}” var=”listItem”>

<p:tab title="#{listItem.propertyA}">

<h:outputText value= "#{listItem.propertyB}"/>

...More content

</p:tab>

</p:accordionPanel>

PrimeFaces User’s Guide

Disabled Tabs

A tab can be disabled by setting disabled attribute to true.

<p:accordionPanel>

<p:tab title="First Tab Title" disabled=”true”>

<h:outputText value= "Lorem"/>

...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, only one tab at a time can be active, enable multiple mode to activate multiple tabs.

<p:accordionPanel multiple=”true”>

//tabs

</p:accordionPanel>

Client Side API

Widget: PrimeFaces.widget.AccordionPanel

Method select(index) unselect(index)

Params index: Index of tab index: Index of tab

Return Type void void

Description

Activates tab with given index.

Deactivates tab with given index.

Skinning

AccordionPanel resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;

Class

.ui-accordion

.ui-accordion-header

.ui-accordion-content

Main container element

Tab header

Tab content

Applies

async process update onstart oncomplete onsuccess onerror global delay

PrimeFaces User’s Guide

3.2 AjaxBehavior

AjaxBehavior is an extension to standard f:ajax.

Info

Tag

Behavior Id

Behavior Class ajax org.primefaces.component.AjaxBehavior

org.primefaces.component.behavior.ajax.AjaxBehavior

Attributes listener

Name immediate partialSubmit disabled event resetValues null null null null true false null null

Default null false null false false null false

Type

Method

Expr

Description

Method to process in partial request.

boolean Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.

Boolean When set to true, ajax requests are not queued.

String

Component(s) to process in partial request.

Component(s) to update with ajax.

Callback to execute before ajax request is begins.

Callback to execute when ajax request is completed.

String

Callback to execute when ajax request succeeds.

Callback to execute when ajax request fails.

Boolean Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus.

String If less than delay milliseconds elapses between calls to

request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.

Boolean Enables serialization of values belonging to the partially processed components only.

Boolean Disables ajax behavior.

String Client side event to trigger ajax request.

Boolean If true, local values of input components to be updated within the ajax request would be reset.

PrimeFaces User’s Guide

Name Default ignoreAutoUpdate false

Type Description

Boolean If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.

Getting Started with AjaxBehavior

AjaxBehavior is attached to the component to ajaxify.

<h:inputText value="#{bean.text}">

<p:ajax update="out" />

</h:inputText>

<h:outputText id="out" value="#{bean.text}" />

In the example above, each time the input changes, an ajax request is sent to the server. When the response is received output text with id "out" is updated with value of the input.

Listener

In case you need to execute a method on a backing bean, define a listener;

<h:inputText id="counter">

<p:ajax update="out" listener="#{counterBean.increment}"/>

</h:inputText>

<h:outputText id="out" value="#{counterBean.count}" /> public class CounterBean { private int count;

//getter setter public void increment() { count++;

}

Events

Default client side events are defined by components that support client behaviors, for input components it is onchange and for command components it is onclick. In order to override the dom event to trigger the ajax request use event option. In following example, ajax request is triggered when key is up on input field.

<h:inputText id="firstname" value="#{bean.text}">

<p:ajax update="out" event="keyup"/>

</h:inputText>

<h:outputText id="out" value="#{bean.text}" />

PrimeFaces User’s Guide

3.3 AjaxExceptionHandler

AjaxExceptionHandler is a utility component for the built-in ExceptionHandler.

Info

Tag

Component Class ajaxExceptionHandler org.primefaces.component.ajaxexceptionhandler.AjaxExceptionHandler

Component Type org.primefaces.component.AjaxExceptionHandler

Component Family org.primefaces.component

Attributes

Name id rendered null true

Default binding null onexception null update type null null

Type

String

Boolean

Object

String

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component.

An el expression that maps to a server side

UIComponent instance in a backing bean

Client side callback to execute after a exception with this type occured.

Components to update after a exception with this type occured.

Exception type to handle.

Getting Started with AjaxExceptionHandler

Please find the detailed information about this component at ExceptionHandler section at Utilities chapter.

PrimeFaces User’s Guide

3.4 AjaxStatus

AjaxStatus is a global notifier for ajax requests.

Info

Tag ajaxStatus

Component Class

Component Type org.primefaces.component.ajaxstatus.AjaxStatus

org.primefaces.component.AjaxStatus

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.AjaxStatusRenderer

org.primefaces.component.ajaxstatus.AjaxStatusRenderer

Attributes

Name id rendered null true

Default binding null onstart null oncomplete null onsuccess null onerror style styleClass widgetVar null null null null

Type

String

Boolean

Object

String

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component.

An el expression that maps to a server side

UIComponent instance in a backing bean

Client side callback to execute after ajax requests start.

Client side callback to execute after ajax requests complete.

Client side callback to execute after ajax requests completed succesfully.

Client side callback to execute when an ajax request fails.

Inline style of the component.

Style class of the component.

Name of the client side widget.

PrimeFaces User’s Guide

Getting Started with AjaxStatus

AjaxStatus uses facets to represent the request status. Most common used facets are start and

complete. Start facet will be visible once ajax request begins and stay visible until it’s completed.

Once the ajax response is received and page is updated, start facet gets hidden and complete facet shows up.

<p:ajaxStatus>

<f:facet name="start">

<p:graphicImage value="ajaxloading.gif" />

</f:facet>

<f:facet name="complete">

<h:outputText value="Done!" />

</f:facet>

</p:ajaxStatus>

Events

Here is the full list of available event names;

default: Initially visible when page is loaded.

start: Before ajax request begins.

success: When ajax response is received without error.

error: When ajax response is received with an http error.

complete: When everything finishes.

<p:ajaxStatus>

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

Custom Events

Facets are the declarative way to use, if you’d like to implement advanced cases with scripting you can take advantage of on* callbacks which are the event handler counterparts of the facets.

<p:ajaxStatus onstart="alert('Start')" oncomplete="alert('End')"/>

PrimeFaces User’s Guide

A comman usage of programmatic approach is to implement a custom status dialog;

<p:ajaxStatus onstart="PF('status').show()" oncomplete="PF('status').hide()"/>

<p:dialog widgetVar="status" modal="true" closable="false">

Please Wait

</p:dialog>

Client Side API

Widget: PrimeFaces.widget.AjaxStatus

Method trigger(event)

Params Return Type event: Name of event. void

Description

Triggers given event.

Skinning

AjaxStatus is equipped with style and styleClass. Styling directly applies to a container element which contains the facets.

<p:ajaxStatus style="width:32px;height:32px" ... />

Tips

• Avoid updating ajaxStatus itself to prevent duplicate facet/callback bindings.

• Provide a fixed width/height to an inline ajaxStatus to prevent page layout from changing.

• Components like commandButton has an attribute (global) to control triggering of AjaxStatus.

• AjaxStatus also supports core JSF ajax requests of f:ajax as well.

3.4 AutoComplete

AutoComplete provides live suggestions while an input is being typed.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class autoComplete org.primefaces.component.autocomplete.AutoComplete

org.primefaces.component.AutoComplete

org.primefaces.component

org.primefaces.component.AutoCompleteRenderer

org.primefaces.component.autocomplete.AutoCompleteRenderer

Attributes id rendered

Name binding value converter

Default null true

Type

String

Boolean null null null

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.

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.

required validator onstart global

Name immediate valueChangeListener requiredMessage converterMessage validatorMessage widgetVar completeMethod var itemLabel itemValue maxResults minQueryLength queryDelay forceSelection oncomplete scrollHeight effect effectDuration dropdown panelStyle

Default false false null null null null null null null null null null unlimited true

300 false null null true null null

400 false null

PrimeFaces User’s Guide

Boolean

Integer

String

Integer

Boolean

String

Type

Boolean

Description

When set true, process validations logic is executed at apply request values phase for this component.

Boolean Marks component as required.

MethodExpr A method expression that refers to a method validationg the input.

MethodExpr A method expression that refers to a method for handling a valuchangeevent.

String Message to be displayed when required field validation fails.

String

Message to be displayed when conversion fails.

Message to be displayed when validation fails.

String Name of the client side widget.

MethodExpr Method providing suggestions.

String

Integer

Boolean

String

Name of the iterator used in pojo based suggestion.

Label of the item.

Value of the item.

Maximum number of results to be displayed.

Number of characters to be typed before starting to query.

Delay to wait in milliseconds before sending each query to the server.

When enabled, autoComplete only accepts input from the selection list.

Client side callback to execute before ajax request to load suggestions begins.

Client side callback to execute after ajax request to load suggestions completes.

Defines whether to trigger ajaxStatus or not.

Defines the height of the items viewport.

Effect to use when showing/hiding suggestions.

Duration of effect in milliseconds.

Enables dropdown mode when set true.

Inline style of the items container element.

onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout

Name panelStyleClass multiple process accesskey alt autocomplete dir disabled label lang maxlength onblur onchange null null null null null null false null null null null null null null null null null null

Default null null null null

Type

String

Boolean

String

Boolean

String

Integer

String

PrimeFaces User’s Guide

Description

Style class of the items container element.

When true, enables multiple selection.

Component(s) to process on query request.

Access key that when pressed transfers focus to the input element.

Alternate textual description of the input field.

Controls browser autocomplete behavior.

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

Disables input field

A localized user presentable name.

Code describing the language used in the generated markup for this component.

Maximum number of characters that may be entered in this field.

Client side callback to execute when input element loses focus.

Client side callback to execute when input element loses focus and its value has been modified since gaining focus.

Client side callback to execute when input element is clicked.

Client side callback to execute when input element is double clicked.

Client side callback to execute when input element receives focus.

Client side callback to execute when a key is pressed down over input element.

Client side callback to execute when a key is pressed and released over input element.

Client side callback to execute when a key is released over input element.

Client side callback to execute when a pointer button is pressed down over input element

Client side callback to execute when a pointer button is moved within input element.

Client side callback to execute when a pointer

Name Default onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title itemTipMyPosition itemTipAtPosition cache cacheTimeout emptyMessage appendTo null null null null false null null null null

Integer

String

Integer null String left top String right bottom String false Boolean

300000 null null

Integer

String

Boolean

Type

PrimeFaces User’s Guide

Description button is moved away from input element.

Client side callback to execute when a pointer button is moved onto input element.

Client side callback to execute when a pointer button is released over input element.

Client side callback to execute when text within input element is selected by user.

Specifies a short hint.

Flag indicating that this component will prevent changes by the user.

Number of characters used to determine the width of the input element.

Inline style of the input element.

Style class of the input element.

Position of the input element in the tabbing order.

Advisory tooltip informaton.

Position of itemtip corner relative to item.

Position of item corner relative to itemtip.

When enabled autocomplete caches the searched result list.

Timeout value for cached results.

Text to display when there is no data to display.

Appends the overlay to the element defined by search expression. Defaults to document body.

Getting Started with AutoComplete

AutoComplete is an input component so it requires a value as usual. Suggestions are loaded by calling a server side completeMethod that takes a single string parameter which is the text entered.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" />

PrimeFaces User’s Guide public class Bean { private String text; public List<String> complete(String query) {

List<String> results = new ArrayList<String>(); for (int i = 0; i < 10; i++) results.add(query + i); return results;

}

//getter setter

}

Pojo Support

Most of the time, instead of simple strings you would need work with your domain objects, autoComplete supports this common use case with the use of a converter and data iterator.

Following example loads a list of players, itemLabel is the label displayed as a suggestion and itemValue is the submitted value. Note that when working with pojos, you need to plug-in your own converter.

<p:autoComplete value="#{playerBean.selectedPlayer}" completeMethod="#{playerBean.completePlayer}" var="player" itemLabel="#{player.name}" itemValue="#{player}" converter="playerConverter"/> public class PlayerBean { private Player selectedPlayer; public Player getSelectedPlayer() { return selectedPlayer;

} public void setSelectedPlayer(Player selectedPlayer) { this.selectedPlayer = selectedPlayer;

} public List<Player> complete(String query) {

List<Player> players = readPlayersFromDatasource(query); return players;

}

} public class Player { private String name;

//getter setter

}

PrimeFaces User’s Guide

Limiting the Results

Number of results shown can be limited, by default there is no limit.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" maxResults="5" />

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. This behavior is tuned using the minQueryLength attribute.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" minQueryLength="3" />

With this setting, suggestions will start when user types the 3rd character at the input field.

Query Delay

AutoComplete is optimized using queryDelay option, by default autoComplete waits for 300 milliseconds to query a suggestion request, if you’d like to tune the load balance, give a longer value. Following autoComplete waits for 1 second after user types an input.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" queryDelay="1000" />

Custom Content

AutoComplete can display custom content by nesting columns.

<p:autoComplete value="#{autoCompleteBean.selectedPlayer}" completeMethod="#{autoCompleteBean.completePlayer}" var="p" itemValue="#{p}" converter="player">

<p:column>

<p:graphicImage value="/images/barca/#{p.photo}" width="40" height="50"/>

</p:column>

<p:column>

#{p.name} - #{p.number}

</p:column>

</p:autoComplete>

Dropdown Mode

When dropdown mode is enabled, a dropdown button is displayed next to the input field, clicking this button will do a search with an empty query, a regular completeMethod implementation should load all available items as a response.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" dropdown="true" />

PrimeFaces User’s Guide

Multiple Selection

AutoComplete supports multiple selection as well, to use this feature set multiple option to true and define a list as your backend model. Following example demonstrates multiple selection with custom content support.

<p:autoComplete id="advanced" value="#{autoCompleteBean.selectedPlayers}" completeMethod="#{autoCompleteBean.completePlayer}"

var="p" itemLabel="#{p.name}" itemValue="#{p}" converter="player" multiple="true">

<p:column style="width:20%;text-align:center">

<p:graphicImage value="/images/barca/#{p.photo}"/>

</p:column>

<p:column style="width:80%">

#{p.name} - #{p.number}

</p:column>

</p:autoComplete> public class AutoCompleteBean { private List<Player> selectedPlayers;

//...

}

Caching

Suggestions can be cached on client side so that the same query does not do a request which is likely to return same suggestions again. To enable this, set cache option to true. There is also a

cacheTimeout option to configure how long it takes to clear a cache automatically.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}" cache="true"/>

PrimeFaces User’s Guide

Ajax Behavior Events

Instead of waiting for user to submit the form manually to process the selected item, you can enable instant ajax selection by using the itemSelect ajax behavior. Example below demonstrates how to display a message about the selected item instantly.

<p:autoComplete value="#{bean.text}" completeMethod="#{bean.complete}">

<p:ajax event="itemSelect" listener="bean.handleSelect" update="msg" />

</p:autoComplete>

<p:messages id=”msg” /> public class Bean { public void handleSelect(SelectEvent event) {

Object item = event.getObject();

FacesMessage msg = new FacesMessage("Selected", "Item:" + item);

}

//...

}

Your listener(if defined) will be invoked with an org.primefaces.event.Select instance that contains a reference to the selected item. Note that autoComplete also supports events inherited from regular input text such as blur, focus, mouseover in addition to itemSelect. Similarly, itemUnselect event is provided for multiple autocomplete when an item is removed by clicking the remove icon. In this case org.primefaces.event.Unselect instance is passed to a listener if defined.

Event itemSelect itemUnselect query

ItemTip

Listener Parameter org.primefaces.event.SelectEvent

org.primefaces.event.UnselectEvent

Fired

On item selection.

On item unselection.

On query.

Itemtip is an advanced built-in tooltip when mouse is over on suggested items. Content of the tooltip is defined via the itemtip facet.

PrimeFaces User’s Guide

<p:autoComplete value="#{autoCompleteBean.selectedPlayer1}" id="basicPojo" completeMethod="#{autoCompleteBean.completePlayer}" var="p" itemLabel="#{p.name}" itemValue="#{p}" converter="player">

<f:facet name="itemtip">

<h:panelGrid columns="2" cellpadding="5">

<f:facet name="header">

<p:graphicImage value="/images/barca/#{p.photo}" />

</f:facet>

<h:outputText value="Name: " />

<h:outputText id="modelNo" value="#{p.name}" />

<h:outputText value="Number " />

<h:outputText id="year" value="#{p.number}" />

</h:panelGrid>

</f:facet>

</p:autoComplete>

<h:outputText value="Position " />

<h:outputText value="#{p.position}"/>

Client Side API

Widget: PrimeFaces.widget.AutoComplete

Method search(value) close() disable() enable() deactivate() activate()

Params value: keyword for search

Skinning

Following is the list of structural style classes;

Return Type void void void void void void

Description

Initiates a search with given value

Hides suggested items menu

Disables the input field

Enables the input field

Deactivates search behavior

Activates search behavior

Class

.ui-autocomplete

.ui-autocomplete-input

.ui-autocomplete-panel

.ui-autocomplete-items

.ui-autocomplete-item

Applies

Container element.

Input field.

Container of suggestions list.

List of items

Each item in the list.

.ui-autocomplete-query Highlighted part in suggestions.

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

PrimeFaces User’s Guide

Tips

• Do not forget to use a converter when working with pojos.

• Enable forceSelection if you’d like to accept values only from suggested list.

• Increase query delay to avoid unnecessary load to server as a result of user typing fast.

• Use emptyMessage option to provide feedback to the users that there are no suggestions.

• Enable caching to avoid duplicate queries.

PrimeFaces User’s Guide

3.5 BlockUI

BlockUI is used to block interactivity of JSF components with optional ajax integration.

Info

Tag

Component Class

Component Type blockUI org.primefaces.component.blockui.BlockUI

org.primefaces.component.BlockUI

Component Family org.primefaces.component

Renderer Type org.primefaces.component.BlockUIRenderer

Renderer Class org.primefaces.component.blockui.BlockUIRenderer

Attributes

Name id rendered binding widgetVar trigger null null null

Default null true

Type

String

Boolean

Object

String

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget.

Identifier of the component(s) to bind.

Name block blocked

Default null false

Type

String

Boolean

PrimeFaces User’s Guide

Description

Identifier of the component to block.

Blocks the UI by default when enabled.

Getting Started with BlockUI

BlockUI requires trigger and block attributes to be defined. With the special ajax integration, ajax requests whose source are the trigger components will block the ui onstart and unblock oncomplete.

Example below blocks the ui of the panel when saveBtn is clicked and unblock when ajax response is received.

<p:panel id="pnl" header="My Panel">

//content

<p:commandButton id="saveBtn" value="Save" />

</p:panel>

<p:blockUI block="pnl" trigger="saveBtn" />

Multiple triggers are defined as a comma separated list.

<p:blockUI block="pnl" trigger="saveBtn,deleteBtn,updateBtn" />

Custom Content

In order to display custom content like a loading text and animation, place the content inside the blockUI.

<p:dataTable id="dataTable" var="car" value="#{tableBean.cars}"

paginator="true" rows="10">

<p:column>

<f:facet name="header">

<h:outputText value="Model" />

</f:facet>

<h:outputText value="#{car.model}" />

</p:column>

//more columns

</p:dataTable>

<p:blockUI block="dataTable" trigger="dataTable">

LOADING<br />

<p:graphicImage value="/images/ajax-loader.gif"/>

</p:blockUI>

PrimeFaces User’s Guide

Client Side API

Widget: PrimeFaces.widget.BlockUI show() hide()

Method Params

Skinning

Following is the list of structural style classes;

Return Type void void

Description

Blocks the UI.

Unblocks the UI

.ui-blockui

.ui-blockui-content

Class Applies

Container element.

Container for custom content.

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

Tips

• BlockUI does not support absolute or fixed positioned components. e.g. dialog.

PrimeFaces User’s Guide

3.6 BreadCrumb

Breadcrumb is a navigation component that provides contextual information about page hierarchy in the workflow.

Info

Tag

Component Class breadCrumb org.primefaces.component.breadcrumb.BreadCrumb

Component Type org.primefaces.component.BreadCrumb

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.BreadCrumbRenderer

org.primefaces.component.breadcrumb.BreadCrumbRenderer

Attributes

Name id rendered binding widgetVar model style styleClass homeDisplay

Default null true

Type

String

Boolean null null null null null icon

Object

String

MenuModel

String

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget.

MenuModel instance to create menus programmatically

Style of main container element.

Style class of main container

Defines display mode of root link, valid values are

"icon" default and "text".

PrimeFaces User’s Guide

Getting Started with BreadCrumb

Steps are defined as child menuitem components in breadcrumb.

<p:breadCrumb>

<p:menuitem label="Categories" url="#" />

<p:menuitem label="Sports" url="#" />

//more menuitems

</p:breadCrumb>

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

Breadcrumb resides in a container element that style and styleClass options apply. Following is the list of structural style classes;

Style Class

.ui-breadcrumb

.ui-breadcrumb .ui-menu-item-link

.ui-breadcrumb .ui-menu-item-text

.ui-breadcrumb-chevron

Applies

Main breadcrumb container element.

Each menuitem.

Each menuitem label.

Seperator of menuitems.

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

Tips

• If there is a dynamic flow, use model option instead of creating declarative p:menuitem components and bind your MenuModel representing the state of the flow.

• Breadcrumb can do ajax/non-ajax action requests as well since p:menuitem has this option. In this case, breadcrumb must be nested in a form.

• url option is the key for a menuitem, if it is defined, it will work as a simple link. If you’d like to use menuitem to execute command with or without ajax, do not define the url option.

PrimeFaces User’s Guide

3.7 Button

Button is an extension to the standard h:button component with skinning capabilities.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class button org.primefaces.component.button.Button

org.primefaces.component.Button

org.primefaces.component

org.primefaces.component.ButtonRenderer

org.primefaces.component.button.ButtonRenderer

Attributes id

Name rendered binding widgetVar value outcome

Default Type null String true null

Description

Unique identifier of the component.

Boolean Boolean value to specify the rendering of the component.

Object An el expression that maps to a server side UIComponent instance in a backing bean.

null null includeViewParams false fragment null null

String Name of the client side widget.

Object Value of the component than can be either an EL expression of a literal text.

String Used to resolve a navigation case.

Boolean Whether to include page parameters in target URI

String Identifier of the target page which should be scrolled to.

disabled accesskey alt dir image lang false null null null null null

Boolean Disables button.

String

Access key that when pressed transfers focus to button.

Alternate textual description.

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

Style class for the button icon. (deprecated: use icon)

Code describing the language used in the generated markup

Name onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup style styleClass readOnly tabindex title href icon iconPos target escape inline

PrimeFaces User’s Guide null null null null left null null false

_self true false

Default Type null null null null null null null null null null null null null

Description for this component.

String

Client side callback to execute when button loses focus.

Client side callback to execute when button loses focus and its value has been modified since gaining focus.

Client side callback to execute when button is clicked.

Client side callback to execute when button is double clicked.

Client side callback to execute when button receives focus.

Client side callback to execute when a key is pressed down over button.

Client side callback to execute when a key is pressed and released over button.

Client side callback to execute when a key is released over button.

Client side callback to execute when a pointer button is pressed down over button.

String

Client side callback to execute when a pointer button is moved within button

Client side callback to execute when a pointer button is moved away from button.

Client side callback to execute when a pointer button is moved onto button.

String Client side callback to execute when a pointer button is released over button.

Inline style of the button.

String

String Style class of the button.

Boolean Makes button read only.

Integer Position in the tabbing order.

String Advisory tooltip informaton.

String Resource to link directly to implement anchor behavior.

String

Icon of the button.

Position of the button icon.

String The window target.

Boolean Defines whether label would be escaped or not.

String Displays button as inline instead of 100% width, mobily

PrimeFaces User’s Guide

Name Default Type disableClientWindow false

Description only.

Boolean Disable appending the ClientWindow on the rendering of this element.

Getting Started with Button p:button usage is same as standard h:button, an outcome is necessary to navigate using GET requests. Assume you are at source.xhtml and need to navigate target.xhtml.

<p:button outcome="target" value="Navigate"/>

Parameters

Parameters in URI are defined with nested <f:param /> tags.

<p:button outcome="target" value="Navigate">

<f:param name="id" value="10" />

</p:button>

Icons

Icons for button are defined via css and icon attribute, if you use title instead of value, only icon will be displayed and title text will be displayed as tooltip on mouseover. You can also use icons from PrimeFaces themes such ui-icon-check.

<p:button outcome="target" icon="star" value="With Icon"/>

<p:button outcome="target" icon="star" title="With Icon"/>

.star { background-image: url("images/star.png");

}

Skinning

Button renders a button tag which style and styleClass applies. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;

Style Class

.ui-button

.ui-button-text-only

.ui-button-text

Applies

Button element

Button element when icon is not used

Label of button

PrimeFaces User’s Guide

3.8 Cache

Cache component is used to reduce page load time by caching the content after initial rendering.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class cache org.primefaces.component.cache.UICache

org.primefaces.component.Cache

org.primefaces.component

org.primefaces.component.UICacheRenderer

org.primefaces.component.cache.UICacheRenderer

Attributes

Name id rendered binding disabled region key

Default null true null false

View Id null

Type

String

Description

Unique identifier of the component.

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object An el expression that maps to a server side UIComponent instance in a backing bean.

Boolean Disables caching.

String

Unique id of the cache region, defaults to view id.

Unique id of the cache entry in region, defaults to client id of component.

Getting Started with Cache

A cache store is required to use the cache component, two different providers are supported as cache implementation; EHCache and Hazelcast. Provider is configured via a context-param.

<context-param>

<param-name>primefaces.CACHE_PROVIDER</param-name>

<param-value>org.primefaces.cache.EHCacheProvider</param-value>

</context-param>

Here is a sample ehcache.xml to configure cache regions, there are two regions in this configuration.

PrimeFaces User’s Guide

<?xml version="1.0" encoding="UTF-8"?>

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="ehcache.xsd"

updateCheck="true" monitoring="autodetect"

dynamicConfig="true">

<defaultCache

maxEntriesLocalHeap="10000"

eternal="false"

timeToIdleSeconds="120"

timeToLiveSeconds="120"

diskSpoolBufferSizeMB="30"

maxEntriesLocalDisk="10000000"

diskExpiryThreadIntervalSeconds="120"

memoryStoreEvictionPolicy="LRU">

</defaultCache>

<cache name="testcache"

maxEntriesLocalHeap="10000"

eternal="false"

timeToIdleSeconds="120"

timeToLiveSeconds="120"

diskSpoolBufferSizeMB="30"

maxEntriesLocalDisk="10000000"

diskExpiryThreadIntervalSeconds="120"

memoryStoreEvictionPolicy="LRU">

</cache>

</ehcache>

After the configuration, at UI side, the cached part needs to be wrapped inside the p:cache component.

<p:cache>

//content to cache

</p:cache>

Once the page is loaded initially, content inside p:cache component is cached inside the cache region of the cache provider. Postbacks on the same page or reopening the page retrieve the output from cache instead of rendering the content regularly.

Cache Provider API

CacheProvider can be accessed via;

RequestContext.getCurrentInstance().getApplicationContext().getCacheProvider()

For example using this API, all cache regions can be cleaned using clear() method. Refer to javadoc of CacheProvider for the full list of available methods.

PrimeFaces User’s Guide

3.9 Calendar

Calendar is an input component used to select a date featuring display modes, paging, localization, ajax selection and more.

Info

Tag

Component Class

Component Type calendar org.primefaces.component.calendar.Calendar

org.primefaces.component.Calendar

Component Family org.primefaces.component

Renderer Type org.primefaces.component.CalendarRenderer

Renderer Class org.primefaces.component.calendar.CalendarRenderer

Attributes id rendered

Name binding value converter immediate required null true

Default null null null false false

Type Description

String Unique identifier of the component

Boolean Boolean value to specify the rendering of the component.

Object An el expression that maps to a server side

UIComponent instance in a backing bean java.util

.Date

Value of the component

Convert er/Strin g

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

Boolean When set true, process validations logic is executed at apply request values phase for this component.

Boolean Marks component as required

converterMessage validatorMessage widgetVar mindate maxdate pages disabled mode pattern locale popupIcon popupIconOnly navigator timeZone validator

Name valueChangeListener requiredMessage readonlyInput showButtonPanel effect effectDuration showOn showWeek disabledWeekends

PrimeFaces User’s Guide null null null null

Default Type

Method

Expr

Method

Expr

String

String null null null

String

Date or

String

Message to be displayed when validation fails.

Name of the client side widget.

Sets calendar's minimum visible date null Date or

String

Sets calendar's maximum visible date

Integer Enables multiple page rendering.

1 false popup

Boolean Disables the calendar when set to true.

String

MM/dd/yyyy String

Defines how the calendar will be displayed.

DateFormat pattern for localization null null false

Description

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.

Message to be displayed when conversion fails.

false null false false null normal both

Object Locale to be used for labels and conversion.

String Icon of the popup button

Boolean When enabled, popup icon is rendered without the button.

Boolean Enables month/year navigator

Time

Zone

String or a java.util.TimeZone instance to specify the timezone used for date conversion, defaults to

TimeZone.getDefault()

Boolean Makes input text of a popup calendar readonly.

Boolean Visibility of button panel containing today and done buttons.

String Effect to use when displaying and showing the popup calendar.

String

Duration of the effect.

Client side event that displays the popup calendar.

false false

Boolean Displays the week number next to each week.

Boolean Disables weekend columns.

Name showOtherMonths selectOtherMonths yearRange timeOnly stepHour stepMinute stepSecond minHour maxHour minMinute maxMinute minSecond maxSecond pagedate accesskey alt autocomplete dir label lang maxlength onblur onchange onclick ondblclick null null null null null null null

Default false false null

1 false

59 null null null null null

PrimeFaces User’s Guide

Type Description

Boolean Displays days belonging to other months.

Boolean Enables selection of days belonging to other months.

String Year range for the navigator, default "c-10:c+10"

Boolean Shows only timepicker without date.

Integer Hour steps.

Integer Minute steps.

Integer Second steps.

Integer Minimum boundary for hour selection.

Integer Maximum boundary for hour selection.

Integer Minimum boundary for minute selection.

Integer Maximum boundary for hour selection.

Integer Minimum boundary for second selection.

Integer Maximum boundary for second selection.

Object Initial date to display if value is null.

String Access key that when pressed transfers focus to the input element.

String

Alternate textual description of the input field.

Controls browser autocomplete behavior.

String

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

A localized user presentable name.

String

String Code describing the language used in the generated markup for this component.

Integer Maximum number of characters that may be entered in this field.

String Client side callback to execute when input element loses focus.

String Client side callback to execute when input element loses focus and its value has been modified since gaining focus.

Client side callback to execute onclick event.

String Client side callback to execute when input element

Name onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly style styleClass size tabindex title beforeShowDay mask null null null null false null null null null null null null null null null null null null null

Default

PrimeFaces User’s Guide

Type Description is double clicked.

String

Client side callback to execute when input element receives focus.

Client side callback to execute when a key is pressed down over input element.

Client side callback to execute when a key is pressed and released over input element.

Client side callback to execute when a key is released over input element.

Client side callback to execute when a pointer button is pressed down over input element

Client side callback to execute when a pointer button is moved within input element.

Client side callback to execute when a pointer button is moved away from input element.

String

Client side callback to execute when a pointer button is moved onto input element.

Client side callback to execute when a pointer button is released over input element.

String Client side callback to execute when text within input element is selected by user.

Specifies a short hint.

String

Boolean Flag indicating that this component will prevent changes by the user.

String

Inline style of the component.

Style class of the component.

Integer Number of characters used to determine the width of the input element.

Integer Position of the input element in the tabbing order.

String

Advisory tooltip informaton.

Client side callback to execute before displaying a date, used to customize date display.

Applies a mask using the pattern.

Getting Started with Calendar

Value of the calendar should be a java.util.Date.

<p:calendar value="#{dateBean.date}"/> public class DateBean { private Date date;

//Getter and Setter

}

Display Modes

Calendar has two main display modes, popup (default) and inline.

Inline

<p:calendar value="#{dateBean.date}" mode="inline" />

PrimeFaces User’s Guide

Popup

<p:calendar value="#{dateBean.date}" mode="popup" />

showOn option defines the client side event to display the calendar. Valid values are;

• focus: When input field receives focus

• button: When popup button is clicked

• both: Both focus and button cases

PrimeFaces User’s Guide

Popup Button

<p:calendar value="#{dateBean.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. This feature is tuned with the pages attribute.

<p:calendar value="#{dateController.date}" pages="3"/>

Localization

By default locale information is retrieved from the view’s locale and can be overridden by the locale attribute. Locale attribute can take a locale key as a String or a java.util.Locale instance. Default language of labels are English and you need to add the necessary translations to your page manually as PrimeFaces does not include language translations. PrimeFaces Wiki Page for

PrimeFaces User’s Guide

PrimeFacesLocales is a community driven page where you may find the translations you need.

Please contribute to this wiki with your own translations.

http://wiki.primefaces.org/display/Components/PrimeFaces+Locales

Translation is a simple javascript object, we suggest adding the code to a javascript file and include in your application. Following is a Turkish calendar.

<h:outputScript name=”path_to_your_translations.js” />

<p:calendar value="#{dateController.date}" locale="tr" navigator="true" showButtonPanel="true"/>

To override calculated pattern from locale, use the pattern option;

<p:calendar value="#{dateController.date1}" pattern="dd.MM.yyyy"/>

<p:calendar value="#{dateController.date2}" pattern="yy, M, d"/>

<p:calendar value="#{dateController.date3}" pattern="EEE, dd MMM, yyyy"/>

Effects

Various effects can be used when showing and hiding the popup calendar, options are; show, slideDown, fadeIn, blind, bounce, clip, drop, fold and slide.

Ajax Behavior Events

Calendar provides a dateSelect ajax behavior event to execute an instant ajax selection whenever a date is selected. If you define a method as a listener, it will be invoked by passing an

org.primefaces.event.SelectEvent instance.

PrimeFaces User’s Guide

<p:calendar value="#{calendarBean.date}">

<p:ajax event=”dateSelect” listener=”#{bean.handleDateSelect}” update=”msg” />

</p:calendar>

<p:messages id="msg" /> public void handleDateSelect(SelectEvent event) {

Date date = (Date) event.getObject();

//Add facesmessage

}

In popup mode, calendar also supports regular ajax behavior events like blur, keyup and more.

Date Ranges

Using mindate and maxdate options, selectable dates can be restricted. Values for these attributes can either be a string or a java.util.Date.

<p:calendar value="#{dateBean.date}" mode="inline"

mindate="07/10/2010" maxdate="07/15/2010"/>

Navigator

Navigator is an easy way to jump between months/years quickly.

<p:calendar value="#{dateBean.date}" mode="inline" navigator="true" />

TimePicker

TimePicker functionality is enabled by adding time format to your pattern.

<p:calendar value="#{dateBean.date}" pattern=”MM/dd/yyyy HH:mm” />

PrimeFaces User’s Guide

Advanced Customization

Use beforeShowDay javascript callback to customize the look of each date. The function returns an array with two values, first one is flag to indicate if date would be displayed as enabled and second parameter is the optional style class to add to date cell. Following example disabled tuesdays and fridays.

<p:calendar value="#{dateBean.date}" beforeShowDay="tuesdaysAndFridaysOnly" />

Function tuesdaysAndFridaysDisabled(date) { var day = date.getDay(); return [(day != 2 && day != 5), '']

}

Mask

Calendar has a built-in mask feature similar to the InputMask component. Set mask option to true to enable mask support.

Client Side API

Widget: PrimeFaces.widget.Calendar

Method getDate() setDate(date) disable() enable()

Params

date: Date to display

Return Type

Date void void void

Description

Return selected date

Sets display date

Disables calendar

Enables calendar

Skinning

Calendar resides in a container element which style and styleClass options apply.

Following is the list of structural style classes;

PrimeFaces User’s Guide

Style Class

.ui-datepicker

.ui-datepicker-header

.ui-datepicker-prev

.ui-datepicker-next

.ui-datepicker-title

.ui-datepicker-month

.ui-datepicker-table

.ui-datepicker-week-end

.ui-datepicker-other-month

.ui-datepicker td

.ui-datepicker-buttonpane

.ui-datepicker-current

.ui-datepicker-close

Applies

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

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

3.10 Captcha

Captcha is a form validation component based on Recaptcha API.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class captcha org.primefaces.component.captcha.Captcha

org.primefaces.component.Captcha

org.primefaces.component

org.primefaces.component.CaptchaRenderer

org.primefaces.component.captcha.CaptchaRenderer

Attributes id rendered

Name binding value converter immediate required

Default null true null null null false false

Type

String

Boolean

Object

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.

Converter/Stri ng

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.

Boolean

When set true, process validations logic is executed at apply request values phase for this component.

Marks component as required.

validator

Name valueChangeListener requiredMessage converterMessage validatorMessage publicKey theme language tabindex label secure null null null red en null null false

Default null null null

PrimeFaces User’s Guide

Type Description

MethodExpr A method binding expression that refers to a method validationg the input.

ValueChange

Listener

String

A method binding expression that refers to a method for handling a valuchangeevent.

Message to be displayed when required field validation fails.

String

Integer

String

Boolean

Message to be displayed when conversion fails.

Message to be displayed when validation fields.

Public recaptcha key for a specific domain

(deprecated)

Theme of the captcha.

Key of the supported languages.

Position of the input element in the tabbing order.

User presentable field name.

Enables https support

Getting Started with Captcha

Catpcha is implemented as an input component with a built-in validator that is integrated with reCaptcha. First thing to do is to sign up to reCaptcha to get public&private keys. Once you have the keys for your domain, add them to web.xml as follows;

<context-param>

<param-name>primefaces.PRIVATE_CAPTCHA_KEY</param-name>

<param-value>YOUR_PRIVATE_KEY</param-value>

</context-param>

<context-param>

<param-name>primefaces.PUBLIC_CAPTCHA_KEY</param-name>

<param-value>YOUR_PUBLIC_KEY</param-value>

</context-param>

That is it, now you can use captcha as follows;

<p:captcha />

Themes

Captcha features following built-in themes for look and feel customization;

- red (default)

- white

- blackglass

- clean

Themes are applied via the theme attribute.

PrimeFaces User’s Guide

<p:captcha theme="white"/>

Languages

Text instructions displayed on captcha is customized with the language attribute. Below is a captcha with Turkish text.

<p:captcha language="tr"/>

Overriding Validation Messages

By default captcha displays it’s own validation messages, this can be easily overridden by the JSF message bundle mechanism. Corresponding keys are;

Summary

Detail primefaces.captcha.INVALID

primefaces.captcha.INVALID_detail

Tips

• Use label option to provide readable error messages in case validation fails.

• Enable secure option to support https otherwise browsers will give warnings.

• See http://www.google.com/recaptcha/learnmore to learn more about how reCaptcha works.

PrimeFaces User’s Guide

3.11 Carousel

Carousel is a multi purpose component to display a set of data or general content with slide effects.

Info

Tag

Component Class carousel org.primefaces.component.carousel.Carousel

Component Type org.primefaces.component.Carousel

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.CarouselRenderer

org.primefaces.component.carousel.CarouselRenderer

Attributes

Name id rendered binding value var numVisible firstVisible widgetVar circular vertical autoPlayInterval null null null

0 null false false

0 null

Default true

Type

String

Description

Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object

An el expression that maps to a server side

UIComponent instance in a backing bean

A value expression that refers to a collection

String

Integer

Name of the request scoped iterator

Number of visible items per page

Integer

String

Index of the first element to be displayed

Name of the client side widget.

Boolean Sets continuous scrolling

Boolean Sets vertical scrolling

Integer Sets the time in milliseconds to have Carousel start

Name Default pageLinks effect easing effectDuration

3 slide

Integer

String easeInOutCirc String

500 Integer dropdownTemplate.

{page} style null styleClass itemStyle itemStyleClass headerText footerText null null null null null

String

Type

PrimeFaces User’s Guide

Description scrolling automatically after being initialized

Defines the number of page links of paginator.

Name of the animation, could be “fade” or “slide”.

Name of the easing animation.

Duration of the animation in milliseconds.

Template string for dropdown of paginator.

Inline style of the component..

Style class of the component..

Inline style of each item.

Style class of each item.

Label for header.

Label for footer.

Getting Started with Carousel

Carousel has two main use-cases; data and general content display. To begin with data iteration let’s use a list of cars to display with carousel.

public class Car { private String model; private int year; private String manufacturer; private String color;

...

} public class CarBean { private List<Car> cars; public CarListController() { cars = new ArrayList<Car>(); cars.add(new Car("myModel", 2005, "ManufacturerX", "blue"));

//add more cars

}

//getter setter

}

PrimeFaces User’s Guide

<p:carousel value="#{carBean.cars}" var="car" itemStyle="width:200px">

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>

<h:outputText value="Model: #{car.model}" />

<h:outputText value="Year: #{car.year}" />

<h:outputText value="Color: #{car.color}" />

</p:carousel>

Carousel iterates through the cars collection and renders it’s children for each car, note that you also need to define a width for each item.

Limiting Visible Items

Bu default carousel lists its items in pages with size 3. This is customizable with the rows attribute.

<p:carousel value="#{carBean.cars}" var="car" numVisible="1" itemStyle="width:200px" >

...

</p:carousel>

Effects

Paging happens with a slider effect by default and following easing options are supported.

• backBoth

• backIn

• backOut

• bounceBoth

• bounceIn

• bounceOut

• easeBoth

• easeBothStrong

• easeIn

• easeInStrong

• easeNone

• easeOut

• easeInOutCirc

• easeOutStrong

• elasticBoth

• elasticIn

• elasticOut

PrimeFaces User’s Guide

SlideShow

Carousel can display the contents in a slideshow, for this purpose autoPlayInterval and circular attributes are used. Following carousel displays a collection of images as a slideshow.

<p:carousel autoPlayInterval="2000" rows="1" effect="easeInStrong" circular="true" itemStyle=”width:200px” >

<p:graphicImage value="/images/nature1.jpg"/>

<p:graphicImage value="/images/nature2.jpg"/>

<p:graphicImage value="/images/nature3.jpg"/>

<p:graphicImage value="/images/nature4.jpg"/>

</p:carousel>

Content Display

Another use case of carousel is tab based content display.

<p:carousel rows="1" itemStyle="height:200px;width:600px;">

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

</h:panelGrid>

</p:tab>

<p:tab title="Godfather Part II">

<h:panelGrid columns="2" cellpadding="10">

<p:graphicImage value="/images/godfather/godfather2.jpg" />

<h:outputText value="Francis Ford Coppola's ..."/>

</h:panelGrid>

</p:tab>

<p:tab title="Godfather Part III">

<h:panelGrid columns="2" cellpadding="10">

<p:graphicImage value="/images/godfather/godfather3.jpg" />

<h:outputText value="After a break of ..." />

</h:panelGrid>

</p:tab>

</p:carousel>

PrimeFaces User’s Guide

Item Selection

Sample below selects an item from the carousel and displays details within a dialog.

<h:form id=”form">

<p:carousel value="#{carBean.cars}" var="car" itemStyle=”width:200px” >

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>

<p:commandLink update=":form:detail" oncomplete="PF('dlg').show()">

<h:outputText value="Model: #{car.model}" />

<f:setPropertyActionListener value="#{car}" target="#{carBean.selected}" />

</p:commandLink>

</p:carousel>

<p:dialog widgetVar="dlg">

<h:outputText id="detail" value="#{carBean.selected}" />

</p:dialog>

</h:form> public class CarBean { private List<Car> cars; private Car selected;

//getters and setters

}

Header and Footer

Header and Footer of carousel can be defined in two ways either, using headerText and footerText options that take simple strings as labels or by header and footer facets that can take any custom content.

Client Side API

Widget: PrimeFaces.widget.Carousel

Method next() prev() setPage() startAutoplay() stopAutoplay()

Params

index

Return Type void void void void void

Description

Displays next page.

Displays previous page.

Displays page with given index.

Starts slideshow.

Stops slideshow.

PrimeFaces User’s Guide

Skinning

Carousel resides in a container element which style and styleClass options apply. itemStyle and

itemStyleClass attributes apply to each item displayed by carousel. Following is the list of structural style classes;

Style Class

.ui-carousel

.ui-carousel-header

.ui-carousel-header-title

.ui-carousel-viewport

.ui-carousel-button

.ui-carousel-next-button

.ui-carousel-prev-button

.ui-carousel-page-links

.ui-carousel-page-link

.ui-carousel-item

Applies

Main container

Header container

Header content

Content container

Navigation buttons

Next navigation button of paginator

Prev navigation button of paginator

Page links of paginator.

Each page link of paginator.

Each item.

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

PrimeFaces User’s Guide

3.12 CellEditor

CellEditor is a helper component of datatable used for incell editing.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class cellEditor org.primefaces.component.celleditor.CellEditor

org.primefaces.component.CellEditor

org.primefaces.component

org.primefaces.component.CellEditorRenderer

org.primefaces.component.celleditor.CellEditorRenderer

Attributes

Name id rendered binding

Default null true

Type

String

Boolean null Object

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

Getting Started with CellEditor

See inline editing section in datatable documentation for more information about usage.

PrimeFaces User’s Guide

3.13 Chart

Chart component is a generic graph component to create various types of charts using jqplot library.

Each chart type has its own subsection with code examples and section 3.12.10 documents the full charting API.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class chart org.primefaces.component.chart.Chart

org.primefaces.component.Chart

org.primefaces.component

org.primefaces.component.ChartRenderer

org.primefaces.component.chart.ChartRenderer

Attributes

Name id rendered binding type model style styleClass widgetVar null null null null null null

Default null true

Type

String

Boolean

Object

String

ChartModel

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

Type of the chart.

Model object of data and settings.

Inline style of the component.

Style class of the component.

Name of the client side widget.

3.13.1 PieChart

PieChart is created with PieChartModel.

Basic

<p:chart type="pie" value="#{bean.model}" /> public class Bean { private PieChartModel model; public Bean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421); model.setTitle("Simple Pie"); model.setLegendPosition("w");

} public PieChartModel getModel() { return model;

}

PrimeFaces User’s Guide

Customized

<p:chart type="pie" value="#{bean.model}" />

public class Bean { private PieChartModel model; public Bean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421);

} model.setTitle("Custom Pie"); model.setLegendPosition("e"); model.setFill(false); model.setShowDataLabels(true); model.setDiameter(150); public PieChartModel getModel() { return model;

}

PrimeFaces User’s Guide

3.13.2 LineChart

LineChartModel is used to create a line chart.

Basic

<p:chart type="line" value="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();

LineChartSeries series1 = new LineChartSeries(); series1.setLabel("Series 1"); series1.set(1, 2); series1.set(2, 1); series1.set(3, 3); series1.set(4, 6); series1.set(5, 8);

LineChartSeries series2 = new LineChartSeries(); series2.setLabel("Series 2"); series2.set(1, 6); series2.set(2, 3); series2.set(3, 2); series2.set(4, 7); series2.set(5, 9);

} model.addSeries(series1); model.addSeries(series2); model.setTitle("Linear Chart"); model.setLegendPosition("e");

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(10); public LineChartModel getModel() { return model;

}

PrimeFaces User’s Guide

Customized

<p:chart type="line" value="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();

ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);

ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 90); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Category Chart"); model.setLegendPosition("e"); model.setShowPointLabels(true); model.getAxes().put(AxisType.X, new CategoryAxis("Years"));

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(200);

} public LineChartModel getModel() { return model;

}

Area

<p:chart type="line" value="#{bean.model}" /> public class Bean { private LineChartModel model; public Bean() { model = new LineChartModel();

LineChartSeries boys = new LineChartSeries(); boys.setFill(true); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);

LineChartSeries girls = new LineChartSeries(); girls.setFill(true); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 90); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Area Chart"); model.setLegendPosition("ne"); model.setStacked(true); model.setShowPointLabels(true); model.getAxis(AxisType.X).setLabel("Years");

Axis yAxis = model.getAxis(AxisType.Y);

} yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(300); public CartesianChartModel getModel() { return model;

}

PrimeFaces User’s Guide

3.13.3 BarChart

BarChartModel is used to created a BarChart.

Basic

<p:chart type="bar" value="#{bean.model}" /> public class Bean { private BarChartModel model; public ChartBean() { model = new BarChartModel();

ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);

ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 135); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Bar Chart"); model.setLegendPosition("ne");

}

Axis xAxis = model.getAxis(AxisType.X); xAxis.setLabel("Gender");

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Births"); yAxis.setMin(0); yAxis.setMax(200); public BarChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

Horizontal and Stacked

<p:chart type="bar" value="#{bean.model}" /> public class Bean { private HorizontalBarChartModel model;

} public ChartBean() { model = new HorizontalBarChartModel();

ChartSeries boys = new ChartSeries(); boys.setLabel("Boys"); boys.set("2004", 50); boys.set("2005", 96); boys.set("2006", 44); boys.set("2007", 55); boys.set("2008", 25);

ChartSeries girls = new ChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 82); girls.set("2007", 35); girls.set("2008", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Horizontal and Stacked"); model.setLegendPosition("e"); model.setStacked(true);

Axis xAxis = model.getAxis(AxisType.X); xAxis.setLabel("Births"); xAxis.setMin(0); xAxis.setMax(200);

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Gender"); public HorizontalBarChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.4 DonutChart

DonutChart is generated using DonutChartModel.

Basic

<p:chart type="donut" value="#{bean.model}" /> public class Bean { private DonutChartModel model; public ChartBean() { model = new DonutChartModel();

Map<String, Number> circle1 = new LinkedHashMap<String, Number>(); circle1.put("Brand 1", 150); circle1.put("Brand 2", 400); circle1.put("Brand 3", 200); circle1.put("Brand 4", 10); model.addCircle(circle1);

Map<String, Number> circle2 = new LinkedHashMap<String, Number>(); circle2.put("Brand 1", 540); circle2.put("Brand 2", 125); circle2.put("Brand 3", 702); circle2.put("Brand 4", 421); model.addCircle(circle2);

Map<String, Number> circle3 = new LinkedHashMap<String, Number>(); circle3.put("Brand 1", 40); circle3.put("Brand 2", 325); circle3.put("Brand 3", 402); circle3.put("Brand 4", 421); model.addCircle(circle3);

} model.setTitle("Donut Chart"); model.setLegendPosition("w"); public DonutChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

Customized

<p:chart type="donut" value="#{bean.model}" /> public class Bean { private DonutChartModel model; public ChartBean() { model = new DonutChartModel();

} model.setTitle("Donut Chart"); model.setLegendPosition("w"); model.setTitle("Custom Options"); model.setLegendPosition("e"); model.setSliceMargin(5); model.setShowDataLabels(true); model.setDataFormat("value"); model.setShadow(false); public DonutChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.5 BubbleChart

BubbleChart is created with a BubbleChartModel.

Basic

<p:chart type="bubble" value="#{bean.model}" /> public class Bean { private BubbleChartModel model; public ChartBean() { model = new BubbleChartModel(); model.add(new BubbleChartSeries("Acura", 70, 183,55)); model.add(new BubbleChartSeries("Alfa Romeo", 45, 92, 36)); model.add(new BubbleChartSeries("AM General", 24, 104, 40)); model.add(new BubbleChartSeries("Bugatti", 50, 123, 60)); model.add(new BubbleChartSeries("BMW", 15, 89, 25)); model.add(new BubbleChartSeries("Audi", 40, 180, 80)); model.add(new BubbleChartSeries("Aston Martin", 70, 70, 48));

} model.setTitle("Bubble Chart"); model.getAxis(AxisType.X).setLabel("Price");

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(250); yAxis.setLabel("Labels"); public BubbleChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

Customized

} model = initBubbleModel(); model.setTitle("Custom Options"); model.setShadow(false); model.setBubbleGradients(true); model.setBubbleAlpha(0.8); model.getAxis(AxisType.X).setTickAngle(-50);

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(250); yAxis.setTickAngle(50); public BubbleChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.6 Ohlc Chart

OhlcChartModel is used to display Ohlc Charts.

Basic

<p:chart type="ohlc" value="#{bean.model}" /> public class Bean { private OhlcChartModel model; public ChartBean() {

ohlcModel = new OhlcChartModel();

ohlcModel.add(new OhlcChartSeries(2007, 143.82, 144.56, 136.04, 136.97));

ohlcModel.add(new OhlcChartSeries(2008, 138.7, 139.68, 135.18, 135.4));

ohlcModel.add(new OhlcChartSeries(2009, 143.46, 144.66, 139.79, 140.02));

ohlcModel.add(new OhlcChartSeries(2010, 140.67, 143.56, 132.88, 142.44));

ohlcModel.add(new OhlcChartSeries(2011, 136.01, 139.5, 134.53, 139.48));

ohlcModel.add(new OhlcChartSeries(2012, 124.76, 135.9, 124.55, 135.81));

ohlcModel.add(new OhlcChartSeries(2012, 123.73, 129.31, 121.57, 122.5));

ohlcModel.setTitle("OHLC Chart");

ohlcModel.getAxis(AxisType.X).setLabel("Year");

ohlcModel.getAxis(AxisType.Y).setLabel("Price Change $K/Unit");

} public OhlcChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

Candlestick

<p:chart type="ohlc" value="#{bean.model}" /> public class Bean { private OhlcChartModel model; public ChartBean() {

model = new OhlcChartModel();

for( int i=1 ; i < 41 ; i++) {

ohlcModel2.add(new OhlcChartSeries(i, Math.random() * 80 + 80,

Math.random() * 50 + 110, Math.random() * 20 + 80, Math.random() * 80 + 80));

}

model.setTitle("Candlestick");

model.setCandleStick(true);

model.getAxis(AxisType.X).setLabel("Sector");

model.getAxis(AxisType.Y).setLabel("Index Value");

} public OhlcChartModel getModel() { return model; }

}

3.13.7 MeterGauge Chart

MeterGauge Chart is created using MeterGaugeChartModel.

Basic

<p:chart type="metergauge" value="#{bean.model}" /> public class Bean { private MeterGaugeChartModel model; public ChartBean() {

List<Number> intervals = new ArrayList<Number>(){{ add(20); add(50); add(120); add(220);

}}; model = new MeterGaugeChartModel(140, intervals); model.setTitle("MeterGauge Chart"); model.setGaugeLabel("km/h");

} public MeterGaugeChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

Customized

<p:chart type="metergauge" value="#{bean.model}" />

public class Bean { private MeterGaugeChartModel model; public ChartBean() {

List<Number> intervals = new ArrayList<Number>(){{ add(20); add(50); add(120); add(220);

}};

} model = new MeterGaugeChartModel(140, intervals); model.setTitle("Custom Options"); model.setSeriesColors("66cc66,93b75f,E7E658,cc6666"); model.setGaugeLabel("km/h"); model.setGaugeLabelPosition("bottom"); model.setShowTickLabels(false); model.setLabelHeightAdjust(110); model.setIntervalOuterRadius(130); public MeterGaugeChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.8 Combined Chart

On same graph, different series type can be displayed together.

Basic

<p:chart type="bar" value="#{bean.model}" /> public class Bean { private BarChartModel model; public ChartBean() { combinedModel = new BarChartModel();

BarChartSeries boys = new BarChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);

LineChartSeries girls = new LineChartSeries(); girls.setLabel("Girls"); girls.set("2004", 52); girls.set("2005", 60); girls.set("2006", 110); girls.set("2007", 135); girls.set("2008", 120);

} model.addSeries(boys); model.addSeries(girls); model.setTitle("Bar and Line"); model.setLegendPosition("ne"); model.setMouseoverHighlight(false); model.setShowDatatip(false); model.setShowPointLabels(true);

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setMin(0); yAxis.setMax(200); public BarChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.9 Multiple Axis

Up to 9 axes (xaxis-x9axis, yaxis-y9axis) can be displayed on the same chart.

Basic

<p:chart type="line" value="#{bean.model}" />

PrimeFaces User’s Guide public class Bean { private LineChartModel model; public ChartBean() { model = new LineChartModel();

BarChartSeries boys = new BarChartSeries(); boys.setLabel("Boys"); boys.set("2004", 120); boys.set("2005", 100); boys.set("2006", 44); boys.set("2007", 150); boys.set("2008", 25);

LineChartSeries girls = new LineChartSeries(); girls.setLabel("Girls"); girls.setXaxis(AxisType.X2); girls.setYaxis(AxisType.Y2); girls.set("A", 52); girls.set("B", 60); girls.set("C", 110); girls.set("D", 135); girls.set("E", 120); model.addSeries(boys); model.addSeries(girls); model.setTitle("Multi Axis Chart"); model.setMouseoverHighlight(false); model.getAxes().put(AxisType.X, new CategoryAxis("Years")); model.getAxes().put(AxisType.X2, new CategoryAxis("Period"));

Axis yAxis = model.getAxis(AxisType.Y); yAxis.setLabel("Birth"); yAxis.setMin(0); yAxis.setMax(200);

}

Axis y2Axis = new LinearAxis("Number"); y2Axis.setMin(0); y2Axis.setMax(200); model.getAxes().put(AxisType.Y2, y2Axis); public LineChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.10 Date Axis

Use DateAxis if you are displaying dates in an axis.

Basic

<p:chart type="line" value="#{bean.model}" /> public class Bean { private LineChartModel model; public ChartBean() { dateModel = new LineChartModel();

LineChartSeries series1 = new LineChartSeries(); series1.setLabel("Series 1"); series1.set("2014-01-01", 51); series1.set("2014-01-06", 22); series1.set("2014-01-12", 65); series1.set("2014-01-18", 74); series1.set("2014-01-24", 24); series1.set("2014-01-30", 51);

LineChartSeries series2 = new LineChartSeries(); series2.setLabel("Series 2"); series2.set("2014-01-01", 32); series2.set("2014-01-06", 73); series2.set("2014-01-12", 24); series2.set("2014-01-18", 12); series2.set("2014-01-24", 74); series2.set("2014-01-30", 62);

} dateModel.addSeries(series1); dateModel.addSeries(series2); dateModel.setTitle("Zoom for Details"); dateModel.setZoom(true); dateModel.getAxis(AxisType.Y).setLabel("Values");

DateAxis axis = new DateAxis("Dates"); axis.setTickAngle(-50); axis.setMax("2014-02-01"); axis.setTickFormat("%b %#d, %y"); dateModel.getAxes().put(AxisType.X, axis); public LineChartModel getModel() { return model; }

}

PrimeFaces User’s Guide

3.13.11 Interactive Chart

Charts are interactive components, information about selected series and items can be passed via ajax to a JSF backing bean using ItemSelectEvent.

Basic

<p:chart type="pie" value="#{bean.model}">

<p:ajax event="itemSelect" listener="#{bean.itemSelect}" />

</p:chart> public class Bean { private PieChartModel model; public ChartBean() { model = new PieChartModel(); model.set("Brand 1", 540); model.set("Brand 2", 325); model.set("Brand 3", 702); model.set("Brand 4", 421);

} model.setTitle("Simple Pie"); model.setLegendPosition("w"); public PieChartModel getModel() { return model; } public void itemSelect(ItemSelectEvent event) {

FacesMessage msg = new FacesMessage(FacesMessage.SEVERITY_INFO,

"Item selected", "Item Index: " + event.getItemIndex() +

", Series Index:" + event.getSeriesIndex());

FacesContext.getCurrentInstance().addMessage(null, msg);

}

PrimeFaces User’s Guide

3.13.12 Export

Chart component provides a client side method to convert the graph to an image. Example below demonstrates how to use a button click to export the chart as an image and display it in a dialog so that users can download it as a regular image.

<p:chart type="line" value="#{bean.model}" style="width:500px;height:300px" widgetVar="chart"/>

<p:commandButton type="button" value="Export" icon="ui-icon-extlink" onclick="exportChart()"/>

<p:dialog widgetVar="dlg" showEffect="fade" modal="true" header="Chart as an Image">

<p:outputPanel id="output" layout="block" style="width:500px;height:300px"/>

</p:dialog> function exportChart() {

//export image

$('#output').empty().append(PF('chart').exportAsImage());

//show the dialog

PF('dlg').show();

}

PrimeFaces User’s Guide

3.13.13 Static Images

JFreeChart with GraphicImage component is an alternative to the chart component.

Basic

<p:graphicImage value="#{bean.chart}" /> public class Bean { private StreamedContent chart; public Bean() {

JFreeChart jfreechart = ChartFactory.createPieChart("Cities", createDataset(), true, true, false);

File chartFile = new File("dynamichart");

ChartUtilities.saveChartAsPNG(chartFile, jfreechart, 375, 300);

chart = new DefaultStreamedContent(new FileInputStream(chartFile),

"image/png");

} public StreamedContent getChart() { return model; } private PieDataset createDataset() {

DefaultPieDataset dataset = new DefaultPieDataset();

dataset.setValue("New York", new Double(45.0));

dataset.setValue("London", new Double(15.0));

dataset.setValue("Paris", new Double(25.2));

dataset.setValue("Berlin", new Double(14.8));

return dataset;

}

PrimeFaces User’s Guide

3.13.14 Skinning

Charts can be styled using regular css. Following is the list of style classes;

.jqplot-target

.jqplot-axis

Style Class

.jqplot-xaxis

.jqplot-yaxis

Plot target container.

Axes.

Primary x-axis.

Primary y-axis.

.jqplot-x2axis, .jqplot-x3axis ...

2nd, 3rd ... x-axis.

.jqplot-y2axis, .jqplot-y3axis ...

2nd, 3rd ... y-axis.

.jqplot-axis-tick Axis ticks.

.jqplot-xaxis-tick

.jqplot-x2axis-tick

Primary x-axis ticks.

Secondary x-axis ticks.

.jqplot-yaxis-tick

.jqplot-y2axis-tick table.jqplot-table-legend

.jqplot-title

.jqplot-cursor-tooltip

.jqplot-highlighter-tooltip div.jqplot-table-legend-swatch

Primary y-axis-ticks.

Seconday y-axis-ticks.

Legend table.

Title of the chart.

Cursor tooltip.

Highlighter tooltip.

Colors swatch of the legend.

Applies

Additionally style and styleClass options of chart component apply to the container element of charts, use these attribute to specify the dimensions of a chart.

<p:pieChart value="#{bean.model}" style=”width:320px;height:200px” />

In case you’d like to change the colors of series, use the seriesColors option in ChartModel API.

PrimeFaces User’s Guide

3.13.15 Extender

Chart API provide high level access to commonly used jqplot options however there are many more customization options available in jqplot. Extender feature provide access to low level apis to do advanced customization by enhancing the configuration object, here is an example to increase shadow depth of the line series where model's extender property is set to "ext".

<p:chart type="line" value="#{bean.model}" /> function ext() {

//this = chart widget instance

//this.cfg = options this.cfg.seriesDefaults = { shadowDepth: 5

};

}

Refer to jqPlot docs for available options.

PrimeFaces User’s Guide

3.13.16 Chart API

Axis org.primefaces.model.chart.Axis

Property label min max tickAngle tickFormat tickInterval tickCount null null null null

Default Type null null null

String

Object

Integer

String

Description

Title of the axis.

Minimum boundary value.

Maximum boundary value.

Angle of text, measured clockwise.

Format string to use with the axis tick formatter

Number of units between ticks.

Integer Desired number of ticks.

AxisType org.primefaces.model.chart.AxisType

AxisType is an enum to define the type of the axis from X-Y to X9-Y9.

BarChartModel

org.primefaces.model.chart.BarChartModel extends org.primefaces.model.chart.ChartModel

Property barPadding barMargin stacked

Default Type

8 Integer

10 false

Integer

Boolean

Description

Padding between bars.

Margin between bars.

Displays series in stacked format.

BarChartSeries

org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries

Property disableStack

Default Type false Boolean

Description

When true, series data is not included in a stacked chart.

BubbleChartModel

org.primefaces.model.chart.BubbleChartModel extends org.primefaces.model.chart.ChartModel

Property data

Default Type null

Description

List<BubbleChartSeries> Data as a list of BubbleChartSeries.

bubbleGradients false bubbleAlpha 1.0

showLabels true

Boolean

Double

Boolean

Displays bubbles with gradients.

Opacity of bubbles.

Displays label of a series inside a bubble.

PrimeFaces User’s Guide

BubbleChartSeries

org.primefaces.model.chart.BarChartSeries extends org.primefaces.model.chart.ChartSeries

Property x y radius label

Default Type null Integer null null null

Integer

String

Description

X-Axis value of the bubble.

Y-Axis value of the bubble.

Radius of the bubble.

Label text of the bubble.

CartesianChartModel org.primefaces.model.chart.CartesianChartModel

Property series axes zoom animate showDatatip datatipFormat showPointLabels

Default Type null List<ChartSeries>

Description

List of series.

HashMap Map<AxisType,Axis> Map of chart axis.

false false true

Boolean

Adds zoom feature when enabled.

When enabled, series are drawn with an effect.

Displays a tooltip on hover.

null false

String

Boolean

Format of the data tooltip.

Displays data inline in plot.

CategoryAxis

org.primefaces.model.chart.CategoryAxis extends org.primefaces.model.chart.Axis

CategoryAxis is used when data on the axis does not consists of numbers.

ChartModel org.primefaces.model.chart.ChartModel

Property title shadow seriesColors legendPosition legendCols legendRows null

0 mouseoverHighlight true extender null

Default Type null true null

String

Description

Title text for the plot

Boolean To show shadow or not on series.

Comma separated list of series colors e.g. "#4BB2C5",

"CCCCC"

String Position of the legend like "n" or "ne".

Integer Maximum number of columns in the legend.

Integer Maximum number of rows in the legend.

Boolean Highlights series on hover.

String Name of javascript function to extend chart with.

ChartSeries org.primefaces.model.chart.ChartSeries

Property label

Default Type null String

Description

Title text of the series.

Property data xaxis yaxis

PrimeFaces User’s Guide

Default Type null Map<Object,Number>

Description

Data of the series as a map.

null null

AxisType

X-Axis of the series.

Y-Axis of the series.

DateAxis

org.primefaces.model.chart.DateAxis extends org.primefaces.model.chart.Axis

DateAxis is used when data on the axis consists of string representations of date values.

DonutChartModel

org.primefaces.model.chart.DonutChartModel extends org.primefaces.model.chart.ChartModel

Property data sliceMargin fill

Default null

0 true

Type Description

List>Map<String,Object>> Data as a list of map instances.

Integer

Boolean showDataLabels false dataFormat percent

Boolean

String

Angular spacing between pie slices in degrees.

True or False to fill the slices.

True to False show data labels on slices.

Either ‘label’, ‘value’, ‘percent’ or an array of labels to place on the pie slices.

HorizontalBarChartModel

org.primefaces.model.chart.HorizontalBarChartModel extends org.primefaces.model.chart.BarChartModel

HorizontalBarChartModel is an extension to BarChartModel with y-axis used for the categories and x-axis for the data values.

LineChartSeries

org.primefaces.model.chart.LineChartSeries extends org.primefaces.model.chart.ChartSeries

Property Default markerStyle filledCircle showLine true showMarker true fill false fillAlpha 1 disableStack false

Type

String

Boolean

Double

Boolean

Description

Style of the markers, valid values are diamond, circle, square,

x, plus, dash, filledDiamond, filledCircle, filledSquare.

Whether to actually draw the line or not.

Displays markes at data points.

Fills the area between lines.

Opacity of the filled area.

When true, series data is not included in a stacked chart.

LinearAxis

org.primefaces.model.chart.LinearAxis extends org.primefaces.model.chart.Axis

LinearAxis is the Axis implementation used to display numbers.

LineChartModel

org.primefaces.model.chart.LineChartModel extends org.primefaces.model.chart.CartesianChartModel

Property stacked breakOnNull

PrimeFaces User’s Guide

Default Type null List<ChartSeries>

Description

Displays series in stacked format.

HashMap Map<AxisType,Axis> Discontinues line plot for null values.

MeterGaugeChartModel

org.primefaces.model.chart.MeterGaugeChartModel extends org.primefaces.model.chart.ChartModel

Property value intervals ticks gaugeLabel gaugeLabelPosition false min null max null showTickLabels true intervalOuterRadius 85 labelHeightAdjust -25

Default Type null Number null

0 true

Description

Value of the gauge.

List<Number> List of ranges to be drawn around the gauge.

List<Number> List of tick values.

String Label text of the gauge.

String

Double

Boolean

Integer

Where to position the label, either ‘inside’ or ‘bottom’.

Minimum value on the gauge.

Displays tick labels next to ticks.

Radius of the outer circle of the interval ring.

Number of Pixels to offset the label up (-) or down (+) from its default position.

OhlcChartModel

org.primefaces.model.chart.OhlcChartModel extends org.primefaces.model.chart.ChartModel

Property data candleStick

Default Type null

Description

List<OhlcChartSeries> Data as a list of OhlChartSeries.

false Boolean Displays series as candlestick.

OhlcChartSeries

org.primefaces.model.chart.OhlcChartSeries extends org.primefaces.model.chart.ChartSeries

Property value open high low close

Default Type null

Description

List<OhlcChartSeries> Data as a list of OhlChartSeries.

null null

Double

Open value.

High value.

null null

Double

Low value.

Close value.

PieChartModel

org.primefaces.model.chart.PieChartModel extends org.primefaces.model.chart.ChartModel

Property data diameter

Default Type null Map<String,Object>

Description

Data as a Map instance.

null Integer Outer diameter of the pie, auto computed by default

Property sliceMargin fill

Default

0 true

Type

Integer

Boolean showDataLabels false dataFormat percent

Boolean

String

PrimeFaces User’s Guide

Description

Angular spacing between pie slices in degrees.

True or False to fill the slices.

True to False show data labels on slices.

Either ‘label’, ‘value’, ‘percent’ or an array of labels to place on the pie slices.

PrimeFaces User’s Guide

3.14 Clock

Clock displays server or client datetime live.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class clock org.primefaces.component.clock.Clock

org.primefaces.component.Clock

org.primefaces.component

org.primefaces.component.ClockRenderer

org.primefaces.component.clock.ClockRenderer

Attributes id rendered

Name binding pattern mode autoSync syncInterval

Default null true null null client false

60000

Type

String

Boolean

Object

String

Boolean

Integer

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean.

Datetime format.

Mode value, valid values are client and server.

Syncs time periodically in server mode.

Defines the sync in ms interval in autoSync setting.

Getting Started with Clock

Clock has two modes, client (default) and server. In simples mode, datetime is displayed by just adding component on page. On page load, clock is initialized and start running based on client time.

<p:clock />

PrimeFaces User’s Guide

Server Mode

In server mode, clock initialized itself with the server’s datetime and starts running on client side.

To make sure client clock and server clock is synced, you can enable autoSync option that makes an ajax call to the server periodically to refresh the server time with client.

DateTime Format

Datetime format used can be changed using pattern attribute.

<p:clock pattern="HH:mm:ss dd.MM.yyyy" />

Skinning

Clock resides in a container element which style and styleClass options apply. Following is the list of structural style classes;

.ui-clock

Style Class

Container element.

Applies

PrimeFaces User’s Guide

3.15 Collector

Collector is a simple utility to manage collections declaratively.

Info

Tag

ActionListener Class collector org.primefaces.component.collector.Collector

Attributes

Name value

Default null addTo null removeFrom null unique true

Type

Object java.util.Collection

java.util.Collection

Boolean

Description

Value to be used in collection operation

Reference to the Collection instance

When enabled, rejects duplicate items on addition.

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.

public class BookBean { private Book book = new Book(); private List<Book> books; public CreateBookBean() { books = new ArrayList<Book>();

}

//getters and setters

}

<p:commandButton value="Add">

<p:collector value="#{bookBean.book}" addTo="#{bookBean.books}" />

</p:commandButton>

<p:commandLink value="Remove">

</p:commandLink>

PrimeFaces User’s Guide

3.16 Color Picker

ColorPicker is an input component with a color palette.

Info

Tag colorPicker

Component Class

Component Type org.primefaces.component.colorpicker.ColorPicker

org.primefaces.component.ColorPicker

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.ColorPickerRenderer

org.primefaces.component.colorpicker.ColorPickerRenderer

Attributes

Name id rendered binding value converter immediate required validator

Default null true null null null false false null

Type

String

Boolean

Object

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

Object

Converter/Str ing

Boolean

Value of the component.

When set true, process validations logic is executed at apply request values phase for this component.

Boolean Marks component as required.

MethodExpr A method expression that refers to a method for validation the input.

Name Default valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar mode style styleClass null null null null popup null null

PrimeFaces User’s Guide

Type

ValueChange

Listener

String

Description

A method binding expression that refers to a method for handling a valuchangeevent.

Message to be displayed when required field validation fails.

Message to be displayed when conversion fails.

Message to be displayed when validation fields.

Name of the client side widget.

Display mode, valid values are “popup” and

“inline”.

Inline style of the component.

Style class of the component.

Getting started with ColorPicker

ColorPicker’s value should be a hex string.

public class Bean { private String color; public String getColor() { return this.color;

} public void setColor(String color) { this.color = color;

}

<p:colorPicker value="#{bean.color}" />

Display Mode

ColorPicker has two modes, default mode is popup and other available option is inline.

<p:colorPicker value="#{bean.color}" mode="inline"/>

PrimeFaces User’s Guide

Skinning

ColorPicker resides in a container element which style and styleClass options apply. Following is the list of structural style classes;

Style Class

.ui-colorpicker

.ui-colorpicker_color

.ui-colorpicker_hue

.ui-colorpicker_new_color

Container element.

Background of gradient.

Hue element.

New color display.

.ui-colorpicker_current_color Current color display.

.ui-colorpicker-rgb-r Red input.

.ui-colorpicker-rgb-g

.ui-colorpicker-rgb-b

Greed input.

Blue input.

.ui-colorpicker-rgb-h

.ui-colorpicker-rgb-s

.ui-colorpicker-rgb-b

.ui-colorpicker-rgb-hex

Hue input.

Saturation input.

Brightness input.

Hex input.

Applies

PrimeFaces User’s Guide

3.17 Column

Column is an extended version of the standard column used by various components like datatable, treetable and more.

Info

Tag

Component Class

Component Type column org.primefaces.component.column.Column

org.primefaces.component.Column

Component Family org.primefaces.component

Attributes id

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

binding null style styleClass sortBy sortFunction filterBy filterStyle filterStyleClass filterOptions null null null null null null null null filterMatchMode startsWith String rowspan 1 Integer colspan 1 Integer headerText footerText null null selectionMode null disabledSelection false

String

Boolean

Object

String

ValueExpr

An el expression that maps to a server side

UIComponent instance in a backing bean

Inline style of the column.

Style class of the column.

ValueExpression to be used for sorting.

MethodExpr Custom pluggable sortFunction.

ValueExpr ValueExpression to be used for filtering.

String Inline style of the filter element

String

Object

Style class of the filter element

A collection of selectitems for filter dropdown.

Match mode for filtering.

Defines the number of rows the column spans.

Defines the number of columns the column spans.

Shortcut for header facet.

Shortcut for footer facet.

Enables selection mode.

Disables row selection.

100

PrimeFaces User’s Guide

Name Default filterMaxLength null resizable true width exportable filterValue toggleable filterFunction field null true null true null null

Type

Integer

Boolean

Description

Maximum number of characters for an input filter.

Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option.

Width in pixels or percentage.

String

Boolean

Object

Boolean

Defines if the column should be exported by dataexporter.

Value of the filter field.

Defines if panel is toggleable by columnToggler component. Default value is true and a false value marks the column as static.

MethodExpr Custom implementation to filter a value against a constraint.

String Name of the field to pass lazy load method for filtering and sorting. If not specified, filterBy-sortBy values are used to identify the field name.

Getting Started with Column

As column is a reused component, see documentation of components that use a column.

Note

Not all attributes of column are implemented by the components that utilize column.

101

PrimeFaces User’s Guide

3.18 Columns

Columns is used by datatable to create columns dynamically.

Info

Tag

Component Class

Component Type columns org.primefaces.component.column.Columns

org.primefaces.component.Columns

Component Family org.primefaces.component

Attributes id

Name rendered binding value var style styleClass sortBy sortFunction filterBy

Default null true null null null null null null null null filterStyle null filterStyleClass null

String

String filterOptions null Object filterMatchMode startsWith String rowspan colspan headerText

1 null

Integer

String

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.

Object An el expression that maps to a server side

UIComponent instance in a backing bean

Data to represent columns.

Object

String

ValueExpr

Name of iterator to access a column.

Inline style of the column.

Style class of the column.

ValueExpression to be used for sorting.

MethodExpr Custom pluggable sortFunction.

ValueExpr ValueExpression to be used for filtering.

Inline style of the filter element

Style class of the filter element

A collection of selectitems for filter dropdown.

Match mode for filtering.

Defines the number of rows the column spans.

Defines the number of columns the column spans.

Shortcut for header facet.

102

PrimeFaces User’s Guide

Name Default footerText null filterMaxLength null resizable true width exportable columnIndexVar filterValue toggleable filterFunction field null true null null true null null

Type Description

String

Integer

Boolean

String

Boolean

Shortcut for footer facet.

Maximum number of characters for an input filter.

Specifies resizable feature at column level. Datatable's resizableColumns must be enabled to use this option.

Width in pixels or percentage.

Defines if the column should be exported by dataexporter.

String

Object

Boolean

Name of iterator to refer each index.

Value of the filter field.

Defines if panel is toggleable by columnToggler component. Default value is true and a false value marks the column as static.

MethodExpr Custom implementation to filter a value against a constraint.

String Name of the field to pass lazy load method for filtering and sorting. If not specified, filterBy-sortBy values are used to identify the field name.

Getting Started with Columns

See dynamic columns section in datatable documentation for detailed information.

103

3.19 ColumnGroup

ColumnGroup is used by datatable for column grouping.

Info

Tag

Component Class columnGroup org.primefaces.component.columngroup.ColumnGroup

Component Type org.primefaces.component. ColumnGroup

Component Family org.primefaces.component

PrimeFaces User’s Guide

Attributes

Name id rendered binding type

Default null true

String

Type

Boolean null null

Object

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

Type of group, valid values are “header” and “footer”.

Getting Started with ColumnGroup

See grouping section in datatable documentation for detailed information.

104

PrimeFaces User’s Guide

3.20 CommandButton

CommandButton is an extended version of standard commandButton with ajax and theming.

Info

Tag commandButton

Component Class org.primefaces.component.commandbutton.CommandButton

Component Type org.primefaces.component.CommandButton

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.CommandButtonRenderer

org.primefaces.component.commandbutton.CommandButtonRenderer

Attributes

Name id rendered binding value action actionListener immediate type ajax async process update

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.

null null null null false submit true

Object

String

MethodExpr/

String

A method expression or a String outcome that’d be processed when button is clicked.

MethodExpr An actionlistener that’d be processed when button is clicked.

Boolean

An el expression that maps to a server side UIComponent instance in a backing bean

Label for the button

String

Boolean

Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.

Sets the behavior of the button.

Specifies the submit mode, when set to true(default), submit would be made with Ajax.

When set to true, ajax requests are not queued.

false null null

Boolean

String

Component(s) to process partially instead of whole view.

Component(s) to be updated with ajax.

105

onstart

Name oncomplete onsuccess onerror global delay partialSubmit resetValues false false ignoreAutoUpdate false

Boolean

Boolean style styleClass onblur onchange onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown null null null null null null null null null null null

String

String null true null

Default null

Type

String null null

String

Boolean

String

PrimeFaces User’s Guide

Description

Client side callback to execute before ajax request is begins.

Client side callback to execute when ajax request is completed.

Client side callback to execute when ajax request succeeds.

Client side callback to execute when ajax request fails.

Defines whether to trigger ajaxStatus or not.

If less than delay milliseconds elapses between calls to

Enables serialization of values belonging to the partially processed components only.

If true, local values of input components to be updated within the ajax request would be reset.

If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.

Inline style of the button element.

StyleClass of the button element.

Client side callback to execute when button loses focus.

Client side callback to execute when button loses focus and its value has been modified since gaining focus.

Client side callback to execute when button is clicked.

Client side callback to execute when button is double clicked.

Client side callback to execute when button receives focus.

Client side callback to execute when a key is pressed down over button.

Client side callback to execute when a key is pressed and released over button.

Client side callback to execute when a key is released over button.

Client side callback to execute when a pointer button is pressed down over button.

106

Name onmousemove onmouseout onmouseover onmouseup onselect accesskey alt dir disabled image label lang tabindex title readonly icon iconPos inline escape widgetVar false null null null null null false null left false true null null null null null null

Default null

Type

String null null

String

Boolean

String

Integer

String

Boolean

String

Boolean

String

PrimeFaces User’s Guide

Description

Client side callback to execute when a pointer button is moved within button.

Client side callback to execute when a pointer button is moved away from button.

Client side callback to execute when a pointer button is moved onto button.

Client side callback to execute when a pointer button is released over button.

Client side callback to execute when text within button is selected by user.

Access key that when pressed transfers focus to the button.

Alternate textual description of the button.

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

Disables the button.

Style class for the button icon. (deprecated: use icon)

A localized user presentable name.

Code describing the language used in the generated markup for this component.

Position of the button element in the tabbing order.

Advisory tooltip information.

Flag indicating that this component will prevent changes by the user.

Icon of the button as a css class.

Position of the icon.

Used by PrimeFaces mobile only.

Defines whether label would be escaped or not.

Name of the client side widget.

Getting started with CommandButton

CommandButton usage is similar to standard commandButton, by default commandButton submits its enclosing form with ajax.

107

PrimeFaces User’s Guide

<p:commandButton value="Save" actionListener="#{bookBean.saveBook}" /> public class BookBean {

public void saveBook() {

//Save book

}

Reset Buttons

Reset buttons do not submit the form, just resets the form contents.

<p:commandButton type="reset" value="Reset" />

Push Buttons

Push buttons are used to execute custom javascript without causing an ajax/non-ajax request. To create a push button set type as "button".

<p:commandButton type="button" value="Alert" onclick="alert(‘Prime’)" />

AJAX and Non-AJAX

CommandButton has built-in ajax capabilities, ajax submit is enabled by default and configured using ajax attribute. When ajax attribute is set to false, form is submitted with a regular full page refresh.

T h e update attribute is used to partially update other component(s) after the ajax response is received. Update attribute takes a comma or white-space separated list of JSF component ids to be updated. Basically any JSF component, not just PrimeFaces components should be updated with the

Ajax response. In the following example, form is submitted with ajax and display outputText is updated with the ajax response.

<h:form>

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

108

PrimeFaces User’s Guide

Icons

An icon on a button is provided using icon option. iconPos is used to define the position of the button which can be “left” or “right”.

<p:commandButton value="With Icon" icon="disk"/>

<p:commandButton icon="disk"/>

.disk is a simple css class with a background property;

.disk { background-image: url(‘disk.png’) !important;

}

You can also use the pre-defined icons from ThemeRoller like ui-icon-search.

Client Side API

Widget: PrimeFaces.widget.CommandButton

Method disable() enable()

Params

Return Type void void

Description

Disables button

Enables button

Skinning

CommandButton renders a button tag which style and styleClass applies. Following is the list of structural style classes;

Style Class

.ui-button

.ui-button-text-only

.ui-button-text

Applies

Button element

Button element when icon is not used

Label of button

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

109

PrimeFaces User’s Guide

3.21 CommandLink

CommandLink extends standard JSF commandLink with Ajax capabilities.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class commandLink org.primefaces.component.commandlink.CommandLink

org.primefaces.component.CommandLink

org.primefaces.component

org.primefaces.component.CommandLinkRenderer

org.primefaces.component. commandlink.CommandLinkRenderer

Attributes

Name id rendered async process ajax update onstart binding value action actionListener immediate

Default null true null null null null false false null true null null

Type

String

Boolean

Object

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

String

MethodExpr/

String

Href value of the rendered anchor.

A method expression or a String outcome that’d be processed when link is clicked.

MethodExpr An actionlistener that’d be processed when link is clicked.

Boolean

String

Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.

When set to true, ajax requests are not queued.

Boolean

String

Component(s) to process partially instead of whole view.

Specifies the submit mode, when set to true(default), submit would be made with Ajax.

Component(s) to be updated with ajax.

Client side callback to execute before ajax request is begins.

110

Name oncomplete onsuccess onerror global delay partialSubmit resetValues false false ignoreAutoUpdate false style styleClass onblur onclick ondblclick onfocus onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout null null null null null

Default null

Type

String null null true null

String

Boolean

String null null null null null null null

Boolean

String

PrimeFaces User’s Guide

Description

Client side callback to execute when ajax request is completed.

Client side callback to execute when ajax request succeeds.

Client side callback to execute when ajax request fails.

Defines whether to trigger ajaxStatus or not.

If less than delay milliseconds elapses between calls to

Enables serialization of values belonging to the partially processed components only.

If true, local values of input components to be updated within the ajax request would be reset.

If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.

Style to be applied on the anchor element

StyleClass to be applied on the anchor element

Client side callback to execute when link loses focus.

Client side callback to execute when link is clicked.

Client side callback to execute when link is double clicked.

Client side callback to execute when link receives focus.

Client side callback to execute when a key is pressed down over link.

Client side callback to execute when a key is pressed and released over link.

Client side callback to execute when a key is released over link.

Client side callback to execute when a pointer button is pressed down over link.

Client side callback to execute when a pointer button is moved within link.

Client side callback to execute when a pointer button is moved away from link.

111

Name onmouseover onmouseup accesskey charset coords dir disabled hreflang rel rev shape tabindex target title type null null null null null null null null null null

Default null

Type

String null null null null

String

Boolean

String

Integer

String

PrimeFaces User’s Guide

Description

Client side callback to execute when a pointer button is moved onto link.

Client side callback to execute when a pointer button is released over link.

Access key that when pressed transfers focus to the link.

Character encoding of the resource designated by this hyperlink.

Position and shape of the hot spot on the screen for client use in image maps.

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

Disables the link

Languae code of the resource designated by the link.

Relationship from the current document to the anchor specified by the link, values are provided by a spaceseparated list of link types.

A reverse link from the anchor specified by this link to the current document, values are provided by a spaceseparated list of link types.

Shape of hot spot on the screen, valid values are default, rect, circle and poly.

Position of the button element in the tabbing order.

Name of a frame where the resource targeted by this link will be displayed.

Advisory tooltip information.

Type of resource referenced by the link.

Getting Started with CommandLink

CommandLink is used just like the standard h:commandLink, difference is form is submitted with ajax by default.

public class BookBean {

public void saveBook() {

//Save book

}

112

PrimeFaces User’s Guide

<p:commandLink actionListener="#{bookBean.saveBook}">

<h:outputText value="Save" />

</p:commandLink>

Skinning

CommandLink renders an html anchor element that style and styleClass attributes apply.

113

3.22 Confirm

Confirm is a behavior element used to integrate with global confirm dialog.

Info

Tag

Behavior Id confirm org.primefaces.behavior.ConfirmBehavior

PrimeFaces User’s Guide

Attributes

Name header message icon

Default null null null

String

Type

Getting started with Confirm

See global confirm dialog topic in next section for details.

Description

Header of confirm dialog.

Message to display in confirm dialog.

Icon to display next to message.

114

PrimeFaces User’s Guide

3.22 ConfirmDialog

ConfirmDialog is a replacement to the legacy javascript confirmation box. Skinning, customization and avoiding popup blockers are notable advantages over classic javascript confirmation.

Info

Tag

Component Class

Component Type confirmDialog org.primefaces.component.confirmdialog.ConfirmDialog

org.primefaces.component.ConfirmDialog

Component Family org.primefaces.component

Renderer Type org.primefaces.component.ConfirmDialogRenderer

Renderer Class org.primefaces.component.confirmdialog.ConfirmDialogRenderer

Attributes

Name id rendered binding widgetVar message header severity width height style styleClass null null null null auto auto null null

Default null true null

Type Description

String Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object An el expression that maps to a server side UIComponent instance in a backing bean

Name of the client side widget.

String

Text to be displayed in body.

Text for the header.

String Message severity for the displayed icon.

Integer Width of the dialog in pixels

String Inline style of the dialog container.

String Style class of the dialog container

115

Name closable appendTo visible showEffect hideEffect closeOnEscape dir global false null null false ltr false

Default true false

PrimeFaces User’s Guide

Type Description

Boolean Defines if close icon should be displayed or not

Boolean Appends the dialog to the element defined by the given search expression.

Boolean Whether to display confirm dialog on load.

String

Effect to use on showing dialog.

Effect to use on hiding dialog.

Boolean Defines if dialog should hide on escape key.

String Defines text direction, valid values are ltr and rtl.

Boolean When enabled, confirmDialog becomes a shared for other components that require confirmation.

Getting started with ConfirmDialog

ConfirmDialog has two modes; global and non-global. Non-Global mode is almost same as the dialog component used with a simple client side api, show() and hide().

<h:form>

<p:commandButton type="button" onclick="PF('cd').show()" />

<p:confirmDialog message="Are you sure about destroying the world?" header="Initiating destroy process" severity="alert" widgetVar="cd">

<p:commandButton value="Yes Sure" actionListener="#{buttonBean.destroyWorld}" update="messages" oncomplete="PF('cd').hide()"/>

<p:commandButton value="Not Yet" onclick="PF('cd').hide();" type="button" />

</p:confirmDialog>

</h:form>

Message and Severity

Message can be defined in two ways, either via message option or message facet. Message facet is useful if you need to place custom content instead of simple text. Note that header can also be defined using the header attribute or the header facet. Severity defines the icon to display next to the message, default severity is alert and the other option is info.

<p:confirmDialog widgetVar="cd" header=”Confirm”>

<f:facet name="message">

<h:outputText value="Are you sure?" />

</f:facet>

//content

</p:confirmDialog>

Global

Creating a confirmDialog for a specific action is a repetitive task, to solve this global confirmDialog which is a singleton has been introduced. Trigger components need to have p:confirm behavior to

116

PrimeFaces User’s Guide use the confirm dialog. Component that trigger the actual command in dialog must have ui-confirm-

dialog-yes style class, similarly component to cancel the command must have ui-confirm-dialog-no.

At the moment p:confirm is supported by p:commandButton and p:commandLink.

<p:growl id="messages" />

<p:commandButton value="Save" actionListener="#{bean.save}" update="messages">

<p:confirm header="Confirmation" message="Sure?" icon="ui-icon-alert"/>

</p:commandButton>

<p:confirmDialog global="true">

<p:commandButton value="Yes" type="button" styleClass="ui-confirmdialog-yes" icon="ui-icon-check"/>

<p:commandButton value="No" type="button" styleClass="ui-confirmdialog-no" icon="ui-icon-close"/>

</p:confirmDialog>

Client Side API

Widget: PrimeFaces.widget.ConfirmDialog show() hide()

Method Params

Return Type void void

Description

Displays dialog.

Closes dialog.

Skinning

ConfirmDialog resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;

Style Class

.ui-dialog

.ui-dialog-titlebar

.ui-dialog-title

.ui-dialog-titlebar-close

.ui-dialog-content

.ui-dialog-buttonpane

Container element of dialog

Applies

Title bar

Header text

Close icon

Dialog body

Footer button panel

117

PrimeFaces User’s Guide

3.23 ContentFlow

ContentFlow is a horizontal content gallery component with a slide animation.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class contentFlow org.primefaces.component.contentflow.ContentFlow

org.primefaces.component.ContentFlow

org.primefaces.component

org.primefaces.component.ContentFlowRenderer

org.primefaces.component.contentflow.ContentFlowRenderer

Attributes id rendered

Name binding widgetVar value var style styleClass null null null null null null

Default null true

Type

String

Boolean

Object

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.

Name of the client side widget.

Collection of items to display.

Name of the iterator to display an item.

Inline style of the component.

Style class of the component.

118

PrimeFaces User’s Guide

Getting Started with ContentFlow

ContentFlow requires content as children that can either be defined dynamically using iteration or one by one. Each item must have the content style class applied as well.

Static Images

<p:contentFlow>

<p:graphicImage value="/images/photo1.jpg" styleClass="content" />

<p:graphicImage value="/images/photo2.jpg" styleClass="content" />

</p:contentFlow>

Dynamic Images

<p:contentFlow var="image" value="#{bean.images}">

<p:graphicImage value="/images/#{image}" styleClass="content" />

</p:contentFlow>

Caption

To present a caption along with an item, embed a div with "caption" style class inside.

<p:contentFlow var="image" value="#{bean.images}">

<p:graphicImage value="#{image.path}" styleClass="content" />

<div class="caption">#{image.title}</div>

</p:contentFlow>

Skinning

ContentFlow resides in a container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;

Applies Style Class

.ui-contentflow

.flow

.item

.caption

Container element.

Container of item list

Item container

Caption element

119

PrimeFaces User’s Guide

3.24 ContextMenu

ContextMenu provides an overlay menu displayed on mouse right-click event.

Info

Tag

Component Class contextMenu org.primefaces.component.contextmenu.ContextMenu

Component Type org.primefaces.component.ContextMenu

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.ContextMenuRenderer

org.primefaces.component.contextmenu.ContextMenuRenderer

Attributes

Name id rendered binding widgetVar for style styleClass model nodeType event beforeShow null null null null null null null

Default null true null null

Type

String

Boolean

Description

Unique identifier of the component

Object

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side UIComponent instance in a backing bean

Name of the client side widget.

String

Id of the component to attach to

Style of the main container element

String Style class of the main container element

MenuModel Menu model instance to create menu programmatically.

String

Specific type of tree nodes to attach to.

Event to bind contextMenu display, default is contextmenu aka right click.

Client side callback to execute before showing.

120

PrimeFaces User’s Guide

Getting started with ContextMenu

ContextMenu is created with submenus and menuitems. Optional for attribute defines which component the contextMenu is attached to. When for is not defined, contextMenu is attached to the page meaning, right-click on anywhere on page will display the menu.

<p:contextMenu>

<p:menuitem value="Save" actionListener="#{bean.save}" update="msg"/>

<p:menuitem value="Delete" actionListener="#{bean.delete}" ajax="false"/>

<p:menuitem value="Go Home" url= " " target="_blank"/>

</p:contextMenu

ContextMenu example above is attached to the whole page and consists of three different menuitems with different use cases. First menuitem triggers an ajax action, second one triggers a non-ajax action and third one is used for navigation.

Attachment

ContextMenu can be attached to any JSF component, this means right clicking on the attached component will display the contextMenu. Following example demonstrates an integration between contextMenu and imageSwitcher, contextMenu here is used to navigate between images.

<p:imageSwitch id="images" widgetVar="gallery" slideshowAuto="false">

<p:graphicImage value="/images/nature1.jpg" />

<p:graphicImage value="/images/nature2.jpg" />

<p:graphicImage value="/images/nature3.jpg" />

<p:graphicImage value="/images/nature4.jpg" />

</p:imageSwitch>

<p:contextMenu for="images">

<p:menuitem value="Previous" url="#" onclick="PF('gallery').previous()" />

<p:menuitem value="Next" url="#" onclick="PF('gallery').next()" />

</p:contextMenu>

Now right-clicking anywhere on an image will display the contextMenu like;

Data Components

Data components like datatable, tree and treeTable has special integration with context menu, see the documentation of these component for more information.

121

PrimeFaces User’s Guide

Dynamic Menus

ContextMenus can be created programmatically as well, see the dynamic menus part in menu component section for more information and an example.

Skinning

ContextMenu resides in a main container which style and styleClass attributes apply. Following is the list of structural style classes;

Style Class

.ui-contextmenu

.ui-menu-list

.ui-menuitem

.ui-menuitem-link

.ui-menuitem-text

Applies

Container element of menu

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 theming section for more information.

122

PrimeFaces User’s Guide

3.25 Dashboard

Dashboard provides a portal like layout with drag&drop based reorder capabilities.

Info

Tag

Component Class dashboard org.primefaces.component.dashboard.Dashboard

Component Type org.primefaces.component.Dashboard

Component Family org.primefaces.component

Renderer Type

Renderer Class org.primefaces.component.DashboardRenderer

org.primefaces.component.dashboard.DashboardRenderer

Attributes

Name id rendered binding widgetVar model disabled style styleClass

Default null true null null null false null null

Type

String

Boolean

Object

String

Dashboard

Model

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

Name of the client side widget

Dashboard model instance representing the layout of the UI.

Disables reordering feature.

Inline style of the dashboard container

Style class of the dashboard container

123

PrimeFaces User’s Guide

Getting started with Dashboard

Dashboard is backed by a DashboardModel and consists of panel components.

<p:dashboard model="#{bean.model}">

<p:panel id="sports">

//Sports Content

</p:panel>

<p:panel id="finance">

//Finance Content

</p:panel>

//more panels like lifestyle, weather, politics...

</p:dashboard>

Dashboard model simply defines the number of columns and the widgets to be placed in each column. See the end of this section for the detailed Dashboard API.

public class Bean { private DashboardModel model; public Bean() { model = new DefaultDashboardModel();

DashboardColumn column1 = new DefaultDashboardColumn();

DashboardColumn column2 = new DefaultDashboardColumn();

DashboardColumn column3 = new DefaultDashboardColumn(); column1.addWidget("sports"); column1.addWidget("finance"); column2.addWidget("lifestyle"); column2.addWidget("weather"); column3.addWidget("politics"); model.addColumn(column1); model.addColumn(column2); model.addColumn(column3);

}

State

Dashboard is a stateful component, whenever a widget is reordered dashboard model will be updated, by persisting the user changes so you can easily create a stateful dashboard.

Ajax Behavior Events

“reorder” is the one and only ajax behavior event provided by dashboard, this event is fired when dashboard panels are reordered. A defined listener will be invoked by passing an

org.primefaces.event.DashboardReorderEvent instance containing information about reorder.

Following dashboard displays a message about the reorder event

124

PrimeFaces User’s Guide

<p:dashboard model="#{bean.model}">

<p:ajax event=”reorder” update=”messages” listener=”#{bean.handleReorder}” />

//panels

</p:dashboard>

<p:growl id="messages" /> public class Bean {

...

public void handleReorder(DashboardReorderEvent event) {

String widgetId = event.getWidgetId(); int widgetIndex = event.getItemIndex(); int columnIndex = event.getColumnIndex(); int senderColumnIndex = event.getSenderColumnIndex();

//Add facesmessage

}

If a widget is reordered in the same column, senderColumnIndex will be null. This field is populated only when a widget is transferred to a column from another column. Also when the listener is invoked, dashboard has already updated it’s model.

Disabling Dashboard

If you’d like to disable reordering feature, set disabled option to true.

<p:dashboard disabled="true" ...>

//panels

</p:dashboard>

Toggle, Close and Options Menu

Widgets presented in dashboard can be closable, toggleable and have options menu as well, dashboard doesn’t implement these by itself as these features are already provided by the panel component. See panel component section for more information.

<p:dashboard model="#{dashboardBean.model}">

<p:panel id="sports" closable="true" toggleable="true">

//Sports Content

</p:panel>

</p:dashboard>

New Widgets

Draggable component is used to add new widgets to the dashboard. This way you can add new panels from outside of the dashboard.

125

PrimeFaces User’s Guide

<p:dashboard model="#{dashboardBean.model}" id="board">

//panels

</p:dashboard>

<p:panel id="newwidget" />

<p:draggable for="newwidget" helper="clone" dashboard="board" />

Skinning

Dashboard resides in a container element which style and styleClass options apply. Following is the list of structural style classes;

Style Class

.ui-dashboard

.ui-dashboard-column div.ui-state-hover

Applies

Container element of dashboard

Each column in dashboard

Placeholder

As skinning style classes are global, see the main theming section for more information. Here is an example based on a different theme;

Tips

• Provide a column width using ui-dashboard-column style class otherwise empty columns might not receive new widgets.

Dashboard Model API

org.primefaces.model.DashboardModel (org.primefaces.model.map.DefaultDashboardModel is the default implementation)

Method void addColumn(DashboardColumn column)

List<DashboardColumn> getColumns() int getColumnCount()

DashboardColumn getColumn(int index) void transferWidget(DashboardColumn from,

DashboardColumn to, String widgetId, int index)

Description

Adds a column to the dashboard

Returns all columns in dashboard

Returns the number of columns in dashboard

Returns the dashboard column at given index

Relocates the widget identifed with widget id to the given index of the new column from old column.

126

PrimeFaces User’s Guide

org.primefaces.model.DashboardColumn (org.primefaces.model.map.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, String widgetId) void reorderWidget(int index, 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

127

PrimeFaces User’s Guide

3.26 DataExporter

DataExporter is handy for exporting data listed using a Primefaces Datatable to various formats such as excel, pdf, csv and xml.

Info

Tag

Tag Class

ActionListener Class dataExporter org.primefaces.component.export.DataExporterTag

org.primefaces.component.export.DataExporter

Attributes

Name type target fileName pageOnly preProcessor postProcessor encoding selectionOnly

Default null null null

String

Type

String

0 null null

UTF-8

String

MethodExpr

Boolean

Description

Export type: "xls","pdf","csv", "xml"

Id of the datatable whose data to export.

Filename of the generated export file, defaults to datatable id.

Exports only current page instead of whole dataset

PreProcessor for the exported document.

PostProcessor for the exported document.

Character encoding to use

When enabled, only selection would be exported.

Getting Started with DataExporter

DataExporter is nested in a UICommand component such as commandButton or commandLink. For pdf exporting itext and for xls exporting poi libraries are required in the classpath. Target must point to a PrimeFaces Datatable. Assume the table to be exported is defined as;

<p:dataTable id="tableId" ...>

//columns

</p:dataTable>

Excel export

<p:commandButton value="Export as Excel" ajax="false">

<p:dataExporter type="xls" target="tableId" fileName="cars"/>

</p:commandButton>

PDF export

128

PrimeFaces User’s Guide

<p:commandButton value="Export as PDF" ajax="false" >

<p:dataExporter type="pdf" target="tableId" fileName="cars"/>

</p:commandButton>

CSV export

<p:commandButton value="Export as CSV" ajax="false" >

<p:dataExporter type="csv" target="tableId" fileName="cars"/>

</p:commandButton>

XML export

<p:commandButton value="Export as XML" ajax="false" >

<p:dataExporter type="xml" target="tableId" fileName="cars"/>

</p:commandLink>

PageOnly

By default dataExporter works on whole dataset, if you’d like export only the data displayed on current page, set pageOnly to true.

<p:dataExporter type="pdf" target="tableId" fileName="cars" pageOnly="true"/>

Excluding Columns

In case you need one or more columns to be ignored set exportable option of column to false.

<p:column exportable="false">

//...

</p:column>

Monitor Status

DataExport is a non-ajax process so ajaxStatus component cannot apply. See FileDownload

Monitor Status section to find out how monitor export process. Same solution applies to data export as well.

Pre and Post Processors

Processors are handy to customize the exported document (e.g. add logo, caption ...). PreProcessors are executed before the data is exported and PostProcessors are processed after data is included in the document. Processors are simple java methods taking the document as a parameter.

Change Excel Table Header

First example of processors changes the background color of the exported excel’s headers.

129

PrimeFaces User’s Guide

<h:commandButton value="Export as XLS">

<p:dataExporter type="xls" target="tableId" fileName="cars" postProcessor="#{bean.postProcessXLS}"/>

</h:commandButton> public void postProcessXLS(Object document) {

HSSFWorkbook wb = (HSSFWorkbook) document;

HSSFSheet sheet = wb.getSheetAt(0);

HSSFRow header = sheet.getRow(0);

HSSFCellStyle cellStyle = wb.createCellStyle(); cellStyle.setFillForegroundColor(HSSFColor.GREEN.index); cellStyle.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND); for(int i=0; i < header.getPhysicalNumberOfCells();i++) { header.getCell(i).setCellStyle(cellStyle);

}

Add Logo to PDF

This example adds a logo to the PDF before exporting begins.

<h:commandButton value="Export as PDF">

<p:dataExporter type="pdf" target="tableId" fileName="cars" preProcessor="#{bean.preProcessPDF}"/>

</h:commandButton> public void preProcessPDF(Object document) throws IOException,

BadElementException, DocumentException {

Document pdf = (Document) document;

ServletContext servletContext = (ServletContext)

FacesContext.getCurrentInstance().getExternalContext().getContext();

String logo = servletContext.getRealPath("") + File.separator + "images" +

File.separator + "prime_logo.png"; pdf.add(Image.getInstance(logo));

}

130

3.27 DataGrid

DataGrid displays a collection of data in a grid layout.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class dataGrid org.primefaces.component.datagrid.DataGrid

org.primefaces.component.DataGrid

org.primefaces.component

org.primefaces.component.DataGridRenderer

org.primefaces.component.datagrid.DataGridRenderer

Attributes

Name id rendered binding

Default null true

Type

String boolean null Object

131

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name value var rows first widgetVar columns paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible style styleClass rowIndexVar lazy emptyMessage null null null false

Default null null

Type

Object

String null

0 null

3 false null null null

10 both true

Integer

String

Integer boolean

String

Integer

String

Boolean

No records found.

String

Boolean

String

PrimeFaces User’s Guide

Description

Data to display.

Name of the request-scoped variable used to refer each data.

Number of rows to display per page.

Index of the first row to be displayed

Name of the client side widget.

Number of columns in grid.

Enables pagination.

Template of the paginator.

Template of the rowsPerPage dropdown.

Template of the currentPageReport UI.

Maximum number of page links to display.

Position of the paginator.

Defines if paginator should be hidden if total data count is less than number of rows per page.

Inline style of the datagrid.

Style class of the datagrid.

Name of the iterator to refer each row index.

Defines if lazy loading is enabled for the data component.

Text to display when there is no data to display.

Getting started with the DataGrid

A list of cars will be used throughout the datagrid, datalist and datatable examples.

public class Car { private String model; private int year; private String manufacturer; private String color;

...

}

The code for CarBean that would be used to bind the datagrid to the car list.

132

PrimeFaces User’s Guide public class CarBean { private List<Car> cars; public CarBean() { cars = new ArrayList<Car>(); cars.add(new Car("myModel",2005,"ManufacturerX","blue"));

//add more cars

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

}

<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12">

<p:column>

<p:panel header="#{car.model}">

<h:panelGrid columns="1">

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>

<h:outputText value="#{car.year}" />

</h:panelGrid>

</p:panel>

</p:column>

</p:dataGrid>

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

133

PrimeFaces User’s Guide

Ajax Pagination

DataGrid has a built-in paginator that is enabled by setting paginator option to true.

<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12" paginator="true">

...

</p:dataGrid>

Paginator Template

Paginator is customized using paginatorTemplateOption that accepts various keys of UI controls.

Note that this section applies to dataGrid, dataList and dataTable.

• FirstPageLink

• LastPageLink

• PreviousPageLink

• NextPageLink

• PageLinks

• CurrentPageReport

• RowsPerPageDropdown

Note that {RowsPerPageDropdown} has it’s own template, options to display is provided via rowsPerPageTemplate attribute (e.g. rowsPerPageTemplate="9,12,15").

Also {CurrentPageReport} has it’s own template defined with currentPageReportTemplate option.

You can use {currentPage},{totalPages},{totalRecords},{startRecord},{endRecord} keyword within currentPageReportTemplate. Default is {currentPage} of{totalPages}. Default UI is; w hich corresponds to the following template.

"{FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink} {LastPageLink}"

Here are more examples based on different templates;

" {CurrentPageReport} {FirstPageLink} {PreviousPageLink} {PageLinks} {NextPageLink}

{LastPageLink} {RowsPerPageDropdown}"

" {PreviousPageLink} {CurrentPageReport} {NextPageLink}"

Paginator Position

Paginator can be positoned using paginatorPosition attribute in three different locations, "top",

"bottom" or "both" (default).

134

PrimeFaces User’s Guide

Selecting Data

Selection of data displayed in datagrid is very similar to row selection in datatable, you can access the current data using the var reference. Here is an example to demonstrate how to select data from datagrid and display within a dialog with ajax.

<h:form id="carForm">

<p:dataGrid var="car" value="#{carBean.cars}" columns="3" rows="12">

<p:panel header="#{car.model}">

<p:commandLink update=":carForm:display" oncomplete="PF('dlg').show()">

<f:setPropertyActionListener value="#{car}" target="#{carBean.selectedCar}"

<h:outputText value="#{car.model}" />

</p:commandLink>

</p:panel>

</p:dataGrid>

<p:dialog modal="true" widgetVar="dlg">

<h:panelGrid id="display" columns="2">

<f:facet name="header">

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>

</f:facet>

<h:outputText value="Model:" />

<h:outputText value="#{carBean.selectedCar.year}" />

//more selectedCar properties

</h:panelGrid>

</p:dialog>

</h:form> public class CarBean { private List<Car> cars; private Car selectedCar;

//getters and setters

}

Ajax Behavior Events

Event page

Listener Parameter org.primefaces.event.data.PageEvent

On pagination.

Fired

135

PrimeFaces User’s Guide

<p:dataGrid var="car" value="#{carBean.model}">

<p:ajax event="page" update=”anothercomponent" />

//content

</p:dataGrid>

Client Side API

Widget: PrimeFaces.widget.DataGrid

Method getPaginator()

Params

Return Type

Paginator

Description

Returns the paginator widget.

Skinning

DataGrid resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;

.ui-datagrid

.ui-datagrid-content

.ui-datagrid-data

Class

.ui-datagrid-row

.ui-datagrid-column

Applies

Main container element

Content container.

Table element containing data

A row in grid

A column in grid

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

Tips

• DataGrid supports lazy loading data via LazyDataModel, see DataTable lazy loading section.

• DataGrid provides two facets named header and footer that you can use to provide custom content at these locations.

136

3.28 DataList

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

PrimeFaces User’s Guide binding value var rows first

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class dataList org.primefaces.component.datalist.DataList

org.primefaces.component.DataList.DataListTag

org.primefaces.component

org.primefaces.component.DataListRenderer

org.primefaces.component.datalist.DataListRenderer

Attributes

Name id rendered

Default null true null null null null

Type Description

String Unique identifier of the component boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object

String

An el expression that maps to a server side

UIComponent instance in a backing bean

Data to display.

Name of the request-scoped variable used to refer each data.

Integer

Number of rows to display per page.

Index of the first row to be displayed

137

Name type itemType widgetVar paginator paginatorTemplate rowsPerPageTemplate currentPageReportTemplate pageLinks paginatorPosition paginatorAlwaysVisible style styleClass rowIndexVar varStatus lazy emptyMessage itemStyleClass

PrimeFaces User’s Guide null null

10 both true null null false null

Default unordered

Type

String

Description

Type of the list, valid values are "unordered",

"ordered", "definition" and "none".

String

Specifies the list item type.

Name of the client side widget.

boolean Enables pagination.

String Template of the paginator.

String

Integer

Template of the rowsPerPage dropdown.

Template of the currentPageReport UI.

Maximum number of page links to display.

String Position of the paginator.

Boolean Defines if paginator should be hidden if total data count is less than number of rows per page.

null

Null null

String

Inline style of the main container.

Style class of the main container.

Name of the iterator to refer each row index.

null false

No records found.

null

String Name of the exported request scoped variable to represent state of the iteration same as in ui:repeat varStatus.

Boolean Defines if lazy loading is enabled for the data component.

String

Text to display when there is no data to display.

Style class of an item in list.

Getting started with the DataList

Since DataList is a data iteration component, it renders it’s children for each data represented with

var option. See itemType section for more information about the possible values.

<p:dataList value="#{carBean.cars}" var="car" itemType="disc">

#{car.manufacturer}, #{car.year}

</p:dataList>

Ordered Lists

DataList displays the data in unordered format by default, if you’d like to use ordered display set

type option to "ordered".

138

PrimeFaces User’s Guide

<p:dataList value="#{carBean.cars}" var="car" type="ordered">

#{car.manufacturer}, #{car.year}

</p:dataList>

Item Type

itemType defines the bullet type of each item. For ordered lists, in addition to commonly used

decimal type, following item types are available;

- A

- a

- i

And for unordered lists, available values are;

- disc

- circle

- square

Definition Lists

Third type of dataList is definition lists that display inline description for each item, to use definition list set type option to "definition". Detail content is provided with the facet called

"description".

<p:dataList value="#{carBean.cars}" var="car" type="definition">

Model: #{car.model}, Year: #{car.year}

<f:facet name="description">

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg"/>

</f:facet>

</p:dataList>

Ajax Pagination

DataList has a built-in paginator that is enabled by setting paginator option to true.

<p:dataList value="#{carBean.cars}" var="car" paginator="true" rows="10">

#{car.manufacturer}, #{car.year}

</p:dataList>

Pagination configuration and usage is same as dataGrid, see pagination section in dataGrid documentation for more information and examples.

139

PrimeFaces User’s Guide

Selecting Data

Data selection can be implemented same as in dataGrid, see selecting data section in dataGrid documentation for more information and an example.

Client Side API

Widget: PrimeFaces.widget.DataList

Method getPaginator()

Params

Return Type

Paginator

Description

Returns the paginator widget.

Skinning

DataList resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;

.ui-datalist

.ui-datalist-content

.ui-datalist-data

.ui-datalist-item

Class

Main container element

Content container

Data container

Each item in list

Applies

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

Tips

• DataList supports lazy loading data via LazyDataModel, see DataTable lazy loading section.

• If you need full control over list type markup, set type to “none”. With this setting, datalist does not render item tags like li and behaves like ui:repeat.

• DataList provides two facets named header and footer that you can use to provide custom content at these locations.

140

PrimeFaces User’s Guide

3.29 DataScroller

DataScroller displays a collection of data with on demand loading using scrolling.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class dataScroller org.primefaces.component.datascroller.DataScroller

org.primefaces.component.DataScroller

org.primefaces.component

org.primefaces.component.DataScrollerRenderer

org.primefaces.component.datascroller.DataScrollerRenderer

Attributes

Name id rendered binding

Default null true null

Type Description

String Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object An el expression that maps to a server side

UIComponent instance in a backing bean

141

value var rows first widgetVar style styleClass chunkSize rowIndexVar mode

Name scrollHeight lazy buffer

PrimeFaces User’s Guide

Default null null null

0 null

Type

Object

String

Integer

String

Description

Data to display.

Name of the request-scoped variable used to refer each data.

Number of rows to display per page.

Index of the first row to be displayed

Name of the client side widget.

null

Null

0 null

String

String int

String

Inline style of the main container.

Style class of the main container.

Number of items to fetch in each load.

Name of iterator to refer each row index.

document null false

String Defines the target to listen for scroll event, valid values are "document" (default) and

"inline".

String

Boolean Defines if lazy loading is enabled for the data component.

Integer

Defines pixel height of the viewport in inline mode.

Percentage height of the buffer between the bottom of the page and the scroll position to initiate the load for the new chunk. Value is defined in integer and default is 10 meaning load would happen after 90% of the viewport is scrolled down.

Getting started with the DataScroller

DataScroller requires a collection of data to display, when the page is scrolled down, datascroller will do a request with ajax to fetch the new chunk of data and append them at the bottom.

<p:dataScroller value="#{carBean.cars}" var="car" chunkSize="10">

#{car.manufacturer}

//more content

</p:dataList>

Scroll Mode

Default element whose scrollbar is monitored is page itself, mode option is used to customize the scroll target. Two possible options for the mode attribute are “document” and “inline”. Document mode is default and inline mode listens to the scroll event of the datascroller container itself.

142

PrimeFaces User’s Guide

<p:dataScroller value="#{carBean.cars}" var="car" mode="inline" chunkSize="10">

#{car.manufacturer}

//more content

</p:dataList>

Loader

In case of scrolling, a UI element such as button can defined as the loader so that new data is loaded when the loader element is clicked. Loader component is defined using "loader" facet.

<p:dataScroller value="#{carBean.cars}" var="car" mode="inline" chunkSize="10">

#{car.manufacturer}

//more content

<f:facet name="loader">

<p:commandButton type="button" value="View More" />

</f:facet>

</p:dataList>

Lazy Loading

Lazy loading is enabled by enabling the lazy attribute and providing a LazyDataModel instance as the value. Refer to lazy load example in DataTable for an example about LazyDataModel.

<p:dataScroller value="#{carBean.lazyModel}" var="car" lazy="true">

#{car.manufacturer}

//more content

</p:dataList>

Header

Header of the component is defined using header facet.

<p:dataScroller value="#{carBean.lazyModel}" var="car">

<f:facet name="header">Cars</f:facet>

#{car.manufacturer}

//more content

</p:dataList>

Client Side API

Widget: PrimeFaces.widget.DataScroller load()

Method Params

Return Type void

Description

Loads the next chunk.

143

PrimeFaces User’s Guide

Skinning

DataScroller resides in a main div container which style and styleClass attributes apply. Following is the list of structural style classes;

Class

.ui-datascroller

.ui-datascroller-inline

.ui-datalist-header

.ui-datalist-content

.ui-datascroller-list

.ui-datascroller-item

.ui-datascroller-loader

.ui-datascroller-loading

Applies

Main container element

Main container element in inline mode

Header element

Content element

List element container

Container of each item in the list

Container of custom loader element.

Built-in load status indicator

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

144

3.30 DataTable

DataTable displays data in tabular format.

PrimeFaces User’s Guide binding value var rows first

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class dataTable org.primefaces.component.datatable.DataTable

org.primefaces.component.DataTable

org.primefaces.component

org.primefaces.component.DataTableRenderer

org.primefaces.component.datatable.DataTableRenderer

Attributes

Name id rendered

Default null false null null null null

Type

Object

String

Description

String Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object An el expression that maps to a server side

UIComponent instance in a backing bean

Data to display.

Integer

Name of the request-scoped variable used to refer each data.

Number of rows to display per page.

Index of the first row to be displayed

145

PrimeFaces User’s Guide

Name widgetVar paginator paginatorTemplate rowsPerPageTemplate rowsPerPageLabel

Default null false null null null

Type

String

Description

Name of the client side widget.

Boolean Enables pagination.

String

Template of the paginator.

Template of the rowsPerPage dropdown.

Label for the rowsPerPage dropdown.

style styleClass dblClickSelect liveScroll rowStyleClass onExpandStart resizableColumns sortBy sortOrder scrollRows rowKey tableStyle currentPageReportTemplate null pageLinks 10 paginatorPosition paginatorAlwaysVisible scrollable scrollHeight scrollWidth selectionMode selection rowIndexVar emptyMessage

String

Integer

Template of the currentPageReport UI.

Maximum number of page links to display.

false null null null both true null null

No records found.

null null

String Position of the paginator.

Boolean Defines if paginator should be hidden if total data count is less than number of rows per page.

Boolean Makes data scrollable with fixed header.

Integer Scroll viewport height.

Integer

String

Object

Scroll viewport width.

Enables row selection, valid values are “single” and “multiple”.

Reference to the selection data.

String

Name of iterator to refer each row index.

Text to display when there is no data to display.

Alternative is emptyMessage facet.

false false null

String

Boolean Enables row selection on double click.

Boolean Enables live scrolling.

String

Inline style of the component.

Style class of the component.

Style class for each row.

null false

String Client side callback to execute before expansion.

Boolean Enables column resizing.

Property to be used for default sorting.

null Object ascending String

0 Integer

“ascending” or “descending”.

Number of rows to load on live scroll.

null null

String

Unique identifier of a row.

Inline style of the table element.

146

Name tableStyleClass filterEvent filterDelay draggableColumns editable lazy filteredValue sortMode editMode editingRow cellSeparator summary frozenRows dir liveResize stickyHeader expandedRow disabledSelection rowSelectMode rowExpandMode dataLocale nativeElements frozenColumns

147

Name draggableRows caseSensitiveSort skipChildren

Default false false false

PrimeFaces User’s Guide

Type Description

Boolean When enabled, rows can be reordered using dragdrop.

Boolean Case sensitivity for sorting, insensitive by default.

Boolean Ignores processing of children during lifecycle, improves performance if table only has output components.

Getting started with the DataTable

We will be using the same Car and CarBean classes described in DataGrid section.

<p:dataTable var="car" value="#{carBean.cars}">

<p:column>

<f:facet name="header">

<h:outputText value="Model" />

</f:facet>

<h:outputText value="#{car.model}" />

</p:column>

//more columns

</p:dataTable>

Header and Footer

Both datatable itself and columns can have custom content in their headers and footers using header and footer facets respectively. Alternatively for columns there are headerText and footerText shortcuts to display simple texts.

148

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{carBean.cars}">

<f:facet name="header">

List of Cars

</f:facet>

<p:column>

<f:facet name="header">

Model

</f:facet>

#{car.model}

<f:facet name="footer">

8 digit code

</f:facet>

</p:column>

<p:column headerText="Year" footerText="1960-2010">

#{car.year}

</p:column>

//more columns

<f:facet name="footer">

In total there are #{fn:length(carBean.cars)} cars.

</f:facet>

</p:dataTable>

Pagination

DataTable has a built-in ajax based paginator that is enabled by setting paginator option to true, see pagination section in dataGrid documentation for more information about customization options.

<p:dataTable var="car" value="#{carBean.cars}" paginator="true" rows="10">

//columns

</p:dataTable>

Sorting

Defining sortBy attribute enables ajax based sorting on that particular column.

<p:dataTable var="car" value="#{carBean.cars}">

<p:column sortBy="#{car.model}" headerText="Model">

<h:outputText value="#{car.model}" />

</p:column>

...more columns

</p:dataTable>

Instead of using the default sorting algorithm which uses a java comparator, you can plug-in your own sort method as well.

public int sortByModel(Object car1, Object car2) {

//return -1, 0 , 1 if car1 is less than, equal to or greater than car2

}

149

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{carBean.cars}">

<p:column sortBy="#{car.model}" sortFunction="#{carBean.sortByModel}" headerText="Model">

<h:outputText value="#{car.model}" />

</p:column>

...more columns

</p:dataTable>

Multiple sorting is enabled by setting sortMode to multiple. In this mode, clicking a sort column while metakey is on adds sort column to the order group.

<p:dataTable var="car" value="#{carBean.cars}" sortMode="multiple">

//columns

</p:dataTable>

DataTable can display data sorted by default, to implement this use the sortBy option of datatable and the optional sortOrder. Table below would be initially displayed as sorted by model.

<p:dataTable var="car" value="#{carBean.cars}" sortBy="#{car.model}">

<p:column sortBy="#{car.model}" headerText=”Model”>

<h:outputText value="#{car.model}" />

</p:column>

<p:column sortBy="#{car.year}" headerText="Year">

<h:outputText value="#{car.year}" />

</p:column>

...more columns

</p:dataTable>

Filtering

Ajax based filtering is enabled by setting filterBy at column level and providing a list to keep the filtered sublist. It is suggested to use a scope longer than request like viewscope to keep the filteredValue so that filtered list is still accessible after filtering.

<p:dataTable var="car" value="#{carBean.cars}" filteredValue="#{carBean.filteredCars}">

<p:column filterBy="#{car.model}" headerText="Model">

<h:outputText value="#{car.model}" />

</p:column>

...more columns

</p:dataTable>

Filtering is triggered with keyup event and filter inputs can be styled using filterStyle,

filterStyleClass attributes. 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. In addition, filterMatchMode defines the built-in matcher which is startsWith by default.

Following is a basic filtering datatable with these options demonstrated;

150

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{carBean.cars}" filteredValue="#{carBean.filteredCars}" widgetVar="carsTable">

<f:facet name="header">

<p:outputPanel>

<h:outputText value="Search all fields:" />

<h:inputText id="globalFilter" onkeyup="PF('carsTable').filter()" />

</p:outputPanel>

</f:facet>

<p:column filterBy="#{car.model}" headerText="Model" filterMatchMode="contains">

<h:outputText value="#{car.model}" />

</p:column>

<p:column filterBy="#{car.year}" headerText="Year" footerText="startsWith">

<h:outputText value="#{car.year}" />

</p:column>

<p:column filterBy="#{car.manufacturer}" headerText="Manufacturer" filterOptions="#{carBean.manufacturerOptions}" filterMatchMode="exact">

<h:outputText value="#{car.manufacturer}" />

</p:column>

<p:column filterBy="#{car.color}" headerText="Color" filterMatchMode="endsWith">

<h:outputText value="#{car.color}" />

</p:column>

<p:column filterBy="#{car.price}" headerText="Price" filterMatchMode="exact">

<h:outputText value="#{car.price}" />

</p:column>

</p:dataTable>

Filter located at header is a global one applying on all fields, this is implemented by calling client side API method called filter(), important part is to specify the id of the input text as globalFilter which is a reserved identifier for datatable.

In addition to default filtering with generated elements, custom elements can also be used as a filter facet. Example below uses custom filter components in combination with generated elements.

When a custom component is used as a filter facet, filtering needs to be called manually from a preferred event such as onchange="PF('carsTable').filter()". Also defining a converter might be necessary if the value of the filter facet is not defined.

151

PrimeFaces User’s Guide

<p:dataTable id="dataTable" var="car" value="#{tableBean.carsSmall}" widgetVar="carsTable" filteredValue="#{tableBean.filteredCars}">

<p:column id="modelColumn" filterBy="#{car.model}" headerText="Model" footerText="contains" filterMatchMode="contains">

<h:outputText value="#{car.model}" />

</p:column>

<p:column id="yearColumn" filterBy="#{car.year}" headerText="Year" footerText="lte" filterMatchMode="lte">

<f:facet name="filter">

<p:spinner onchange="PF('carsTable').filter()" min="1960" max="2010">

<f:converter converterId="javax.faces.Integer" />

</p:spinner>

</f:facet>

<h:outputText value="#{car.year}" />

</p:column>

<p:column id="manufacturerColumn" filterBy="#{car.manufacturer}" headerText="Manufacturer" footerText="exact" filterMatchMode="exact">

<f:facet name="filter">

<p:selectOneMenu onchange="PF('carsTable').filter()" >

<f:selectItems value="#{tableBean.manufacturerOptions}" />

</p:selectOneMenu>

</f:facet>

<h:outputText value="#{car.manufacturer}" />

</p:column>

<p:column id="colorColumn" filterBy="#{car.color}" headerText="Color" footerText="in" filterMatchMode="in">

<f:facet name="filter">

<p:selectCheckboxMenu label="Colors" onchange="PF('carsTable').filter()">

<f:selectItems value="#{tableBean.colors}" />

</p:selectCheckboxMenu>

</f:facet>

<h:outputText value="#{car.color}" />

</p:column>

<p:column id="soldColumn" filterBy="#{car.sold}" headerText="Status" footerText="equals" filterMatchMode="equals">

<f:facet name="filter">

<p:selectOneButton onchange="PF('carsTable').filter()">

<f:converter converterId="javax.faces.Boolean" />

<f:selectItem itemLabel="All" itemValue="" />

<f:selectItem itemLabel="Sold" itemValue="true" />

<f:selectItem itemLabel="Sale" itemValue="false" />

</p:selectOneButton>

</f:facet>

<h:outputText value="#{car.sold ? 'Sold': 'Sale'}" />

</p:column>

</p:dataTable>

152

PrimeFaces User’s Guide filterMatchMode defines which built-in filtering algorithm would be used per column, valid values for this attribute are;

- startsWith: Checks if column value starts with the filter value.

- endsWith: Checks if column value ends with the filter value.

- contains: Checks if column value contains the filter value.

- exact: Checks if string representations of column value and filter value are same.

- lt: Checks if column value is less than the filter value.

- lte: Checks if column value is less than or equals the filter value.

- gt: Checks if column value is greater than the filter value.

- gte: Checks if column value is greater than or equals the filter value.

- equals: Checks if column value equals the filter value.

- in: Checks if column value is in the collection of the filter value.

In case the built-in methods do not suffice, custom filtering can be implemented using filterFunction approach.

<p:column filterBy="#{car.price}" filterFunction="#{tableBean.filterByPrice}">

<h:outputText value="#{car.price}">

<f:convertNumber currencySymbol="$" type="currency"/>

</h:outputText>

</p:column>

filterFunction should be a method with three parameters; column value, filter value and locale.

Return value is a boolean, true accepts the value and false rejects it.

public boolean filterByPrice(Object value, Object filter, Locale locale) {

//return true or false

}

Locale is provided as optional in case you need to use a locale aware method like

toLowerCase(Locale locale). Note that String based filters like startsWith, endsWith uses toLowerCase already and dataLocale attribute is used to provide the locale to use when filtering.

Row Selection

There are several ways to select row(s) from datatable. 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.

public class CarBean { private List<Car> cars; private Car selectedCar; private Car[] selectedCars; public CarBean() { cars = new ArrayList<Car>();

//populate cars

}

//getters and setters

}

Single Selection with a Command Component

This method is implemented with a command component such as commandLink or commandButton. Selected row can be set to a server side instance by passing as a parameter if you are using EL 2.2 or using f:setPropertyActionListener.

153

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{carBean.cars}">

<p:column>

<p:commandButton value="Select">

<f:setPropertyActionListener value="#{car}" target="#{carBean.selectedCar}" />

</p:commandButton>

</p:column>

...columns

</p:dataTable>

Single Selection with Row Click

Previous method works when the button is clicked, if you’d like to enable selection wherever the row is clicked, use selectionMode option.

<p:dataTable var="car" value="#{carBean.cars}" selectionMode="single" selection="#{carBean.selectedCar}" rowKey="#{car.id}">

...columns

</p:dataTable>

Multiple Selection with Row Click

Multiple row selection is similar to single selection but selection should reference an array or a list of the domain object displayed and user needs to use press modifier key(e.g. ctrl) during selection *.

<p:dataTable var="car" value="#{carBean.cars}" selectionMode="multiple" selection="#{carBean.selectedCars}" rowKey="#{car.id}" >

...columns

</p:dataTable>

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:selectOneRadios and low level bits. In order to enable this feature, define a column with selectionMode set as single.

<p:dataTable var="car" value="#{carBean.cars}" selection="#{carBean.selectedCar}" rowKey="#{car.id}">

<p:column selectionMode="single"/>

...columns

</p:dataTable>

Multiple Selection with Checkboxes

Similar to how radio buttons are enabled, define a selection column with a multiple selectionMode.

DataTable will also provide a selectAll checkbox at column header.

<p:dataTable var="car" value="#{carBean.cars}" selection="#{carBean.selectedCars}" rowKey="#{car.id}" >

<p:column selectionMode="multiple"/>

...columns

</p:dataTable>

154

PrimeFaces User’s Guide

* Use rowSelectMode option to customize the default behavior on row click of a multiple selection enabled datatable. Default value is "new" that clears previous selections and "add" mode keeps previous selections same as selecting a row with mouse click when metakey is on.

RowKey

RowKey should a unique identifier from your data model and used by datatable to find the selected rows. You can either define this key by using the rowKey attribute or by binding a data model which implements org.primefaces.model.SelectableDataModel.

Dynamic Columns

Dynamic columns is handy in case you can’t know how many columns to render. Columns component is used to define the columns programmatically. It requires a collection as the value, two iterator variables called var and columnIndexVar.

<p:dataTable var="cars" value="#{tableBean.cars}">

<p:columns value="#{tableBean.columns}" var="column" sortBy="#{column.property}" filterBy="#{column.property}">

<f:facet name="header">

#{column.header}

</f:facet>

<h:outputText value="#{cars[column.property]}" />

</p:columns>

</p:dataTable>

155

PrimeFaces User’s Guide public class CarBean { private List<ColumnModel> columns = new ArrayList<ColumnModel>(); private List<Car> cars; public CarBean() { populateColumns(); cars = //populate cars;

} public void populateColumns() {

String[] columnKeys = new String[]{"model","year","color"};

for(String columnKey : columnKeys) {

columns.add(new ColumnModel(columnKey.toUpperCase(), columnKey));

}

//getters and setters

static public class ColumnModel implements Serializable {

private String header;

private String property;

public ColumnModel(String header, String property) {

this.header = header;

this.property = property;

}

public String getHeader() {

return header;

}

public String getProperty() {

return property;

}

Grouping

Grouping is defined by ColumnGroup component used to combine datatable header and footers.

156

PrimeFaces User’s Guide

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

</p:column>

<p:column>

#{sale.lastYearProfit}%

</p:column>

<p:column>

#{sale.thisYearProfit}%

</p:column>

<p:column>

#{sale.lastYearSale}$

</p:column>

<p:column>

#{sale.thisYearSale}$

</p:column>

<p:columnGroup type="footer">

<p:row>

<p:column colspan="3" style="text-align:right" footerText="Totals:"/>

<p:column footerText="#{tableBean.lastYearTotal}$" />

<p:column footerText="#{tableBean.thisYearTotal}$" />

</p:row>

</p:columnGroup>

</p:dataTable> public class CarBean { private List<Sale> sales; public CarBean() { sales = //create a list of BrandSale objects

} public List<Sale> getSales() { return this.sales;

}

157

PrimeFaces User’s Guide

Scrolling

Scrolling makes the header-footer of the table fixed and the body part scrollable. scrollable attribute must be enabled and depending on the scrolling orientation, scrollHeight and/or scrollWidth options must be specified.

<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150">

<p:column />

//columns

</p:dataTable>

Simple scrolling renders all data to client whereas live scrolling is useful to deal with huge data, in this case data is fetched whenever the scrollbar reaches bottom. Set liveScroll to enable this option;

<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150" liveScroll="true">

<p:column />

//columns

</p:dataTable>

Scrolling has 3 modes; x, y and x-y scrolling that are defined by scrollHeight and scrollWidth.

These two scroll attributes can be defined using integer values indicating fixed pixels or percentages relative to the container dimensions.

Frozen Rows

Certain rows can be fixed in a scrollable table by using the frozenRows attribute that defines the number of rows to freeze from the start.

<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollHeight="150" frozenRows="2">

<p:column />

//columns

</p:dataTable>

Frozen Columns

Specific columns can be fixed while the rest of them remain as scrollable. frozenColumns defines the number of columns to freeze from the start.

158

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{bean.data}" scrollable="true" scrollWidth="200" frozenColumns="2">

<p:column />

//columns

</p:dataTable>

Expandable Rows

RowToggler and RowExpansion facets are used to implement expandable rows.

<p:dataTable var="car" value="#{carBean.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, clicking on a collapsed row loads expanded content with ajax. If you need to display a row as expanded by default, use expandedRow attribute which is evaluated before rendering of each row so value expressions are supported.

Additionally, rowExpandMode attribute defines if multiple rows can be expanded at the same time or not, valid values are "single" and "multiple" (default).

Editing

Incell editing provides an easy way to display editable data. p:cellEditor is used to define the cell editor of a particular column. There are two types of editing, row and cell. Row editing is the default mode and used by adding a p:rowEditor component as row controls.

159

<p:dataTable var="car" value="#{carBean.cars}" editable="true">

<f:facet name="header">

In-Cell Editing

</f:facet>

<p:column headerText="Model">

<p:cellEditor>

<f:facet name="output">

<h:outputText value="#{car.model}" />

</f:facet>

<f:facet name="input">

<h:inputText value="#{car.model}"/>

</f:facet>

</p:cellEditor>

</p:column>

//more columns with cell editors

<p:column>

<p:rowEditor />

</p:column>

</p:dataTable>

PrimeFaces User’s Guide

When pencil icon is clicked, row is displayed in editable mode meaning input facets are displayed and output facets are hidden. Clicking tick icon only saves that particular row and cancel icon reverts the changes, both options are implemented with ajax interaction.

Another option for incell editing is cell editing, in this mode a cell switches to edit mode when it is clicked, losing focus triggers an ajax event to save the change value.

Lazy Loading

Lazy Loading is an approach to deal with huge datasets efficiently, regular ajax based pagination works by rendering only a particular page but still requires all data to be loaded into memory. Lazy loading datatable renders a particular page similarly but also only loads the page data into memory not the whole dataset. In order to implement this, you’d n e e d t o b i n d a

org.primefaces.model.LazyDataModel as the value and implement load method and enable lazy option. Also it is required to implement getRowData and getRowKey if you have selection enabled.

160

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{carBean.model}" paginator="true" rows="10" lazy="true">

//columns

</p:dataTable> public class CarBean { private LazyDataModel model; public CarBean() { model = new LazyDataModel() {

@Override public void load(int first, int pageSize, String sortField,

SortOrder sortOrder, Map<String,Object> filters) {

//load physical data

}

}; int totalRowCount = //logical row count based on a count query model.setRowCount(totalRowCount);

} public LazyDataModel getModel() { return model;

}

DataTable calls your load implementation whenever a paging, sorting or filtering occurs with following parameters;

• first: Offset of first data to start from

• pageSize: Number of data to load

• sortField: Name of sort field

• sortOrder: SortOrder enum.

• filter: Filter map with field name as key (e.g. "model" for filterBy="#{car.model}") and value.

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.

It is suggested to use field attribute of column component to define the field names passed as sortField and filterFields, otherwise these fields would be tried to get extracted from the value expression which is not possible in cases like composite components.

Sticky Header

Sticky Header feature makes the datatable header visible on page scrolling.

<p:dataTable var="car" value="#{carBean.model}" stickyHeader="true">

//columns

</p:dataTable>

161

PrimeFaces User’s Guide

SummaryRow

Summary is a helper component to display a summary for the grouping which is defined by the sortBy option.

162

<p:dataTable var="car" value="#{tableBean.cars}">

<p:column headerText="Model">

#{car.model}

</p:column>

<p:column headerText="Year" sortBy="year">

#{car.year}

</p:column>

<p:column headerText="Manufacturer" sortBy="manufacturer">

#{car.manufacturer}

</p:column>

<p:column headerText="Color" sortBy="color">

#{car.color}

</p:column>

<p:summaryRow>

<p:column colspan="3" style="text-align:right">

Total:

</p:column>

<p:column>

#{tableBean.randomPrice}$

</p:column>

</p:summaryRow>

</p:dataTable>

PrimeFaces User’s Guide

SubTable

SubTable is a helper component to display nested collections. Example below displays a collection of players and a subtable for the stats collection of each player.

163

PrimeFaces User’s Guide

<p:dataTable var="player" value="#{tableBean.players}">

<f:facet name="header">

FCB Statistics

</f:facet>

<p:columnGroup type="header">

<p:row>

<p:column rowspan="2" headerText="Player" />

<p:column colspan="2" headerText="Stats" />

</p:row>

<p:row>

<p:column headerText="Goals" />

<p:column headerText="Assists" />

</p:row>

</p:columnGroup>

<p:subTable var="stats" value="#{player.stats}">

<f:facet name="header">

#{player.name}

</f:facet>

<p:column>

#{stats.season}

</p:column>

<p:column>

#{stats.goals}

</p:column>

<p:column>

#{stats.assists}

</p:column>

<p:columnGroup type="footer">

<p:row>

<p:column footerText="Totals: " style="text-align:right"/>

</p:row>

</p:columnGroup>

</p:subTable>

<p:column footerText="#{player.allGoals}" />

<p:column footerText="#{player.allAssists}" />

</p:dataTable>

164

PrimeFaces User’s Guide

Column Toggler

Visible columns of a table can be toggled using the column toggler helper component.

<p:dataTable var="car" value="#{tableBean.cars}">

<f:facet name="header">

List of Cars

<p:commandButton id="toggler" type="button" value="Columns" style="float:right" icon="ui-icon-calculator" />

<p:columnToggler datasource="cars" trigger="toggler" />

</f:facet>

<p:column headerText="Model">

#{car.model}

</p:column>

<p:column headerText="Year" sortBy="year">

#{car.year}

</p:column>

<p:column headerText="Manufacturer" sortBy="manufacturer">

#{car.manufacturer}

</p:column>

<p:column headerText="Color" sortBy="color">

#{car.color}

</p:column>

</p:dataTable>

On page load, column chooser finds all columns of datatable and generates the ui. If you'd like some of the columns to be ignored, set toggleable option of a column as false. Optional toggle ajax behavior is provided by columnChooser component to listen to toggle events at server side. Listener of this behavior gets an org.primefaces.event.ToggleEvent as a parameter that gives the visibility and index of the column being toggled.

Reordering Rows

Rows of the table can be reordered using drag&drop. Set draggableRows attribute to true to enable this feature.

Optional rowReorder ajax behavior is provided to listen to reorder events at server side. Listener of this behavior gets an org.primefaces.event.ReorderEvent as a parameter that gives the past and current index of the row being moved.

165

PrimeFaces User’s Guide

<p:dataTable var="car" value="#{tableBean.cars}" draggableRows="true">

<p:ajax event="rowReorder" listener="#{tableBean.onRowReorder}" />

<p:column headerText="Model">

#{car.model}

</p:column>

//columns

</p:dataTable> public class TableBean {

//...

public void onRowReorder(ReorderEvent event) {

//int from = event.getFromIndex();

//int end = event.getEndIndex();

}

Reordering Columns

Columns of the table can be reordered using drag&drop as well. Set draggableColumns attribute to true to enable this feature. Optional colReorder ajax behavior is provided to listen to reorder events at server side.

<p:dataTable var="car" value="#{tableBean.cars}" draggableColumns="true">

<p:column headerText="Model">

#{car.model}

</p:column>

//columns

</p:dataTable>

166

PrimeFaces User’s Guide

Ajax Behavior Events

Event page sort filter rowSelect rowUnselect rowEdit rowEditInit rowEditCancel colResize toggleSelect colReorder rowSelectRadio rowSelectCheckbox rowUnselectCheckbox rowDblselect rowToggle contextMenu cellEdit rowReorder

Listener Parameter org.primefaces.event.data.PageEvent

org.primefaces.event.data.SortEvent

Fired

On pagination.

When a column is sorted.

org.primefaces.event.data.FilterEvent

org.primefaces.event.SelectEvent

org.primefaces.event.UnselectEvent

org.primefaces.event.RowEditEvent

On filtering.

When a row is being selected.

When a row is being unselected.

When a row is edited.

When a row switches to edit mode org.primefaces.event.RowEditEvent

When row edit is cancelled.

org.primefaces.event.ColumnResizeEvent When a column is being selected.

org.primefaces.event.ToggleSelectEvent

When header checkbox is toggled.

When columns are reordered.

org.primefaces.event.SelectEvent

Row selection with radio.

org.primefaces.event.SelectEvent

org.primefaces.event.UnselectEvent

org.primefaces.event.SelectEvent

org.primefaces.event.ToggleEvent

Row selection with checkbox.

Row unselection with checkbox.

Row selection with double click.

Row expand or collapse.

org.primefaces.event.SelectEvent

org.primefaces.event.CellEditEvent

org.primefaces.event.ReorderEvent

ContextMenu display.

When a cell is edited.

On row reorder.

For example, datatable below makes an ajax request when a row is selected with a click on row.

<p:dataTable var="car" value="#{carBean.model}">

<p:ajax event=”rowSelect” update=”another_component” />

//columns

</p:dataTable>

167

PrimeFaces User’s Guide

Client Side API

Widget: PrimeFaces.widget.DataTable

Method getPaginator() clearFilters() getSelectedRowsCount() selectRow(r, silent) unselectRow(r, silent) unselectAllRows() toggleCheckAll() filter() selectAllRows() selectAllRowsOnPage() unselectAllRowsOnPage()

Params

r: number or tr element as jQuery object,

silent: flag to fire row select ajax behavior

r: number or tr element as jQuery object,

silent: flag to fire row select ajax behavior

Return Type Description

Paginator Returns the paginator insance.

void Clears all column filters

Number Returns number of selected rows.

void Selects the given row.

void void void

Void void void void

Unselects the given row.

Unselects all rows.

Toggles header checkbox state.

Filters the data.

Select all rows.

Select all rows on current page.

Unselect all rows on current page.

168

PrimeFaces User’s Guide

Skinning

DataTable resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes;

Class

.ui-datatable

.ui-datatable-data

.ui-datatable-empty-message

.ui-datatable-header

.ui-datatable-footer

.ui-sortable-column

.ui-sortable-column-icon

.ui-expanded-row-content

.ui-row-toggler

.ui-editable-column

.ui-cell-editor

.ui-cell-editor-input

.ui-cell-editor-output

.ui-datatable-even

.ui-datatable-odd

.ui-datatable-scrollable

.ui-datatable-scrollable-header

.ui-datatable-scrollable-header-box

.ui-datatable-scrollable-body

.ui-datatable-scrollable-footer

.ui-datatable-scrollable-footer-box

.ui-datatable-resizable

Applies

Main container element

Table body

Empty message row

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

Main container element of a scrollable table.

Header wrapper of a scrollable table.

Header container of a scrollable table.

Body container of a scrollable table.

Footer wrapper of a scrollable table.

Footer container of a scrollable table.

Main container element of a resizable table.

169

PrimeFaces User’s Guide

3.31 DefaultCommand

Which command to submit the form with when enter key is pressed a common problem in web apps not just specific to JSF. Browsers tend to behave differently as there doesn’t seem to be a standard and even if a standard exists, IE probably will not care about it. There are some ugly workarounds like placing a hidden button and writing javascript for every form in your app. DefaultCommand solves this problem by normalizing the command(e.g. button or link) to submit the form with on enter key press.

Info

Tag

Component Class

Component Type defaultCommand org.primefaces.component.defaultcommand.DefaultCommand

org.primefaces.component.DefaultCommand

Component Family org.primefaces.component

Renderer Type org.primefaces.component.DefaultCommandRenderer

Renderer Class org.primefaces.component.defaultcommand.DefaultCommandRenderer

Attributes id rendered

Name binding widgetVar target scope null null null null

Default null true

Type

String

Boolean

Object

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

Name of the client side widget

Identifier of the default command component.

Identifier of the ancestor component to enable multiple default commands in a form.

Getting Started with the DefaultCommand

DefaultCommand must be nested inside a form requires target option to reference a clickable command. Example below triggers btn2 when enter key is pressed. Note that an input must have focused due to browser nature.

170

PrimeFaces User’s Guide

<h:form id="form">

<h:panelGrid columns="3" cellpadding="5">

<h:outputLabel for="name" value="Name:" style="font-weight:bold"/>

<p:inputText id="name" value="#{defaultCommandBean.text}" />

<h:outputText value="#{defaultCommandBean.text}" id="display" />

</h:panelGrid>

<p:commandButton value="Button1" id="btn1" actionListener="#{bean.submit1}" ajax="false"/>

<p:commandButton value="Button2" id="btn2" actionListener="#{bean.submit2}" />

<h:commandButton value="Button3" id="btn3" actionListener="#{bean.submit3}" />

<p:defaultCommand target="bt2" />

</h:form>

Scope

If you need multiple default commands on same page use scope attribute that refers to the ancestor component of the target input.

171

3.32 Dialog

Dialog is a panel component that can overlay other elements on page.

PrimeFaces User’s Guide binding widgetVar header draggable resizable modal visible width height minWidth

Info

Tag

Component Class dialog org.primefaces.component.dialog.Dialog

Component Type org.primefaces.component.Dialog

Component Family org.primefaces.component

Renderer Type org.primefaces.component.DialogRenderer

Renderer Class org.primefaces.component.dialog.DialogRenderer

Attributes id rendered

Name null null true true false false auto auto

150

Default null true null

Type

String

Description

Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object

String

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget

String Text of the header

Boolean Specifies draggability

Boolean Specifies resizability

Boolean Enables modality.

Boolean When enabled, dialog is visible by default.

Integer

Width of the dialog

Height of the dialog

Minimum width of a resizable dialog.

172

Name minHeight style styleClass showEffect hideEffect position closable onShow onHide appendTo showHeader footer dynamic minimizable maximizable closeOnEscape dir focus fitViewport

PrimeFaces User’s Guide true null false false false false ltr null false

Default null null null null null true null null null

Type

Integer

String

Description

Minimum height of a resizable dialog.

Inline style of the dialog.

Style class of the dialog

String

Effect to use when showing the dialog

Effect to use when hiding the dialog

String Defines where the dialog should be displayed

Boolean Defines if close icon should be displayed or not

String Client side callback to execute when dialog is displayed.

String

Client side callback to execute when dialog is hidden.

Appends the dialog to the element defined by the given search expression.

Boolean Defines visibility of the header content.

String Text of the footer.

Boolean Enables lazy loading of the content with ajax.

Boolean Whether a dialog is minimizable or not.

Boolean Whether a dialog is maximizable or not.

Boolean Defines if dialog should close on escape key.

String Defines text direction, valid values are ltr and rtl.

String Defines which component to apply focus.

Boolean Dialog size might exceeed viewport if content is bigger than viewport in terms of height. fitViewport option automatically adjusts height to fit dialog within the viewport.

Getting started with the Dialog

Dialog is a panel component containing other components, note that by default dialog is not visible.

<p:dialog>

<h:outputText value="Resistance to PrimeFaces is Futile!" />

//Other content

</p:dialog>

Show and Hide

Showing and hiding the dialog is easy using the client side api.

173

PrimeFaces User’s Guide

<p:dialog header="Header Text" widgetVar="dlg">//Content</p:dialog>

<p:commandButton value="Show" type="button" onclick="PF('dlg').show()" />

<p:commandButton value="Hide" type="button" onclick="PF('dlg').hide()" />

Effects

There are various effect options to be used when displaying and closing the dialog. Use showEffect and hideEffect options to apply these effects; blind, bounce, clip, drop, explode, fade, fold, highlight, puff, pulsate, scale, shake, size, slide and transfer.

<p:dialog showEffect="fade" hideEffect="explode" ...>

//...

</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;

• Single string value like ‘center’, ‘left’, ‘right’, ‘top’, ‘bottom’ representing the position within viewport.

• Comma separated x and y coordinate values like 200, 500

• Comma separated position values like ‘top’,‘right’. (Use single quotes when using a combination)

Some examples are described below;

<p:dialog position="top" ...>

<p:dialog position="left,top" ...>

<p:dialog position="200,50" ...>

Focus

Dialog applies focus on first visible input on show by default which is useful for user friendliness however in some cases this is not desirable. Assume the first input is a popup calendar and opening the dialog shows a popup calendar. To customize default focus behavior, use focus attribute.

Ajax Behavior Events

close event is one of the ajax behavior events provided by dialog that is fired when the dialog is hidden. If there is a listener defined it’ll be executed by passing an instance of

org.primefaces.event.CloseEvent.

Example below adds a FacesMessage when dialog is closed and updates the messages component to display the added message.

174

PrimeFaces User’s Guide

<p:dialog>

<p:ajax event="close" listener="#{dialogBean.handleClose}" update="msg" />

//Content

</p:dialog>

<p:messages id="msg" /> public class DialogBean { public void handleClose(CloseEvent event) {

//Add facesmessage

}

Two other ajax behavior events are maximize and minimize that are invoked when dialog is maximized or minimized.

Client Side Callbacks

Similar to close listener, onShow and onHide are handy callbacks for client side in case you need to execute custom javascript.

<p:dialog onShow="alert(‘Visible’)" onHide="alert(‘Hidden’)">

//Content

</p:dialog>

Client Side API

Widget: PrimeFaces.widget.Dialog show()

Method hide()

Params

Return Type void void

Description

Displays dialog.

Closes dialog.

Skinning

Dialog resides in a main container element which styleClass option apply. Following is the list of structural style classes;

Style Class

.ui-dialog

.ui-dialog-titlebar

.ui-dialog-title-dialog

.ui-dialog-titlebar-close

.ui-dialog-content

Container element of dialog

Title bar

Applies

Header text

Close icon

Dialog body

175

PrimeFaces User’s Guide

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

Tips

• Use appendTo with care as the page definition and html dom would be different, for example if dialog is inside an h:form component and appendToBody is enabled, on the browser dialog would be outside of form and may cause unexpected results. In this case, nest a form inside a dialog.

• Do not place dialog inside tables, containers likes divs with relative positioning or with nonvisible overflow defined, in cases like these functionality might be broken. This is not a limitation but a result of DOM model. For example dialog inside a layout unit, tabview, accordion are a couple of examples. Same applies to confirmDialog as well.

176

PrimeFaces User’s Guide

3.33 Drag&Drop

Drag&Drop utilities of PrimeFaces consists of two components; Draggable and Droppable.

3.33.1 Draggable

Info

Tag

Component Class

Component Type draggable org.primefaces.component.dnd.Draggable

org.primefaces.component.Draggable

Component Family org.primefaces.component

Renderer Type org.primefaces.component.DraggableRenderer

Renderer Class org.primefaces.component.dnd.DraggableRenderer

Attributes

Name id rendered

Default null true

Type

String boolean binding widgetVar proxy dragOnly for disabled axis containment helper revert snap snapMode null null false false null false null null null false false null

Object

String

Boolean

String

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

Name of the client side widget

Displays a proxy element instead of actual element.

Specifies a draggable that can’t be dropped.

Id of the component to add draggable behavior

Disables draggable behavior when true.

Specifies drag axis, valid values are ‘x’ and ‘y’.

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

Specifies the snap mode. Valid values are ‘both’,

177

Name snapTolerance zindex handle opacity stack

20 null null

1 null grid scope cursor dashboard

Default

Integer

String

Double

String null null crosshair null

String

Type

PrimeFaces User’s Guide

Description

‘inner’ and ‘outer’.

Distance from the snap element in pixels to trigger snap.

ZIndex to apply during dragging.

Specifies a handle for dragging.

Defines the opacity of the helper during dragging.

In stack mode, draggable overlap is controlled automatically using the provided selector, dragged item always overlays other draggables.

Dragging happens in every x and y pixels.

Scope key to match draggables and droppables.

CSS cursor to display in dragging.

Id of the dashboard to connect with.

Getting started with Draggable

Any component can be enhanced with draggable behavior, basically this is achieved by defining the id of component using the for attribute of draggable.

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

<h:graphicImage id="campnou" value="/images/campnou.jpg">

<p:draggable />

</h:graphicImage>

Handle

By default any point in dragged component can be used as handle, if you need a specific handle, you can define it with handle option. Following panel is dragged using it’s header only.

<p:panel id="pnl" header="Draggable Panel">

<h:outputText value="I can only be dragged using my header" />

</p:panel>

<p:draggable for="pnl" handle="div.ui-panel-titlebar"/>

178

PrimeFaces User’s Guide

Drag Axis

Dragging can be limited to either horizontally or vertically.

<p:panel id="pnl" header="Draggable Panel">

<h:outputText value="I am dragged on an axis only" />

</p:panel>

<p:draggable for="pnl" axis="x or y"/>

Clone

By default, actual component is used as the drag indicator, if you need to keep the component at it’s original location, use a clone helper.

<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, revert option enables the component to move back to it’s original position with an animation.

<p:panel id="pnl" header="Draggable Panel">

<h:outputText value="I will be reverted back to my original position" />

</p:panel>

<p:draggable for="pnl" revert="true"/>

Opacity

During dragging, opacity option can be used to give visual feedback, helper of following panel’s opacity is reduced in dragging.

<p:panel id="pnl" header="Draggable Panel">

<h:outputText value="My opacity is lower during dragging" />

</p:panel>

<p:draggable for="pnl" opacity="0.5"/>

Grid

Defining a grid enables dragging in specific pixels. This value takes a comma separated dimensions in x,y format.

<p:panel id="pnl" header="Draggable Panel">

<h:outputText value="I am dragged in grid mode" />

</p:panel>

<p:draggable for="pnl" grid="20,40"/>

179

PrimeFaces User’s Guide

Containment

A draggable can be restricted to a certain section on page, following draggable cannot go outside of it’s parent.

<p:outputPanel layout="block" style="width:400px;height:200px;">

<p:panel id="conpnl" header="Restricted">

<h:outputText value="I am restricted to my parent's boundaries" />

</p:panel>

</p:outputPanel>

<p:draggable for="conpnl" containment="parent" />

180

PrimeFaces User’s Guide

3.33.2 Droppable

Info

Tag

Component Class

Component Type droppable org.primefaces.component.dnd.Droppable

org.primefaces.component.Droppable

Component Family org.primefaces.component

Renderer Type org.primefaces.component.DroppableRenderer

Renderer Class org.primefaces.component.dnd.DroppableRenderer

Attributes

Name id rendered binding widgetVar for disabled hoverStyleClass activeStyleClass null onDrop accept scope tolerance datasource null null null null null null null null false null

Default null true

Type

String

Boolean

Object

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

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.

Style class to apply when an acceptable draggable is being dragged.

Client side callback to execute when a draggable is dropped.

Selector to define the accepted draggables.

Scope key to match draggables and droppables.

Specifies the intersection mode to accept a draggable.

Id of a UIData component to connect with.

181

PrimeFaces User’s Guide

Getting Started with Droppable

Usage of droppable is very similar to draggable, 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.

.slot { background:#FF9900; width:64px; height:96px; display:block;

}

</style>

If for attribute is omitted, parent component becomes droppable.

<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. In case you define a listener it’ll be executed by passing an

org.primefaces.event.DragDrop event instance parameter holding information about the dragged and dropped components.

Following example shows how to enable draggable images to be dropped on droppables.

<p:graphicImage id="messi" value="barca/messi_thumb.jpg" />

<p:draggable for="messi"/>

<p:outputPanel id="zone" styleClass="slot" />

<p:droppable for="zone">

<p:ajax listener="#{ddController.onDrop}" />

</p:droppable> public void onDrop(DragDropEvent ddEvent) {

String draggedId = ddEvent.getDragId();

String droppedId = ddEvent.getDropId();

Object data = ddEvent.getData();

}

//Client id of dragged component

//Client id of dropped component

//Model object of a datasource

182

PrimeFaces User’s Guide onDrop onDrop is a client side callback that is invoked when a draggable is dropped, it gets two parameters event and ui object holding information about the drag drop event.

<p:outputPanel id="zone" styleClass="slot" />

<p:droppable for="zone" onDrop="handleDrop"/> function handleDrop(event, ui) { var draggable = ui.draggable, helper = ui.helper, position = ui.position, offset = ui.offset;

}

//draggable element, a jQuery object

//helper element of draggable, 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.g. datatable, datagrid), in order to connect a droppable to accept data from a data component define datasource option as the id of the data component. Example below show how to drag data from datagrid and drop onto a droppable to implement a dragdrop based selection. Dropped cars are displayed with a datatable.

public class TableBean { private List<Car> availableCars; private List<Car> droppedCars; public TableBean() { availableCars = //populate data

}

//getters and setters public void onCarDrop(DragDropEvent event) {

Car car = ((Car) ddEvent.getData()); droppedCars.add(car); availableCars.remove(car);

}

183

PrimeFaces User’s Guide

<h:form id="carForm">

<p:fieldset legend="AvailableCars">

<p:dataGrid id="availableCars" var="car" value="#{tableBean.availableCars}" columns="3">

<p:column>

<p:panel id="pnl" header="#{car.model}" style="text-align:center">

<p:graphicImage value="/images/cars/#{car.manufacturer}.jpg" />

</p:panel>

<p:draggable for="pnl" revert="true" handle=".ui-panel-titlebar" stack=".ui-panel"/>

</p:column>

</p:dataGrid>

</p:fieldset>

<p:fieldset id="selectedCars" legend="Selected Cars" style="margin-top:20px">

<p:outputPanel id="dropArea">

<h:outputText value="!!!Drop here!!!" rendered="#{empty tableBean.droppedCars}" style="font-size:24px;" />

<p:dataTable var="car" value="#{tableBean.droppedCars}" rendered="#{not empty tableBean.droppedCars}">

<p:column headerText="Model">

<h:outputText value="#{car.model}" />

</p:column>

<p:column headerText="Year">

<h:outputText value="#{car.year}" />

</p:column>

<p:column headerText="Manufacturer">

<h:outputText value="#{car.manufacturer}" />

</p:column>

<p:column headerText="Color">

<h:outputText value="#{car.color}" />

</p:column>

</p:dataTable>

</p:outputPanel>

</p:fieldset>

<p:droppable for="selectedCars" tolerance="touch" activeStyleClass="ui-state-highlight" datasource="availableCars" onDrop="handleDrop"/>

<p:ajax listener="#{tableBean.onCarDrop}" update="dropArea availableCars" />

</p:droppable>

</h:form>

}

</script>

//fade out the dropped item

184

PrimeFaces User’s Guide

Tolerance

There are four different tolerance modes that define the way of accepting a draggable.

fit intersect pointer touch

Mode 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, only first image can be accepted by droppable.

<p:graphicImage id="messi" value="barca/messi_thumb.jpg" />

<p:draggable for="messi" scope="forward"/>

<p:graphicImage id="xavi" value="barca/xavi_thumb.jpg" />

<p:draggable for="xavi" scope="midfield"/>

<p:outputPanel id="forwardsonly" styleClass="slot" scope="forward" />

<p:droppable for="forwardsonly" />

Skinning

hoverStyleClass and activeStyleClass attributes are used to change the style of the droppable when interacting with a draggable.

185

3.34 Dock

Dock component mimics the well known dock interface of Mac OS X.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class dock org.primefaces.component.dock.Dock

org.primefaces.component.Dock

org.primefaces.component

org.primefaces.component.DockRenderer

org.primefaces.component.dock.DockRenderer

Attributes

Name id rendered

Default null true

String

Boolean

Type binding model null null position itemWidth maxWidth proximity halign widgetVar bottom

90 center null

Object

MenuModel

String

Integer

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

MenuModel instance to create menus programmatically

Position of the dock, bottom or top.

Initial width of items.

Maximum width of items.

Distance to enlarge.

Horizontal alignment,

Name of the client side widget.

186

PrimeFaces User’s Guide

Getting started with the Dock

A dock is composed of menuitems.

<p:dock>

<p:menuitem value="Home" icon="/images/dock/home.png" url="#" />

<p:menuitem value="Music" icon="/images/dock/music.png" url="#" />

<p:menuitem value="Video" icon="/images/dock/video.png" url="#"/>

<p:menuitem value="Email" icon="/images/dock/email.png" url="#"/>

<p:menuitem value="Link" icon="/images/dock/link.png" url="#"/>

<p:menuitem value="RSS" icon="/images/dock/rss.png" url="#"/>

<p:menuitem value="History" icon="/images/dock/history.png" url="#"/>

</p:dock>

Position

Dock can be located in two locations, top or bottom (default). For a dock positioned at top set position to top.

Dock Effect

When mouse is over the dock items, icons are zoomed in. The configuration of this effect is done via the maxWidth and proximity attributes.

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

Following is the list of structural style classes, {positon} can be top or bottom.

Style Class

.ui-dock-{position}

.ui-dock-container-{position}

.ui-dock-item-{position}

Main container.

Menu item container.

Each menu item.

Applies

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

187

3.35 Editor

Editor is an input component with rich text editing capabilities.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class

Attributes id rendered

Name binding value converter immediate required editor org.primefaces.component.editor.Editor

org.primefaces.component.Editor

org.primefaces.component

org.primefaces.component.EditorRenderer

org.primefaces.component.editor.EditorRenderer

Default null true null null null false false

Type

String

Boolean

Object

Converter/

String

Boolean

Description

Unique identifier of the component.

Boolean value to specify the rendering of the component.

An el expression that maps to a server side

UIComponent instance in a backing bean.

Value of the component than can be either an EL expression of a literal text.

When set true, process validations logic is executed at apply request values phase for this component.

Marks component as required.

188

validator

Name valueChangeListener requiredMessage

Default null null null

Type

Method

Expr

Method

Expr

String converterMessage validatorMessage widgetVar controls height width disabled style styleClass onchange maxlength null null null null null null null null null false null

String

Integer

Boolean

String

Integer

PrimeFaces User’s Guide

Description

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.

Message to be displayed when conversion fails.

Message to be displayed when validation fails.

Name of the client side widget.

List of controls to customize toolbar.

Height of the editor.

Width of the editor.

Disables editor.

Inline style of the editor container.

Style class of the editor container.

Client side callback to execute when editor data changes.

Maximum length of the raw input.

Getting started with the Editor

Rich Text entered using the Editor is passed to the server using value expression.

public class Bean { private String text;

//getter and setter

}

<p:editor value="#{bean.text}" />

Custom Toolbar

Toolbar of editor is easy to customize using controls option;

<p:editor value="#{bean.text}" controls="bold italic underline strikethrough" />

189

PrimeFaces User’s Guide

Here is the full list of all available controls;

• bold

• italic

• underline

• strikethrough

• subscript

• superscript

• font

• size

• style

• color

• highlight

• bullets

• numbering

• alignleft

• center

• alignright

Client Side API

Widget: PrimeFaces.widget.Editor init()

Method Params

saveHTML() clear() enable() disable() focus() selectAll() getSelectedHTML() getSelectedText()

• justify

• undo

• redo

• rule

• image

• link

• unlink

• cut

• copy

• paste

• pastetext

• print

• source

• outdent

• indent

• removeFormat void void void void void void

String

Return Type void

Description

Initializes a lazy editor, subsequent calls do not reinit the editor.

Saves html text in iframe back to the textarea.

Clears the text in editor.

Enables editing.

Disables editing.

Adds cursor focus to edit area.

Selects all text in editor.

Returns selected text as HTML.

Returns selected text in plain format.

190

PrimeFaces User’s Guide

Skinning

Following is the list of structural style classes.

Style Class

.ui-editor

.ui-editor-toolbar

.ui-editor-group

.ui-editor-button

.ui-editor-divider

.ui-editor-disabled

.ui-editor-list

.ui-editor-color

.ui-editor-popup

.ui-editor-prompt

.ui-editor-message

Main container.

Toolbar of editor.

Button groups.

Each button.

Divider to separate buttons.

Applies

Disabled editor controls.

Dropdown lists.

Color picker.

Popup overlays.

Overlays to provide input.

Overlays displaying a message.

Editor is not integrated with ThemeRoller as there is only one icon set for the controls.

191

PrimeFaces User’s Guide

3.36 Effect

Effect component is based on the jQuery UI effects library.

Info

Tag

Tag Class

Component Class

Component Type

Component Family

Renderer Type

Renderer Class effect org.primefaces.component.effect.EffectTag

org.primefaces.component.effect.Effect

org.primefaces.component.Effect

org.primefaces.component

org.primefaces.component.EffectRenderer

org.primefaces.component.effect.EffectRenderer

Attributes

Name id rendered binding effect event type for speed delay

Default null

1 null null null null null

1000 null

String

Boolean

Type

Object

String

Integer

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget.

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.

Getting started with Effect

Effect component needs a trigger and target which is effect’s parent by default. In example below clicking outputText (trigger) will run the pulsate effect on outputText(target) itself.

192

PrimeFaces User’s Guide

<h:outputText value="#{bean.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. Use for option to specify a target.

<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.jpg" style="display:none"/>

With this setting, outputLink becomes the trigger for the effect on graphicImage. When the link is clicked, initially hidden graphicImage comes up with a fade effect.

Note: It’s important for components that have the effect component as a child to have an assigned id because some components do not render their clientId’s if you don’t give them an id explicitly.

List of Effects

Following is the list of effects;

• blind

• clip

• drop

• explode

• fold

• puff

• slide

• scale

• bounce

• highlight

• pulsate

• shake

• size

• transfer

193

PrimeFaces User’s Guide

Effect Configuration

Each effect has different parameters for animation like colors, duration and more. In order to change the configuration of the animation, provide these parameters with the f:param tag.

<h:outputText value="#{bean.value}">

<p:effect type="scale" event="mouseover">

<f:param name="percent" value="90"/>

</p:effect>

</h:outputText>

It’s important to provide string options with single quotes.

<h:outputText value="#{bean.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, please see the jquery documentation; http://docs.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. Following example animates messages with pulsate effect after ajax request completes.

<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.action}" update="messages"/>

194

PrimeFaces User’s Guide

3.37 FeedReader

FeedReader is used to display content from a feed.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class feedReader org.primefaces.component.feedreader.FeedReader

org.primefaces.component.FeedReader

org.primefaces.component

org.primefaces.component.FeedReaderRenderer

org.primefaces.component.feedreader.FeedReaderRenderer

Attributes

Name id rendered

Default null true

String

Boolean

Type binding value var size null null null

Unlimited

Object

String

Integer

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

URL of the feed.

Iterator to refer each item in feed.

Number of items to display.

Getting started with FeedReader

FeedReader requires a feed url to display and renders its content for each feed item.

<p:feedReader value=" http://rss.news.yahoo.com/rss/sports " var="feed">

<h:outputText value="#{feed.title}" style="font-weight: bold"/>

<h:outputText value="#{feed.description.value}" escape="false"/>

<p:separator />

<f:facet name="error">

Something went wrong.

</f:facet>

</p:feedReader>

Note that you need the ROME library in your classpath to make feedreader work.

195

3.38 Fieldset

Fieldset is a grouping component as an extension to html fieldset.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class fieldset org.primefaces.component.fieldset.Fieldset

org.primefaces.component.Fieldset

org.primefaces.component

org.primefaces.component.FieldsetRenderer

org.primefaces.component.fieldset.FieldsetRenderer

Attributes

Name id rendered binding widgetVar legend style styleClass toggleable toggleSpeed collapsed null

Default true

Type

String

Boolean null null null null null false

500 false

Object

String

Boolean

Integer

Boolean

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget.

Title text.

Inline style of the fieldset.

Style class of the fieldset.

Makes content toggleable with animation.

Toggle duration in milliseconds.

Defines initial visibility state of content.

196

PrimeFaces User’s Guide

Getting started with Fieldset

Fieldset is used as a container component for its children.

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

</h:panelGrid>

</p:fieldset>

Legend

Legend can be defined in two ways, 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.

<p:fieldset>

<f:facet name="legend">

</f:facet>

//content

</p:fieldset>

When both legend attribute and legend facet are present, 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.

<p:fieldset legend="Toggleable Fieldset" toggleable="true">

<h:panelGrid column="2">

<p:graphicImage value="/images/godfather/2.jpg" />

<h:outputText value="Francis Ford Coppolas’ legendary ..." />

</h:panelGrid>

</p:fieldset>

Ajax Behavior Events

toggle is the default and only ajax behavior event provided by fieldset that is processed when the content is toggled. In case you have a listener defined, it will be invoked by passing an instance of org.primefaces.event.ToggleEvent.

197

PrimeFaces User’s Guide

Here is an example that adds a facesmessage and updates growl component when fieldset is toggled.

<p:growld id="messages" />

<p:fieldset legend="Toggleable Fieldset" toggleable="true"

<p:ajax listener="#{bean.onToggle}" update="messages">

//content

</p:fieldset> public void onToggle(ToggleEvent event) {

Visibility visibility = event.getVisibility();

FacesMessage msg = new FacesMessage(); msg.setSummary("Fieldset " + event.getId() + " toggled"); msg.setDetail("Visibility: " + visibility);

FacesContext.getCurrentInstance().addMessage(null, msg);

}

Client Side API

Widget: PrimeFaces.widget.Fieldset toggle()

Method Params

Return Type void

Description

Toggles fieldset content.

Skinning

style and styleClass options apply to the fieldset. Following is the list of structural style classes;

Style Class

.ui-fieldset

.ui-fieldset-toggleable

Applies

Main container

Main container when fieldset is toggleable

.ui-fieldset .ui-fieldset-legend Legend of fieldset

.ui-fieldset-toggleable .ui-fieldset-legend Legend of fieldset when fieldset is toggleable

.ui-fieldset .ui-fieldset-toggler Toggle icon on fieldset

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

Tips

• A collapsed fieldset will remain collapsed after a postback since fieldset keeps its toggle state internally, you don’t need to manage this using toggleListener and collapsed option.

198

PrimeFaces User’s Guide

3.39 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. FileDownload presents an easier way to do the same.

Info

Tag fileDownload

ActionListener Class org.primefaces.component.filedownload.FileDownloadActionListener

Attributes value

Name Default null contextDisposition attachment String

Type

StreamedContent

Description

A streamed content instance

Specifies display mode.

Getting started with FileDownload

A user command action is required to trigger the filedownload process. FileDownload can be attached to any command component like a commandButton or commandLink. The value of the

FileDownload must be an org.primefaces.model.StreamedContent instance. We suggest using the built-in DefaultStreamedContent implementation. First parameter of the constructor is the binary stream, second is the mimeType and the third parameter is the name of the file.

public class FileBean {

private StreamedContent file;

public FileDownloadController() {

InputStream stream = this.getClass().getResourceAsStream("yourfile.pdf");

file = new DefaultStreamedContent(stream, "application/pdf",

"downloaded_file.pdf");

} public StreamedContent getFile() { return this.file;

}

This streamed content should be bound to the value of the fileDownload.

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

199

PrimeFaces User’s Guide

<h:commandLink value="Download">

<p:fileDownload value="#{fileBean.file}"/>

<h:graphicImage value="pdficon.gif" />

</h:commandLink>

If you’d like to use PrimeFaces commandButton and commandLink, disable ajax option as fileDownload requires a full page refresh to present the file.

<p:commandButton value="Download" ajax="false">

<p:fileDownload value="#{fileBean.file}" />

</p:commandButton>

<p:commandLink value="Download" ajax="false">

<p:fileDownload value="#{fileBean.file}"/>

<h:graphicImage value="pdficon.gif" />

</p:commandLink>

ContentDisposition

By default, content is displayed as an attachment with a download dialog box, another alternative is the inline mode, in this case browser will try to open the file internally without a prompt. Note that content disposition is not part of the http standard although it is widely implemented.

Monitor Status

As fileDownload process is non-ajax, ajaxStatus cannot apply. Still PrimeFaces provides a feature to monitor file downloads via client side monitorDownload(startFunction, endFunction) method.

Example below displays a modal dialog when dowload begins and hides it on complete.

PF('statusDialog').show();

} function hideStatus() {

PF('statusDialog').hide();

}

</script>

<h:form>

<p:dialog modal="true" widgetVar="statusDialog" header="Status" draggable="false" closable="false">

<p:graphicImage value="/design/ajaxloadingbar.gif" />

</p:dialog>

<p:commandButton value="Download" ajax="false" onclick="PrimeFaces.monitorDownload(showStatus, hideStatus)">

<p:fileDownload value="#{fileDownloadController.file}"/>

</p:commandButton>

</h:form>

Cookies must be enabled for monitoring.

200

PrimeFaces User’s Guide

3.40 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 binding

Default null true

String boolean null Object

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.

201

PrimeFaces User’s Guide

Name Default Description value converter immediate required validator valueChangeListener requiredMessage converterMessage validatorMessage widgetVar update process fileUploadListener multiple auto label allowTypes sizeLimit fileLimit style null null false false null null

Object Value of the component than can be either an EL expression of a literal text.

Converter

/String

Boolean

When set true, process validations logic is executed at apply request values phase for this component.

Marks component as required.

Boolean

MethodExpr A method expression that refers to a method validationg the input.

MethodExpr A method expression that refers to a method for handling a valuchangeevent.

null null null null null null null false false

Choose null null

String

String Component(s) to process in fileupload request.

MethodExpr Method to invoke when a file is uploaded.

Boolean

String

Integer

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.

Allows choosing of multi file uploads from native file browse dialog

When set to true, selecting a file starts the upload process implicitly.

Label of the browse button.

Regular expression for accepted file types, e.g. /(\.|\/)(gif|jpe?g|png)$/

Individual file size limit in bytes.

styleClass mode uploadLabel cancelLabel null null

Integer

String null String advanced String

Upload String

Cancel String

Maximum number of files allowed to upload.

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.

202

Name Default invalidSizeMessage null invalidFileMessage null fileLimitMessage null dragDropSupport true

String

Boolean onstart onerror oncomplete disabled messageTemplate previewWidth null null null false

{name}

{size}

String

Boolean

String

Integer

PrimeFaces User’s Guide

Description

Message to display when size limit exceeds.

Message to display when file is not accepted.

Message to display when file limit exceeds.

Specifies dragdrop based file selection from filesystem, default is true and works only on supported browsers.

Client side callback to execute when upload begins.

Callback to execute if fileupload request fails.

Client side callback to execute when upload ends.

Disables component when set true.

Message template to use when displaying file validation errors.

Width for image previews in pixels.

Getting started with FileUpload

FileUpload engine on the server side can either be servlet 3.0 or commons fileupload. PrimeFaces selects the most appropriate uploader engine by detection and it is possible to force one or the other usign an optional configuration param.

<context-param>

<param-name>primefaces.UPLOADER</param-name>

<param-value>auto|native|commons</param-value>

</context-param>

auto: This is the default mode and PrimeFaces tries to detect the best method by checking the runtime environment, if JSF runtime is at least 2.2 native uploader is selected, otherwise commons.

native: Native mode uses servlet 3.x Part API to upload the files and if JSF runtime is less than 2.2

and exception is being thrown.

commons: This option chooses commons fileupload regardless of the environment, advantage of this option is that it works even on a Servlet 2.5 environment.

If you have decided to choose commons fileupload, it requires the following filter configration in your web deployment descriptior.

203

PrimeFaces User’s Guide

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

Note that the servlet-name should match the configured name of the JSF servlet which is Faces

Servlet in this case. Alternatively you can do a configuration based on url-pattern as well.

Simple File Upload

Simple file upload mode works in legacy mode with a file input whose value should be an

UploadedFile instance. Ajax uploads are not supported in simple upload.

<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

FileUploadListener is the way to access the uploaded files in this mode, when a file is uploaded defined fileUploadListener is processed with a FileUploadEvent as the parameter.

<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" /> public class FileBean { public void handleFileUpload(FileUploadEvent event) {

UploadedFile file = event.getFile();

//application code

}

204

PrimeFaces User’s Guide

Multiple Uploads

Multiple uploads can be enabled using the multiple attribute so that multiple files can be selected from browser dialog. Multiple uploads are not supported in legacy browsers. Note that multiple mode is for selection only, it does not send all files in one request. FileUpload component always uses a new request for each file.

<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

}

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)$/"/>

Size Limit

Most of the time you might need to restrict the file upload size for a file, 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" />

205

PrimeFaces User’s Guide

File Limit

FileLimit restricts the number of maximum files that can be uploaded.

<p:fileUpload fileUploadListener="#{fileBean.handleFileUpload}" fileLimit="3" />

Validation Messages

invalidFileMessage, invalidSizeMessage and fileLimitMessage options are provided to display validation messages to the users. Similar to the FacesMessage message API, these message define the summary part, the detail part is retrieved from the messageTemplate option where default value is “{name} {size}”.

Skinning

FileUpload resides in a container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. 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

Browser Compatibility

Advanced uploader is implemented with HTML5 and provides far more features compared to single version. For legacy browsers that do not support HMTL5 features like canvas or file api, fileupload uses graceful degradation so that iframe is used for transport, detailed file information is not shown and a gif animation is displayed instead of progress bar. It is suggested to offer simple uploader as a fallback.

Filter Configuration

Filter configuration is required if you are using commons uploader only. Two configuration options exist, threshold size and temporary file upload location.

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")

206

PrimeFaces User’s Guide

An example configuration below defined thresholdSize to be 50kb and uploads to users temporary folder.

<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 always need to implement the logic to save the file contents yourself in your backing bean.

207

PrimeFaces User’s Guide

3.41 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 binding for context minSeverity

Default null true

String

Type boolean null null null error

Object

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

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

Following is a simple example;

208

PrimeFaces User’s Guide

<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 up, 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}" />

209

PrimeFaces User’s Guide

3.42 Fragment

Fragment component is used to define automatically partially process and update sections whenever ajax request is triggered by a descendant component.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class fragment org.primefaces.component.fragment.Fragment

org.primefaces.component.Fragment

org.primefaces.component

org.primefaces.component.FragmentRenderer

org.primefaces.component.fragment.FragmentRenderer

Attributes id

Name rendered binding autoUpdate

Default null true null false

Type Description

String Unique identifier of the component

Boolean Boolean value to specify the rendering of the component, when set to false component will not be rendered.

Object An el expression that maps to a server side UIComponent instance in a backing bean

Boolean Updates the fragment automatically.

Getting started with Fragment

In the following case, required input field outside the fragment is ignored and only the contents of the fragment are processed-updated automatically on button click since button is inside the fragment. Fragment makes it easy to define partial ajax process and update without explicitly defining component identifiers.

210

PrimeFaces User’s Guide

<h:form>

<h:panelGrid columns="2">

<p:outputLabel for="ign" value="Required:" />

<p:inputText id="ign" required="true" />

</h:panelGrid>

<p:fragment autoUpdate="true">

<h:panelGrid columns="4" cellpadding="5">

<h:outputLabel for="name" value="Name:" />

<h:outputText value="#{pprBean.firstname}" />

</h:panelGrid>

</p:fragment>

<p:inputText id="name" value="#{pprBean.firstname}" />

<p:commandButton value="Submit"/>

</h:form>

AutoUpdate has different notion compared to autoUpdate of message, growl and outputPanel. The fragment is updated automatically after an ajax request if the source is a descendant. In other mentioned components, there is no such restriction as they are updated for every ajax request regardless of the source.

211

PrimeFaces User’s Guide

3.43 Galleria

Galleria is used to display a set of images.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class galleria org.primefaces.component.galleria.Galleria

org.primefaces.component.Galleria

org.primefaces.component

org.primefaces.component.GalleriaRenderer

org.primefaces.component.galleria.GalleriaRenderer

Attributes

Name id rendered binding widgetVar value var style styleClass effect

Default null true

String

Type boolean null null null null null null fade

Object

String

Collection

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

Name of the client side widget.

Collection of data to display.

Name of variable to access an item in collection.

Inline style of the container element.

Style class of the container element.

Name of animation to use.

212

Name effectSpeed panelWidth panelHeight frameWidth frameHeight

40 showFilmstrip showCaption true false transitionInterval 4000 autoPlay true

Default

700

600

400

Type

Integer

Boolean

Integer

Boolean

PrimeFaces User’s Guide

Description

Duration of animation in milliseconds.

Width of the viewport.

Height of the viewport.

Width of the frames.

Height of the frames.

Defines visibility of filmstrip.

Defines visibility of captions.

Defines interval of slideshow.

Images are displayed in a slideshow in autoPlay.

Getting Started with Galleria

Images to displayed are defined as children of galleria;

<p:galleria effect="slide" effectDuration="1000">

<p:graphicImage value="/images/image1.jpg" title="image1" alt="image1 desc" />

<p:graphicImage value="/images/image2.jpg" title="image1" alt=" image2 desc" />

<p:graphicImage value="/images/image3.jpg" title="image1" alt=" image3 desc" />

<p:graphicImage value="/images/image4.jpg" title="image1" alt=" image4 desc" />

</p:galleria>

Galleria displays the details of an image using an overlay which is displayed by clicking the information icon. 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.

Dynamic Collection

Most of the time, 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.

<p:galleria value="#{galleriaBean.images}" var="image" >

<p:graphicImage value="#{image.path}" title="#{image.title}" alt="#{image.description}" />

</p:galleria>

Effects

There are various effect options to be used in transitions; blind, bounce, clip, drop, explode, fade, fold, highlight, puff, pulsate, scale, shake, size, slide and transfer.

By default animation takes 500 milliseconds, use effectSpeed option to tune this.

213

PrimeFaces User’s Guide

<p:galleria effect="slide" effectSpeed="1000">

//images

</p:galleria>

Skinning

Galleria resides in a main container element which style and styleClass options apply. As skinning style classes are global, see the main theming section for more information. Following is the list of structural style classes

Style Class

.ui-galleria

.ui-galleria-panel-wrapper

Applies

Container element for galleria.

Container of panels.

.ui-galleria-panel

.ui-galleria-caption

Container of each image.

Caption element.

.ui-galleria-nav-prev, .ui-galleria-nav-next Navigators of filmstrip.

.ui-galleria-filmstrip-wrapper Container of filmstrip.

.ui-galleria-filmstrip

.ui-galleria-frame

.ui-galleria-frame-content

.ui-galleria-frame-image

Filmstrip element.

Frame element in a filmstrip.

Content of a frame.

Thumbnail image.

214

3.44 GMap

GMap is a map component integrated with Google Maps API V3.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class gmap org.primefaces.component.gmap.GMap

org.primefaces.component.Gmap

org.primefaces.component

org.primefaces.component.GmapRenderer

org.primefaces.component.gmap.GmapRenderer

Attributes

Name id rendered binding widgetVar model

Default null true null null null

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.

Object

String

An el expression that maps to a server side

UIComponent instance in a backing bean.

Name of the client side widget.

MapModel An org.primefaces.model.MapModel instance.

215

Name style styleClass type center zoom streetView disableDefaultUI navigationControl mapTypeControl draggable disabledDoubleClickZoom onPointClick fitBounds

Default false false true true true false null null null null null

Type

String

Integer

Boolean

String true Boolean

PrimeFaces User’s Guide

Description

Inline style of the map container.

Style class of the map container.

Type of the map.

Center point of the map.

Defines the initial zoom level.

Controls street view support.

Disables default UI controls

Defines visibility of navigation control.

Defines visibility of map type control.

Defines draggability of map.

Disables zooming on mouse double click.

Javascript callback to execute when a point on map is clicked.

Defines if center and zoom should be calculated automatically to contain all markers on the map.

Getting started with GMap

First thing to do is placing V3 of the Google Maps API that the GMap is based on. Ideal location is the head section of your page.

As Google Maps api states, mandatory sensor parameter is used to specify if your application requires a sensor like GPS locator. Four options are required to place a gmap on a page, these are center, zoom, type and style.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" />

center: Center of the map in lat, lng format

zoom: Zoom level of the map

type: Type of map, valid values are, "hybrid", "satellite", "hybrid" and "terrain".

style: Dimensions of the map.

216

PrimeFaces User’s Guide

MapModel

GMap is backed by an org.primefaces.model.map.MapModel instance, PrimeFaces provides

org.primefaces.model.map.DefaultMapModel as the default implementation. API Docs of all GMap related model classes are available at the end of GMap section and also at javadocs of PrimeFaces.

Markers

A marker is represented by org.primefaces.model.map.Marker.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {

private MapModel model = new DefaultMapModel();

public MapBean() { model.addOverlay(new Marker(new LatLng(36.879466, 30.667648), "M1"));

//more overlays

}

public MapModel getModel() { return this.model; }

}

Polylines

A polyline is represented by org.primefaces.model.map.Polyline.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/>

217

public class MapBean {

private MapModel model;

public MapBean() { model = new DefaultMapModel();

Polyline polyline = new Polyline(); polyline.getPaths().add(new LatLng(36.879466, 30.667648)); polyline.getPaths().add(new LatLng(36.883707, 30.689216)); polyline.getPaths().add(new LatLng(36.879703, 30.706707)); polyline.getPaths().add(new LatLng(36.885233, 37.702323)); model.addOverlay(polyline);

}

public MapModel getModel() { return this.model; }

}

PrimeFaces User’s Guide

Polygons

A polygon is represented by org.primefaces.model.map.Polygon.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {

private MapModel model;

public MapBean() { model = new DefaultMapModel();

Polygon polygon = new Polygon(); polyline.getPaths().add(new LatLng(36.879466, 30.667648)); polyline.getPaths().add(new LatLng(36.883707, 30.689216)); polyline.getPaths().add(new LatLng(36.879703, 30.706707)); model.addOverlay(polygon);

}

public MapModel getModel() { return this.model; }

}

Circles

A circle is represented by org.primefaces.model.map.Circle.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/>

218

PrimeFaces User’s Guide public class MapBean {

private MapModel model;

public MapBean() { model = new DefaultMapModel();

Circle circle = new Circle(new LatLng(36.879466, 30.667648), 500); model.addOverlay(circle);

}

public MapModel getModel() { return this.model; }

}

Rectangles

A circle is represented by org.primefaces.model.map.Rectangle.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}"/> public class MapBean {

private MapModel model;

public MapBean() { model = new DefaultMapModel();

LatLng coord1 = new LatLng(36.879466, 30.667648);

LatLng coord2 = new LatLng(36.883707, 30.689216);

Rectangle rectangle = new Rectangle(coord1, coord2); model.addOverlay(circle);

}

public MapModel getModel() { return this.model; }

}

Ajax Behavior Events

GMap provides many custom ajax behavior events for you to hook-in to various features.

Event overlaySelect stateChange pointSelect markerDrag

Listener Parameter org.primefaces.event.map.OverlaySelectEvent

org.primefaces.event.map.StateChangeEvent

org.primefaces.event.map.PointSelectEvent

org.primefaces.event.map.MarkerDragEvent

Fired

When an overlay is selected.

When map state changes.

When an empty point is selected.

When a marker is dragged.

Following example displays a FacesMessage about the selected marker with growl component.

219

PrimeFaces User’s Guide

<h:form>

<p:growl id="growl" />

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}">

<p:ajax event="overlaySelect" listener="#{mapBean.onMarkerSelect}" update="growl" />

</p:gmap>

</h:form> public class MapBean {

private MapModel model;

public MapBean() { model = new DefaultMapModel();

//add markers

}

public MapModel getModel() { return model

}

public void onMarkerSelect(OverlaySelectEvent event) {

Marker selectedMarker = (Marker) event.getOverlay();

//add facesmessage

}

InfoWindow

A common use case is displaying an info window when a marker is selected. gmapInfoWindow is used to implement this special use case. Following example, displays an info window that contains an image of the selected marker data.

<h:form>

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" model="#{mapBean.model}">

<p:ajax event="overlaySelect" listener="#{mapBean.onMarkerSelect}" />

<p:gmapInfoWindow>

<p:graphicImage value="/images/#{mapBean.marker.data.image}" />

<h:outputText value="#{mapBean.marker.data.title}" />

</p:gmapInfoWindow>

</p:gmap>

</h:form>

220

public class MapBean {

private MapModel model;

private Marker marker;

public MapBean() { model = new DefaultMapModel();

//add markers

}

public MapModel getModel() { return model; }

public Marker getMarker() { return marker; }

public void onMarkerSelect(OverlaySelectEvent event) { this.marker = (Marker) event.getOverlay();

}

PrimeFaces User’s Guide

Street View

StreeView is enabled simply by setting streetView option to true.

<p:gmap center="41.381542, 2.122893" zoom="15" type="hybrid" style="width:600px;height:400px" streetView="true" />

221

PrimeFaces User’s Guide

Map Controls

Controls on map can be customized via attributes like navigationControl and mapTypeControl.

Alternatively setting disableDefaultUI to true will remove all controls at once.

<p:gmap center="41.381542, 2.122893" zoom="15" type="terrain" style="width:600px;height:400px" mapTypeControl="false" navigationControl="false" />

Native Google Maps API

In case you need to access native google maps api with javascript, use provided getMap() method.

var gmap = PF('yourWidgetVar').getMap();

//gmap is a google.maps.Map instance

Full map api is provided at; http://code.google.com/apis/maps/documentation/javascript/reference.html

GMap API

org.primefaces.model.map.MapModel (org.primefaces.model.map.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

Description

Returns the list of circles

Returns the list of rectangles.

Finds an overlay by it’s unique id

222

PrimeFaces User’s Guide org.primefaces.model.map.Overlay

Property id data zindex

Default null null null

Type

String

Object

Integer

Description

Id of the overlay, generated and used internally

Data represented in marker

Z-Index of the overlay

org.primefaces.model.map.Marker extends org.primefaces.model.map.Overlay

Property title latlng icon shadow cursor draggable clickable flat visible

Default null null

1 null null pointer

Type

String

LatLng

String

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

If enabled, shadow image is not displayed

Defines visibility of the marker

org.primefaces.model.map.Polyline extends org.primefaces.model.map.Overlay

Description Property paths strokeColor strokeOpacity strokeWeight

Default null null

List

Type

String

Double

Integer

List of coordinates

Color of a line

Opacity of a line

Width of a line

org.primefaces.model.map.Polygon extends org.primefaces.model.map.Overlay

Description Property paths strokeColor strokeOpacity

Default null null

Type

List

String

Double

List of coordinates

Color of a line

Opacity of a line

223

Property strokeWeight fillColor fillOpacity

Default

1 null

Type

Integer

String

Double

PrimeFaces User’s Guide

Description

Weight of a line

Background color of the polygon

Opacity of the polygon

org.primefaces.model.map.Circle extends org.primefaces.model.map.Overlay

Property center radius strokeColor strokeOpacity strokeWeight fillColor fillOpacity

1 null

Default null null null

Type

LatLng

Double

String

Double

Integer

String

Double

Description

Center of the circle

Radius of the circle.

Stroke color of the circle.

Stroke opacity of circle.

Stroke weight of the circle.

Background color of the circle.

Opacity of the circle.

org.primefaces.model.map.Rectangle extends org.primefaces.model.map.Overlay

Property bounds strokeColor strokeOpacity strokeWeight fillColor fillOpacity

Default null null

1 null

Type Description

LatLngBounds Boundaries of the rectangle.

String Stroke color of the rectangle.

Double

Integer

String

Double

Stroke opacity of rectangle.

Stroke weight of the rectangle.

Background color of the rectangle.

Opacity of the rectangle.

org.primefaces.model.map.LatLng

lat lng

Property Default null null

Type double double org.primefaces.model.map.LatLngBounds

Description

Latitude of the coordinate

Longitude of the coordinate

224

Property center northEast southWest

Default null null null

Type

LatLng

PrimeFaces User’s Guide

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

org.primefaces.event.map.MarkerDragEvent

Property marker

Default null

Type

Marker

Description

Dragged marker instance org.primefaces.event.map.OverlaySelectEvent

Property overlay

Default null

Type

Overlay

Description

Selected overlay instance org.primefaces.event.map.PointSelectEvent

Property latLng

Default null

Type

LatLng

Description

Coordinates of the selected point org.primefaces.event.map.StateChangeEvent

Property bounds zoomLevel

Default null

Type

LatLngBounds

Integer

Description

Boundaries of the map

Zoom level of the map

225

PrimeFaces User’s Guide

3.45 GMapInfoWindow

GMapInfoWindow is used with GMap component to open a window on map when an overlay is selected.

Info

Tag

Tag Class

Component Class

Component Type

Component Family gmapInfoWindow org.primefaces.component.gmap.GMapInfoWindowTag

org.primefaces.component.gmap.GMapInfoWindow

org.primefaces.component.GMapInfoWindow

org.primefaces.component

Attributes

Name id rendered binding maxWidth

Default null true

Type

String

Boolean null null

Object

Integer

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Maximum width of the info window

Getting started with GMapInfoWindow

See GMap section for more information about how gmapInfoWindow is used.

226

binding value alt url width height title dir lang ismap usemap style

PrimeFaces User’s Guide

3.46 GraphicImage

GraphicImage extends standard JSF graphic image component with the ability of displaying binary data like an inputstream. Main use cases of GraphicImage is to make displaying images stored in database or on-the-fly images easier. Legacy way to do this is to come up with a Servlet that does the streaming, GraphicImage does all the hard work without the need of a Servlet.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class graphicImage org.primefaces.component.graphicimage.GraphicImage

org.primefaces.component.GraphicImage

org.primefaces.component

org.primefaces.component.GraphicImageRenderer

org.primefaces.component.graphicimage.GraphicImageRenderer

Attributes

Name id rendered

Default null true

String

Type boolean null null null null null false null null null null null null

Object

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

Binary data to stream or context relative path.

Alternate text for the image

Alias to value attribute

Width of the image

Height of the image

Title of the image

Direction of the text displayed

Language code

Specifies to use a server-side image map

Name of the client side map

Style of the image

227

Name styleClass onclick ondblclick onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup cache name library

Default null null null null null null true null null null null null null null

String

Type

PrimeFaces User’s Guide

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

Name of the image.

Library name of the image.

Getting started with GraphicImage

GraphicImage requires an org.primefaces.model.StreamedContent content as it’s value for dynamic images. StreamedContent is an interface and PrimeFaces provides a built-in implementation called

DefaultStreamedContent. Following examples loads an image from the classpath.

<p:graphicImage value="#{imageBean.image}" /> public class ImageBean { private StreamedContent image; public DynamicImageController() {

InputStream stream = this.getClass().getResourceAsStream("barcalogo.jpg");

image = new DefaultStreamedContent(stream, "image/jpeg");

} public StreamedContent getImage() { return this.image;

}

DefaultStreamedContent gets an inputstream as the first parameter and mime type as the second.

In a real life application, you can create the inputstream after reading the image from the database.

For example java.sql.ResultsSet API has the getBinaryStream() method to read blob files stored in database.

228

PrimeFaces User’s Guide

Displaying Charts with JFreeChart

See static images section at chart component for a sample usage of graphicImage with jFreeChart.

Displaying a Barcode

Similar to the chart example, a barcode can be generated as well. This sample uses barbecue project for the barcode API.

<p:graphicImage value="#{backingBean.barcode}" /> public class BarcodeBean { private StreamedContent barcode; public BackingBean() { try {

File barcodeFile = new File("dynamicbarcode");

BarcodeImageHandler.saveJPEG(

BarcodeFactory.createCode128("PRIMEFACES"), barcodeFile); barcode = new DefaultStreamedContent( new FileInputStream(barcodeFile), "image/jpeg");

} catch (Exception e) { e.printStackTrace();

}

} public BarcodeBean getBarcode() { return this.barcode;

}

Displaying Regular Images

As GraphicImage extends standard graphicImage component, it can also display regular non dynamic images just like standard graphicImage component using name and optional library.

<p:graphicImage name="barcalogo.jpg" library="yourapp" />

How It Works

Dynamic image display works as follows;

• Dynamic image encryps its value expression string to generate a key.

• This key is appended to the image url that points to JSF resource handler.

• Custom PrimeFaces ResourceHandler gets the key from the url, decrypts the expression string to something like #{bean.streamedContentValue}, evaluates it to get the instance of

StreamedContent from bean and streams contents to client.

229

PrimeFaces User’s Guide

As a result there will be 2 requests to display an image, 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. Please note that you cannot use viewscope beans as they are not available in resource loading request.

Passing Parameters and Data Iteration

You can pass request parameters to the graphicImage via f:param tags, as a result the actual request rendering the image can have access to these values. This is extremely handy to display dynamic images if your image is in a data iteration component like datatable or ui:repeat.

230

PrimeFaces User’s Guide

3.47 Growl

Growl is based on the Mac’s growl notification widget and used to display FacesMessages in an overlay.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class growl org.primefaces.component.growl.Growl

org.primefaces.component.Growl

org.primefaces.component

org.primefaces.component.GrowlRenderer

org.primefaces.component.growl.GrowlRenderer

Attributes

Name id rendered binding sticky null false showSummary true showDetail globalOnly false false life 6000 null true

Default Type

String

Boolean

Object

Boolean

Integer

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Specifies if the message should stay instead of hidden automatically.

Specifies if the summary of message should be displayed.

Specifies if the detail of message should be displayed.

When true, only facesmessages without clientids are displayed.

Duration in milliseconds to display non-sticky messages.

231

Name autoUpdate redisplay for escape severity false

Default true null true null

Type

Boolean

String

Boolean

String

PrimeFaces User’s Guide

Description

Specifies auto update mode.

Defines if already rendered messaged should be displayed.

Name of associated key, takes precedence when used with globalOnly.

Defines whether html would be escaped or not.

Comma separated list of severities to display only.

Getting Started with Growl

Growl usage is similar to standard h:messages component. Simply place growl anywhere on your page, since messages are displayed as an overlay, the location of growl in JSF page does not matter.

<p:growl />

Lifetime of messages

By default each message will be displayed for 6000 ms and then hidden. A message can be made sticky meaning it’ll never be hidden automatically.

<p:growl sticky="true" />

If growl is not working in sticky mode, it’s also possible to tune the duration of displaying messages. Following growl will display the messages for 5 seconds and then fade-out.

<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, growl will be updated automatically with each ajax request anyway.

<p:growl id="messages"/>

<p:commandButton value="Submit" update="messages" />

Positioning

Growl is positioned at top right corner by default, position can be controlled with a CSS selector called ui-growl. With the below setting growl will be located at top left corner.

.ui-growl { left:20px;

}

232

PrimeFaces User’s Guide

Targetable Messages

There may be times where you need to target one or more messages to a specific message component, for example suppose you have growl and messages on same page and you need to display some messages on growl and some on messages. Use for attribute to associate messages with specific components.

<p:messages for="somekey" />

<p:growl for="anotherkey" />

FacesContext context = FacesContext.getCurrentInstance();

context.addMessage("somekey", facesMessage1);

context.addMessage("somekey", facesMessage2);

context.addMessage("anotherkey", facesMessage3);

In sample above, messages will display first and second message and growl will only display the

3rd message.

Severity Levels

Using severity attribute, you can define which severities can be displayed by the component. For instance, you can configure growl to only display infos and warnings.

<p:growl severity="info,warn" />

Escaping

Growl escapes html content in messages, in case you need to display html via growl set escape option to false.

<p:growl escape="false" />

Skinning

Following is the list of structural style classes;

Style Class

.ui-growl

.ui-growl-item-container

.ui-growl-item

.ui-growl-message

.ui-growl-title

.ui-growl-message p

.ui-growl-image

Applies

Main container element of growl

Container of messages

Container of a message

Text message container

Summary of the message

Detail of the message

Severity icon

233

PrimeFaces User’s Guide

Style Class

.ui-growl-image-info

.ui-growl-image-warn

.ui-growl-image-error

.ui-growl-image-fatal

Info severity icon

Warning severity icon

Error severity icon

Fatal severity icon

Applies

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

234

PrimeFaces User’s Guide

3.48 HotKey

HotKey is a generic key binding component that can bind any formation of keys to javascript event handlers or ajax calls.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class hotkey org.primefaces.component.hotkey.HotKey

org.primefaces.component.HotKey

org.primefaces.component

org.primefaces.component.HotKeyRenderer

org.primefaces.component.hotkey.HotKeyRenderer

Attributes

Name id rendered

Default null true

Type

String

Boolean binding bind handler action actionListener immediate null null null null null false

Object

String

MethodExpr

Boolean async process update false null null

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

The Key binding.

Javascript event handler to be executed when the key binding is pressed.

A method expression that’d be processed in the partial request caused by uiajax.

An actionlistener that’d be processed in the partial request caused by uiajax.

Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.

When set to true, ajax requests are not queued.

Component id(s) to process partially instead of whole view.

Client side id of the component(s) to be updated after async partial submit request.

235

onstart

Name oncomplete onsuccess onerror global delay

Default null String

Type null null

String

String null true

String

Boolean null partialSubmit resetValues false false ignoreAutoUpdate false

String

Boolean

PrimeFaces User’s Guide

Description

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.

If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. If this option is not specified, or if the value of delay is the literal string 'none' without the quotes, no delay is used.

Enables serialization of values belonging to the partially processed components only.

If true, local values of input components to be updated within the ajax request would be reset.

If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.

Getting Started with HotKey

HotKey is used in two ways, either on client side with the event handler or with ajax support.

Simplest example would be;

<p:hotkey bind="a" handler="alert(‘Pressed a’);" />

When this hotkey is on page, pressing the a key will alert the ‘Pressed key a’ text.

Key combinations

Most of the time you’d need key combinations rather than a single key.

<p:hotkey bind="ctrl+s" handler="alert(‘Pressed ctrl+s’);" />

<p:hotkey bind="ctrl+shift+s" handler="alert(‘Pressed ctrl+shift+s’)" />

Integration

Here’s an example demonstrating how to integrate hotkeys with a client side api. Using left and right keys will switch the images displayed via the p:imageSwitch component.

236

PrimeFaces User’s Guide

<p:hotkey bind="left" handler="PF('switcher').previous();" />

<p:hotkey bind="right" handler="PF('switcher').next();" />

<p:imageSwitch widgetVar="switcher">

//content

</p:imageSwitch>

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.

<h:form>

<p:hotkey bind="ctrl+shift+s" update="display" />

<h:panelGrid columns="2">

<h:outputLabel for="name" value="Name:" />

<h:inputText id="name" value="#{bean.name}" />

</h:panelGrid>

<h:outputText id="display" value="Hello: #{bean.firstname}" />

</h:form>

Note that hotkey will not be triggered if there is a focused input on page.

237

PrimeFaces User’s Guide

3.49 IdleMonitor

IdleMonitor watches user actions on a page and notify callbacks in case they go idle or active again.

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class idleMonitor org.primefaces.component.idlemonitor.IdleMonitor

org.primefaces.component.IdleMonitor

org.primefaces.component

org.primefaces.component.IdleMonitorRenderer

org.primefaces.component.idlemonitor.IdleMonitor

Attributes

Name id rendered binding timeout onidle onactive widgetVar

Default null true

Type

String

Boolean null

300000 null null null

Object

Integer

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

Time to wait in milliseconds until deciding if the user is idle. Default is 5 minutes.

Client side callback to execute when user goes idle.

Name of the client side widget.

Getting Started with IdleMonitor

To begin with, you can hook-in to client side events that are called when a user goes idle or becomes active again. Example below toggles visibility of a dialog to respond these events.

<p:idleMonitor onidle="PF('idleDialog').show();" onactive="PF('idleDialog').hide();"/>

<p:dialog header="What's happening?" widgetVar="idleDialog" modal="true">

<h:outputText value="Dude, are you there?" />

</p:dialog>

238

PrimeFaces User’s Guide

Controlling Timeout

By default, idleMonitor waits for 5 minutes (300000 ms) until triggering the onidle event. You can customize this duration with the timeout attribute.

Ajax Behavior Events

IdleMonitor provides two ajax behavior events which are idle and active that are fired according to user status changes. Example below displays messages for each event;

<p:idleMonitor timeout="5000" update="messages">

<p:ajax event="idle" listener="#{bean.idleListener}" update="msg" />

<p:ajax event="active" listener="#{bean.activeListener}" update="msg" />

</p:idleMonitor>

<p:growl id=”msg” /> public class Bean { public void idleListener() {

//Add facesmessage

} public void idle() {

//Add facesmessage

}

239

3.50 ImageCompare

ImageCompare provides a user interface to compare two images.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class imageCompare org.primefaces.component.imagecompare.ImageCompare

org.primefaces.component.ImageCompare

org.primefaces.component

org.primefaces.component.ImageCompareRenderer

org.primefaces.component.imagecompare.ImageCompareRenderer

Attributes id rendered

Name binding widgetVar

Default null true

Type

String

Boolean null null

Object

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

Name of the client side widget.

240

Name leftImage rightImage width height style styleClass

Default null null null null null null

Type

String

PrimeFaces User’s Guide

Description

Source of the image placed on the left side

Source of the image placed on the right side

Width of the images

Height of the images

Inline style of the container element

Style class of the container element

Getting started with ImageCompare

ImageCompare is created with two images with same height and width. It is required to set width and height of the images as well.

<p:imageCompare leftImage="xbox.png" rightImage="ps3.png" width="438" height="246"/>

Skinning

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

241

PrimeFaces User’s Guide

3.51 ImageCropper

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

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class imageCropper org.primefaces.component. imagecropper.ImageCropper

org.primefaces.component.ImageCropper

org.primefaces.component

org.primefaces.component.ImageCropperRenderer

org.primefaces.component.imagecropper.ImageCropperRenderer

Attributes id rendered

Name binding value converter immediate required

Default null true null null null false false

Type

String

Boolean

Object

Converter

/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

When set true, process validations logic is executed at apply request values phase for this component.

Marks component as required

242

validator

Name valueChangeListener requiredMessage converterMessage validatorMessage widgetVar image alt aspectRatio minSize maxSize backgroundColor backgroundOpacity initialCoords null null

0,6 null null null null null null null null

Default null null null

Type

Method

Expr

Method

Expr

String

Double

String

Double

String

PrimeFaces User’s Guide

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.

Message to be displayed when conversion fails.

Message to be displayed when validation fields.

Name of the client side widget.

Context relative path to the image.

Alternate text of the image.

Aspect ratio of the cropper area.

Minimum size of the cropper area.

Maximum size of the cropper area.

Background color of the container.

Background opacity of the container

Initial coordinates of the cropper area.

Getting started with the ImageCropper

ImageCropper is an input component and image to be cropped is provided via the image attribute.

The cropped area of the original image is used to create a new image, this new image can be accessed on the backing bean by setting the value attribute of the image cropper. Assuming the image is at %WEBAPP_ROOT%/campnou.jpg

<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" /> public class Cropper { private CroppedImage croppedImage;

//getter and setter

}

org.primefaces.model.CroppedImage belongs a PrimeFaces API and contains handy information about the crop process. Following table describes CroppedImage properties.

Property originalFileName bytes

String byte[]

Type Description

Name of the original file that’s cropped

Contents of the cropped area as a byte array

243

left right width height

Property int int int int

Type

PrimeFaces User’s Guide

Description

Left coordinate

Right coordinate

Width of the cropped image

Height of the cropped image

External Images

ImageCropper has the ability to crop external images as well.

<p:imageCropper value="#{cropper.croppedImage}" image= " ">

</p:imageCropper>

Context Relative Path

For local images, ImageCropper always requires the image path to be context relative. So to accomplish this simply just add slash ("/path/to/image.png") and imagecropper will recognize it at

%WEBAPP_ROOT%/path/to/image.png. Action url relative local images are not supported.

Initial Coordinates

By default, user action is necessary to initiate the cropper area on an image, you can specify an initial area to display on page load using initialCoords option in x,y,w,h format.

<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" initialCoords="225,75,300,125"/>

Boundaries minSize and maxSize attributes are control to limit the size of the area to crop.

<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" minSize="50,100" maxSize="150,200"/>

Saving Images

Below is an example to save the cropped image to file system.

<p:imageCropper value="#{cropper.croppedImage}" image="/campnou.jpg" />

<p:commandButton value="Crop" actionListener="#{myBean.crop}" />

244

PrimeFaces User’s Guide public class Cropper { private CroppedImage croppedImage;

//getter and setter public String crop() {

ServletContext servletContext = (ServletContext)

FacesContext.getCurrentInstance().getExternalContext().getContext();

String newFileName = servletContext.getRealPath("") + File.separator +

"ui" + File.separator + "barca" + File.separator+ croppedImage.getOriginalFileName()

+ "cropped.jpg";

FileImageOutputStream imageOutput; try { imageOutput = new FileImageOutputStream(new File(newFileName)); imageOutput.write(croppedImage.getBytes(), 0, croppedImage.getBytes().length); imageOutput.close();

} catch (Exception e) { e.printStackTrace();

} return null;

}

245

3.52 ImageSwitch

Imageswitch component is a simple image gallery component.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type imageSwitch org.primefaces.component.imageswitch.ImageSwitch

org.primefaces.component.ImageSwitch

Component Family org.primefaces.component

Renderer Type org.primefaces.component.ImageSwitchRenderer

Renderer Class org.primefaces.component.imageswitch.ImageSwitchRenderer

Attributes

Name id rendered binding widgetVar effect speed slideshowSpeed slideshowAuto style styleClass null null null

500

3000 true null null

Default null true

Type

String

Boolean

Object

String

Integer

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

Name of the client side widget.

Name of the effect for transition.

Speed of the effect in milliseconds.

Slideshow speed in milliseconds.

Starts slideshow automatically on page load.

Style of the main container.

Style class of the main container.

246

PrimeFaces User’s Guide

Getting Started with ImageSwitch

ImageSwitch component needs a set of images to display. Provide the image collection as a set of children components.

<p:imageSwitch effect="FlyIn">

<p:graphicImage value="/images/nature1.jpg" />

<p:graphicImage value="/images/nature2.jpg" />

<p:graphicImage value="/images/nature3.jpg" />

<p:graphicImage value="/images/nature4.jpg" />

</p:imageSwitch>

Most of the time, images could be dynamic, ui:repeat is supported to implement this case.

<p:imageSwitch>

<ui:repeat value="#{bean.images}" var="image">

<p:graphicImage value="#{image}" />

</ui:repeat>

</p:imageSwitch>

Slideshow or Manual

ImageSwitch is in slideShow mode by default, if you’d like manual transitions disable slideshow and use client side api to create controls.

<p:imageSwitch effect="FlyIn" widgetVar="imageswitch">

//images

</p:imageSwitch>

<span onclick="PF('imageswitch').previous();">Previous</span>

Client Side API

Widget: PrimeFaces.widget.ImageSwitch

Method startSlideshow() stopSlideshow() toggleSlideshow() pauseSlideshow() next() previous() switchTo(index)

Params

index

Return Type void void void void void void void

Description

Starts slideshow mode.

Stops slideshow mode.

Toggles slideshow mode.

Pauses slideshow mode.

Switches to next image.

Switches to previous image.

Displays image with given index.

247

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

//set of images

</p:imageSwitch>

List of Effects

ImageSwitch supports a wide range of transition effects. Following is the full list, note that values are case sensitive.

• blindX

• blindY

• blindZ

• cover

• curtainX

• curtainY

• fade

• fadeZoom

• growX

• growY

• none

• scrollUp

• scrollDown

• scrollLeft

• scrollRight

• scrollVert

• shuffle

• slideX

• slideY

• toss

• turnUp

• turnDown

• turnLeft

• turnRight

• uncover

• wipe

• zoom

248

PrimeFaces User’s Guide

3.53 Inplace

Inplace provides easy inplace editing and inline content display. Inplace consists of two members, display element is the initial clickable label and inline element is the hidden content that is displayed when display element is toggled.

binding widgetVar label emptyLabel effect effectSpeed disabled style styleClass editor

Info

Tag

Component Class

Component Type inplace org.primefaces.component.inplace.Inplace

org.primefaces.component.Inplace

Component Family org.primefaces.component

Renderer Type org.primefaces.component.InplaceRenderer

Renderer Class org.primefaces.component.inplace.InplaceRenderer

Attributes

Name id rendered

Default null true

Type

String

Boolean null null null null fade normal false null null false

Object

String

Boolean

String

Boolean

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Name of the client side widget.

Label to be shown in display mode.

Label to be shown in display mode when value is empty.

Effect to be used when toggling.

Speed of the effect.

Prevents hidden content to be shown.

Inline style of the main container element.

Style class of the main container element.

Specifies the editor mode.

249

Name saveLabel cancelLabel event toggleable

Default

Save

Cancel click

String

Type true Boolean

PrimeFaces User’s Guide

Description

Tooltip text of save buttin in editor mode.

Tooltip text of cancel buttin in editor mode.

Name of the client side event to display inline content.

Defines if inplace is toggleable or not.

Getting Started with Inplace

The inline component needs to be a child of inplace.

<p:inplace>

<h:inputText value="Edit me" />

</p:inplace>

Custom Labels

By default inplace displays its first childs value as the label, you can customize it via the label attribute.

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

Facets

For advanced customization, output and input facets are provided.

<p:inplace id="checkboxInplace">

<f:facet name="output">

Yes or No

</f:facet>

<f:facet name="input">

<h:selectBooleanCheckbox />

</f:facet>

</p:inplace>

250

PrimeFaces User’s Guide

Effects

Default effect is fade and other possible effect is slide, also effect speed can be tuned with values

slow, normal and fast.

<p:inplace label="Show Image" effect="slide" effectSpeed="fast">

<p:graphicImage value="/images/nature1.jpg" />

</p:inplace>

Editor

Inplace editing is enabled via the editor option.

public class InplaceBean { private String text;

//getter-setter

}

<p:inplace editor="true">

<h:inputText value="#{inplaceBean.text}" />

</p:inplace>

save and cancel are two provided ajax behaviors events you can use to hook-in the editing process.

public class InplaceBean { private String text; public void handleSave() {

//add faces message with update text value

}

//getter-setter

}

<p:inplace editor="true">

<p:ajax event="save" listener="#{inplaceBean.handleSave}" update="msgs" />

<h:inputText value="#{inplaceBean.text}" />

</p:inplace>

<p:growl id="msgs" />

251

PrimeFaces User’s Guide

Client Side API

Widget: PrimeFaces.widget.Inplace

Method show() hide() toggle() save() cancel()

Params

Return Type void void void void void

Description

Shows content and hides display element.

Shows display element and hides content.

Toggles visibility of between content and display element.

Triggers an ajax request to process inplace input.

Triggers an ajax request to revert inplace input.

Skinning

Inplace resides in a main container element which style and styleClass options apply. Following is the list of structural style classes;

.ui-inplace

.ui-inplace-disabled

.ui-inplace-display

.ui-inplace-content

.ui-inplace-editor

.ui-inplace-save

.ui-inplace-cancel

Style Class Applies

Main container element.

Main container element when disabled.

Display element.

Inline content.

Editor controls container.

Save button.

Cancel button.

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

252

3.54 InputMask

InputMask forces an input to fit in a defined mask template.

PrimeFaces User’s Guide

Info

Tag

Component Class

Component Type

Component Family

Renderer Type

Renderer Class inputMask org.primefaces.component.inputmask.InputMask

org.primefaces.component.InputMask

org.primefaces.component

org.primefaces.component.InputMaskRenderer

org.primefaces.component.inputmask.InputMaskRenderer

Attributes

Name id rendered binding mask placeHolder value null null null null

Default null true

Type

String

Boolean

Object

String

Object

Description

Unique identifier of the component

Boolean value to specify the rendering of the component, when set to false component will not be rendered.

An el expression that maps to a server side

UIComponent instance in a backing bean

Mask template

PlaceHolder in mask template.

Value of the component than can be either an EL expression of a literal text

253

PrimeFaces User’s Guide converter immediate required validator false null valueChangeListener null requiredMessage converterMessage validatorMessage widgetVar accesskey alt autocomplete dir disabled label lang onblur onclick

Name maxlength onchange ondblclick

Default null false null null null null null null null null false null null null null null null null ing

Type

Converter/Str

String

Boolean

String

Description

Boolean

MethodExpr A method binding expression that refers to a method validationg the input

MethodExpr A method binding expression that refers to a method for handling a valuchangeevent

String Message to be displayed when required field validation fails.

String

When set true, process validations logic is executed at apply request values phase for this component.

Marks component as required

Message to be displayed when conversion fails.

Message to be displayed when validation fields.

Name of the client side widget.

Access key that when pressed transfers focus to the input element.

Alternate textual description of the input field.

Controls browser autocomplete behavior.

Direction indication for text that does not inherit directionality. Valid values are LTR and RTL.

Disables input field

A localized user presentable name.

Integer

String

Code describing the language used in the generated markup for this component.

Maximum number of characters that may be entered in this field.

Client side callback to execute when input element loses focus.

String

Client side callback to execute when input element loses focus and its value has been modified since gaining focus.

Client side callback to execute when input element is clicked.

Client side callback to execute when input element is double clicked.

254

onfocus

Name onkeydown onkeypress onkeyup onmousedown onmousemove onmouseout onmouseover onmouseup onselect placeholder readonly size style styleClass tabindex title null null null false null null null null null null null null null null