Package io.jmix.reportsflowui.runner

Interface SpreadsheetViewSupport

All Known Implementing Classes:
SpreadsheetReportSupport
@NullMarked public interface SpreadsheetViewSupport
Optional contract for UI views to check spreadsheet rendering availability and open stored report outputs. Implemented by the premium spreadsheet module and injected as an optional bean.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isSpreadsheetViewAccessible()
     
    boolean
    open(@Nullable View<?> owner, FileRef fileRef)
    Opens the stored file in the spreadsheet viewer relative to the given owner view.
    boolean
    supportsFileRef(@Nullable FileRef fileRef)
     

  • Method Details

    • supportsFileRef

      boolean supportsFileRef(@Nullable FileRef fileRef)
      Returns:
      whether the given stored file can be opened in a spreadsheet viewer

    • open

      boolean open(@Nullable View<?> owner, FileRef fileRef)
      Opens the stored file in the spreadsheet viewer relative to the given owner view.
      Returns:
      true if the file was successfully opened, false otherwise

    • isSpreadsheetViewAccessible

      boolean isSpreadsheetViewAccessible()
      Returns:
      whether the current user is allowed to open the spreadsheet viewer view. Report views use it to hide the "open in spreadsheet" action from users who lack access to that view, so the action is not offered when activating it would be denied.