Package io.jmix.reportsui.runner

Class UiReportRunContext

java.lang.Object

io.jmix.reportsui.runner.UiReportRunContext

public class UiReportRunContext
extends Object

Class stores the information required for report running from UI. The instance of the class may be created using the constructor or using the FluentUiReportRunner bean.
In addition to options required to run a report, it is possible to control the following ones:

• Show dialog to input the report parameters before a run or not
• Execute report generation synchronously or in the background

Note: if a report runs in the background, the screen (or screen fragment) from which the report runs should be specified as well.
Creation examples:

  UiReportRunContext context = new UiReportRunContext(report)
                 .addParam("customers", customersList)
                 .setOutputNamePattern("Customers")
                 .setOriginFrameOwner(screen)
                 .setInBackground(true)
                 .setParametersDialogShowMode(ParametersDialogShowMode.NO);


  UiReportRunContext context = new UiReportRunContext(report)
                 .setReportTemplate(template)
                 .setOutputType(ReportOutputType.PDF)
                 .setParams(paramsMap);

  UiReportRunContext context = new UiReportRunContext(report)
                 .setOutputNamePattern("Customers")
                 .setParametersDialogShowMode(ParametersDialogShowMode.IF_REQUIRED);
 

See Also:

• FluentUiReportRunner
• UiReportRunner
• ParametersDialogShowMode

Constructor Summary

Constructors

Constructor	Description
UiReportRunContext()
UiReportRunContext(Report report)

Method Summary

Modifier and Type	Method	Description
UiReportRunContext	addParam(String alias, Object value)
boolean	getInBackground()
FrameOwner	getOriginFrameOwner()
String	getOutputNamePattern()
ReportOutputType	getOutputType()
ParametersDialogShowMode	getParametersDialogShowMode()
Map<String,Object>	getParams()
Report	getReport()
ReportRunContext	getReportRunContext()
ReportTemplate	getReportTemplate()
UiReportRunContext	setInBackground(boolean inBackground)
UiReportRunContext	setOriginFrameOwner(FrameOwner originFrameOwner)
UiReportRunContext	setOutputNamePattern(String outputNamePattern)
UiReportRunContext	setOutputType(ReportOutputType type)
UiReportRunContext	setParametersDialogShowMode(ParametersDialogShowMode parametersDialogShowMode)
UiReportRunContext	setParams(Map<String,Object> params)
UiReportRunContext	setReport(Report report)
UiReportRunContext	setReportRunContext(ReportRunContext reportRunContext)
UiReportRunContext	setReportTemplate(ReportTemplate template)

Methods inherited from class java.lang.Object

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

Constructor Details

UiReportRunContext

public UiReportRunContext()

UiReportRunContext

public UiReportRunContext(Report report)

Method Details

getReportRunContext

public ReportRunContext getReportRunContext()

setReportRunContext

public UiReportRunContext setReportRunContext(ReportRunContext reportRunContext)

getOriginFrameOwner

@Nullable
public FrameOwner getOriginFrameOwner()

setOriginFrameOwner

public UiReportRunContext setOriginFrameOwner(FrameOwner originFrameOwner)

getInBackground

public boolean getInBackground()

setInBackground

public UiReportRunContext setInBackground(boolean inBackground)

getParametersDialogShowMode

@Nullable
public ParametersDialogShowMode getParametersDialogShowMode()

setParametersDialogShowMode

public UiReportRunContext setParametersDialogShowMode(@Nullable
 ParametersDialogShowMode parametersDialogShowMode)

setReport

public UiReportRunContext setReport(Report report)

setParams

public UiReportRunContext setParams(Map<String,Object> params)

addParam

public UiReportRunContext addParam(String alias,
 Object value)

setReportTemplate

public UiReportRunContext setReportTemplate(ReportTemplate template)

setOutputType

public UiReportRunContext setOutputType(ReportOutputType type)

setOutputNamePattern

public UiReportRunContext setOutputNamePattern(String outputNamePattern)

getReport

public Report getReport()

getOutputType

@Nullable
public ReportOutputType getOutputType()

getParams

public Map<String,Object> getParams()

getOutputNamePattern

@Nullable
public String getOutputNamePattern()

getReportTemplate

@Nullable
public ReportTemplate getReportTemplate()