TableCellImpl (FastODS 0.8.1 API)

java.lang.Object
- com.github.jferard.fastods.TableCellImpl

All Implemented Interfaces:

TableCell, WritableTableCell
```
public class TableCellImpl
extends Object
implements WritableTableCell
```
WHERE ? content.xml/office:document-content/office:body/office:spreadsheet/ table:table/table:table-row

Author:

Julien Férard, Martin Schulz

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendXMLToTableRow(XMLUtil util, Appendable appendable)` Generate the XML for the table cell.
`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 value)` 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)` Set the percentage value of the cell.
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - appendXMLToTableRow
```
public void appendXMLToTableRow(XMLUtil util,
                                Appendable appendable)
                         throws IOException
```
    Description copied from interface: WritableTableCell
    
    Generate the XML for the table cell.
    
    Specified by:
    
    appendXMLToTableRow in interface WritableTableCell
    
    Parameters:
    
    util - an util.
    
    appendable - the appendable to fill
    
    Throws:
    
    IOException - if an error occurs
  - isCovered
```
public boolean isCovered()
```
    Specified by:
    
    isCovered in interface TableCell
    
    Returns:
    
    true if the cell is covered by a span
  - setCovered
```
public void setCovered()
```
    Description copied from interface: TableCell
    
    Set the cell covered flag
    
    Specified by:
    
    setCovered in interface TableCell
  - setColumnsSpanned
```
public void setColumnsSpanned(int n)
```
    Description copied from interface: TableCell
    
    Create a span over cells at the right
    
    Specified by:
    
    setColumnsSpanned in interface TableCell
    
    Parameters:
    
    n - the number of cells to be spanned
  - markColumnsSpanned
```
public void markColumnsSpanned(int n)
```
    Description copied from interface: TableCell
    
    Mark the columns a spanned
    
    Specified by:
    
    markColumnsSpanned in interface TableCell
    
    Parameters:
    
    n - the number of columns
  - setRowsSpanned
```
public void setRowsSpanned(int n)
                    throws IOException
```
    Description copied from interface: TableCell
    
    Create a span over cells below
    
    Specified by:
    
    setRowsSpanned in interface TableCell
    
    Parameters:
    
    n - the number of cells to be spanned
    
    Throws:
    
    IOException - if the cell can't be merged (only when flushing data)
  - markRowsSpanned
```
public void markRowsSpanned(int n)
```
    Description copied from interface: TableCell
    
    Marks a number of rows with a span
    
    Specified by:
    
    markRowsSpanned in interface TableCell
    
    Parameters:
    
    n - the number of rows
  - setBooleanValue
```
public void setBooleanValue(boolean value)
```
    Description copied from interface: TableCell
    
    Set the boolean value of the cell. Type will be CellType.BOOLEAN and data style the default data style for booleans.
    
    Specified by:
    
    setBooleanValue in interface TableCell
    
    Parameters:
    
    value - true or false
  - setCellValue
```
public void setCellValue(CellValue value)
```
    Description copied from interface: TableCell
    
    Set the value for a cell. The value should be wrapped in a CellValue object.
    
    Specified by:
    
    setCellValue in interface TableCell
    
    Parameters:
    
    value - the value as a CellValue object.
  - setCurrencyValue
```
public void setCurrencyValue(float value,
                             String currency)
```
    Description copied from interface: TableCell
    
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Specified by:
    
    setCurrencyValue in interface TableCell
    
    Parameters:
    
    value - the value as a float
    
    currency - The currency value
  - setCurrencyValue
```
public void setCurrencyValue(int value,
                             String currency)
```
    Description copied from interface: TableCell
    
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Specified by:
    
    setCurrencyValue in interface TableCell
    
    Parameters:
    
    value - the value as an int
    
    currency - The currency value
  - setCurrencyValue
