Interface FormulaErrorReporter

All Known Implementing Classes:
FormulaTooltipErrorReporter

public interface FormulaErrorReporter
Implementations of this interface are intended to report errors on evaluating formulas via FormulaDataProvider.
Since:
1.4
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFormulaError(int column, int row, String message)
    Registers the error message for the given cell coordinates to this FormulaErrorReporter.
    void
    clearFormulaError(int column, int row)
    Removes the error message for the given cell coordinates.
    getFormulaError(int column, int row)
    Returns the error message that is registered for the given cell coordinates or null if no error message is registered for that cell coordinates.
    boolean
    hasFormulaError(int column, int row)
    Checks if an error message is registered for the given cell coordinates.
  • Method Details

    • addFormulaError

      void addFormulaError(int column, int row, String message)
      Registers the error message for the given cell coordinates to this FormulaErrorReporter.
      Parameters:
      column - The column index of the cell where the error happened.
      row - The row index of the cell where the error happened.
      message - The error message.
    • clearFormulaError

      void clearFormulaError(int column, int row)
      Removes the error message for the given cell coordinates.
      Parameters:
      column - The column index of the cell for which an error message is registered.
      row - The row index of the cell for which an error message is registered.
    • hasFormulaError

      boolean hasFormulaError(int column, int row)
      Checks if an error message is registered for the given cell coordinates.
      Parameters:
      column - The column index of the cell for which a check should be performed.
      row - The row index of the cell for which a check should be performed.
      Returns:
      true if an error message is registered for the given cell coordinates, false if not.
    • getFormulaError

      String getFormulaError(int column, int row)
      Returns the error message that is registered for the given cell coordinates or null if no error message is registered for that cell coordinates.
      Parameters:
      column - The column index of the cell for which the error message is requested.
      row - The row index of the cell for which the error message is requested.
      Returns:
      The error message that is registered for the given cell coordinates or null if no error message is registered for that cell coordinates.