com.haulmont.reports.gui

Class ReportGuiManager

java.lang.Object

com.haulmont.reports.gui.ReportGuiManager

@Component(value="cuba_ReportGuiManager")
public class ReportGuiManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReportGuiManager()

Method Summary

Modifier and Type	Method and Description
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrint(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintBackground(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
void	bulkPrintSync(Report report, java.lang.String templateCode, ReportOutputType outputType, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window, java.util.Map<java.lang.String,java.lang.Object> additionalParameters) Print certain reports for list of entities and pack result files into ZIP.
boolean	containsAlterableTemplate(Report report)
java.util.List<Report>	getAvailableReports(java.lang.String screenId, com.haulmont.cuba.security.entity.User user, com.haulmont.chile.core.model.MetaClass inputValueMetaClass) Return list of reports, available for certain screen, user and input parameter
com.haulmont.yarg.reporting.ReportOutputDocument	getReportResult(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode) Generate ReportOutputDocument
com.haulmont.yarg.reporting.ReportOutputDocument	getReportResult(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, ReportOutputType outputType) Generate ReportOutputDocument
boolean	inputParametersRequiredByTemplates(Report report)
boolean	parameterMatchesMetaClass(ReportInputParameter parameter, com.haulmont.chile.core.model.MetaClass metaClass) Check if the meta class is applicable for the input parameter
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params) Print report synchronously
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, com.haulmont.cuba.gui.components.Frame window) Print report synchronously or asynchronously, depending on configurations
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName) Print report synchronously
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, com.haulmont.cuba.gui.components.Frame window) Print report synchronously or asynchronously, depending on configurations
void	printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, com.haulmont.cuba.gui.components.Frame window) Print report synchronously or asynchronously, depending on configurations
void	printReportBackground(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, com.haulmont.cuba.gui.components.Frame window) Print report in background task with window, supports cancel
void	printReportBackground(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, com.haulmont.cuba.gui.components.Frame window) Print report in background task with window, supports cancel
void	printReportSync(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, com.haulmont.cuba.gui.components.Frame window) Print report synchronously
void	printReportSync(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String templateCode, java.lang.String outputFileName, ReportOutputType outputType, com.haulmont.cuba.gui.components.Frame window) Print report synchronously
void	runReport(Report report, com.haulmont.cuba.gui.components.Frame window) Open input parameters dialog if report has parameters otherwise print report
void	runReport(Report report, com.haulmont.cuba.gui.components.Frame window, ReportInputParameter parameter, java.lang.Object parameterValue, java.lang.String templateCode, java.lang.String outputFileName) Open input parameters dialog if report has parameters otherwise print report.
boolean	supportAlterableForTemplate(ReportTemplate template)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportGuiManager

public ReportGuiManager()

Method Detail

runReport

public void runReport(Report report,
                      com.haulmont.cuba.gui.components.Frame window)

Open input parameters dialog if report has parameters otherwise print report

Parameters:

report - - target report

window - - caller window

runReport

public void runReport(Report report,
                      com.haulmont.cuba.gui.components.Frame window,
                      ReportInputParameter parameter,
                      java.lang.Object parameterValue,
                      @Nullable
                      java.lang.String templateCode,
                      @Nullable
                      java.lang.String outputFileName)

Open input parameters dialog if report has parameters otherwise print report. The method allows to select target template code, pass single parameter to report, and set output file name.

Parameters:

report - - target report

window - - caller window

parameter - - input parameter linked with passed parameter value

parameterValue - -

templateCode - - target template code

outputFileName - - name for output file

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        com.haulmont.cuba.gui.components.Frame window)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

window - - caller window

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName,
                        @Nullable
                        com.haulmont.cuba.gui.components.Frame window)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

window - - caller window

printReport

public void printReport(Report report,
                        java.util.Map<java.lang.String,java.lang.Object> params,
                        @Nullable
                        java.lang.String templateCode,
                        @Nullable
                        java.lang.String outputFileName,
                        @Nullable
                        ReportOutputType outputType,
                        com.haulmont.cuba.gui.components.Frame window)

Print report synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

window - - caller window

printReportSync

public void printReportSync(Report report,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            @Nullable
                            java.lang.String templateCode,
                            @Nullable
                            java.lang.String outputFileName,
                            @Nullable
                            com.haulmont.cuba.gui.components.Frame window)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

window - - caller window

printReportSync

public void printReportSync(Report report,
                            java.util.Map<java.lang.String,java.lang.Object> params,
                            @Nullable
                            java.lang.String templateCode,
                            @Nullable
                            java.lang.String outputFileName,
                            @Nullable
                            ReportOutputType outputType,
                            @Nullable
                            com.haulmont.cuba.gui.components.Frame window)

Print report synchronously

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

window - - caller window

getReportResult

