ag.ion.bion.officelayer.text.table
Interface ITextTableCellReferencesService

All Known Implementing Classes:

ETextTableCellReferencesService, TextTableCellReferencesService

public interface ITextTableCellReferencesService

Text table cell references service of a formula which was placed into a text table cell. Please consider that all modifications must be applied to the formula before they will become part of the expression. A single text table cell reference can only be modified one time, also if you call several modification methods. First after you have been applied the modifications, the text table cell reference can be modified again.

Method Summary

void	applyModifications() Applies cell reference modifications to the text table cell formula.
void	extendColumnAndRowReferences(java.lang.String cellName, int columnCount, int rowCount) Extends column and row references which have a reference to the submitted name of a text table cell.
void	extendColumnReferences(int columnIndex, int columnCount) Extends column references which have a reference to the submitted column index of a text table cell.
void	extendColumnReferences(int columnIndex, int columnCount, int[] exceptRows) Extends column references which have a reference to the submitted column index of a text table cell except references with the given row indices.
void	extendColumnReferences(java.lang.String cellName, int columnCount) Extends column references which have a reference to the column index of the submitted name of a text table cell.
void	extendRowReferences(int rowIndex, int rowCount) Extends row references which have a reference to the submitted row index of a text table cell.
void	extendRowReferences(int rowIndex, int[] rowIndicesTo) Extends row references which have a reference to the submitted row index of a text table cell.
void	extendRowReferences(int rowIndex, int rowCount, int[] exceptCols) Extends row references which have a reference to the submitted row index of a text table cell except references with the given column indices.
void	extendRowReferences(java.lang.String cellName, int rowCount) Extends row references which have a reference to the row index of the submitted name of a text table cell.
void	extendRowReferencesTo(int rowIndex, int rowIndexTo) Extends row references which have a reference to the submitted row index of a text table cell.
boolean	hasCellReferenceTo(java.lang.String cellName) Returns information whether this formula has a reference to a text table cell with the submitted name.
boolean	hasColumnReferenceAfter(int columnIndex) Returns information whether this formula has a reference to a column after the submitted column index.
boolean	hasColumnReferenceTo(int columnIndex) Returns information whether this formula has a reference to a column with the submitted index.
boolean	hasRowReferenceAfter(int rowIndex) Returns information whether this formula has a reference to a row after the submitted row index.
boolean	hasRowReferenceTo(int rowIndex) Returns information whether this formula has a reference to the submitted row index.
void	modifyCellReferences(int newColumnsStartIndex, int newColumnsCount, int newRowsStartIndex, int newRowsCount) Modifies all cell references on the basis of the submitted table expansion informations.
void	moveColumnReferences(int columnCount) Moves column references.
void	moveColumnReferences(int columnIndex, int columnCount) Moves column references which have a reference to the column with the submitted index.
void	moveColumnReferences(int columnIndex, int columnCount, int[] exceptRows) Moves column references which have a reference to the column with the submitted index except references with the given row indices.
void	moveColumnReferences(java.lang.String cellName, int columnCount) Moves column references which have a reference to the column of the submitted name of a text table cell.
void	moveColumnReferencesAfter(int columnIndex, int columnCount) Moves column references which have a reference to a column after the submitted index.
void	moveRowReferences(int rowCount) Moves row references.
void	moveRowReferences(int rowIndex, int rowCount) Moves row references which have a reference to the submitted row index.
void	moveRowReferences(int rowIndex, int rowCount, int[] exceptCols) Moves row references which have a reference to the submitted row index except references with the given column indices.
void	moveRowReferences(java.lang.String cellName, int rowCount) Moves row references which have a reference to the row index of the submitted name of a text table cell.
void	moveRowReferencesAfter(int rowIndex, int rowCount) Moves row references which have a reference to a row after the submitted index.
void	revertModelToOriginal() Reverts the model to the state before replacing cell references with method extendRowReferences().

Method Detail

hasCellReferenceTo

boolean hasCellReferenceTo(java.lang.String cellName)