```
public void setCurrencyValue(Number value,
                             String currency)
```
    Description copied from interface: TableCell
    
    Set the currency value of the cell. Type will be CellType.CURRENCY and data style the default data style for currency.
    
    Specified by:
    
    setCurrencyValue in interface TableCell
    
    Parameters:
    
    value - the value as a Number
    
    currency - the currency value
  - setDataStyle
```
public void setDataStyle(DataStyle dataStyle)
```
    Description copied from interface: TableCell
    
    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.
    
    Specified by:
    
    setDataStyle in interface TableCell
    
    Parameters:
    
    dataStyle - the data style
  - setValidation
```
public void setValidation(Validation validation)
```
    Description copied from interface: TableCell
    
    Set a content validation on this cell
    
    Specified by:
    
    setValidation in interface TableCell
    
    Parameters:
    
    validation - the validation
  - colIndex
```
public int colIndex()
```
    Specified by:
    
    colIndex in interface TableCell
    
    Returns:
    
    the index of the cell in the current row
  - setDateValue
```
public void setDateValue(Calendar cal)
```
    Description copied from interface: TableCell
    
    Set the date value of the cell. Type will be CellType.DATE and data style the default data style for date.
    
    Specified by:
    
    setDateValue in interface TableCell
    
    Parameters:
    
    cal - a Calendar object with the date to be used
  - setDateValue
```
public void setDateValue(Date value)
```
    Description copied from interface: TableCell
    
    Set the date value of the cell. Type will be CellType.DATE and data style the default data style for date.
    
    Specified by:
    
    setDateValue in interface TableCell
    
    Parameters:
    
    value - a Date object
  - setFloatValue
```
public void setFloatValue(float value)
```
    Description copied from interface: TableCell
    
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Specified by:
    
    setFloatValue in interface TableCell
    
    Parameters:
    
    value - a double object with the value to be used
  - setFloatValue
```
public void setFloatValue(int value)
```
    Description copied from interface: TableCell
    
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Specified by:
    
    setFloatValue in interface TableCell
    
    Parameters:
    
    value - a double object with the value to be used
  - setFloatValue
```
public void setFloatValue(Number value)
```
    Description copied from interface: TableCell
    
    Set the float value of the cell. Type will be CellType.FLOAT and data style the default data style for float.
    
    Specified by:
    
    setFloatValue in interface TableCell
    
    Parameters:
    
    value - a double object with the value to be used
  - setPercentageValue
```
public void setPercentageValue(int value)
```
    Description copied from interface: TableCell
    
    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.
    
    Specified by:
    
    setPercentageValue in interface TableCell
    
    Parameters:
    
    value - an int with the value to be used
  - setPercentageValue
```
public void setPercentageValue(float value)
```
    Description copied from interface: TableCell
    
    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.
    
    Specified by:
    
    setPercentageValue in interface TableCell
    
    Parameters:
    
    value - a float object with the value to be used
  - setPercentageValue
```
public void setPercentageValue(Number value)
```
    Description copied from interface: TableCell
    
    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.
    
    Specified by:
    
    setPercentageValue in interface TableCell
    
    Parameters:
    
    value - a double object with the value to be used.
  - setStringValue
```
public void setStringValue(String value)
```
    Description copied from interface: TableCell
    
    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)
    
    Specified by:
    
    setStringValue in interface TableCell
    
    Parameters:
    
    value - a double object with the value to be used
  - setStyle
```
public void setStyle(TableCellStyle style)
```
    Description copied from interface: TableCell
    
    Set a style for this cell
    
    Specified by:
    
    setStyle in interface TableCell
    
    Parameters:
    
    style - the style
  - setText
```
public void setText(Text text)
```
    Description copied from interface: TableCell
    
    Set a text in this cell. Type will be CellType.STRING.
    
    Specified by:
    
    setText in interface TableCell
    
    Parameters:
    
    text - the text
  - setCellMerge
```
public void setCellMerge(int rowMerge,
                         int columnMerge)
                  throws IOException
```
    Description copied from interface: TableCell
    
    Merge cells
    
    Specified by:
    
    setCellMerge in interface TableCell
    
    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
