Interface SpreadsheetInCtrl


public interface SpreadsheetInCtrl
Special controller interface for controlling client to server behavior. Only spreadsheet developer need to use this interface. (All method start should with in prefix to represent a client side update)
Author:
Dennis.Chen
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSelectionRect(int left, int top, int right, int bottom)
    Indicate user change multiple selection rectangle
    void
    addSelectionRect(int left, int top, int right, int bottom, CellSelectionType type)
    Indicate user change multiple selection rectangle
    void
    setColumnSize(String sheetId, int column, int newsize, int id, boolean hidden)
    Indicate user set the size of a column
    void
    setFocusRect(int left, int top, int right, int bottom)
    Indicate user change focus rectangle
    void
    setLoadedRect(int left, int top, int right, int bottom)
    Indicate user do some scroll, and change loaded rectangle.
    void
    setRowSize(String sheetId, int row, int newsize, int id, boolean hidden, boolean isCustom)
    Indicate user set the size of a row
    void
    setSelectedSheetDirectly(String name, boolean cacheInClient, int row, int col, int left, int top, int right, int bottom, int highlightLeft, int highlightTop, int highlightRight, int highlightBottom, int rowfreeze, int colfreeze)
     
    void
    setSelectionRect(int left, int top, int right, int bottom)
    Indicate user change selection rectangle
    void
     
    void
    setVisibleRect(int left, int top, int right, int bottom)
    Indicate user's visible range
  • Method Details

    • setColumnSize

      void setColumnSize(String sheetId, int column, int newsize, int id, boolean hidden)
      Indicate user set the size of a column
      Parameters:
      sheetId - the sheet id
      column - the column index
      newsize - the new size
      id - a unique id of this customized column size
      hidden - whether this column is hidden
    • setRowSize

      void setRowSize(String sheetId, int row, int newsize, int id, boolean hidden, boolean isCustom)
      Indicate user set the size of a row
      Parameters:
      sheetId - the sheet id
      row - the row index
      newsize - the new size
      id - a unique id of this customized column size
      hidden - whether this row is hidden
      isCustom - whether the size is custom (set by users) or not (determined by the component automatically)
    • setSelectionRect

      void setSelectionRect(int left, int top, int right, int bottom)
      Indicate user change selection rectangle
    • setFocusRect

      void setFocusRect(int left, int top, int right, int bottom)
      Indicate user change focus rectangle
    • setLoadedRect

      void setLoadedRect(int left, int top, int right, int bottom)
      Indicate user do some scroll, and change loaded rectangle.
    • setVisibleRect

      void setVisibleRect(int left, int top, int right, int bottom)
      Indicate user's visible range
      Parameters:
      left -
      top -
      right -
      bottom -
    • setSelectedSheetDirectly

      void setSelectedSheetDirectly(String name, boolean cacheInClient, int row, int col, int left, int top, int right, int bottom, int highlightLeft, int highlightTop, int highlightRight, int highlightBottom, int rowfreeze, int colfreeze)
    • setSelType

      void setSelType(CellSelectionType type)
      Parameters:
      type -
      Since:
      3.8.3
    • addSelectionRect

      void addSelectionRect(int left, int top, int right, int bottom)
      Indicate user change multiple selection rectangle
      Since:
      6.0.0
    • addSelectionRect

      void addSelectionRect(int left, int top, int right, int bottom, CellSelectionType type)
      Indicate user change multiple selection rectangle
      Since:
      6.0.0