nextapp.echo
Class Column

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.Column

All Implemented Interfaces:

java.io.Serializable, Component

public class Column
extends AbstractComponent

A layout container component which arranges its children in a single column.

See Also:

Serialized Form

Field Summary

static java.lang.String	CELL_HEIGHT_CHANGED_PROPERTY
static java.lang.String	CELL_SPACING_CHANGED_PROPERTY
static java.lang.String	HEIGHT_EXTENT_CHANGED_PROPERTY
static java.lang.String	HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
static java.lang.String	STYLE_CELL_HEIGHT A style constant for the Cell Height property.
static java.lang.String	STYLE_CELL_SPACING A style constant for the Cell Spacing property.
static java.lang.String	STYLE_HEIGHT_EXTENT A style constant for the Height Extent property.
static java.lang.String	STYLE_HORIZONTAL_ALIGNMENT A style constant for the Horizontal Alignment property.
static java.lang.String	STYLE_VERTICAL_ALIGNMENT A style constant for the Vertical Alignment property.
static java.lang.String	STYLE_WIDTH_EXTENT A style constant for the Width Extent property.
static java.lang.String	VERTICAL_ALIGNMENT_CHANGED_PROPERTY
static java.lang.String	WIDTH_EXTENT_CHANGED_PROPERTY

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

Column()
Creates a new Column.

Method Summary

void	applyStyle(Style style) Sets stylistic properties of this component based on a Style object.
Extent	getCellHeight() Returns the height of a single cell of the container.
Extent	getCellSpacing() Returns the spacing between cells.
Extent	getHeightExtent() Returns the overall height of the container.
int	getHorizontalAlignment() Returns the horizontal alignment of the contents of cells of this container.
int	getVerticalAlignment() Returns the vertical alignment of the contents of cells of this container.
Extent	getWidthExtent() Returns the overall width of the container.
void	setCellHeight(Extent newValue) Sets the height of a single cell of the container.
void	setCellSpacing(Extent newValue) Sets the spacing between individual cells of the container.
void	setHeightExtent(Extent newValue) Sets the overall height of the container.
void	setHorizontalAlignment(int newValue) Sets the horizontal alignment of the contents of cells of this container.
void	setVerticalAlignment(int newValue) Sets the vertical alignment of the contents of cells of this container.
void	setWidthExtent(Extent newValue) Sets the overall width of the container.

Methods inherited from class nextapp.echo.AbstractComponent

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_CELL_HEIGHT

public static final java.lang.String STYLE_CELL_HEIGHT

A style constant for the Cell Height property. Values of this key must be of type nextapp.echo.Extent.

See Also:

Constant Field Values

STYLE_CELL_SPACING

public static final java.lang.String STYLE_CELL_SPACING

A style constant for the Cell Spacing property. Values of this key must be of type nextapp.echo.Extent.

See Also:

Constant Field Values

STYLE_HORIZONTAL_ALIGNMENT

public static final java.lang.String STYLE_HORIZONTAL_ALIGNMENT

A style constant for the Horizontal Alignment property. Values of this key must be of type java.lang.Integer.

See Also:

Constant Field Values

STYLE_VERTICAL_ALIGNMENT

public static final java.lang.String STYLE_VERTICAL_ALIGNMENT

A style constant for the Vertical Alignment property. Values of this key must be of type java.lang.Integer.

See Also:

Constant Field Values

STYLE_HEIGHT_EXTENT

public static final java.lang.String STYLE_HEIGHT_EXTENT

A style constant for the Height Extent property. Values of this key must be of type nextapp.echo.Extent.

See Also:

Constant Field Values

STYLE_WIDTH_EXTENT

public static final java.lang.String STYLE_WIDTH_EXTENT

A style constant for the Width Extent property. Values of this key must be of type nextapp.echo.Extent.

See Also:

Constant Field Values

CELL_HEIGHT_CHANGED_PROPERTY

public static final java.lang.String CELL_HEIGHT_CHANGED_PROPERTY

See Also:

Constant Field Values

CELL_SPACING_CHANGED_PROPERTY

public static final java.lang.String CELL_SPACING_CHANGED_PROPERTY

See Also:

Constant Field Values

HEIGHT_EXTENT_CHANGED_PROPERTY

public static final java.lang.String HEIGHT_EXTENT_CHANGED_PROPERTY

See Also:

Constant Field Values

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String VERTICAL_ALIGNMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

WIDTH_EXTENT_CHANGED_PROPERTY

public static final java.lang.String WIDTH_EXTENT_CHANGED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

Column

public Column()

Creates a new Column.

Method Detail

applyStyle

public void applyStyle(Style style)

Description copied from interface: Component

Sets stylistic properties of this component based on a Style object. The version of this method in Component will set foreground and background colors and the font from the style if they are present. Components should override this method if they allow more properties to be set from a style object, and should call super.applyStyle() if necessary.

Specified by:

applyStyle in interface Component

Overrides:

applyStyle in class AbstractComponent

Parameters:

style - The style object from which to retrieve properties for this Component.

See Also:

Component.applyStyle(Style)

getCellHeight

public Extent getCellHeight()

Returns the height of a single cell of the container.

Returns:

The height of a single cell of the container.

getCellSpacing

public Extent getCellSpacing()

Returns the spacing between cells.

Returns:

The spacing between cells.

getHeightExtent

public Extent getHeightExtent()

Returns the overall height of the container.

Returns:

The overall height of the container.

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment of the contents of cells of this container.

Returns:

The horizontal alignment of the contents of cells of this container, one of the following values:

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment of the contents of cells of this container.

Returns:

The vertical alignment of the contents of cells of this container, one of the following values:

• EchoConstants.TOP
• EchoConstants.CENTER (the default)
• EchoConstants.BOTTOM

getWidthExtent

public Extent getWidthExtent()

Returns the overall width of the container.

Returns:

The overall width of the container.

setCellHeight

public void setCellHeight(Extent newValue)

Sets the height of a single cell of the container.

Parameters:

newValue - The new height of a single cell of the container.

setCellSpacing

public void setCellSpacing(Extent newValue)

Sets the spacing between individual cells of the container.

Parameters:

newValue - The new cell spacing.

setHeightExtent

public void setHeightExtent(Extent newValue)

Sets the overall height of the container.

Parameters:

newValue - The new overall height.

setHorizontalAlignment

public void setHorizontalAlignment(int newValue)

Sets the horizontal alignment of the contents of cells of this container.

Parameters:

newValue - The horizontal alignment of the contents of cells of this container, one of the following values:

• EchoConstants.LEFT (the default)
• EchoConstants.CENTER
• EchoConstants.RIGHT

setVerticalAlignment

public void setVerticalAlignment(int newValue)

Sets the vertical alignment of the contents of cells of this container.

Parameters:

newValue - The vertical alignment of the contents of cells of this container, one of the following values:

• EchoConstants.TOP
• EchoConstants.CENTER (the default)
• EchoConstants.BOTTOM

setWidthExtent

public void setWidthExtent(Extent newValue)

Sets the overall width of the container.

Parameters:

newValue - The new overall width.