```
public void setAttribute(String attribute,
                         CharSequence value)
```
    Description copied from interface: TableCell
    
    Add an attribute to a cell
    
    Specified by:
    
    setAttribute in interface TableCell
    
    Parameters:
    
    attribute - the attribute name
    
    value - the value
  - setTimeValue
```
public void setTimeValue(long timeInMillis)
```
    Description copied from interface: TableCell
    
    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)
    
    Specified by:
    
    setTimeValue in interface TableCell
    
    Parameters:
    
    timeInMillis - the duration in milliseconds
  - setTimeValue
```
public void setTimeValue(long years,
                         long months,
                         long days,
                         long hours,
                         long minutes,
                         double seconds)
```
    Description copied from interface: TableCell
    
    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
    
    Specified by:
    
    setTimeValue in interface TableCell
    
    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
```
public void setNegTimeValue(long years,
                            long months,
                            long days,
                            long hours,
                            long minutes,
                            double seconds)
```
    Description copied from interface: TableCell
    
    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
    
    Specified by:
    
    setNegTimeValue in interface TableCell
    
    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
```
public void setTooltip(String tooltipText)
```
    Description copied from interface: TableCell
    
    Add a tooltip to the cell
    
    Specified by:
    
    setTooltip in interface TableCell
    
    Parameters:
    
    tooltipText - the text of the tooltip
  - setTooltip
```
public void setTooltip(String tooltipText,
                       Length width,
                       Length height,
                       boolean visible)
```
    Description copied from interface: TableCell
    
    Add a tooltip to the cell
    
    Specified by:
    
    setTooltip in interface TableCell
    
    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
```
public void setTooltip(Tooltip tooltip)
```
    Description copied from interface: TableCell
    
    Add a tooltip to the cell
    
    Specified by:
    
    setTooltip in interface TableCell
    
    Parameters:
    
    tooltip - the tooltip
  - setVoidValue
```
public void setVoidValue()
```
    Description copied from interface: TableCell
    
    Set a void value in this cell
    
    Specified by:
    
    setVoidValue in interface TableCell
  - setFormula
```
public void setFormula(String formula)
```
    Description copied from interface: TableCell
    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.
    Specified by:
    
    setFormula in interface TableCell
    
    Parameters:
    
    formula - the formula, without '=' sign.
  - setMatrixFormula
```
public void setMatrixFormula(String formula)
```
    Description copied from interface: TableCell
    
    Set a matrix formula
    
    Specified by:
    
    setMatrixFormula in interface TableCell
    
    Parameters:
    
    formula - the formula
  - setMatrixFormula
```
public void setMatrixFormula(String formula,
                             int matrixRowsSpanned,
                             int matrixColumnsSpanned)
```
    Description copied from interface: TableCell
    
    Set a matrix formula
    
    Specified by:
    
    setMatrixFormula in interface TableCell
    
    Parameters:
    
    formula - the formula
    
    matrixRowsSpanned - the number of rows
    
    matrixColumnsSpanned - the number of columns
  - hasValue
```
public boolean hasValue()
```
    Specified by:
    
    hasValue in interface TableCell
    
    Returns:
    
    true if the cell has a value. A void value is a value

Class TableCellImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

appendXMLToTableRow

isCovered

setCovered

setColumnsSpanned

markColumnsSpanned

setRowsSpanned

markRowsSpanned

setBooleanValue

setCellValue

setCurrencyValue

setCurrencyValue

setCurrencyValue

setDataStyle

setValidation

colIndex

setDateValue

setDateValue

setFloatValue

setFloatValue

setFloatValue

setPercentageValue

setPercentageValue

setPercentageValue

setStringValue

setStyle

setText

setCellMerge

setAttribute

setTimeValue

setTimeValue

setNegTimeValue

setTooltip

setTooltip

setTooltip

setVoidValue

setFormula

setMatrixFormula

setMatrixFormula

hasValue