com.smartsheet.api.models

Class Cell

java.lang.Object

com.smartsheet.api.models.Cell

Direct Known Subclasses:

CellHistory, ReportCell

public class Cell
extends Object

Represents the Cell object that holds data in a sheet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cell.AddRowCellsBuilder A convenience class for quickly creating a List of cells to add.
static class	Cell.UpdateRowCellsBuilder A convenience class for quickly creating a List of cells to update.

Constructor Summary

Constructors

Constructor and Description
Cell() Default constructor
Cell(Long id) Construct a cell with specified column id

Method Summary

Modifier and Type	Method and Description
Long	getColumnId() Gets the column id for this cell.
ColumnType	getColumnType() Gets the column columnType.
String	getConditionalFormat()
String	getDisplayValue() Gets the display value used on special columns such as "Contact List".
Format	getFormat()
String	getFormula() Gets the formula for this cell.
Hyperlink	getHyperlink()
Image	getImage() Gets the image for this cell.
CellLink	getLinkInFromCell()
List<CellLink>	getLinksOutToCells()
ObjectValue	getObjectValue() Get object representation of the cell's value
Boolean	getOverrideValidation() Gets the value of the overrideValidation flag.
Long	getRowId() Gets the row id for this cell.
Boolean	getStrict() Gets the strict value for this cell.
ColumnType	getType() Gets the column columnType.
Object	getValue() Gets the value.
Cell	setColumnId(Long columnId) Sets the column id for this cell.
Cell	setColumnType(ColumnType columnType) Sets the column columnType.
Cell	setConditionalFormat(String conditionalFormat)
Cell	setDisplayValue(String displayValue) Sets the display value used on columns special columns such as "Contact List".
Cell	setFormat(Format format)
Cell	setFormula(String formula) Sets the formula for this cell.
Cell	setHyperlink(Hyperlink hyperlink)
Cell	setImage(Image image) Sets the image for this cell.
Cell	setLinkInFromCell(CellLink linkInFromCell)
Cell	setLinksOutToCells(List<CellLink> linksOutToCells)
Cell	setObjectValue(ObjectValue objectValue) Set object representation of the cell's value
Cell	setOverrideValidation(Boolean overrideValidation) Sets the value of the overrideValidation flag.
Cell	setRowId(Long rowId) Sets the row id for this cell.
Cell	setStrict(Boolean strict) Sets the strict formatting rule for this cell.
Cell	setType(ColumnType type) Sets the column columnType.
Cell	setValue(Object value) Sets the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cell

public Cell()

Default constructor

Cell

public Cell(Long id)

Construct a cell with specified column id

Parameters:

id - Column id

Method Detail

getColumnType

public ColumnType getColumnType()

Gets the column columnType.

Returns:

the columnType

setColumnType

public Cell setColumnType(ColumnType columnType)

Sets the column columnType.

Parameters:

columnType - the new columnType

getType

public ColumnType getType()

Gets the column columnType.

Returns:

the columnType

setType

public Cell setType(ColumnType type)

Sets the column columnType.

Parameters:

type - the new columnType

getValue

public Object getValue()

Gets the value. Can be one of columnType String, Number, or Boolean

Returns:

the value

setValue

public Cell setValue(Object value)

Sets the value. Can be one of columnType String, Number, or Boolean

Parameters:

value - the new value

getObjectValue

public ObjectValue getObjectValue()

Get object representation of the cell's value

Returns:

objectValue

setObjectValue

public Cell setObjectValue(ObjectValue objectValue)

Set object representation of the cell's value

Parameters:

objectValue -

getDisplayValue

public String getDisplayValue()

Gets the display value used on special columns such as "Contact List".

Returns:

the display value

setDisplayValue

public Cell setDisplayValue(String displayValue)

Sets the display value used on columns special columns such as "Contact List".

Parameters:

displayValue - the new display value

getColumnId

public Long getColumnId()

Gets the column id for this cell.

Returns:

the column id

setColumnId

public Cell setColumnId(Long columnId)

Sets the column id for this cell.

Parameters:

columnId - the new column id

getRowId

public Long getRowId()

Gets the row id for this cell.

Returns:

the row id

setRowId

public Cell setRowId(Long rowId)

Sets the row id for this cell.

Parameters:

rowId - the new row id

getFormula

public String getFormula()

Gets the formula for this cell.

Returns:

the formula

setFormula

public Cell setFormula(String formula)

Sets the formula for this cell.

Parameters:

formula - the new formula

See Also:

Using Formulas

getStrict

public Boolean getStrict()

Gets the strict value for this cell.

Returns:

the strict

See Also:

Column Types

setStrict

public Cell setStrict(Boolean strict)

Sets the strict formatting rule for this cell.

Parameters:

strict - the new strict

See Also:

Column Types

getFormat

public Format getFormat()

Returns:

the Format

setFormat

public Cell setFormat(Format format)

Parameters:

format - the Format to set

getHyperlink

public Hyperlink getHyperlink()

Returns:

hyperlink to a URL, sheet, or report

setHyperlink

public Cell setHyperlink(Hyperlink hyperlink)

Parameters:

hyperlink - hyperlink to a URL, sheet, or report to set

getLinkInFromCell

public CellLink getLinkInFromCell()

Returns:

inbound link from a cell in another sheet

setLinkInFromCell

public Cell setLinkInFromCell(CellLink linkInFromCell)

Parameters:

linkInFromCell - inbound link from a cell in another sheet to set

getLinksOutToCells

public List<CellLink> getLinksOutToCells()

Returns:

array of CellLink objects

setLinksOutToCells

public Cell setLinksOutToCells(List<CellLink> linksOutToCells)

Parameters:

linksOutToCells - array of CellLink objects

getConditionalFormat

public String getConditionalFormat()

Returns:

the format descriptor describing this cell’s conditional format

setConditionalFormat

public Cell setConditionalFormat(String conditionalFormat)

Parameters:

conditionalFormat - the format descriptor describing this cell’s conditional format to set

getImage

public Image getImage()

Gets the image for this cell.

Returns:

image

setImage

public Cell setImage(Image image)

Sets the image for this cell.

Parameters:

image -

getOverrideValidation

public Boolean getOverrideValidation()

Gets the value of the overrideValidation flag.

Returns:

the overrideValidation flag

setOverrideValidation

public Cell setOverrideValidation(Boolean overrideValidation)

Sets the value of the overrideValidation flag.

Parameters:

overrideValidation - the new overrideValidation

Returns:

the Cell