com.spire.doc.interfaces
Interface ITable

All Superinterfaces:

ICompositeObject, IDocumentObject

All Known Implementing Classes:

Table

public interface ITable
extends ICompositeObject

Represents a table in a document.

Method Summary

TableRow	addRow() Adds a new row to table.
TableRow	addRow(boolean isCopyFormat) Adds new row to table.
TableRow	addRow(boolean isCopyFormat, boolean autoPopulateCells) Adds a row to table with copy format option
void	applyHorizontalMerge(int rowIndex, int startCellIndex, int endCellIndex) Applies horizontal merging for cells of table row.
void	applyVerticalMerge(int columnIndex, int startRowIndex, int endRowIndex) Applies the vertical merge for table cells.
TableCell	get(int row, int column) Gets cell by row/column indexes.
TableRow	getFirstRow() Gets the last row in table.
float	getIndentFromLeft() Gets indent from left for the table.
TableCell	getLastCell() Gets the last cell in last row.
TableRow	getLastRow() Gets the last row in table.
RowCollection	getRows() Gets row collection.
RowFormat	getTableFormat() Gets the table format.
float	getWidth() Returns table width.
void	removeAbsPosition() Removes the absolute position data.
void	resetCells(int rowsNum, int columnsNum) Resets rows / columns numbers.
void	resetCells(int rowsNum, int columnsNum, RowFormat format, float cellWidth) Resets rows / columns numbers.
void	setIndentFromLeft(float value) Sets indent from left for the table.

Methods inherited from interface com.spire.doc.interfaces.ICompositeObject

getChildObjects

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Method Detail

getRows

RowCollection getRows()

Gets row collection.

getTableFormat

RowFormat getTableFormat()

Gets the table format.

Returns:

the table format.

getLastCell

TableCell getLastCell()

Gets the last cell in last row.

Returns:

The cell

getFirstRow

TableRow getFirstRow()

Gets the last row in table.

Returns:

The row

getLastRow

TableRow getLastRow()

Gets the last row in table.

Returns:

The row

get

TableCell get(int row,
              int column)

Gets cell by row/column indexes.

Parameters:

row - The index of the specified row

column - The index of the specified column

Returns:

The cell

getWidth

float getWidth()

Returns table width.

Returns:

The width

addRow

TableRow addRow()

Adds a new row to table.

Returns:

The row

addRow

TableRow addRow(boolean isCopyFormat)

Adds new row to table.

Parameters:

isCopyFormat - Copy the format from the previous row or NOT

Returns:

The row

addRow

TableRow addRow(boolean isCopyFormat,
                boolean autoPopulateCells)

Adds a row to table with copy format option

Parameters:

isCopyFormat - indicates whether copy format from previous row or not

autoPopulateCells - if it specifies auto populate cells, set to true.

Returns:

The row

resetCells

void resetCells(int rowsNum,
                int columnsNum)

Resets rows / columns numbers.

Parameters:

rowsNum - the rows number.

columnsNum - the columns number.

resetCells

void resetCells(int rowsNum,
                int columnsNum,
                RowFormat format,
                float cellWidth)

Resets rows / columns numbers.

Parameters:

rowsNum - the rows num.

columnsNum - the columns num.

format - the format.

cellWidth - width of the cell.

applyVerticalMerge

void applyVerticalMerge(int columnIndex,
                        int startRowIndex,
                        int endRowIndex)

Applies the vertical merge for table cells.

Parameters:

columnIndex - index of the column.

startRowIndex - start index of the row.

endRowIndex - end index of the row.

applyHorizontalMerge

void applyHorizontalMerge(int rowIndex,
                          int startCellIndex,
                          int endCellIndex)

Applies horizontal merging for cells of table row.

Parameters:

rowIndex - index of the row.

startCellIndex - start index of the cell.

endCellIndex - end index of the cell.

getIndentFromLeft

float getIndentFromLeft()

Gets indent from left for the table.

Returns:

The indent

setIndentFromLeft

void setIndentFromLeft(float value)

Sets indent from left for the table.

Parameters:

value - The indent

removeAbsPosition

void removeAbsPosition()

Removes the absolute position data. If table has absolute position in the document, all position data will be erased.