public com.haulmont.yarg.reporting.ReportOutputDocument getReportResult(Report report,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        @Nullable
                                                                        java.lang.String templateCode)

Generate ReportOutputDocument

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

Returns:

resulting ReportOutputDocument

getReportResult

public com.haulmont.yarg.reporting.ReportOutputDocument getReportResult(Report report,
                                                                        java.util.Map<java.lang.String,java.lang.Object> params,
                                                                        @Nullable
                                                                        java.lang.String templateCode,
                                                                        @Nullable
                                                                        ReportOutputType outputType)

Generate ReportOutputDocument

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputType - - target output type

Returns:

resulting ReportOutputDocument

printReportBackground

public void printReportBackground(Report report,
                                  java.util.Map<java.lang.String,java.lang.Object> params,
                                  @Nullable
                                  java.lang.String templateCode,
                                  @Nullable
                                  java.lang.String outputFileName,
                                  com.haulmont.cuba.gui.components.Frame window)

Print report in background task with window, supports cancel

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

window - - caller window

printReportBackground

public void printReportBackground(Report report,
                                  java.util.Map<java.lang.String,java.lang.Object> params,
                                  @Nullable
                                  java.lang.String templateCode,
                                  @Nullable
                                  java.lang.String outputFileName,
                                  @Nullable
                                  ReportOutputType outputType,
                                  com.haulmont.cuba.gui.components.Frame window)

Print report in background task with window, supports cancel

Parameters:

report - - target report

params - - report parameters (map keys should match with parameter aliases)

templateCode - - target template code

outputFileName - - name for output file

outputType - - output type for file

window - - caller window

getAvailableReports

public java.util.List<Report> getAvailableReports(@Nullable
                                                  java.lang.String screenId,
                                                  @Nullable
                                                  com.haulmont.cuba.security.entity.User user,
                                                  @Nullable
                                                  com.haulmont.chile.core.model.MetaClass inputValueMetaClass)

Return list of reports, available for certain screen, user and input parameter

Parameters:

screenId - - id of the screen

user - - caller user

inputValueMetaClass - - meta class of report input parameter

bulkPrint

public void bulkPrint(Report report,
                      @Nullable
                      java.lang.String templateCode,
                      @Nullable
                      ReportOutputType outputType,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      com.haulmont.cuba.gui.components.Frame window,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      com.haulmont.cuba.gui.components.Frame window,
                      @Nullable
                      java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities,
                      @Nullable
                      com.haulmont.cuba.gui.components.Frame window)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as inputParameter with certain alias. Synchronously or asynchronously, depending on configurations

Parameters:

report - - target report

alias - - inputParameter alias

selectedEntities - - list of selected entities

window - - caller window

bulkPrint

public void bulkPrint(Report report,
                      java.lang.String alias,
                      java.util.Collection selectedEntities)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

bulkPrintSync

public void bulkPrintSync(Report report,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          com.haulmont.cuba.gui.components.Frame window,
                          java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrintSync

public void bulkPrintSync(Report report,
                          @Nullable
                          java.lang.String templateCode,
                          @Nullable
                          ReportOutputType outputType,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          com.haulmont.cuba.gui.components.Frame window,
                          java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Synchronously.

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrintSync

public void bulkPrintSync(Report report,
                          java.lang.String alias,
                          java.util.Collection selectedEntities,
                          @Nullable
                          com.haulmont.cuba.gui.components.Frame window)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as inputParameter with certain alias. Synchronously.

Parameters:

report - - target report

alias - - inputParameter alias

selectedEntities - - list of selected entities

window - - caller window

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                com.haulmont.cuba.gui.components.Frame window,
                                java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                @Nullable
                                java.lang.String templateCode,
                                @Nullable
                                ReportOutputType outputType,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                com.haulmont.cuba.gui.components.Frame window,
                                java.util.Map<java.lang.String,java.lang.Object> additionalParameters)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

templateCode - - target template code

outputType - - output type for file

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

additionalParameters - - user-defined parameters

bulkPrintBackground

public void bulkPrintBackground(Report report,
                                java.lang.String alias,
                                java.util.Collection selectedEntities,
                                com.haulmont.cuba.gui.components.Frame window)

Print certain reports for list of entities and pack result files into ZIP. Each entity is passed to report as parameter with certain alias. Asynchronously.

Parameters:

report - - target report

alias - - parameter alias

selectedEntities - - list of selected entities

window - - caller window

parameterMatchesMetaClass

public boolean parameterMatchesMetaClass(ReportInputParameter parameter,
                                         com.haulmont.chile.core.model.MetaClass metaClass)

Check if the meta class is applicable for the input parameter

inputParametersRequiredByTemplates

public boolean inputParametersRequiredByTemplates(Report report)

containsAlterableTemplate

public boolean containsAlterableTemplate(Report report)

supportAlterableForTemplate

public boolean supportAlterableForTemplate(ReportTemplate template)