ag.ion.bion.officelayer.internal.text.table
Class TextTableCellReference

java.lang.Object
  ag.ion.bion.officelayer.internal.text.table.TextTableCellReference

public class TextTableCellReference
extends java.lang.Object

Reference to a text table cell or a range of text table cells.

Constructor Summary

TextTableCellReference(java.lang.String cellReferenceExpression)
Constructs new TextTableCellReference.

Method Summary

boolean	containsCell(int columnIndex, int rowIndex) Returns information whether this text table cell reference contains a cell with the submitted column and row index.
boolean	containsCell(java.lang.String cellName) Returns information whether this text table cell reference contains a cell with the submitted name.
boolean	containsColumn(int columnIndex) Returns information whether this text table cell reference contains the submitted column index
boolean	containsColumn(java.lang.String cellName) Returns information whether this text table cell reference contains the column of the submitted text table cell name.
boolean	containsColumnAfter(int columnIndex) Returns information whether this text table cell reference contains a column after the submitted column index.
boolean	containsColumnAfter(java.lang.String cellName) Returns information whether this text table cell reference contains a column after the submitted column of the text table cell name.
boolean	containsRow(int rowIndex) Returns information whether this text table cell reference contains a row with the submtted index.
boolean	containsRow(java.lang.String cellName) Returns information whether this text table cell reference contains the row of the submitted text table cell name.
boolean	containsRowAfter(int rowIndex) Returns information whether this text table cell reference contains a row after the submitted row index.
boolean	containsRowAfter(java.lang.String cellName) Returns information whether this text table cell reference contains a row after the row index of the submitted text table cell name.
void	extendColumnRange(int count) Extends text table cell reference range.
void	extendColumnRangeTo(int endColumnIndex) Extends text table cell range reference to submitted end column index.
void	extendRowRange(int count) Extends text table cell reference range.
void	extendRowRangeTo(int rowIndexTo) Extends text table cell reference range.
int	getEndColumnIndex() Returns end column index.
int	getEndRowIndex() Returns start row index.
java.lang.String	getStartColumnCharacter() Returns start column character.
int	getStartColumnIndex() Returns start column index.
int	getStartRowIndex() Returns start row index.
java.lang.String	getTableName() Returns name of the table to which the text table cell reference is bounded.
boolean	isModified() Returns information whether this text table cell reference was modified after the last toString() call.
boolean	isRangeReference() Returns information whether the text table cell reference is a range reference.
void	moveColumnIndex(int count) Moves column index.
void	moveRowIndex(int count) Moves row index.
void	setTableName(java.lang.String tableName) Bounds text table cell reference to the table with the submitted name.
void	toColumnRange(int startColumnIndex, int endColumnIndex) Extends text table cell reference to text table cell range reference on the basis of the submitted index informations.
java.lang.String	toString() Returns cell reference expression and resets the modified status.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextTableCellReference

public TextTableCellReference(java.lang.String cellReferenceExpression)
                       throws java.lang.IllegalArgumentException

Constructs new TextTableCellReference.

Parameters:

cellReferenceExpression - text table cell reference expression

Throws:

java.lang.IllegalArgumentException - if the submitted reference expression is not valid

Method Detail

isRangeReference

public boolean isRangeReference()

Returns information whether the text table cell reference is a range reference.

Returns:

information whether the text table cell reference is a range reference

getTableName

public java.lang.String getTableName()

Returns name of the table to which the text table cell reference is bounded. Returns null if no table is defined.

Returns:

name of the table to which the text table cell reference is bounded

containsCell

public boolean containsCell(java.lang.String cellName)

Returns information whether this text table cell reference contains a cell with the submitted name.

Parameters:

cellName - name of a text table cell

Returns:

informations whether this text table cell reference contains a cell with the submitted name

containsCell

public boolean containsCell(int columnIndex,
                            int rowIndex)

Returns information whether this text table cell reference contains a cell with the submitted column and row index.

Parameters:

columnIndex - column index of the text table cell

rowIndex - row index of the text table cell

Returns:

informations whether this text table cell reference contains a cell with the submitted column and row index

containsColumn

public boolean containsColumn(java.lang.String cellName)

Returns information whether this text table cell reference contains the column of the submitted text table cell name.

Parameters:

cellName - name of a text table cell

Returns:

informations whether this text table cell reference contains the column of the submitted text table cell name

containsColumn

public boolean containsColumn(int columnIndex)

Returns information whether this text table cell reference contains the submitted column index

