TableCell (FastODS 0.8.1 API)

All Known Subinterfaces:

RowCellWalker, WritableTableCell

All Known Implementing Classes:

AbstractTableCell, RowCellWalkerImpl, TableCellImpl, TableCellWalker
```
public interface TableCell
```
A TableCell represents a cell in a spreadsheet sheet. A cell value may be set using one of the following methods: setBooleanValue, setCurrencyValue, setDateValue, setFloatValue, setPercentageValue, setStringValue, setTextValue, setTimeValue. Those methods mimic the existing value types in the OpenDocument specification (boolean, currency, date, float, percentage, string, time -- void value is not implemented). Remarks: 1. there is no integer type in OpenDocument specification: use setFloatValue. 2. setStringValue and setTextValue both set the value type to string. Use setTextValue for multiline or formatted text.

Author:

Julien Férard

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`colIndex()`
`boolean`	`hasValue()`
`boolean`	`isCovered()`
`void`	`markColumnsSpanned(int n)` Mark the columns a spanned
`void`	`markRowsSpanned(int n)` Marks a number of rows with a span
`void`	`setAttribute(String attribute, CharSequence value)` Add an attribute to a cell
`void`	`setBooleanValue(boolean value)` Set the boolean value of the cell.
`void`	`setCellMerge(int rowMerge, int columnMerge)` Merge cells
`void`	`setCellValue(CellValue value)` Set the value for a cell.
`void`	`setColumnsSpanned(int n)` Create a span over cells at the right
`void`	`setCovered()` Set the cell covered flag
`void`	`setCurrencyValue(float value, String currency)` Set the currency value of the cell.
`void`	`setCurrencyValue(int value, String currency)` Set the currency value of the cell.
`void`	`setCurrencyValue(Number value, String currency)` Set the currency value of the cell.
`void`	`setDataStyle(DataStyle dataStyle)` Set a custom data style.
`void`	`setDateValue(Calendar cal)` Set the date value of the cell.
`void`	`setDateValue(Date date)` Set the date value of the cell.
`void`	`setFloatValue(float value)` Set the float value of the cell.
`void`	`setFloatValue(int value)` Set the float value of the cell.
`void`	`setFloatValue(Number value)` Set the float value of the cell.
`void`	`setFormula(String formula)` Sets a formula in an existing cell.
`void`	`setMatrixFormula(String formula)` Set a matrix formula
`void`	`setMatrixFormula(String formula, int matrixRowsSpanned, int matrixColumnsSpanned)` Set a matrix formula
`void`	`setNegTimeValue(long years, long months, long days, long hours, long minutes, double seconds)` Set the time value of the cell.
`void`	`setPercentageValue(float value)` Set the percentage value of the cell.
`void`	`setPercentageValue(int value)` Deprecated. This is misleading: setPercentageValue(10) means 1000 %. For n %, use setPercentageValue(n/100)
`void`	`setPercentageValue(Number value)` Set the percentage value of the cell.
`void`	`setRowsSpanned(int n)` Create a span over cells below
`void`	`setStringValue(String value)` Set the string value for a cell.
`void`	`setStyle(TableCellStyle style)` Set a style for this cell
`void`	`setText(Text text)` Set a text in this cell.
`void`	`setTimeValue(long timeInMillis)` Set the time value of the cell.
`void`	`setTimeValue(long years, long months, long days, long hours, long minutes, double seconds)` Set the time value of the cell.
`void`	`setTooltip(String tooltipText)` Add a tooltip to the cell
`void`	`setTooltip(String tooltipText, Length width, Length height, boolean visible)` Add a tooltip to the cell
`void`	`setTooltip(Tooltip tooltip)` Add a tooltip to the cell
`void`	`setValidation(Validation validation)` Set a content validation on this cell
`void`	`setVoidValue()` Set a void value in this cell

- Method Detail
  - markRowsSpanned
```
void markRowsSpanned(int n)
```
    Marks a number of rows with a span
    
    Parameters:
    
    n - the number of rows
  - setBooleanValue
```
void setBooleanValue(boolean value)
```
    Set the boolean value of the cell. Type will be CellType.BOOLEAN and data style the default data style for booleans.
    
    Parameters:
    
    value - true or false
  - setCellValue
```
void setCellValue(CellValue value)
```
    Set the value for a cell. The value should be wrapped in a CellValue object.
    
    Parameters:
    
    value - the value as a CellValue object.
  - setCurrencyValue
