thinwire.ui
Class GridBox.Column

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<java.lang.Object>
          thinwire.util.ArrayGrid.Column
              thinwire.ui.GridBox.Column

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, Grid.Column

Enclosing class:

GridBox

public static final class GridBox.Column
extends ArrayGrid.Column

Nested Class Summary

static interface	GridBox.Column.Format
static class	GridBox.Column.SortOrder

Field Summary

static java.lang.String	PROPERTY_COLUMN_ALIGN_X
static java.lang.String	PROPERTY_COLUMN_DISPLAY_FORMAT
static java.lang.String	PROPERTY_COLUMN_NAME
static java.lang.String	PROPERTY_COLUMN_SORT_COMPARATOR
static java.lang.String	PROPERTY_COLUMN_SORT_ORDER
static java.lang.String	PROPERTY_COLUMN_VISIBLE
static java.lang.String	PROPERTY_COLUMN_WIDTH

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

GridBox.Column()
Construct a Column.

GridBox.Column(java.util.Collection<? extends java.lang.Object> c)
Construct a Column, specifying a Collection whose values will serve as the Column's values.

GridBox.Column(java.lang.Object... a)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, java.util.Collection<? extends java.lang.Object> c)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, int width, AlignTextComponent.AlignX alignX, java.util.Collection<? extends java.lang.Object> c)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, int width, AlignTextComponent.AlignX alignX, java.lang.Object... a)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, int width, java.util.Collection<? extends java.lang.Object> c)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, int width, java.lang.Object... a)
Construct a Column that contains the values of the specified Array.

GridBox.Column(java.lang.String name, boolean visible, java.lang.Object... a)
Construct a Column that contains the values of the specified Array.

Method Summary

AlignTextComponent.AlignX	getAlignX()
GridBox.Column.Format	getDisplayFormat()
GridBox.Header	getHeader() Gets the Header object instance for this Column.
java.util.Comparator	getSortComparator() Get this Column's Comparator.
GridBox.Column.SortOrder	getSortOrder()
int	getWidth()
boolean	isVisible() Gets whether this column is visible.
void	setAlignX(AlignTextComponent.AlignX alignX) Sets the text justification (left, right, or center)
void	setDisplayFormat(GridBox.Column.Format displayFormat) Set the display format for this Column.
void	setName(java.lang.String name) Sets the name of the column.
void	setSortComparator(java.util.Comparator sortComparator) Set the Comparator for this Column.
void	setSortOrder(GridBox.Column.SortOrder sortOrder)
void	setVisible(boolean visible) Sets whether this column is visible.
void	setWidth(int width) Sets the width of the column.
java.lang.String	toString()

Methods inherited from class thinwire.util.ArrayGrid.Column

add, get, getIndex, getName, getParent, remove, set, size

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, retainAll, subList, toArray, toArray

Field Detail

PROPERTY_COLUMN_NAME

public static final java.lang.String PROPERTY_COLUMN_NAME

See Also:

Constant Field Values

PROPERTY_COLUMN_ALIGN_X

public static final java.lang.String PROPERTY_COLUMN_ALIGN_X

See Also:

Constant Field Values

PROPERTY_COLUMN_WIDTH

public static final java.lang.String PROPERTY_COLUMN_WIDTH

See Also:

Constant Field Values

PROPERTY_COLUMN_VISIBLE

public static final java.lang.String PROPERTY_COLUMN_VISIBLE

See Also:

Constant Field Values

PROPERTY_COLUMN_DISPLAY_FORMAT

public static final java.lang.String PROPERTY_COLUMN_DISPLAY_FORMAT

See Also:

Constant Field Values

PROPERTY_COLUMN_SORT_COMPARATOR

public static final java.lang.String PROPERTY_COLUMN_SORT_COMPARATOR

See Also:

Constant Field Values

PROPERTY_COLUMN_SORT_ORDER

public static final java.lang.String PROPERTY_COLUMN_SORT_ORDER

See Also:

Constant Field Values

Constructor Detail

GridBox.Column

public GridBox.Column()

Construct a Column.

GridBox.Column

public GridBox.Column(java.util.Collection<? extends java.lang.Object> c)

Construct a Column, specifying a Collection whose values will serve as the Column's values.

Parameters:

c - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      java.util.Collection<? extends java.lang.Object> c)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      int width,
                      java.util.Collection<? extends java.lang.Object> c)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      int width,
                      AlignTextComponent.AlignX alignX,
                      java.util.Collection<? extends java.lang.Object> c)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.Object... a)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      java.lang.Object... a)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      int width,
                      java.lang.Object... a)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

GridBox.Column

public GridBox.Column(java.lang.String name,
                      boolean visible,
                      int width,
                      AlignTextComponent.AlignX alignX,
                      java.lang.Object... a)

Construct a Column that contains the values of the specified Array.

Parameters:

a - the new Column's values

Method Detail

getHeader

public GridBox.Header getHeader()

Gets the Header object instance for this Column.

Returns:

the Header object representing this Column.

isVisible

public boolean isVisible()

Gets whether this column is visible.

Returns:

true if the column is visible.

setVisible

public void setVisible(boolean visible)

Sets whether this column is visible.

Parameters:

visible - (Default = false)

setName

public void setName(java.lang.String name)

Sets the name of the column.

Specified by:

setName in interface Grid.Column

Overrides:

setName in class ArrayGrid.Column

Parameters:

name - the name of this Column

See Also:

Grid.Column.setName(java.lang.String)

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

Sets the width of the column.

Parameters:

width - the width of the column

Throws:

java.lang.IllegalArgumentException - if width < -1 or > 65534

getAlignX

public AlignTextComponent.AlignX getAlignX()

setAlignX

public void setAlignX(AlignTextComponent.AlignX alignX)

Sets the text justification (left, right, or center)

Parameters:

alignX - (Default = AlignX.LEFT)

getDisplayFormat

public GridBox.Column.Format getDisplayFormat()

setDisplayFormat

public void setDisplayFormat(GridBox.Column.Format displayFormat)

Set the display format for this Column. A Column's Displ

Parameters:

displayFormat - the display format to set for the column.

getSortComparator

public java.util.Comparator getSortComparator()

Get this Column's Comparator.

Returns:

this Column's Comparator

setSortComparator

public void setSortComparator(java.util.Comparator sortComparator)

Set the Comparator for this Column.

Parameters:

sortComparator - this Column's Comparator.

See Also:

Comparator

getSortOrder

public GridBox.Column.SortOrder getSortOrder()

setSortOrder

public void setSortOrder(GridBox.Column.SortOrder sortOrder)

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<java.lang.Object>