Returns information whether this formula has a reference to a text table cell with the submitted name.

Parameters:

cellName - name of a text table cell

Returns:

informations whether this formula has a reference to a text table cell with the submitted name

hasColumnReferenceTo

boolean hasColumnReferenceTo(int columnIndex)

Returns information whether this formula has a reference to a column with the submitted index.

Parameters:

columnIndex - index of a column

Returns:

information whether this formula has a reference to a column with the submitted index

hasColumnReferenceAfter

boolean hasColumnReferenceAfter(int columnIndex)

Returns information whether this formula has a reference to a column after the submitted column index.

Parameters:

columnIndex - column index to be used

Returns:

information whether this formula has a reference to a column after the submitted column index

hasRowReferenceTo

boolean hasRowReferenceTo(int rowIndex)

Returns information whether this formula has a reference to the submitted row index.

Parameters:

rowIndex - index of row

Returns:

information whether this formula has a reference to the submitted row index

hasRowReferenceAfter

boolean hasRowReferenceAfter(int rowIndex)

Returns information whether this formula has a reference to a row after the submitted row index.

Parameters:

rowIndex - row index to be used

Returns:

information whether this formula has a reference to a row after the submitted row index

moveColumnReferences

void moveColumnReferences(int columnCount)
                          throws TextException

Moves column references. Use positive values in order to move the column references forward and negative values to move them backward.

Parameters:

columnCount - column index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveColumnReferences

void moveColumnReferences(java.lang.String cellName,
                          int columnCount)
                          throws TextException

Moves column references which have a reference to the column of the submitted name of a text table cell. Use positive values in order to move the column references forward and negative values to move them backward.

Parameters:

cellName - name of a text table cell

columnCount - column index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveColumnReferences

void moveColumnReferences(int columnIndex,
                          int columnCount)
                          throws TextException

Moves column references which have a reference to the column with the submitted index. Use positive values in order to move the column references forward and negative values to move them backward.

Parameters:

columnIndex - index of a column

columnCount - column index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveColumnReferences

void moveColumnReferences(int columnIndex,
                          int columnCount,
                          int[] exceptRows)
                          throws TextException

Moves column references which have a reference to the column with the submitted index except references with the given row indices. Use positive values in order to move the column references forward and negative values to move them backward.

Parameters:

columnIndex - index of a column

columnCount - column index difference to be moved

exceptRows - references to rows that are ignored

Throws:

TextException - if the text table cell references can not be moved

moveRowReferences

void moveRowReferences(int rowCount)
                       throws TextException

Moves row references. Use positive values in order to move the row references forward and negative values to move them backward.

Parameters:

rowCount - row index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveRowReferences

void moveRowReferences(java.lang.String cellName,
                       int rowCount)
                       throws TextException

Moves row references which have a reference to the row index of the submitted name of a text table cell. Use positive values in order to move the row references forward and negative values to move them backward.

Parameters:

cellName - name of a text table cell

rowCount - row index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveRowReferences

void moveRowReferences(int rowIndex,
                       int rowCount)
                       throws TextException

Moves row references which have a reference to the submitted row index. Use positive values in order to move the row references forward and negative values to move them backward.

Parameters:

rowIndex - row index to be used

rowCount - row index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveRowReferences

void moveRowReferences(int rowIndex,
                       int rowCount,
                       int[] exceptCols)
                       throws TextException

Moves row references which have a reference to the submitted row index except references with the given column indices. Use positive values in order to move the row references forward and negative values to move them backward.

Parameters:

rowIndex - row index to be used

rowCount - row index difference to be moved

exceptCols - references to columns that are ignored

Throws:

TextException - if the text table cell references can not be moved

moveColumnReferencesAfter

void moveColumnReferencesAfter(int columnIndex,
                               int columnCount)
                               throws TextException

Moves column references which have a reference to a column after the submitted index. Use positive values in order to move the column references forward and negative values to move them backward.

Parameters:

columnIndex - column index to be used

columnCount - column index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