Parameters:

columnIndex - index of a text table column

Returns:

informations whether this text table cell reference contains the submitted column index

containsRow

public boolean containsRow(java.lang.String cellName)

Returns information whether this text table cell reference contains the row of the submitted text table cell name.

Parameters:

cellName - name of a text table cell

Returns:

information whether this text table cell reference contains the row of the submitted text table cell name

containsRow

public boolean containsRow(int rowIndex)

Returns information whether this text table cell reference contains a row with the submtted index.

Parameters:

rowIndex - index of a row

Returns:

information whether this text table cell reference contains a row with the submtted index

containsColumnAfter

public boolean containsColumnAfter(java.lang.String cellName)

Returns information whether this text table cell reference contains a column after the submitted column of the text table cell name.

Parameters:

cellName - name of a text table cell

Returns:

information whether this text table cell reference contains a column after the submitted column of the text table cell name

containsColumnAfter

public boolean containsColumnAfter(int columnIndex)

Returns information whether this text table cell reference contains a column after the submitted column index.

Parameters:

columnIndex - index of column

Returns:

information whether this text table cell reference contains a column after the submitted column index

containsRowAfter

public boolean containsRowAfter(java.lang.String cellName)

Returns information whether this text table cell reference contains a row after the row index of the submitted text table cell name.

Parameters:

cellName - name of a text table cell

Returns:

information whether this text table cell reference contains a row after the row index of the submitted text table cell name

containsRowAfter

public boolean containsRowAfter(int rowIndex)

Returns information whether this text table cell reference contains a row after the submitted row index.

Parameters:

rowIndex - index of a row

Returns:

information whether this text table cell reference contains a row after the submitted row index

getStartColumnIndex

public int getStartColumnIndex()

Returns start column index.

Returns:

start column index

getStartColumnCharacter

public java.lang.String getStartColumnCharacter()

Returns start column character.

Returns:

start column character

getEndColumnIndex

public int getEndColumnIndex()

Returns end column index. If the text table cell reference is not a range the method will return the start column index.

Returns:

end column index

getStartRowIndex

public int getStartRowIndex()

Returns start row index.

Returns:

start row index

getEndRowIndex

public int getEndRowIndex()

Returns start row index. If the text table cell reference is not a range the method will return the start row index.

Returns:

start row index

setTableName

public void setTableName(java.lang.String tableName)

Bounds text table cell reference to the table with the submitted name.

Parameters:

tableName - name of a table to be used

moveColumnIndex

public void moveColumnIndex(int count)
                     throws TextException

Moves column index.

Parameters:

count - difference to be moved

Throws:

TextException - if the column index can not be moved

moveRowIndex

public void moveRowIndex(int count)
                  throws TextException

Moves row index.

Parameters:

count - difference to be moved

Throws:

TextException - if the row index can not be moved

toColumnRange

public void toColumnRange(int startColumnIndex,
                          int endColumnIndex)
                   throws TextException

Extends text table cell reference to text table cell range reference on the basis of the submitted index informations. The column range will be completely redefined.

Parameters:

startColumnIndex - start column index to be used

endColumnIndex - end column index to be used

Throws:

TextException - if the text table cell reference can not be extended

extendColumnRangeTo

public void extendColumnRangeTo(int endColumnIndex)
                         throws TextException

Extends text table cell range reference to submitted end column index.

Parameters:

endColumnIndex - end column index to be used

Throws:

TextException - if the column range can not be extended

extendColumnRange

public void extendColumnRange(int count)
                       throws TextException

Extends text table cell reference range. If the text table cell reference is not a range, a new one will be constructed.

Parameters:

count - column count to be used

Throws:

TextException - if the column range can not be extended

extendRowRangeTo

public void extendRowRangeTo(int rowIndexTo)
                      throws TextException

Extends text table cell reference range.

Parameters:

rowIndexTo - row index where the range has to end

Throws:

TextException - if the row range can not be extended

extendRowRange

public void extendRowRange(int count)
                    throws TextException

Extends text table cell reference range. If the text table cell reference is not a range, a new one will be constructed.

Parameters:

count - row count to be used

Throws:

TextException - if the row range can not be extended

isModified

public boolean isModified()

Returns information whether this text table cell reference was modified after the last toString() call.

Returns:

information whether this text table cell reference was modified

toString

public java.lang.String toString()

Returns cell reference expression and resets the modified status.

Overrides:

toString in class java.lang.Object

Returns:

cell reference expression