org.apache.pivot.wtk
Class TablePane.Row

java.lang.Object
  extended by org.apache.pivot.wtk.TablePane.Row
All Implemented Interfaces:
Iterable<Component>, org.apache.pivot.collections.Sequence<Component>
Enclosing class:
TablePane

public static class TablePane.Row
extends Object
implements org.apache.pivot.collections.Sequence<Component>, Iterable<Component>

Represents a table pane row.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence
org.apache.pivot.collections.Sequence.Tree<T>
 
Constructor Summary
TablePane.Row()
           
TablePane.Row(int height)
           
TablePane.Row(int height, boolean relative)
           
TablePane.Row(int height, boolean relative, boolean highlighted)
           
 
Method Summary
 int add(Component component)
           
 Component get(int index)
           
 int getHeight()
          Returns the row height.
 int getLength()
           
 TablePane getTablePane()
          Returns the table pane with which this row is associated.
 int indexOf(Component component)
           
 void insert(Component component, int index)
           
 boolean isHighlighted()
          Returns the highlighted flag.
 boolean isRelative()
          Returns the relative flag.
 Iterator<Component> iterator()
           
 int remove(Component component)
           
 org.apache.pivot.collections.Sequence<Component> remove(int index, int count)
           
 void setHeight(int height)
          Set the row height.
 void setHeight(int height, boolean relative)
          Sets the row height.
 void setHeight(String height)
          Set the row height.
 void setHighlighted(boolean highlighted)
          Sets the highlighted flag.
 Component update(int index, Component component)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TablePane.Row

public TablePane.Row()

TablePane.Row

public TablePane.Row(int height)

TablePane.Row

public TablePane.Row(int height,
                     boolean relative)

TablePane.Row

public TablePane.Row(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(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)
Specified by:
add in interface org.apache.pivot.collections.Sequence<Component>

insert

public void insert(Component component,
                   int index)
Specified by:
insert in interface org.apache.pivot.collections.Sequence<Component>

update

public Component update(int index,
                        Component component)
Specified by:
update in interface org.apache.pivot.collections.Sequence<Component>

remove

public int remove(Component component)
Specified by:
remove in interface org.apache.pivot.collections.Sequence<Component>

remove

public org.apache.pivot.collections.Sequence<Component> remove(int index,
                                                               int count)
Specified by:
remove in interface org.apache.pivot.collections.Sequence<Component>

get

public Component get(int index)
Specified by:
get in interface org.apache.pivot.collections.Sequence<Component>

indexOf

public int indexOf(Component component)
Specified by:
indexOf in interface org.apache.pivot.collections.Sequence<Component>

getLength

public int getLength()
Specified by:
getLength in interface org.apache.pivot.collections.Sequence<Component>

iterator

public Iterator<Component> iterator()
Specified by:
iterator in interface Iterable<Component>