Package com.vaadin.flow.component.spreadsheet.command

Interface Command

All Superinterfaces:
Serializable
All Known Subinterfaces:
ValueChangeCommand
All Known Implementing Classes:
CellShiftValuesCommand, CellValueCommand, RowInsertOrDeleteCommand, SizeChangeCommand, SpreadsheetCommand
public interface Command extends Serializable
Common interface for all Spreadsheet commands.
Since:
1.0
Author:
Vaadin Ltd.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
    Executes this command.
    int
    getActiveSheetIndex()
    Returns the index of the currently active sheet.
    org.apache.poi.ss.util.CellRangeAddress
    getPaintedCellRange()
    The painted range that should be set when this command is run.
    org.apache.poi.ss.util.CellReference
    getSelectedCellReference()
    The selected cell that should be set when this command is run.
    void
    setActiveSheetIndex(int index)
    Sets the sheet at the given index the currently active sheet.

  • Method Details

    • execute

      void execute()
      Executes this command.

    • getActiveSheetIndex

      int getActiveSheetIndex()
      Returns the index of the currently active sheet.
      Returns:
      index of active sheet

    • setActiveSheetIndex

      void setActiveSheetIndex(int index)
      Sets the sheet at the given index the currently active sheet.
      Parameters:
      index - Index of sheet to set active

    • getSelectedCellReference

      org.apache.poi.ss.util.CellReference getSelectedCellReference()
      The selected cell that should be set when this command is run. In case this command shouldn't change the selected cell, null is returned.
      Returns:
      the selection or null

    • getPaintedCellRange

      org.apache.poi.ss.util.CellRangeAddress getPaintedCellRange()
      The painted range that should be set when this command is run. In case his command shouldn't set a painted range, null is returned.
      Returns:
      the painted range or null