ag.ion.bion.officelayer.internal.text
Class TextTableCell

java.lang.Object
  ag.ion.bion.officelayer.text.AbstractTextComponent
      ag.ion.bion.officelayer.internal.text.TextTableCell

All Implemented Interfaces:

ICloneServiceProvider, ITextComponent, ITextTableCell

public class TextTableCell
extends AbstractTextComponent
implements ITextTableCell

Cell of a table in a text document.

Field Summary

protected ITextTableCellName

textTableCellName

Fields inherited from class ag.ion.bion.officelayer.text.AbstractTextComponent

textDocument

Fields inherited from interface ag.ion.bion.officelayer.text.ITextTableCell

STYLE_TABLE_CONTENT, STYLE_TABLE_HEADER, TYPE_EMPTY, TYPE_FORMULA, TYPE_TEXT, TYPE_VALUE

Constructor Summary

TextTableCell(ITextDocument textDocument, com.sun.star.table.XCell xCell)
Constructs new TextTableCell.

Method Summary

java.lang.String	getCellParagraphStyle() Returns style of the cell paragraph, or null if not available.
ITextTableCellPropertyStore	getCellPropertyStore(int horizontalPosition, int verticalPosition) 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.
ICloneService	getCloneService() Gets the clone service of the element.
int	getContentType() Returns content type.
IFormulaService	getFormulaService() Returns the 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.
ITextDocument	getTextDocument() Returns text document.
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 class java.lang.Object

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

Field Detail

textTableCellName

protected ITextTableCellName textTableCellName

Constructor Detail

TextTableCell

public TextTableCell(ITextDocument textDocument,
                     com.sun.star.table.XCell xCell)
              throws java.lang.IllegalArgumentException

Constructs new TextTableCell.

Parameters:

textDocument - text document to be used

xCell - OpenOffice.org XCell interface

Throws:

java.lang.IllegalArgumentException - if the submitted text document or OpenOffice.org XCell interface is not valid

Method Detail

getTextDocument

public ITextDocument getTextDocument()

Returns text document.

Specified by:

getTextDocument in interface ITextComponent

Overrides:

getTextDocument in class AbstractTextComponent

Returns:

text document

getName

public ITextTableCellName getName()

Returns name of the cell.

Specified by:

getName in interface ITextTableCell

Returns:

name of the cell or null if the name is not available

getTextTable

public ITextTable getTextTable()
                        throws TextException

Returns text table of the cell.

Specified by:

getTextTable in interface ITextTableCell

Returns:

text table of the cell

Throws:

TextException - if the text table is not available

getContentType

public int getContentType()

Returns content type.

Specified by:

getContentType in interface ITextTableCell

Returns:

content type

getTextService

public ITextService getTextService()

Returns text service.

Specified by:

getTextService in interface ITextTableCell

Returns:

text service

getProperties

public ITextTableCellProperties getProperties()

Returns text table cell properties.

Specified by:

getProperties in interface ITextTableCell

Returns:

text table cell properties

getCharacterProperties

public ICharacterProperties getCharacterProperties()

Returns text table cell character properties.

Specified by:

getCharacterProperties in interface ITextTableCell

Returns:

text table cell character properties

getFormulaService

public IFormulaService getFormulaService()

Returns the formula service.

Specified by:

getFormulaService in interface ITextTableCell

Returns:

the formula Service

getPageStyle

public IPageStyle getPageStyle()
                        throws TextException

Returns related page style of the text table cell.

Specified by:

getPageStyle in interface ITextTableCell

Returns:

related page style of the text table cell

Throws:

TextException - if the page style is not available

getCellPropertyStore

public ITextTableCellPropertyStore getCellPropertyStore(int horizontalPosition,
                                                        int verticalPosition)
                                                 throws TextException

Returns the property store of this cell.

Specified by:

getCellPropertyStore in interface ITextTableCell

Parameters:

horizontalPosition - horizontal position to be used

verticalPosition - vertical position to be used

Returns:

property store of the cell

Throws:

TextException - if the cell property store is not available

getCharacterPropertyStore

public ICharacterPropertyStore getCharacterPropertyStore()
                                                  throws TextException

Returns the character property store of this cell.

Specified by:

getCharacterPropertyStore in interface ITextTableCell

Returns:

character property store of the cell

Throws:

TextException - if property store could not be returned

getCloneService

public ICloneService getCloneService()
                              throws CloneException

Gets the clone service of the element.

Specified by:

getCloneService in interface ICloneServiceProvider

Returns:

the clone service

Throws:

CloneException - if the clone service could not be returned

getValue

public double getValue()

Gets the value of the cell.

Specified by:

getValue in interface ITextTableCell

Returns:

the value of the cell

setValue

public void setValue(double value)

Sets the value of the cell.

Specified by:

setValue in interface ITextTableCell

Parameters:

value - the value to be set in the table

setFormula

public void setFormula(java.lang.String formula)

Sets the formula.

Specified by:

setFormula in interface ITextTableCell

Parameters:

formula - formula

getPageNumber

public short getPageNumber()

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

Specified by:

getPageNumber in interface ITextTableCell

Returns:

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

setCellParagraphStyle

public 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.

Specified by:

setCellParagraphStyle in interface ITextTableCell

Parameters:

cellParagraphStyle - style of the cell paragraph

Throws:

TextException - if the property can not be modified

getCellParagraphStyle

public 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.

Specified by:

getCellParagraphStyle in interface ITextTableCell

Returns:

style of the cell paragraph, or null

Throws:

TextException - if the property is not available