nextapp.echo.app
Class ContentPane

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.ContentPane

All Implemented Interfaces:

java.io.Serializable, Pane, PaneContainer, RenderIdSupport

public class ContentPane
extends Component
implements Pane, PaneContainer

ContentPane component: a high-level container/layout object which fills a region and optionally provides the capability to add FloatingPanes (e.g. WindowPanes) above that content. A ContentPane is often suitable for use as a base class to extend when creating a composite (pane) component. May contain at most one non- FloatinPane component as a child. May contain zero or more FloatingPane components as children.

A ContentPane may only be added to a Component which implements PaneContainer.

At most one Component that does NOT implement FloatingPane may be added to a ContentPane. Any number of FloatingPanes may be added as children.

See Also:

Serialized Form

Field Summary

static int	OVERFLOW_AUTO
static int	OVERFLOW_HIDDEN
static int	OVERFLOW_SCROLL
static java.lang.String	PROPERTY_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_HORIZONTAL_SCROLL
static java.lang.String	PROPERTY_INSETS
static java.lang.String	PROPERTY_OVERFLOW
static java.lang.String	PROPERTY_VERTICAL_SCROLL

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

ContentPane()
Creates a new ContentPane.

Method Summary

FillImage	getBackgroundImage() Returns the background image.
Extent	getHorizontalScroll() Returns the horizontal scrollbar position.
Insets	getInsets() Returns the inset margin of the content.
int	getOverflow() Returns the overflow state, describing how the pane will behave when the content is larger than display area.
Extent	getVerticalScroll() Returns the vertical scrollbar position.
boolean	isValidChild(Component child) Determines if a given Component is valid to be added as a child to this Component.
boolean	isValidParent(Component parent) Determines if this Component is valid to be added as a child of the given parent Component.
void	processInput(java.lang.String inputName, java.lang.Object inputValue) Processes client input specific to the Component received from the UpdateManager.
void	setBackgroundImage(FillImage newValue) Sets the background image.
void	setHorizontalScroll(Extent newValue) Sets the horizontal scrollbar position.
void	setInsets(Insets newValue) Sets the inset margin of the content.
void	setOverflow(int newValue) Sets the overflow state, describing how the pane will behave when the content is larger than display area.
void	setVerticalScroll(Extent newValue) Sets the vertical scrollbar position.

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, isVisible, 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_HORIZONTAL_SCROLL

public static final java.lang.String PROPERTY_HORIZONTAL_SCROLL

See Also:

Constant Field Values

PROPERTY_INSETS

public static final java.lang.String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_OVERFLOW

public static final java.lang.String PROPERTY_OVERFLOW

See Also:

Constant Field Values

PROPERTY_VERTICAL_SCROLL

public static final java.lang.String PROPERTY_VERTICAL_SCROLL

See Also:

Constant Field Values

OVERFLOW_AUTO

public static final int OVERFLOW_AUTO

See Also:

Constant Field Values

OVERFLOW_HIDDEN

public static final int OVERFLOW_HIDDEN

See Also:

Constant Field Values

OVERFLOW_SCROLL

public static final int OVERFLOW_SCROLL

See Also:

Constant Field Values

Constructor Detail

ContentPane

public ContentPane()

Creates a new ContentPane.

Method Detail

getBackgroundImage

public FillImage getBackgroundImage()

Returns the background image.

Returns:

the background image

getHorizontalScroll

public Extent getHorizontalScroll()

Returns the horizontal scrollbar position.

Returns:

the horizontal scrollbar position

getOverflow

public int getOverflow()

Returns the overflow state, describing how the pane will behave when the content is larger than display area.

Returns:

the overflow state, one of the following values:

• OVERFLOW_AUTO: provide scrollbars as necessary
• OVERFLOW_HIDDEN: never display scrollbars, hide overflow content
• OVERFLOW_SCROLL: always display scrollbars

getInsets

public Insets getInsets()

Returns the inset margin of the content. Note that FloatingPanes, such as WindowPanes, will NOT be constrained by this margin. Values may only be specified in pixel-based units.

Returns:

newValue the inset margin

getVerticalScroll

public Extent getVerticalScroll()

Returns the vertical scrollbar position.

Returns:

the vertical scrollbar position

isValidChild

public boolean isValidChild(Component child)

Description copied from class: Component

Determines if a given Component is valid to be added as a child to this Component. Default implementation always returns true, may be overridden to provide specific behavior.

Overrides:

isValidChild in class Component

Parameters:

child - the Component to evaluate as a child

Returns:

true if the Component is a valid child

See Also:

Component.isValidChild(nextapp.echo.app.Component)

isValidParent

public boolean isValidParent(Component parent)

Description copied from class: Component

Determines if this Component is valid to be added as a child of the given parent Component. Default implementation always returns true, may be overridden to provide specific behavior.

Overrides:

isValidParent in class Component

Parameters:

parent - the Component to evaluate as a parent

Returns:

true if the Component is a valid parent

See Also:

Component.isValidParent(nextapp.echo.app.Component)

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Description copied from class: Component

Processes client input specific to the Component received from the UpdateManager. Derivative implementations should take care to invoke super.processInput(). Security note: Because input to this method is likely from a remote client, it should be treated as potentially hostile. All input to this method should be carefully verified. For example, directly invoking set() method with the provided input would constitute a security hole.

Overrides:

processInput in class Component

Parameters:

inputName - the name of the input

inputValue - the value of the input

See Also:

Component.processInput(java.lang.String, java.lang.Object)

setBackgroundImage

public void setBackgroundImage(FillImage newValue)

Sets the background image.

Parameters:

newValue - the new background image

setHorizontalScroll

public void setHorizontalScroll(Extent newValue)

Sets the horizontal scrollbar position. Values must be in pixel units. A value of -1px indicates that the scrollbar should be positioned at the end of the range.

Parameters:

newValue - the new horizontal scrollbar position

setInsets

public void setInsets(Insets newValue)

Sets the inset margin of the content. Note that FloatingPanes, such as WindowPanes, will NOT be constrained by this margin. Values may only be specified in pixel-based units.

Parameters:

newValue - the new inset margin

setOverflow

public void setOverflow(int newValue)

Sets the overflow state, describing how the pane will behave when the content is larger than display area.

Parameters:

newValue - the overflow state, one of the following values:

• OVERFLOW_AUTO: provide scrollbars as necessary
• OVERFLOW_HIDDEN: never display scrollbars, hide overflow content
• OVERFLOW_SCROLL: always display scrollbars

setVerticalScroll

public void setVerticalScroll(Extent newValue)

Sets the vertical scrollbar position. Values must be in pixel units. A value of -1px indicates that the scrollbar should be positioned at the end of the range.

Parameters:

newValue - the new vertical scrollbar position