Package io.jmix.reportsspreadsheetflowui.view

Class ReportSpreadsheetView

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.Composite<ViewLayout>
io.jmix.flowui.view.View<ViewLayout>
io.jmix.flowui.view.StandardView
io.jmix.reportsspreadsheetflowui.view.ReportSpreadsheetView
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, FacetOwner, FragmentOwner, Serializable
@Route(value="report/spreadsheets", layout=DefaultMainViewParent.class) @ViewController("report_ReportSpreadsheetView") @ViewDescriptor("report-spreadsheet-view.xml") @DialogMode(width="80em", height="65em", resizable=true) public class ReportSpreadsheetView extends StandardView
View that renders a generated spreadsheet report and allows downloading the current workbook state. Can be opened either as a dialog or via navigation to its route.
See Also:

  • Field Details

  • Constructor Details

    • ReportSpreadsheetView

      public ReportSpreadsheetView()

  • Method Details

    • setDocumentContent

      public void setDocumentContent(byte[] documentContent)
      Sets generated report content to be opened by this view.

    • setDocumentName

      public void setDocumentName(@Nullable String documentName)
      Sets the report document name shown by the view and used for download.

    • setFileRef

      public void setFileRef(FileRef fileRef)
      Sets a stored report document reference to be opened by this view.

    • setContent

      public void setContent(ReportSpreadsheetContent content)
      Sets the generated report content to be opened by this view.

    • setPendingContent

      public static void setPendingContent(@Nullable com.vaadin.flow.component.UI ui, ReportSpreadsheetContent content)
      Hands the report content over to the ReportSpreadsheetView instance the specified UI navigates to next.

      The content is stored in the UI instead of being passed by a navigation callback, because such a callback is delivered on detaching the origin view: for a dialog that has already been closed it arrives after the target view has been rendered, or does not arrive at all. The target view takes the stored content itself on View.BeforeShowEvent, so the Spreadsheet is filled before it is rendered for the first time.

    • getPageTitle

      public String getPageTitle()
      Specified by:
      getPageTitle in interface com.vaadin.flow.router.HasDynamicTitle
      Overrides:
      getPageTitle in class View<ViewLayout>

    • onBeforeShow

      @Subscribe protected void onBeforeShow(View.BeforeShowEvent event)

    • onReady

      @Subscribe protected void onReady(View.ReadyEvent event)

    • takePendingContent

      protected void takePendingContent()
      Applies the content handed over by setPendingContent(UI, ReportSpreadsheetContent), if any. The pending content is always removed from the UI, but is applied only when this view has no content of its own, so that a view configured directly, e.g. opened as a dialog, is not overwritten.

    • loadContent

      public void loadContent()
      Reads the configured spreadsheet content into the Spreadsheet component. Idempotent: subsequent invocations (e.g. on a repeated lifecycle event) are no-ops, and the method does nothing until setDocumentContent(byte[]) or setFileRef(FileRef) has been called.

    • onOpenInViewBtnClick

      @Subscribe("openInViewBtn") protected void onOpenInViewBtnClick(com.vaadin.flow.component.ClickEvent<JmixButton> event)

    • getCurrentContent

      protected byte[] getCurrentContent()
      Returns the current content of the Spreadsheet component, including unsaved user edits, to be handed over to another instance of this view. Returns null if no content has been loaded yet or the current workbook cannot be written, so the caller falls back to the originally provided content.

    • closeOtherDialogs

      protected void closeOtherDialogs(@Nullable com.vaadin.flow.component.UI ui)
      Closes any other dialog views that remained open (e.g. the input parameters dialog stacked behind this view), so that the navigation target is shown without leftover modal layers.

    • onDownloadBtnClick

      @Subscribe("downloadBtn") protected void onDownloadBtnClick(com.vaadin.flow.component.ClickEvent<JmixButton> event)

    • onCloseBtnClick

      @Subscribe("closeBtn") protected void onCloseBtnClick(com.vaadin.flow.component.ClickEvent<JmixButton> event)

    • openInputStream

      protected InputStream openInputStream() throws IOException
      Throws:
      IOException

    • resolveWorkbookExtension

      protected String resolveWorkbookExtension()

    • buildDownloadFileName

      protected String buildDownloadFileName(String extension)