arya-blue
luna-amber
luna-blue
luna-green
luna-pink
nova-dark
nova-light
saga-blue
vela-blue
Layout
Layout creates a border layout that has auto-sizing 'center pane' surrounded by up to four closable and resizable 'border panes' (north, south, east and west). It can also create multiple headers inside each pane. For more complex layouts you can nest layouts within layouts. Possibilities are unlimited - from simple fixed headers or sidebars to rich applications. Each layout pane can be closed, opened and resized, within automatic or specified limits. You can use layout either for an entire page (full page layout) or for a specific region in the page (element layout). Furthermore, any custom content can be placed between layout panes. There are also client-side and server-side state management.

The layout in PrimeFaces Extensions is described by model which binds all layout options together. Layout options are built up by the class LayoutOptions. By this way, you can use all available options from the underlying jQuery layout plugin. Please refer the documentation to learn all options:

Overview of Layout Options

Changelog, Using Examples

Another way to specify options is setting options as attributes of layout pane (pe:layoutPane). By this way, no model class LayoutOptions is needed, but the possibilities are limited. It is not possible to introduce a lot of various options via tag attributes of pe:layoutPane. The number of options is too big. Only mostly used options are available via tag attributes.

Another advantage of the options attribute is the performance. This attribute points to an instance of the class LayoutOptions or an JSON String representing serialized LayoutOptions. Serializing of layout options to an JSON string can increase the time of layout building when the layout is built during application startup in an application scoped bean (LayoutOptions gets always serialized to JSON to be able to be used in the underlying widget). Use the method toJson() in the LayoutOptions if you want to serialize all options to an JSON string.
Components and more
Documentation
Attributes (move mouse over the names to see data types)
Name Description
bindingAn EL expression referring to a server side UIComponent instance in a backing bean.Default is generated.
fullPageFull page layout mode.Default is true.
idUnique identifier of the component in a namingContainer.Default is generated.
maskPanesEarlyMask panes early during init.Default is false.
optionsLayout options (object or JSON string).
renderedBoolean value to specify the rendering of the component, when set to false component will not be rendered.Default is true.
resizerTipResizer tooltip.
sliderTipSlider tooltip.
stateSerialized layout state for server-side persistence.
stateCookiePersist state in cookie.Default is false.
styleInline style of the component.
styleClassStyle class of the component.
togglerTipClosedTooltip when toggler is closed.
togglerTipOpenTooltip when toggler is open.
widgetVarName of the client side widget.
PrimeFaces Extensions Showcase - © 2011-2025,PrimeFaces: 16.0.0-SNAPSHOT,PrimeFaces Extensions: 16.0.0-SNAPSHOT,JSF: Apache MyFaces Core 4.0 - Impl 4.0.3,Server: Apache Tomcat (TomEE)/10.1.52 (10.1.4),Build time: 2026-03-11 11:42