org.icefaces.ace.component.borderlayout

Class BorderLayoutPaneBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.icefaces.ace.component.borderlayout.BorderLayoutPaneBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, IBorderLayoutPane

Direct Known Subclasses:

BorderLayoutPane

public abstract class BorderLayoutPaneBase
extends javax.faces.component.UIPanel
implements IBorderLayoutPane, IceClientBehaviorHolder

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BorderLayoutPaneBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
BorderLayoutPaneBase()

Method Summary

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
int	getBorderWidth() Return the value of the borderWidth property.
int	getCollapseSize() Return the value of the collapseSize property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.lang.String	getEffect() Return the value of the effect property.
int	getEffectLength() Return the value of the effectLength property.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
javax.faces.component.UIComponent	getFooterFacet() Return the value of the footer facet property.
java.lang.String	getFooterText() Return the value of the footerText property.
javax.faces.component.UIComponent	getHeaderFacet() Return the value of the header facet property.
java.lang.String	getHeaderText() Return the value of the headerText property.
java.lang.String	getListenerArgument(java.lang.String event)
int	getMaxSize() Return the value of the maxSize property.
int	getMinSize() Return the value of the minSize property.
java.lang.String	getPosition() Return the value of the position property.
java.lang.String	getSize() Return the value of the size property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getToggleButtonPosition() Return the value of the toggleButtonPosition property.
boolean	isClosable() Return the value of the closable property.
boolean	isCollapsed() Return the value of the collapsed property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isResizable() Return the value of the resizable property.
boolean	isToggleable() Return the value of the toggleable property.
boolean	isVisible() Return the value of the visible property.
void	setBorderWidth(int borderWidth) Set the value of the borderWidth property.
void	setClosable(boolean closable) Set the value of the closable property.
void	setCollapsed(boolean collapsed) Set the value of the collapsed property.
void	setCollapseSize(int collapseSize) Set the value of the collapseSize property.
void	setEffect(java.lang.String effect) Set the value of the effect property.
void	setEffectLength(int effectLength) Set the value of the effectLength property.
void	setFooterFacet(javax.faces.component.UIComponent footer) Set the value of the footer facet property.
void	setFooterText(java.lang.String footerText) Set the value of the footerText property.
void	setHeaderFacet(javax.faces.component.UIComponent header) Set the value of the header facet property.
void	setHeaderText(java.lang.String headerText) Set the value of the headerText property.
void	setMaxSize(int maxSize) Set the value of the maxSize property.
void	setMinSize(int minSize) Set the value of the minSize property.
void	setPosition(java.lang.String position) Set the value of the position property.
void	setResizable(boolean resizable) Set the value of the resizable property.
void	setSize(java.lang.String size) Set the value of the size property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setToggleable(boolean toggleable) Set the value of the toggleable property.
void	setToggleButtonPosition(java.lang.String toggleButtonPosition) Set the value of the toggleButtonPosition property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setVisible(boolean visible) Set the value of the visible property.

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

BorderLayoutPaneBase

public BorderLayoutPaneBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

setBorderWidth

public void setBorderWidth(int borderWidth)

Set the value of the borderWidth property.

Contents: Specifies the width in pixels of the resizable borders. This attribute doesn't apply to the center pane.

Specified by:

setBorderWidth in interface IBorderLayoutPane

getBorderWidth

public int getBorderWidth()

Return the value of the borderWidth property.

Contents: Specifies the width in pixels of the resizable borders. This attribute doesn't apply to the center pane. Default = '5'.

Specified by:

getBorderWidth in interface IBorderLayoutPane

setClosable

public void setClosable(boolean closable)

Set the value of the closable property.

Contents: 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.

Specified by:

setClosable in interface IBorderLayoutPane

isClosable

public boolean isClosable()

Return the value of the closable property.

Contents: 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. Default = 'false'.

Specified by:

isClosable in interface IBorderLayoutPane

setCollapseSize

public void setCollapseSize(int collapseSize)

Set the value of the collapseSize property.

Contents: Specifies the width in pixels of the border when this pane is collapsed. This attribute doesn't apply to the center pane.

Specified by:

setCollapseSize in interface IBorderLayoutPane

getCollapseSize

public int getCollapseSize()

Return the value of the collapseSize property.

Contents: Specifies the width in pixels of the border when this pane is collapsed. This attribute doesn't apply to the center pane. Default = '20'.

Specified by:

getCollapseSize in interface IBorderLayoutPane

setCollapsed

public void setCollapsed(boolean collapsed)

Set the value of the collapsed property.

Contents: Specifies whether this pane starts out being collapsed or not.

Specified by:

setCollapsed in interface IBorderLayoutPane

isCollapsed

public boolean isCollapsed()

Return the value of the collapsed property.

Contents: Specifies whether this pane starts out being collapsed or not. Default = 'false'.

Specified by:

isCollapsed in interface IBorderLayoutPane

setEffect

public void setEffect(java.lang.String effect)

Set the value of the effect property.

Contents: Specifies the name of the effect to use when collapsing and expanding the pane. Possible values are "slide", "drop", "scale", and "none".

Specified by:

setEffect in interface IBorderLayoutPane

getEffect

public java.lang.String getEffect()

Return the value of the effect property.

Contents: Specifies the name of the effect to use when collapsing and expanding the pane. Possible values are "slide", "drop", "scale", and "none". Default = 'slide'.

Specified by:

