Module io.github.tonywasher.joceanus.prometheus.sheet.api
Package io.github.tonywasher.joceanus.prometheus.service.sheet

Interface PrometheusSheet.PrometheusSheetSheetCtl

All Known Implementing Classes:
PrometheusSheetSheet
Enclosing interface:
PrometheusSheet
public static interface PrometheusSheet.PrometheusSheetSheetCtl
Interface representing a sheet within a workBook.

  • Method Details

    • getName

      String getName()
      Obtain the name of the sheet.
      Returns:
      the name

    • getSheetIndex

      int getSheetIndex()
      Get sheet index.
      Returns:
      the index of the sheet

    • isHidden

      boolean isHidden()
      Is the sheet hidden?
      Returns:
      true/false

    • setHidden

      void setHidden(boolean isHidden)
      Set sheet hidden status.
      Parameters:
      isHidden - true/false

    • getReadOnlyRowByIndex

      PrometheusSheet.PrometheusSheetRowCtl getReadOnlyRowByIndex(int pRowIndex)
      Obtain the row at required index within the sheet, if it exists.
      Parameters:
      pRowIndex - the requested row index
      Returns:
      the requested row.

    • getMutableRowByIndex

      PrometheusSheet.PrometheusSheetRowCtl getMutableRowByIndex(int pRowIndex)
      Obtain the row at required index within the sheet, create it if it does not exist.
      Parameters:
      pRowIndex - the requested row index
      Returns:
      the requested row.

    • getReadOnlyColumnByIndex

      PrometheusSheet.PrometheusSheetColumnCtl getReadOnlyColumnByIndex(int pColIndex)
      Obtain the column by index.
      Parameters:
      pColIndex - the column index
      Returns:
      the column

    • getMutableColumnByIndex

      PrometheusSheet.PrometheusSheetColumnCtl getMutableColumnByIndex(int pColIndex)
      Obtain the column by index, creating column if it does not exist.
      Parameters:
      pColIndex - the column index
      Returns:
      the column

    • declareRange

      void declareRange(String pName, PrometheusSheetCellPosition pFirstCell, PrometheusSheetCellPosition pLastCell) throws OceanusException
      Name a range.
      Parameters:
      pName - the name of the range
      pFirstCell - the first cell in the range
      pLastCell - the last cell in the range
      Throws:
      OceanusException - on error

    • applyDataValidation

      void applyDataValidation(PrometheusSheetCellPosition pFirstCell, PrometheusSheetCellPosition pLastCell, String pName) throws OceanusException
      Apply data validation to a range of cells.
      Parameters:
      pFirstCell - the first cell in the range
      pLastCell - the last cell in the range
      pName - the name of the validation range list
      Throws:
      OceanusException - on error

    • applyDataFilter

      void applyDataFilter(PrometheusSheetCellPosition pBaseCell, int pNumRows) throws OceanusException
      Apply data validation to a range of cells.
      Parameters:
      pBaseCell - the first cell in the range
      pNumRows - the number of rows in the filter
      Throws:
      OceanusException - on error

    • createFreezePane

      void createFreezePane(PrometheusSheetCellPosition pFreezeCell)
      Create freeze panes.
      Parameters:
      pFreezeCell - the cell to freeze at