Package io.keikai.model

Interface SSheetViewInfo

All Known Implementing Classes:
SheetViewInfoImpl
public interface SSheetViewInfo
Store those visual statuses of a sheet, e.g. freeze status of row (column), or grid-line display.
Since:
3.5.0
Author:
dennis

  • Method Details

    • getNumOfRowFreeze

      int getNumOfRowFreeze()

    • getNumOfColumnFreeze

      int getNumOfColumnFreeze()

    • setNumOfRowFreeze

      void setNumOfRowFreeze(int num)

    • setNumOfColumnFreeze

      void setNumOfColumnFreeze(int num)

    • getFreezeTopRow

      int getFreezeTopRow()
      Returns the 0-based index of the first frozen row — the row component of <sheetView topLeftCell> (ECMA-376 §18.3.1.87). For a view that was scrolled before "Freeze Panes" was applied, the frozen region spans [getFreezeTopRow(), getFreezeTopRow() + getNumOfRowFreeze()), so a sheet frozen after scrolling to row 19 reports 18 here (KEIKAI-537).

      Default: 0 (frozen region anchored at row 1).

      Since:
      7.0.0

    • setFreezeTopRow

      void setFreezeTopRow(int row)
      Sets the 0-based first-frozen-row anchor. See getFreezeTopRow().
      Since:
      7.0.0

    • getFreezeLeftColumn

      int getFreezeLeftColumn()
      Returns the 0-based index of the first frozen column — the column component of <sheetView topLeftCell>. Frozen columns span [getFreezeLeftColumn(), getFreezeLeftColumn() + getNumOfColumnFreeze()).

      Default: 0 (frozen region anchored at column A).

      Since:
      7.0.0

    • setFreezeLeftColumn

      void setFreezeLeftColumn(int column)
      Sets the 0-based first-frozen-column anchor. See getFreezeLeftColumn().
      Since:
      7.0.0

    • isDisplayGridlines

      boolean isDisplayGridlines()

    • setDisplayGridlines

      void setDisplayGridlines(boolean enable)

    • getHeader

      SHeader getHeader()

    • getFooter

      SFooter getFooter()

    • getRowBreaks

      int[] getRowBreaks()
      Returns:
      row indexes of all the horizontal page breaks
      See Also:

    • setRowBreaks

      void setRowBreaks(int[] breaks)
      See Also:

    • addRowBreak

      void addRowBreak(int rowIdx)
      See Also:

    • getColumnBreaks

      int[] getColumnBreaks()
      Returns:
      column indexes of all the vertical page breaks
      See Also:

    • setColumnBreaks

      void setColumnBreaks(int[] breaks)
      See Also:

    • addColumnBreak

      void addColumnBreak(int columnIdx)
      See Also:

    • setTabSelected

      void setTabSelected(boolean tabSelected)
      Sets to select the sheet tab.
      Since:
      5.10

    • isTabSelected

      boolean isTabSelected()
      Returns whether the sheet tab is selected.

      Default: false

      Since:
      5.10

    • setActiveCell

      void setActiveCell(String activeCell)
      Sets the active cell.

      Default: "A1"

      Since:
      5.10

    • getActiveCell

      String getActiveCell()
      Returns the active cell.

      Default: "A1"

      Since:
      5.10

    • setSelectionAreas

      void setSelectionAreas(String selectionAreas)
      Sets the selection areas.
      Since:
      5.10

    • getSelectionAreas

      String getSelectionAreas()
      Returns the selection areas.

      Default: "A1"

      Since:
      5.10

    • addSelectionAreas

      void addSelectionAreas(String selectionArea)
      Add the selection area.
      Since:
      6.0.0

    • isRightToLeft

      boolean isRightToLeft()
      Returns whether this sheet uses right-to-left column order and direction. Corresponds to ECMA-376 §18.3.1.88 <sheetView rightToLeft="1"/>.

      Default: false

      Since:
      7.0.0

    • setRightToLeft

      void setRightToLeft(boolean rightToLeft)
      Sets whether this sheet uses right-to-left direction.
      Since:
      7.0.0