```
void setCurrencyValue(float value,
                      String currency)
```
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Parameters:
    
    value - the value as a float
    
    currency - The currency value
  - setCurrencyValue
```
void setCurrencyValue(int value,
                      String currency)
```
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Parameters:
    
    value - the value as an int
    
    currency - The currency value
  - setCurrencyValue
```
void setCurrencyValue(Number value,
                      String currency)
```
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Parameters:
    
    value - the value as a Number
    
    currency - the currency value
  - setDateValue
```
void setDateValue(Calendar cal)
```
    Set the date value of the cell. Type will be CellType.DATE and data style the default data style for date.
    
    Parameters:
    
    cal - a Calendar object with the date to be used
  - setDateValue
```
void setDateValue(Date date)
```
    Set the date value of the cell. Type will be CellType.DATE and data style the default data style for date.
    
    Parameters:
    
    date - a Date object
  - setFloatValue
```
void setFloatValue(float value)
```
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Parameters:
    
    value - a double object with the value to be used
  - setFloatValue
```
void setFloatValue(int value)
```
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Parameters:
    
    value - a double object with the value to be used
  - setFloatValue
```
void setFloatValue(Number value)
```
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Parameters:
    
    value - a double object with the value to be used
  - setPercentageValue
```
void setPercentageValue(float value)
```
    Set the percentage value of the cell. Type will be CellType.PERCENTAGE and data style the default data style for percentage. Beware: 0.75 means 75 %, 75.0 means 7500 %. This is consistent with OpenDocument specification.
    
    Parameters:
    
    value - a float object with the value to be used
  - setPercentageValue
```
@Deprecated
void setPercentageValue(int value)
```
    Deprecated. This is misleading: setPercentageValue(10) means 1000 %. For n %, use setPercentageValue(n/100)
    
    Set the percentage value of the cell. Type will be CellType.PERCENTAGE and data style the default data style for percentage. Beware: 75 means 7500 %. This is consistent with OpenDocument specification.
    
    Parameters:
    
    value - an int with the value to be used
  - setPercentageValue
```
void setPercentageValue(Number value)
```
    Set the percentage value of the cell. Type will be CellType.PERCENTAGE and data style the default data style for percentage. Beware: 0.75 means 75 %, 75.0 means 7500 %. This is consistent with OpenDocument specification.
    
    Parameters:
    
    value - a double object with the value to be used.
  - setStringValue
