Package io.keikai.ui.sys

Interface SpreadsheetCtrl

public interface SpreadsheetCtrl
Special controller interface . Only spreadsheet developer need to use this interface.
Author:
Dennis.Chen

  • Field Details

  • Method Details

    • getRowPositionHelper

      HeaderPositionHelper getRowPositionHelper(String sheetId)

    • getColumnPositionHelper

      HeaderPositionHelper getColumnPositionHelper(String sheetId)

    • getMergeMatrixHelper

      MergeMatrixHelper getMergeMatrixHelper(SSheet sheet)

    • getSelectionArea

      AreaRef getSelectionArea()

    • getFocusArea

      AreaRef getFocusArea()

    • getLoadedArea

      AreaRef getLoadedArea()

    • getVisibleArea

      AreaRef getVisibleArea()

    • getWidgetHandler

      WidgetHandler getWidgetHandler()

    • getRowHeaderAttrs

      org.zkoss.json.JSONObject getRowHeaderAttrs(SSheet sheet, int rowStart, int rowEnd)

    • getColumnHeaderAttrs

      org.zkoss.json.JSONObject getColumnHeaderAttrs(SSheet sheet, int colStart, int colEnd)

    • addWidget

      boolean addWidget(Widget widget)
      Add widget to the WidgetHandler of this spreadsheet,
      Parameters:
      widget - a widget
      Returns:
      true if success to add a widget

    • removeWidget

      boolean removeWidget(Widget widget)
      Remove widget from the WidgetHandler of this spreadsheet,
      Parameters:
      widget -
      Returns:
      true if success to remove a widget

    • getTopHeaderHiddens

      Boolean getTopHeaderHiddens(int col)

    • getLeftHeaderHiddens

      Boolean getLeftHeaderHiddens(int row)

    • setUserActionManagerCtrl

      void setUserActionManagerCtrl(UserActionManagerCtrl actionHandler)
      Sets user action manager ctrl
      Since:
      3.0.0

    • getUserActionManagerCtrl

      UserActionManagerCtrl getUserActionManagerCtrl()
      Returns:
      user action manager ctrl
      Since:
      3.0.0

    • getFreezeInfoLoader

      FreezeInfoLoader getFreezeInfoLoader()
      Returns:
      Since:
      3.0.0

    • getRangeAttrs

      org.zkoss.json.JSONObject getRangeAttrs(SSheet sheet, SpreadsheetCtrl.Header containsHeader, SpreadsheetCtrl.CellAttribute type, int left, int top, int right, int bottom)
      Parameters:
      sheet -
      containsHeader -
      type -
      left -
      top -
      right -
      bottom -
      Returns:
      Since:
      3.8.0

    • getSelType

      CellSelectionType getSelType()
      Returns:
      Since:
      3.8.3
      See Also:

    • releaseBook

      void releaseBook()
      Releases the book from the spreadsheet component.
      Since:
      5.1.0

    • getCellAttr

      org.zkoss.json.JSONObject getCellAttr(SSheet sheet, SpreadsheetCtrl.CellAttribute type, int row, int col, StringAggregation styleAggregation, StringAggregation textAggregation, MergeAggregation mergeAggregation)
      Return Cell attributes
      • r: row number
      • c: column number
      • t: cell html text
      • et: cell edit text
      • ft: format text
      • meft: merge cell html text, edit text and format text
      • ct: cell type
      • s: cell style
      • is: cell inner style
      • rb: cell right border
      • l: locked</>
      • wp: wrap
      • ha: horizontal alignment</>
      • va: vertical alignment</>
      • mi: merge id index
      • mc: merge CSS index
      • fs: font size
      • fn: font name
      • ovf: overflow
      Ignore put attribute if it's default Default attributes
      • Cell type: blank</>
      • Locked: true</>
      • Wrap: false
      • Horizontal alignment: left</>
      • Vertical alignment: top</>
      • Overflow: false
      • Font size: 11pt</>