getEffect in interface IBorderLayoutPane

setEffectLength

public void setEffectLength(int effectLength)

Set the value of the effectLength property.

Contents: Specifies the length of the effect in milliseconds.

Specified by:

setEffectLength in interface IBorderLayoutPane

getEffectLength

public int getEffectLength()

Return the value of the effectLength property.

Contents: Specifies the length of the effect in milliseconds. Default = '400'.

Specified by:

getEffectLength in interface IBorderLayoutPane

setFooterText

public void setFooterText(java.lang.String footerText)

Set the value of the footerText property.

Contents: 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.

Specified by:

setFooterText in interface IBorderLayoutPane

getFooterText

public java.lang.String getFooterText()

Return the value of the footerText property.

Contents: 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.

Specified by:

getFooterText in interface IBorderLayoutPane

setHeaderText

public void setHeaderText(java.lang.String headerText)

Set the value of the headerText property.

Contents: 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.

Specified by:

setHeaderText in interface IBorderLayoutPane

getHeaderText

public java.lang.String getHeaderText()

Return the value of the headerText property.

Contents: 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.

Specified by:

getHeaderText in interface IBorderLayoutPane

setMaxSize

public void setMaxSize(int maxSize)

Set the value of the maxSize property.

Contents: Specifies 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.

Specified by:

setMaxSize in interface IBorderLayoutPane

getMaxSize

public int getMaxSize()

Return the value of the maxSize property.

Contents: Specifies 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'.

Specified by:

getMaxSize in interface IBorderLayoutPane

setMinSize

public void setMinSize(int minSize)

Set the value of the minSize property.

Contents: Specifies 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.

Specified by:

setMinSize in interface IBorderLayoutPane

getMinSize

public int getMinSize()

Return the value of the minSize property.

Contents: Specifies 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'.

Specified by:

getMinSize in interface IBorderLayoutPane

setPosition

public void setPosition(java.lang.String position)

Set the value of the position property.

Contents: 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.

Specified by:

setPosition in interface IBorderLayoutPane

getPosition

public java.lang.String getPosition()

Return the value of the position property.

Contents: 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.

Specified by:

getPosition in interface IBorderLayoutPane

setResizable

public void setResizable(boolean resizable)

Set the value of the resizable property.

Contents: Specifies whether this pane is resizable or not. This attribute doesn't apply to the center pane.

Specified by:

setResizable in interface IBorderLayoutPane

isResizable

public boolean isResizable()

Return the value of the resizable property.

Contents: Specifies whether this pane is resizable or not. This attribute doesn't apply to the center pane. Default = 'false'.

Specified by:

isResizable in interface IBorderLayoutPane

setSize

public void setSize(java.lang.String size)

Set the value of the size property.

Contents: 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.

Specified by:

setSize in interface IBorderLayoutPane

getSize

public java.lang.String getSize()

Return the value of the size property.

Contents: 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. Default = 'auto'.

Specified by:

getSize in interface IBorderLayoutPane

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style to apply to the content container of the pane (i.e. excluding the header and the footer).

Specified by:

setStyle in interface IBorderLayoutPane

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style to apply to the content container of the pane (i.e. excluding the header and the footer).

Specified by:

getStyle in interface IBorderLayoutPane

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Style class of the main container of the pane (the one containing the header, content and footer).

Specified by:

setStyleClass in interface IBorderLayoutPane

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Style class of the main container of the pane (the one containing the header, content and footer).

Specified by:

getStyleClass in interface IBorderLayoutPane

setToggleButtonPosition

public void setToggleButtonPosition(java.lang.String toggleButtonPosition)

Set the value of the toggleButtonPosition property.

Contents: Specifies where to place the toggle button in the header. Valid values are "right" and "left".

Specified by:

setToggleButtonPosition in interface IBorderLayoutPane

getToggleButtonPosition

public java.lang.String getToggleButtonPosition()

Return the value of the toggleButtonPosition property.

Contents: Specifies where to place the toggle button in the header. Valid values are "right" and "left". Default = 'right'.

Specified by:

getToggleButtonPosition in interface IBorderLayoutPane

setToggleable

public void setToggleable(boolean toggleable)

Set the value of the toggleable property.

Contents: Specifies whether this pane can be collapsed/expanded or not.

Specified by:

setToggleable in interface IBorderLayoutPane

isToggleable

public boolean isToggleable()

Return the value of the toggleable property.

Contents: Specifies whether this pane can be collapsed/expanded or not. Default = 'false'.

Specified by:

isToggleable in interface IBorderLayoutPane

setVisible

public void setVisible(boolean visible)

Set the value of the visible property.

Contents: Specifies whether this pane starts out being visible or not.

Specified by:

setVisible in interface IBorderLayoutPane

isVisible

public boolean isVisible()

Return the value of the visible property.

Contents: Specifies whether this pane starts out being visible or not. Default = 'true'.

Specified by:

isVisible in interface IBorderLayoutPane

setFooterFacet

public void setFooterFacet(javax.faces.component.UIComponent footer)

Set the value of the footer facet property.

getFooterFacet

public javax.faces.component.UIComponent getFooterFacet()

Return the value of the footer facet property.

setHeaderFacet

public void setHeaderFacet(javax.faces.component.UIComponent header)

Set the value of the header facet property.

getHeaderFacet

public javax.faces.component.UIComponent getHeaderFacet()

Return the value of the header facet property.

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase