ICEfaces-EE ACE Components
Tag borderLayoutPane


The BorderLayoutPane component defines one of the five regions of a BorderLayout component. This component controls all aspects of a region in the BorderLayout, including sizes, state, and ajax events.

For more information, see the BorderLayoutPane Wiki Documentation.


Facets
header
footer


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
toggleFired when the pane is either collapsed or expanded.org.icefaces.ace.event.ToggleEventexecute=@this render=@all
closeFired when the pane is closed.org.icefaces.ace.event.CloseEventexecute=@this render=@all
resizeFired when the pane is resized (Note that getSize() on the event object returns an int value, representing the new pane size in pixels, while the size attribute of this component must be of type String).org.icefaces.ace.event.ResizePaneEventexecute=@this render=@none
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.borderlayout.BorderLayoutPaneTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
borderWidthnotrueintSpecifies the width in pixels of the resizable borders. This attribute doesn't apply to the center pane. Default = '5'.
closablenotruebooleanSpecifies 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. Default = 'false'.
collapseSizenotrueintSpecifies the width in pixels of the border when this pane is collapsed. This attribute doesn't apply to the center pane. Default = '20'.
collapsednotruebooleanSpecifies whether this pane starts out being collapsed or not. Default = 'false'.
effectnotruejava.lang.StringSpecifies the name of the effect to use when collapsing and expanding the pane. Possible values are "slide", "drop", "scale", and "none". Default = 'slide'.
effectLengthnotrueintSpecifies the length of the effect in milliseconds. Default = '400'.
footerTextnotruejava.lang.StringThe 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.
headerTextnotruejava.lang.StringThe 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.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
maxSizenotrueintSpecifies the maximum size of the pane in pixels, meaning that it cannot be resized to a larger size than this. 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. A value of 0 indicates no set limit. Default = '0'.
minSizenotrueintSpecifies the minumum size of the pane in pixels, meaning that it cannot be resized to a smaller size than this. 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. Default = '100'.
positionnotruejava.lang.StringThe 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.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
resizablenotruebooleanSpecifies whether this pane is resizable or not. This attribute doesn't apply to the center pane. Default = 'false'.
sizenotruejava.lang.StringSpecifies 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. Default = 'auto'.
stylenotruejava.lang.StringStyle to apply to the content container of the pane (i.e. excluding the header and the footer).
styleClassnotruejava.lang.StringStyle class of the main container of the pane (the one containing the header, content and footer).
toggleButtonPositionnotruejava.lang.StringSpecifies where to place the toggle button in the header. Valid values are "right" and "left". Default = 'right'.
toggleablenotruebooleanSpecifies whether this pane can be collapsed/expanded or not. Default = 'false'.
visiblenotruebooleanSpecifies whether this pane starts out being visible or not. Default = 'true'.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.