Package io.jmix.reportsspreadsheetflowui.runner

Class SpreadsheetReportExecutionPresentation

java.lang.Object

io.jmix.reportsspreadsheetflowui.runner.SpreadsheetReportExecutionPresentation

All Implemented Interfaces:

ReportExecutionPresentation

@Component("repspd_SpreadsheetReportExecutionPresentation")
public class SpreadsheetReportExecutionPresentation
extends Object
implements ReportExecutionPresentation

ReportExecutionPresentation that targets the embedded spreadsheet viewer.

Limits template and output-type choices to XLS/XLSX combinations that the spreadsheet viewer can render.

Constructor Summary

Constructors

Constructor	Description
SpreadsheetReportExecutionPresentation()

Method Summary

Modifier and Type	Method	Description
List<ReportOutputType>	getAvailableOutputTypes(@Nullable Report report, @Nullable ReportTemplate template)
List<ReportTemplate>	getAvailableTemplates(@Nullable Report report)
String	getId()
boolean	requiresUserChoice(@Nullable Report report, @Nullable ReportTemplate selectedTemplate, @Nullable ReportOutputType selectedOutputType)	A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.
@Nullable ReportOutputType	resolveDefaultOutputType(@Nullable Report report, @Nullable ReportTemplate template, @Nullable ReportOutputType selectedOutputType)	Resolves the output type to run the report with.
@Nullable ReportTemplate	resolveDefaultTemplate(@Nullable Report report, @Nullable ReportTemplate selectedTemplate)
protected boolean	supportsOutputType(@Nullable ReportOutputType outputType)
boolean	supportsReport(@Nullable Report report)
protected boolean	supportsTemplate(@Nullable ReportTemplate template)

Methods inherited from class java.lang.Object

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

Constructor Details

SpreadsheetReportExecutionPresentation

public SpreadsheetReportExecutionPresentation()

Method Details

getId

public String getId()

Specified by:

getId in interface ReportExecutionPresentation

Returns:

ReportExecutionPresentationIds.SPREADSHEET

supportsReport

public boolean supportsReport(@Nullable Report report)

Specified by:

supportsReport in interface ReportExecutionPresentation

Returns:

true if the report has at least one template that can be opened in the spreadsheet viewer

getAvailableTemplates

public List<ReportTemplate> getAvailableTemplates(@Nullable Report report)

Specified by:

getAvailableTemplates in interface ReportExecutionPresentation

Returns:

templates of the report that produce spreadsheet-compatible output

resolveDefaultTemplate

public @Nullable ReportTemplate resolveDefaultTemplate(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate)

Specified by:

resolveDefaultTemplate in interface ReportExecutionPresentation

Returns:

the template to use by default when opening in the spreadsheet viewer, preferring selectedTemplate if it is spreadsheet-compatible

getAvailableOutputTypes

public List<ReportOutputType> getAvailableOutputTypes(@Nullable Report report,
 @Nullable ReportTemplate template)

Specified by:

getAvailableOutputTypes in interface ReportExecutionPresentation

Returns:

output types for the template that are renderable in the spreadsheet viewer, or an empty list when the template does not support alterable output

resolveDefaultOutputType

public @Nullable ReportOutputType resolveDefaultOutputType(@Nullable Report report,
 @Nullable ReportTemplate template,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

Resolves the output type to run the report with.

An explicitly requested selectedOutputType, e.g. the one set through the report runner API, must not be silently replaced: an implementation may return another type only if the requested one cannot be produced, either because this presentation is unable to render it or because the template cannot be converted to it. Restrictions on what the user is allowed to choose belong to ReportExecutionPresentation.getAvailableOutputTypes(Report, ReportTemplate) instead.

Specified by:

resolveDefaultOutputType in interface ReportExecutionPresentation

Returns:

the output type to use by default when opening in the spreadsheet viewer, preferring selectedOutputType if it is spreadsheet-compatible

requiresUserChoice

public boolean requiresUserChoice(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.

Specified by:

requiresUserChoice in interface ReportExecutionPresentation

Returns:

true if the user must choose a template or output type before the report can be opened in the spreadsheet viewer. Returns true whenever multiple spreadsheet-compatible templates exist (even if a default was pre-filled by the runner) or when the single template offers more than one compatible output type and none has been explicitly chosen.

supportsTemplate

protected boolean supportsTemplate(@Nullable ReportTemplate template)

supportsOutputType

protected boolean supportsOutputType(@Nullable ReportOutputType outputType)