```
void setStringValue(String value)
```
    Set the string value for a cell. The type will be CellType.STRING.
    Note that this will not set the data style of the cell to "text" but let it to "standard", hence the quote before numbers in LO. This is the same behavior as LO (see https://github.com/jferard/fastods/issues/148)
    
    Parameters:
    
    value - a double object with the value to be used
  - setStyle
```
void setStyle(TableCellStyle style)
```
    Set a style for this cell
    
    Parameters:
    
    style - the style
  - setTimeValue
```
void setTimeValue(long timeInMillis)
```
    Set the time value of the cell. Type will be CellType.TIME and data style the default data style for time. Set the time value as in 19.382 office:time-value. The xml datatype is "duration" (https://www.w3.org/TR/xmlschema-2/#duration)
    
    Parameters:
    
    timeInMillis - the duration in milliseconds
  - setTimeValue
```
void setTimeValue(long years,
                  long months,
                  long days,
                  long hours,
                  long minutes,
                  double seconds)
```
    Set the time value of the cell. Type will be CellType.TIME and data style the default data style for time. Set the time value as in 19.382 office:time-value. The xml datatype is "duration" (https://www.w3.org/TR/xmlschema-2/#duration) All parameters must be positive
    
    Parameters:
    
    years - number of years
    
    months - number of months
    
    days - number of days
    
    hours - number of hours
    
    minutes - number of minutes
    
    seconds - number of seconds
  - setNegTimeValue
```
void setNegTimeValue(long years,
                     long months,
                     long days,
                     long hours,
                     long minutes,
                     double seconds)
```
    Set the time value of the cell. Type will be CellType.TIME and data style the default data style for time. Set the time value as in 19.382 office:time-value. The xml datatype is "duration" (https://www.w3.org/TR/xmlschema-2/#duration) All parameters must be positive
    
    Parameters:
    
    years - number of years
    
    months - number of months
    
    days - number of days
    
    hours - number of hours
    
    minutes - number of minutes
    
    seconds - number of seconds
  - setTooltip
```
void setTooltip(String tooltipText)
```
    Add a tooltip to the cell
    
    Parameters:
    
    tooltipText - the text of the tooltip
  - setTooltip
```
void setTooltip(String tooltipText,
                Length width,
                Length height,
                boolean visible)
```
    Add a tooltip to the cell
    
    Parameters:
    
    tooltipText - the text of the tooltip
    
    width - the width of the tooltip
    
    height - the height of the tooltip
    
    visible - if the tooltip should be visible.
  - setTooltip
```
void setTooltip(Tooltip tooltip)
```
    Add a tooltip to the cell
    
    Parameters:
    
    tooltip - the tooltip
  - setFormula
```
void setFormula(String formula)
```
    Sets a formula in an existing cell. The user is responsible for creating the cell and setting the correct value, as show below:
```
     walker.setFloatValue(2.0);
     walker.setFormula("1+1");
 
```
    One can type Shift+Ctrl+F9 to recalculate the right value in LibreOffice.
    Parameters:
    
    formula - the formula, without '=' sign.
  - isCovered
```
boolean isCovered()
```
    Returns:
    
    true if the cell is covered by a span
  - setCovered
```
void setCovered()
```
    Set the cell covered flag
  - setColumnsSpanned
```
void setColumnsSpanned(int n)
```
    Create a span over cells at the right
    
    Parameters:
    
    n - the number of cells to be spanned
    
    Throws:
    
    IllegalArgumentException - if n < 0
  - markColumnsSpanned
```
void markColumnsSpanned(int n)
```
    Mark the columns a spanned
    
    Parameters:
    
    n - the number of columns
    
    Throws:
    
    IllegalArgumentException - if n < 0
  - setRowsSpanned
```
void setRowsSpanned(int n)
             throws IOException
```
    Create a span over cells below
    
    Parameters:
    
    n - the number of cells to be spanned
    
    Throws:
    
    IOException - if the cell can't be merged (only when flushing data)
    
    IllegalArgumentException - if n < 0
  - setVoidValue
```
void setVoidValue()
```
    Set a void value in this cell
  - setMatrixFormula
```
void setMatrixFormula(String formula)
```
    Set a matrix formula
    
    Parameters:
    
    formula - the formula
  - setMatrixFormula
```
void setMatrixFormula(String formula,
                      int matrixRowsSpanned,
                      int matrixColumnsSpanned)
```
    Set a matrix formula
    
    Parameters:
    
    formula - the formula
    
    matrixRowsSpanned - the number of rows
    
    matrixColumnsSpanned - the number of columns
  - hasValue
```
boolean hasValue()
```
    Returns:
    
    true if the cell has a value. A void value is a value
  - setText
```
void setText(Text text)
```
    Set a text in this cell. Type will be CellType.STRING.
    
    Parameters:
    
    text - the text
  - setCellMerge
```
void setCellMerge(int rowMerge,
                  int columnMerge)
           throws IOException
```
    Merge cells
    
    Parameters:
    
    rowMerge - number of rows below
    
    columnMerge - number of rows at the right
    
    Throws:
    
    IOException - if the cell can't be merged (only when flushing data)
  - setAttribute
```
void setAttribute(String attribute,
                  CharSequence value)
```
    Add an attribute to a cell
    
    Parameters:
    
    attribute - the attribute name
    
    value - the value
  - setDataStyle
```
void setDataStyle(DataStyle dataStyle)
```
    Set a custom data style. In an Open Document, a data style is always carried by a style. Thus, FastOds will create a new style, child of the current style, with the given data style. The new style will have the same visibility as the data style.
    
    Parameters:
    
    dataStyle - the data style
  - setValidation
```
void setValidation(Validation validation)
```
    Set a content validation on this cell
    
    Parameters:
    
    validation - the validation
  - colIndex
```
int colIndex()
```
    Returns:
    
    the index of the cell in the current row

Interface TableCell

Method Summary

Method Detail

markRowsSpanned

setBooleanValue

setCellValue

setCurrencyValue

setCurrencyValue

setCurrencyValue

setDateValue

setDateValue

setFloatValue

setFloatValue

setFloatValue

setPercentageValue

setPercentageValue

setPercentageValue

setStringValue

setStyle

setTimeValue

setTimeValue

setNegTimeValue

setTooltip

setTooltip

setTooltip

setFormula

isCovered

setCovered

setColumnsSpanned

markColumnsSpanned

setRowsSpanned

setVoidValue

setMatrixFormula

setMatrixFormula

hasValue

setText

setCellMerge

setAttribute

setDataStyle

setValidation

colIndex