Package io.jmix.reportsflowui.runner

Class TableReportResultHandler

java.lang.Object

io.jmix.reportsflowui.runner.TableReportResultHandler

All Implemented Interfaces:

ReportResultHandler

@NullMarked
@Order(100)
@Component("report_TableReportResultHandler")
public class TableReportResultHandler
extends Object
implements ReportResultHandler

ReportResultHandler that opens report output with the table output type in a table viewer (either dialog or via navigation, depending on configuration).

Field Summary

Fields

Modifier and Type	Field	Description
protected DialogWindows	dialogWindows
protected org.springframework.beans.factory.ObjectProvider<OpenedDialogWindows>	openedDialogWindowsProvider
protected ReportsClientProperties	reportsClientProperties
protected ViewNavigators	viewNavigators

Constructor Summary

Constructors

Constructor	Description
TableReportResultHandler()

Method Summary

Modifier and Type	Method	Description
protected void	closeOpenedDialogs(View<?> owner)	Closes any dialog views currently opened in the owner's UI before navigating to the table view, so that the navigation target is not hidden behind leftover modal layers (e.g.
boolean	handle(ReportOutputDocument document, UiReportRunContext context)	Handles the report output document by opening it in the table viewer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dialogWindows

@Autowired
protected DialogWindows dialogWindows

viewNavigators

@Autowired
protected ViewNavigators viewNavigators

reportsClientProperties

@Autowired
protected ReportsClientProperties reportsClientProperties

openedDialogWindowsProvider

@Autowired
protected org.springframework.beans.factory.ObjectProvider<OpenedDialogWindows> openedDialogWindowsProvider

Constructor Details

TableReportResultHandler

public TableReportResultHandler()

Method Details

handle

public boolean handle(ReportOutputDocument document,
 UiReportRunContext context)

Handles the report output document by opening it in the table viewer.

Returns true if the document was handled (output type is table), false to pass handling to the next handler in the chain.

Specified by:

handle in interface ReportResultHandler

Parameters:

document - the generated report document

context - the run context that produced the document

Returns:

true if the document was handled and further handlers should not be invoked, false to pass to the next handler

closeOpenedDialogs

protected void closeOpenedDialogs(View<?> owner)

Closes any dialog views currently opened in the owner's UI before navigating to the table view, so that the navigation target is not hidden behind leftover modal layers (e.g. the input parameters dialog).