Package com.smartsheet.api.models

Class Cell

  • Direct Known Subclasses:
    CellHistory, ReportCell
    public class Cell
extends java.lang.Object
    Represents the Cell object that holds data in a sheet.

    • Constructor Detail

      • Cell

        public Cell()
        Default constructor

      • Cell

        public Cell​(java.lang.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 java.lang.Object getValue()
        Gets the value. Can be one of columnType String, Number, or Boolean
        Returns:
        the value

      • setValue

        public Cell setValue​(java.lang.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

      • getDisplayValue

        public java.lang.String getDisplayValue()
        Gets the display value used on special columns such as "Contact List".
        Returns:
        the display value

      • setDisplayValue

        public Cell setDisplayValue​(java.lang.String displayValue)
        Sets the display value used on columns special columns such as "Contact List".
        Parameters:
        displayValue - the new display value

      • getColumnId

        public java.lang.Long getColumnId()
        Gets the column id for this cell.
        Returns:
        the column id

      • setColumnId

        public Cell setColumnId​(java.lang.Long columnId)
        Sets the column id for this cell.
        Parameters:
        columnId - the new column id

      • getRowId

        public java.lang.Long getRowId()
        Gets the row id for this cell.
        Returns:
        the row id

      • setRowId

        public Cell setRowId​(java.lang.Long rowId)
        Sets the row id for this cell.
        Parameters:
        rowId - the new row id

      • getFormula

        public java.lang.String getFormula()
        Gets the formula for this cell.
        Returns:
        the formula

      • setFormula

        public Cell setFormula​(java.lang.String formula)
        Sets the formula for this cell.
        Parameters:
        formula - the new formula
        See Also:
        Using Formulas

      • getStrict

        public java.lang.Boolean getStrict()
        Gets the strict value for this cell.
        Returns:
        the strict
        See Also:
        Column Types

      • setStrict

        public Cell setStrict​(java.lang.Boolean strict)
        Sets the strict formatting rule for this cell.
        Parameters:
        strict - the new strict
        See Also:
        Column Types

      • 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 java.util.List<CellLink> getLinksOutToCells()
        Returns:
        array of CellLink objects

      • setLinksOutToCells

        public Cell setLinksOutToCells​(java.util.List<CellLink> linksOutToCells)
        Parameters:
        linksOutToCells - array of CellLink objects

      • getConditionalFormat

        public java.lang.String getConditionalFormat()
        Returns:
        the format descriptor describing this cell’s conditional format

      • setConditionalFormat

        public Cell setConditionalFormat​(java.lang.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.

      • getOverrideValidation

        public java.lang.Boolean getOverrideValidation()
        Gets the value of the overrideValidation flag.
        Returns:
        the overrideValidation flag

      • setOverrideValidation

        public Cell setOverrideValidation​(java.lang.Boolean overrideValidation)
        Sets the value of the overrideValidation flag.
        Parameters:
        overrideValidation - the new overrideValidation
        Returns:
        the Cell