moveRowReferencesAfter

void moveRowReferencesAfter(int rowIndex,
                            int rowCount)
                            throws TextException

Moves row references which have a reference to a row after the submitted index. Use positive values in order to move the row references forward and negative values to move them backward.

Parameters:

rowIndex - row index to be used

rowCount - row index difference to be moved

Throws:

TextException - if the text table cell references can not be moved

extendColumnReferences

void extendColumnReferences(java.lang.String cellName,
                            int columnCount)
                            throws TextException

Extends column references which have a reference to the column index of the submitted name of a text table cell.

Parameters:

cellName - name of a text table cell

columnCount - column index difference to be used

Throws:

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

extendColumnReferences

void extendColumnReferences(int columnIndex,
                            int columnCount)
                            throws TextException

Extends column references which have a reference to the submitted column index of a text table cell.

Parameters:

columnIndex - column index of a text table cell

columnCount - column index difference to be used

Throws:

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

extendColumnReferences

void extendColumnReferences(int columnIndex,
                            int columnCount,
                            int[] exceptRows)
                            throws TextException

Extends column references which have a reference to the submitted column index of a text table cell except references with the given row indices.

Parameters:

columnIndex - column index of a text table cell

columnCount - column index difference to be used

exceptRows - references to rows that are ignored

Throws:

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

extendRowReferences

void extendRowReferences(java.lang.String cellName,
                         int rowCount)
                         throws TextException

Extends row references which have a reference to the row index of the submitted name of a text table cell.

Parameters:

cellName - name of a text table cell

rowCount - row index difference to be used

Throws:

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

extendRowReferences

void extendRowReferences(int rowIndex,
                         int rowCount)
                         throws TextException

Extends row references which have a reference to the submitted row index of a text table cell.

Parameters:

rowIndex - row index of a text table cell

rowCount - row index difference to be used

Throws:

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

extendRowReferences

void extendRowReferences(int rowIndex,
                         int rowCount,
                         int[] exceptCols)
                         throws TextException

Extends row references which have a reference to the submitted row index of a text table cell except references with the given column indices.

Parameters:

rowIndex - row index of a text table cell

rowCount - row index difference to be used

exceptCols - references to columns that are ignored

Throws:

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

extendRowReferencesTo

void extendRowReferencesTo(int rowIndex,
                           int rowIndexTo)
                           throws TextException

Extends row references which have a reference to the submitted row index of a text table cell.

Parameters:

rowIndex - row index of a text table cell

rowIndexTo - the index of the row where the extension has to end

Throws:

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

extendRowReferences

void extendRowReferences(int rowIndex,
                         int[] rowIndicesTo)
                         throws TextException

Extends row references which have a reference to the submitted row index of a text table cell.

Parameters:

rowIndex - row index of a text table cell

rowIndicesTo - the indices of the rows that the extension has to contain

Throws:

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

revertModelToOriginal

void revertModelToOriginal()

Reverts the model to the state before replacing cell references with method extendRowReferences().

extendColumnAndRowReferences

void extendColumnAndRowReferences(java.lang.String cellName,
                                  int columnCount,
                                  int rowCount)
                                  throws TextException

Extends column and row references which have a reference to the submitted name of a text table cell.

Parameters:

cellName - name of a text table cell

columnCount - column index difference to be used

rowCount - row index difference to be used

Throws:

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

modifyCellReferences

void modifyCellReferences(int newColumnsStartIndex,
                          int newColumnsCount,
                          int newRowsStartIndex,
                          int newRowsCount)
                          throws TextException

Modifies all cell references on the basis of the submitted table expansion informations.

Parameters:

newColumnsStartIndex - start index of the new columns

newColumnsCount - number of new columns

newRowsStartIndex - start index of the new rows

newRowsCount - number of new rows

Throws:

TextException - if the text table cell references can not be modified

applyModifications

void applyModifications()
                        throws TextException

Applies cell reference modifications to the text table cell formula.

Throws:

TextException - if any error occurs.