ag.ion.bion.officelayer.text
Interface ITextTableCell

All Superinterfaces:

ICloneServiceProvider, ITextComponent

All Known Implementing Classes:

TextTableCell

public interface ITextTableCell
extends ITextComponent, ICloneServiceProvider

Cell of a table in a text document.

Field Summary

static java.lang.String	STYLE_TABLE_CONTENT The paragraph style for the table content
static java.lang.String	STYLE_TABLE_HEADER The paragraph style for the table header
static int	TYPE_EMPTY The cell is empty.
static int	TYPE_FORMULA The cell contains a formula.
static int	TYPE_TEXT The cell conains text.
static int	TYPE_VALUE The cell contains a value.

Method Summary

java.lang.String	getCellParagraphStyle() Returns style of the cell paragraph, or null if not available.
ITextTableCellPropertyStore	getCellPropertyStore(int verticalPosition, int horizontalPosition) Returns the property store of this cell.
ICharacterProperties	getCharacterProperties() Returns text table cell character properties.
ICharacterPropertyStore	getCharacterPropertyStore() Returns the character property store of this cell.
int	getContentType() Returns content type.
IFormulaService	getFormulaService() Returns formula service.
ITextTableCellName	getName() Returns name of the cell.
short	getPageNumber() Returns the page number of the cell, returns -1 if page number could not be determined.
IPageStyle	getPageStyle() Returns related page style of the text table cell.
ITextTableCellProperties	getProperties() Returns text table cell properties.
ITextService	getTextService() Returns text service.
ITextTable	getTextTable() Returns text table of the cell.
double	getValue() Gets the value of the cell.
void	setCellParagraphStyle(java.lang.String cellParagraphStyle) Sets style of the cell paragraph.
void	setFormula(java.lang.String formula) Sets the formula.
void	setValue(double value) Sets the value of the cell.

Methods inherited from interface ag.ion.bion.officelayer.text.ITextComponent

getTextDocument

Methods inherited from interface ag.ion.bion.officelayer.clone.ICloneServiceProvider

getCloneService

Field Detail

TYPE_EMPTY

static final int TYPE_EMPTY

The cell is empty.

See Also:

Constant Field Values

TYPE_VALUE

static final int TYPE_VALUE

The cell contains a value.

See Also:

Constant Field Values

TYPE_TEXT

static final int TYPE_TEXT

The cell conains text.

See Also:

Constant Field Values

TYPE_FORMULA

static final int TYPE_FORMULA

The cell contains a formula.

See Also:

Constant Field Values

STYLE_TABLE_HEADER

static final java.lang.String STYLE_TABLE_HEADER

The paragraph style for the table header

See Also:

Constant Field Values

STYLE_TABLE_CONTENT

static final java.lang.String STYLE_TABLE_CONTENT

The paragraph style for the table content

See Also:

Constant Field Values

Method Detail

getName

ITextTableCellName getName()

Returns name of the cell.

Returns:

name of the cell

getTextTable

ITextTable getTextTable()
                        throws TextException

Returns text table of the cell.

Returns:

text table of the cell

Throws:

TextException - if the text table is not available

getContentType

int getContentType()

Returns content type.

Returns:

content type

getTextService

ITextService getTextService()

Returns text service.

Returns:

text service

getProperties

ITextTableCellProperties getProperties()

Returns text table cell properties.

Returns:

text table cell properties

getCharacterProperties

ICharacterProperties getCharacterProperties()

Returns text table cell character properties.

Returns:

text table cell character properties

getFormulaService

IFormulaService getFormulaService()

Returns formula service.

Returns:

formula service

setFormula

void setFormula(java.lang.String formula)

Sets the formula.

Parameters:

formula - formula

getPageStyle

IPageStyle getPageStyle()
                        throws TextException

Returns related page style of the text table cell.

Returns:

related page style of the text table cell

Throws:

TextException - if the page style is not available

getCellPropertyStore

ITextTableCellPropertyStore getCellPropertyStore(int verticalPosition,
                                                 int horizontalPosition)
                                                 throws TextException

Returns the property store of this cell.

Parameters:

verticalPosition - vertical position to be used

horizontalPosition - horizontal position to be used

Returns:

property store of the cell

Throws:

TextException - if the cell is not available

getCharacterPropertyStore

ICharacterPropertyStore getCharacterPropertyStore()
                                                  throws TextException

Returns the character property store of this cell.

Returns:

character property store of the cell

Throws:

TextException - if property store could not be returned

getValue

double getValue()

Gets the value of the cell.

Returns:

the value of the cell

setValue

void setValue(double value)

Sets the value of the cell.

Parameters:

value - the value to be set in the table

getPageNumber

short getPageNumber()

Returns the page number of the cell, returns -1 if page number could not be determined.

Returns:

the page number of the cell, returns -1 if page number could not be determined

setCellParagraphStyle

void setCellParagraphStyle(java.lang.String cellParagraphStyle)
                           throws TextException

Sets style of the cell paragraph. NOTE: The style will be applied to all paragraphs found in the cell.

Parameters:

cellParagraphStyle - style of the cell paragraph

Throws:

TextException - if the property can not be modified

getCellParagraphStyle

java.lang.String getCellParagraphStyle()
                                       throws TextException

Returns style of the cell paragraph, or null if not available. NOTE: The style of the first found paragraph in the cell will be returned.

Returns:

style of the cell paragraph, or null

Throws:

TextException - if the property is not available