com.lowagie.text

Class Row

public class Row extends Object implements Element

A Row is part of a Table and contains some Cells.

All Rows are constructed by a Table-object. You don't have to construct any Row yourself. In fact you can't construct a Row outside the package.

Since a Cell can span several rows and/or columns a row can contain reserved space without any content.

See Also: Element Cell Table

Field Summary
protected Object[]cells
This is the array of Objects (Cell or Table).
protected intcolumns
This is the number of columns in the Row.
protected intcurrentColumn
This is a valid position the Row.
static intCELL
id of the Cell element in a Row
protected inthorizontalAlignment
This is the vertical alignment.
protected PropertiesmarkupAttributes
Contains extra markupAttributes
static intNULL
id of a null element in a Row
protected boolean[]reserved
This is the array that keeps track of reserved cells.
static intTABLE
id of the Table element in a Row
protected intverticalAlignment
This is the vertical alignment.
Constructor Summary
protected Row(int columns)
Constructs a Row with a certain number of columns.
Method Summary
intaddElement(Object element)
Adds a Cell to the Row.
intaddElement(Object element, int column)
Adds an element to the Row at the position given.
intcolumns()
Gets the number of columns.
voiddeleteColumn(int column)
Returns a Row that is a copy of this Row in which a certain column has been deleted.
ObjectgetCell(int column)
Gets a Cell or Table from a certain column.
ArrayListgetChunks()
Gets all the chunks in this element.
intgetElementID(int column)
Returns the type-id of the element in a Row.
intgetObjectID(Object element)
Returns the type-id of an Object.
inthorizontalAlignment()
Gets the horizontal alignment.
booleanisEmpty()
Checks if the row is empty.
booleanisReserved(int column)
Returns true/false when this position in the Row has been reserved, either filled or through a colspan of an Element.
static booleanisTag(String tag)
Checks if a given tag corresponds with this object.
booleanprocess(ElementListener listener)
Processes the element by adding it (or the different parts) to a ElementListener.
booleanreserve(int column)
Reserves a Cell in the Row.
booleanreserve(int column, int size)
Reserves a Cell in the Row.
voidsetElement(Object aElement, int column)
Puts Cell to the Row at the position given, doesn't reserve colspan.
voidsetHorizontalAlignment(int value)
Sets the horizontal alignment.
voidsetVerticalAlignment(int value)
Sets the vertical alignment.
inttype()
Gets the type of the text element.
intvalidPosition()
Gets the index of the current, valid position
intverticalAlignment()
Gets the vertical alignment.

Field Detail

cells

protected Object[] cells
This is the array of Objects (Cell or Table).

columns

protected int columns
This is the number of columns in the Row.

currentColumn

protected int currentColumn
This is a valid position the Row.

CELL

public static final int CELL
id of the Cell element in a Row

horizontalAlignment

protected int horizontalAlignment
This is the vertical alignment.

markupAttributes

protected Properties markupAttributes
Contains extra markupAttributes

NULL

public static final int NULL
id of a null element in a Row

reserved

protected boolean[] reserved
This is the array that keeps track of reserved cells.

TABLE

public static final int TABLE
id of the Table element in a Row

verticalAlignment

protected int verticalAlignment
This is the vertical alignment.

Constructor Detail

Row

protected Row(int columns)
Constructs a Row with a certain number of columns.

Parameters: columns a number of columns

Method Detail

addElement

int addElement(Object element)
Adds a Cell to the Row.

Parameters: element the element to add (currently only Cells and Tables supported)

Returns: the column position the Cell was added, or -1 if the element couldn't be added.

addElement

int addElement(Object element, int column)
Adds an element to the Row at the position given.

Parameters: element the element to add. (currently only Cells and Tables supported column the position where to add the cell.

Returns: the column position the Cell was added, or -1 if the Cell couldn't be added.

columns

public int columns()
Gets the number of columns.

Returns: a value

deleteColumn

void deleteColumn(int column)
Returns a Row that is a copy of this Row in which a certain column has been deleted.

Parameters: column the number of the column to delete

getCell

public Object getCell(int column)
Gets a Cell or Table from a certain column.

Parameters: column the column the Cell/Table is in.

Returns: the Cell,Table or Object if the column was reserved or null if empty.

getChunks

public ArrayList getChunks()
Gets all the chunks in this element.

Returns: an ArrayList

getElementID

int getElementID(int column)
Returns the type-id of the element in a Row.

Parameters: column the column of which you'd like to know the type

Returns: the type-id of the element in the row

getObjectID

int getObjectID(Object element)
Returns the type-id of an Object.

Parameters: element the object of which you'd like to know the type-id, -1 if invalid

Returns: the type-id of an object

horizontalAlignment

public int horizontalAlignment()
Gets the horizontal alignment.

Returns: a value

isEmpty

public boolean isEmpty()
Checks if the row is empty.

Returns: true if none of the columns is reserved.

isReserved

boolean isReserved(int column)
Returns true/false when this position in the Row has been reserved, either filled or through a colspan of an Element.

Parameters: column the column.

Returns: true if the column was reserved, false if not.

isTag

public static boolean isTag(String tag)
Checks if a given tag corresponds with this object.

Parameters: tag the given tag

Returns: true if the tag corresponds

process

public boolean process(ElementListener listener)
Processes the element by adding it (or the different parts) to a ElementListener.

Parameters: listener an ElementListener

Returns: true if the element was processed successfully

reserve

boolean reserve(int column)
Reserves a Cell in the Row.

Parameters: column the column that has to be reserved.

Returns: true if the column was reserved, false if not.

reserve

boolean reserve(int column, int size)
Reserves a Cell in the Row.

Parameters: column the column that has to be reserved. size the number of columns

Returns: true if the column was reserved, false if not.

setElement

void setElement(Object aElement, int column)
Puts Cell to the Row at the position given, doesn't reserve colspan.

Parameters: aElement the cell to add. column the position where to add the cell.

setHorizontalAlignment

public void setHorizontalAlignment(int value)
Sets the horizontal alignment.

Parameters: value the new value

setVerticalAlignment

public void setVerticalAlignment(int value)
Sets the vertical alignment.

Parameters: value the new value

type

public int type()
Gets the type of the text element.

Returns: a type

validPosition

int validPosition()
Gets the index of the current, valid position

Returns: a value

verticalAlignment

public int verticalAlignment()
Gets the vertical alignment.

Returns: a value