nextapp.echo.app
Class Panel

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.Composite
          nextapp.echo.app.Panel

All Implemented Interfaces:

java.io.Serializable, PaneContainer, RenderIdSupport

public class Panel
extends Composite
implements PaneContainer

Panel component: a single child container. Provides a configurable border, margin, background image, and dimensions. May contain at most one child. May contain Pane components, and may be used as a means to add Pane components to containers which do not allow Pane components as children. In such a case it may be necessary to manually set the height property of the Panel itself.

See Also:

Serialized Form

Field Summary

static java.lang.String	PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_BORDER
static java.lang.String	PROPERTY_HEIGHT
static java.lang.String	PROPERTY_INSETS
static java.lang.String	PROPERTY_WIDTH

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

Panel()

Method Summary

FillImage	getBackgroundImage() Returns the background image.
Border	getBorder() Returns the Border that encloses the entire Column.
Extent	getHeight() Returns the height of the panel.
Insets	getInsets() Returns the default inset between the border and cells of the Column.
Extent	getWidth() Returns the width.
void	setBackgroundImage(FillImage newValue) Sets the background image.
void	setBorder(Border newValue) Sets the Border that encloses the entire Column.
void	setHeight(Extent newValue) Sets the height.
void	setInsets(Insets newValue) Sets the inset between the border and cells of the Column.
void	setWidth(Extent newValue) Sets the width.

Methods inherited from class nextapp.echo.app.Composite

isValidChild

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_BORDER

public static final java.lang.String PROPERTY_BORDER

See Also:

Constant Field Values

PROPERTY_INSETS

public static final java.lang.String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_WIDTH

public static final java.lang.String PROPERTY_WIDTH

See Also:

Constant Field Values

PROPERTY_HEIGHT

public static final java.lang.String PROPERTY_HEIGHT

See Also:

Constant Field Values

Constructor Detail

Panel

public Panel()

Method Detail

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image.

Returns:

the background image

getBorder

public Border getBorder()

Returns the Border that encloses the entire Column.

Returns:

the border

getHeight

public Extent getHeight()

Returns the height of the panel. If unset, the Panel will be sized by the height of its content, unless it contains a Pane component of indeterminate size. This property only supports Extents with fixed (i.e., not percent) units.

Returns:

the height

getInsets

public Insets getInsets()

Returns the default inset between the border and cells of the Column. This value will be overridden for a child component if a setting is specified in its ColumnLayoutData.

Returns:

the inset

getWidth

public Extent getWidth()

Returns the width. If unset, the Panel will expand to the width of its container.

Returns:

the width

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image.

Parameters:

newValue - the new background image

setBorder

public void setBorder(Border newValue)

Sets the Border that encloses the entire Column.

Parameters:

newValue - the new border

setHeight

public void setHeight(Extent newValue)

Sets the height. If unset, the Panel will be sized by the height of its content, unless it contains a Pane component of indeterminate size. This property only supports Extents with fixed (i.e., not percent) units.

Parameters:

newValue - the new height

setInsets

public void setInsets(Insets newValue)

Sets the inset between the border and cells of the Column. This value will be overridden for a child component if a setting is specified in its ColumnLayoutData.

Parameters:

newValue - the new inset

setWidth

public void setWidth(Extent newValue)

Sets the width. If unset, the Panel will expand to the width of its container.

Parameters:

newValue - the new width