Package org.apache.pivot.wtk

Class TablePane.Row

java.lang.Object

org.apache.pivot.wtk.TablePane.Row

All Implemented Interfaces:

java.lang.Iterable<Component>, Sequence<Component>

Enclosing class:

TablePane

public static class TablePane.Row
extends java.lang.Object
implements Sequence<Component>, java.lang.Iterable<Component>

Represents a table pane row.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

Sequence.Tree<T>

Constructor Summary

Constructors

Constructor	Description
Row()
Row(int height)
Row(int height, boolean relative)
Row(int height, boolean relative, boolean highlighted)
Row(TablePane tablePane)
Row(TablePane tablePane, int height)
Row(TablePane tablePane, int height, boolean relative)
Row(TablePane tablePane, int height, boolean relative, boolean highlighted)

Method Summary

Modifier and Type	Method	Description
int	add(Component component)	Adds an item to the sequence.
Component	get(int index)	Retrieves the item at the given index.
int	getHeight()	Returns the row height.
int	getLength()	Returns the length of the sequence.
TablePane	getTablePane()	Returns the table pane with which this row is associated.
int	indexOf(Component component)	Returns the index of an item in the sequence.
void	insert(Component component, int index)	Inserts an item into the sequence at a specific index.
boolean	isHighlighted()	Returns the highlighted flag.
boolean	isRelative()	Returns the relative flag.
java.util.Iterator<Component>	iterator()
Sequence<Component>	remove(int index, int count)	Removes one or more items from the sequence.
int	remove(Component component)	Removes the first occurrence of the given item from the sequence.
void	setHeight(int height)	Set the row height.
void	setHeight(int height, boolean relative)	Sets the row height.
void	setHeight(java.lang.String height)	Set the row height.
void	setHighlighted(boolean highlighted)	Sets the highlighted flag.
Component	update(int index, Component component)	Updates the item at the given index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.pivot.collections.Sequence

addAll, addAll

Constructor Detail

Row

public Row()

Row

public Row(int height)

Row

public Row(int height,
           boolean relative)

Row

public Row(int height,
           boolean relative,
           boolean highlighted)

Row

public Row(TablePane tablePane)

Row

public Row(TablePane tablePane,
           int height)

Row

public Row(TablePane tablePane,
           int height,
           boolean relative)

Row

public Row(TablePane tablePane,
           int height,
           boolean relative,
           boolean highlighted)

Method Detail

getTablePane

public TablePane getTablePane()

Returns the table pane with which this row is associated.

Returns:

The row's table pane, or null if the row does not currently belong to a table.

getHeight

public int getHeight()

Returns the row height.

Returns:

The height of the row.

isRelative

public boolean isRelative()

Returns the relative flag.

Returns:

true if the row height is relative, false if it is fixed.

setHeight

public void setHeight(int height)

Set the row height.

Parameters:

height - The absolute height of the row.

setHeight

public void setHeight(java.lang.String height)

Set the row height.

Parameters:

height - The encoded height of the row. If the string ends with the '*' character, it is treated as a relative value. Otherwise, it is considered an absolute value.

setHeight

public void setHeight(int height,
                      boolean relative)

Sets the row height.

Parameters:

height - The height of the row.

relative - true if the row height is relative, false if it is fixed.

isHighlighted

public boolean isHighlighted()

Returns the highlighted flag.

Returns:

true if the row is highlighted, false if it is not

setHighlighted

public void setHighlighted(boolean highlighted)

Sets the highlighted flag.

Parameters:

highlighted - true to set the row as highlighted, false to set it as not highlighted

add

public int add(Component component)

Description copied from interface: Sequence

Adds an item to the sequence.

Specified by:

add in interface Sequence<Component>

Parameters:

component - The item to be added to the sequence.

Returns:

The index at which the item was added, or -1 if the item was not added to the sequence.

insert

public void insert(Component component,
                   int index)

Description copied from interface: Sequence

Inserts an item into the sequence at a specific index.

Specified by:

insert in interface Sequence<Component>

Parameters:

component - The item to be added to the sequence.

index - The index at which the item should be inserted. Must be a value between 0 and getLength().

update

public Component update(int index,
                        Component component)

Description copied from interface: Sequence

Updates the item at the given index.

Specified by:

update in interface Sequence<Component>

Parameters:

index - The index of the item to update.

component - The item that will replace any existing value at the given index.

Returns:

The item that was previously stored at the given index.

remove

public int remove(Component component)

Description copied from interface: Sequence

Removes the first occurrence of the given item from the sequence.

Specified by:

remove in interface Sequence<Component>

Parameters:

component - The item to remove.

Returns:

The index of the item that was removed, or -1 if the item could not be found.

See Also:

Sequence.remove(int, int)

remove

public Sequence<Component> remove(int index,
                                  int count)

Description copied from interface: Sequence

Removes one or more items from the sequence.

Specified by:

remove in interface Sequence<Component>

Parameters:

index - The starting index to remove.

count - The number of items to remove, beginning with index.

Returns:

A sequence containing the items that were removed.

get

public Component get(int index)

Description copied from interface: Sequence

Retrieves the item at the given index.

Specified by:

get in interface Sequence<Component>

Parameters:

index - The index of the item to retrieve.

Returns:

The item at this index in the sequence.

indexOf

public int indexOf(Component component)

Description copied from interface: Sequence

Returns the index of an item in the sequence.

Specified by:

indexOf in interface Sequence<Component>

Parameters:

component - The item to locate.

Returns:

The index of first occurrence of the item if it exists in the sequence; -1, otherwise.

getLength

public int getLength()

Description copied from interface: Sequence

Returns the length of the sequence.

Specified by:

getLength in interface Sequence<Component>

Returns:

The number of items in the sequence.

iterator

public java.util.Iterator<Component> iterator()

Specified by:

iterator in interface java.lang.Iterable<Component>