View Source

h2. Overview
_Since 4.3_

The {{ace:borderLayoutPane}} component component defines one of the five regions of an {{ace:borderLayout}} component. This component controls all aspects of a region in the BorderLayout, including sizes, state, and ajax events.

{tip}See the ICEfaces Showcase [Live Demo|http://icefaces-showcase.icesoft.org/showcase.jsf?grp=ace:borderLayout] of this component, complete with source code.{tip}

h2. Getting Started


An {{ace:borderLayoutPane}} component is always defined as a direct child of {{ace:borderLayout}}. The 'position' attribute is always required.
{panel}
{code:xml|borderStyle=dashed}
<h:form id="form">
<ace:borderLayout>
<ace:borderLayoutPane position="center" headerText="Center" footerText="(center footer)">
<h:outputText value="CENTER" />
</ace:borderLayoutPane>
</ace:borderLayout>
</h:form>
{code}
{panel}

As mentioned before, only the center pane is required. The others are optional. Other {{ace:borderLayout}}'s con be nested inside one or more of these panes, each with its own configuration and defined number of panes.

h2. Attributes

{tip:title=TagLib Documentation}This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available [here|http://www.icefaces.org/docs/v4_latest/ace/tld/ace/borderLayout.html].{tip}

{panel}
*position* The pane position that this component defines in the layout. Valid values are 'center', 'north', 'south', 'east', and 'west'. The center pane is required for the layout to work
{panel}

{panel}
*size* Specifies the size of the pane in pixels. For the north and south panes the size is the height, and for the east and west panes the size is the width. The size refers to the total size, including paddings and border widths. The value can be 'auto' for an appropriate, standard size for the pane. The default value is 'auto'.
{panel}

{panel}
*resizable* Specifies whether this pane is resizable or not. This attribute doesn't apply to the center pane. The default value is 'false'.
{panel}

{panel}
*closable* Specifies whether this pane can be closed or not. If true, a close button will be rendered at the upper right corner of the pane header. The default value is 'false'.
{panel}

{panel}
*toggleable* Specifies whether this pane can be collapsed/expanded or not. The default value is 'false'.
{panel}

{panel}
*visible* Specifies whether this pane starts out being visible or not. The default value is 'true'.
{panel}

{panel}
*collapsed* Specifies whether this pane starts out being collapsed or not. The default value is 'false'.
{panel}

{panel}
*headerText* The text to render in the header of the pane. If no header text is specified and no header facet is defined, the header will not be rendered.
{panel}

{panel}
*footerText* The text to render in the footer of the pane. If no footer text is specified and no footer facet is defined, the header will not be rendered.
{panel}

{panel}
*style* The style to apply to the main container of the layout."
{panel}

{panel}
*styleClass* The style class of the main container of the layout."
{panel}


h2. Client Behavior Events

| toggle | Fired when the pane is either collapsed or expanded. | org.icefaces.ace.event.ToggleEvent |
| close | Fired when the pane is closed | org.icefaces.ace.event.CloseEvent |


h2. JavaScript APIs

See the same section for [ace:borderLayout|BorderLayout|].

h2. Keyboard and ARIA Support

Ability to tab through the close and toggle buttons as well as button roles for them.

h2. Known Issues

An {{ace:borderLayout}} component inside an {{ace:tabSet}} is not displaying properly at the moment.