Package ch.rabanti.nanoxlsx4j

Class Cell

java.lang.Object
ch.rabanti.nanoxlsx4j.Cell
All Implemented Interfaces:
Comparable<Cell>
public class Cell extends Object implements Comparable<Cell>
Class representing a cell of a worksheet
Author:
Raphael Stoeckli

  • Constructor Details

    • Cell

      public Cell()
      Default constructor. Cells created with this constructor do not have a link to a worksheet initially

    • Cell

      public Cell(Object value, Cell.CellType type)
      Constructor with value and cell type. Cells created with this constructor do not have a link to a worksheet initially
      API Note:
      If the dataType is defined as Cell.CellType.EMPTY any passed value will be set to null
      Parameters:
      value - Value of the cell
      type - Type of the cell

    • Cell

      public Cell(Object value, Cell.CellType type, String address)
      Constructor with value, cell type and address. The worksheet reference is set to null and must be assigned later
      API Note:
      If the dataType is defined as Cell.CellType.EMPTY any passed value will be set to null
      Parameters:
      value - Value of the cell
      type - Type of the cell
      address - Address of the cell

    • Cell

      public Cell(Object value, Cell.CellType type, Address address)
      Constructor with value, cell type and address class. The worksheet reference is set to null and must be assigned later
      API Note:
      If the dataType is defined as Cell.CellType.EMPTY any passed value will be set to null
      Parameters:
      value - Value of the cell
      type - Type of the cell
      address - Address class of the cell

    • Cell

      public Cell(Object value, Cell.CellType type, int column, int row)
      Constructor with value, cell type, row number and column number
      API Note:
      If the dataType is defined as Cell.CellType.EMPTY any passed value will be set to null
      Parameters:
      value - Value of the cell
      type - Type of the cell
      column - Column number of the cell (zero-based)
      row - Row number of the cell (zero-based)

  • Method Details

    • getCellAddress

      public String getCellAddress()
      Gets the combined cell Address as string in the format A1 - XFD1048576
      Returns:
      Cell address

    • setCellAddress

      public void setCellAddress(String address)
      Sets the combined cell Address as string in the format A1 - XFD1048576
      Parameters:
      address - Cell address
      Throws:
      RangeException - Thrown in case of an illegal address

    • getCellAddress2

      public Address getCellAddress2()
      Gets the combined cell address as class
      Returns:
      Cell address

    • setCellAddress2

      public void setCellAddress2(Address address)
      Sets the combined cell address as class
      Parameters:
      address - Cell address

    • getCellStyle

      public Style getCellStyle()
      Gets the assigned style of the cell
      Returns:
      Assigned style

    • getColumnNumber

      public int getColumnNumber()
      Gets the number of the column (zero-based)
      Returns:
      Column number (zero-based)

    • setColumnNumber

      public void setColumnNumber(int columnNumber)
      Sets the number of the column (zero-based)
      Parameters:
      columnNumber - Column number (zero-based)

    • getDataType

      public Cell.CellType getDataType()
      Gets the type of the cell
      Returns:
      Type of the cell

    • setDataType

      public void setDataType(Cell.CellType dataType)
      Sets the type of the cell
      Parameters:
      dataType - Type of the cell

    • getRowNumber

      public int getRowNumber()
      Gets the number of the row (zero-based)
      Returns:
      Row number (zero-based)

    • setRowNumber

      public void setRowNumber(int rowNumber)
      Sets the number of the row (zero-based)
      Parameters:
      rowNumber - Row number (zero-based)

    • getCellAddressType

      public Cell.AddressType getCellAddressType()
      Gets the optional address type that can be part of the cell address.
      API Note:
      The type has no influence on the behavior of the cell, though. It is preserved to avoid losing information on the address object of the cell
      Returns:
      Address type

    • setCellAddressType

      public void setCellAddressType(Cell.AddressType cellAddressType)
      Sets the optional address type that can be part of the cell address.
      API Note:
      The type has no influence on the behavior of the cell, though. It is preserved to avoid losing information on the address object of the cell
      Parameters:
      cellAddressType - Address type

    • getValue

      public Object getValue()
      Gets the value of the cell (generic object type)
      Returns:
      Value of the cell

    • setValue

      public void setValue(Object value)
      Sets the value of the cell (generic object type). When setting a value, the dataType is automatically resolved
      Parameters:
      value - Value of the cell

    • compareTo

      public int compareTo(Cell other)
      Implemented compareTo method
      Specified by:
      compareTo in interface Comparable<Cell>
      Implementation Note:
      Note that this method only compares the row and column numbers, since the values or styles may completely different types, and therefore hard to compare at all.
      The Equals() method considers values and style, though.
      Parameters:
      other - Object to compare
      Returns:
      0 if values are the same, -1 if this object is smaller, 1 if it is bigger

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • removeStyle

      public void removeStyle()
      Removes the assigned style from the cell
      Throws:
      StyleException - Thrown if the workbook to remove was not found in the style sheet collection

    • resolveCellType

      public void resolveCellType()
      Method resets the Cell type and tries to find the actual type. This is used if a Cell was created with the CellType DEFAULT or automatically if a value was set by setValue(Object). CellType FORMULA will skip this method and EMPTY will discard the value of the cell

    • setCellLockedState

      public void setCellLockedState(boolean isLocked, boolean isHidden)
      Sets the lock state of the cell
      API Note:
      The listed exception should never happen because the mentioned style is internally generated
      Parameters:
      isLocked - If true, the cell will be locked if the worksheet is protected
      isHidden - If true, the value of the cell will be invisible if the worksheet is protected
      Throws:
      StyleException - Throws an UndefinedStyleException if the style used to lock cells cannot be referenced

    • setStyle

      public Style setStyle(Style style)
      Sets the style of the cell
      Parameters:
      style - style to assign
      Returns:
      If the passed style already exists in the repository, the existing one will be returned, otherwise the passed one

    • setStyle

      public Style setStyle(Style style, boolean unmanaged)
      Sets the style of the cell
      Parameters:
      style - style to assign
      unmanaged - Internally used: If true, the style repository is not invoked and only the style object of the cell is updated. Do not use!
      Returns:
      If the passed style already exists in the repository, the existing one will be returned, otherwise the passed one

    • convertArray

      public static <T> List<Cell> convertArray(List<T> list)
      Converts a List of supported objects into a list of cells
      Type Parameters:
      T - Generic data type
      Parameters:
      list - List of generic objects
      Returns:
      List of cells

    • getCellRange

      public static List<Address> getCellRange(String range)
      Gets a list of cell addresses from a cell range (format A1:B3 or AAD556:AAD1000)
      Parameters:
      range - Range to process
      Returns:
      List of cell addresses
      Throws:
      FormatException - Throws a FormatException if a part of the passed range is malformed
      RangeException - Throws a RangeException if the range is out of range (A-XFD and 1 to 1048576)

    • getCellRange

      public static List<Address> getCellRange(String startAddress, String endAddress)
      Get a list of cell addresses from a cell range
      Parameters:
      startAddress - Start address as string in the format A1 - XFD1048576
      endAddress - End address as string in the format A1 - XFD1048576
      Returns:
      List of cell addresses
      Throws:
      FormatException - Throws a FormatException if a part of the passed range is malformed
      RangeException - Throws a RangeException if the range is out of range (A-XFD and 1 to 1048576)

    • getCellRange

      public static List<Address> getCellRange(int startColumn, int startRow, int endColumn, int endRow)
      Get a list of cell addresses from a cell range
      Parameters:
      startColumn - Start column (zero based)
      startRow - Start roe (zero based)
      endColumn - End column (zero based)
      endRow - End row (zero based)
      Returns:
      List of cell addresses
      Throws:
      RangeException - Throws a RangeException if the value of one passed address parts is out of range (A-XFD and 1 to 1048576)

    • getCellRange

      public static List<Address> getCellRange(Address startAddress, Address endAddress)
      Get a list of cell addresses from a cell range
      Parameters:
      startAddress - Start address
      endAddress - End address
      Returns:
      List of cell addresses
      Throws:
      FormatException - Throws a FormatException if a part of the passed addresses is malformed
      RangeException - Throws a RangeException if the value of one passed address is out of range (A-XFD and 1 to 1048576)

    • resolveCellAddress

      public static String resolveCellAddress(int column, int row)
      Gets the address of a cell by the column and row number (zero based)
      Parameters:
      column - Column address of the cell (zero-based)
      row - Row address of the cell (zero-based)
      Returns:
      Cell Address as string in the format A1 - XFD1048576
      Throws:
      RangeException - Throws a RangeException if the start or end address was out of range

    • resolveCellAddress

      public static String resolveCellAddress(int column, int row, Cell.AddressType type)
      Gets the address of a cell by the column and row number (zero based)
      Parameters:
      column - Column address of the cell (zero-based)
      row - Row address of the cell (zero-based)
      type - Referencing type of the address
      Returns:
      Cell Address as string in the format A1 - XFD1048576. Depending on the type, Addresses like '$A55', 'B$2' or '$A$5' are possible outputs
      Throws:
      RangeException - Throws a RangeException if the start or end address was out of range

    • resolveCellCoordinate

      public static Address resolveCellCoordinate(String address)
      Gets the column and row number (zero based) of a cell by the address
      Parameters:
      address - Address as string in the format A1 - XFD1048576. '$' signs indicating fixed rows and / or columns are considered
      Returns:
      Address object of the passed string
      Throws:
      FormatException - Throws a FormatException if the passed address is malformed
      RangeException - Throws a RangeException if the value of the passed address is out of range (A-XFD and 1 to 1048576)

    • resolveCellRange

      public static Range resolveCellRange(String range)
      Resolves a cell range from the format like A1:B3 or AAD556:AAD1000
      Parameters:
      range - Range to process
      Returns:
      Range object of the passed string range
      Throws:
      FormatException - Thrown if the passed range is malformed

    • resolveColumn

      public static int resolveColumn(String columnAddress)
      Gets the column number from the column address (A - XFD)
      Parameters:
      columnAddress - Column address (A - XFD)
      Returns:
      Column number (zero-based)
      Throws:
      RangeException - Thrown if the column is out of range

    • resolveColumnAddress

      public static String resolveColumnAddress(int columnNumber)
      Gets the column address (A - XFD)
      Parameters:
      columnNumber - Column number (zero-based)
      Returns:
      Column address (A - XFD)
      Throws:
      RangeException - Thrown if the passed column number is out of range

    • getAddressScope

      public static Cell.AddressScope getAddressScope(String addressExpression)
      Gets the scope of the passed address (string expression). Scope means either single cell address or range
      Parameters:
      addressExpression - Address expression
      Returns:
      Scope of the address expression