Package io.keikai.api.model

Interface Sheet

All Known Implementing Classes:
SheetImpl
public interface Sheet
This interface provides the access to a sheet of a Book.
Since:
3.0.0
Author:
dennis

  • Method Details

    • getInternalSheet

      SSheet getInternalSheet()
      get the internal model object to do advanced operation
      Note : operate on internal object will not automatically update Spreadsheet
      Returns:

    • getBook

      Book getBook()

    • isProtected

      boolean isProtected()

    • isAutoFilterEnabled

      boolean isAutoFilterEnabled()

    • isDisplayGridlines

      boolean isDisplayGridlines()

    • isRowHidden

      boolean isRowHidden(int row)

    • isColumnHidden

      boolean isColumnHidden(int column)

    • getSheetName

      String getSheetName()

    • getCharts

      List<Chart> getCharts()

    • getPictures

      List<Picture> getPictures()

    • getRowFreeze

      int getRowFreeze()
      Get number of row freeze of this sheet, 0 means no row freeze
      Returns:

    • getColumnFreeze

      int getColumnFreeze()
      Get number of column freeze of this sheet, 0 means no column freeze
      Returns:

    • isPrintGridlines

      boolean isPrintGridlines()

    • getRowHeight

      int getRowHeight(int row)
      get row height in pixel
      Parameters:
      row -
      Returns:
      row height in pixel

    • getColumnWidth

      int getColumnWidth(int column)
      get column width in pixel
      Parameters:
      column -
      Returns:
      column width in pixel

    • getFirstRow

      int getFirstRow()
      get the first row which contains data of this sheet
      Returns:

    • getLastRow

      int getLastRow()
      get the last row which contains data of this sheet
      Returns:

    • getFirstColumn

      int getFirstColumn(int row)
      Get the first column of row which contains data
      Parameters:
      row -
      Returns:
      -1 if not such column or no no such row

    • getLastColumn

      int getLastColumn(int row)
      Get the last column of row which contains data
      Parameters:
      row -
      Returns:
      -1 if not such column or no no such row

    • isHidden

      boolean isHidden()
      Returns whether this sheet is hidden.
      Since:
      3.7.0

    • isVeryHidden

      boolean isVeryHidden()
      Returns whether this sheet is very hidden.
      Since:
      3.7.0

    • isSummaryBelow

      boolean isSummaryBelow()
      Returns whether to display summary below or above for rows.
      Returns:
      true to display summary below, unless display summary above.
      Since:
      6.0.0

    • isSummaryRight

      boolean isSummaryRight()
      Returns whether to display summary right or left for columns.
      Returns:
      true to display summary right, unless display summary left.
      Since:
      6.0.0

    • addCellRegionValueChangeListener

      void addCellRegionValueChangeListener(CellRegion cellRegion, SerializableConsumer<CellRegion> listener)
      Adds the listener when specific cell region value change.
      Parameters:
      cellRegion -
      listener -
      Since:
      6.2.0

    • removeCellRegionValueChangeListener

      boolean removeCellRegionValueChangeListener(CellRegion cellRegion)
      Remove all cell region value change listeners of specific cell region.
      Parameters:
      cellRegion -
      Returns:
      whether the listeners are removed successfully.
      Since:
      6.2.0

    • removeCellRegionValueChangeListener

      boolean removeCellRegionValueChangeListener(SerializableConsumer<CellRegion> listener)
      Remove the cell region value change listener.
      Parameters:
      listener -
      Returns:
      whether the listener is removed successfully.
      Since:
      6.2.0

    • addChart

      Chart addChart(String name, SChart.ChartType type, ViewAnchor anchor)
      Add a chart with name, type and anchor
      Parameters:
      name -
      type -
      anchor -
      Returns:
      the created chart
      Since:
      6.2.0

    • getChartByName

      Chart getChartByName(String name)
      Returns the first chart with specific name
      Parameters:
      name -
      Returns:
      the chart with specific name
      Since:
      6.2.0

    • getChartsByName

      List<Chart> getChartsByName(String name)
      Returns the charts with specific name
      Parameters:
      name -
      Returns:
      the charts with specific name
      Since:
      6.2.0