@Component(value="cuba_ReportGuiManager")
public class ReportGuiManager
extends java.lang.Object
Constructor and Description |
---|
ReportGuiManager() |
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) |
public void runReport(Report report, com.haulmont.cuba.gui.components.Frame window)
report
- - target reportwindow
- - caller windowpublic 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)
report
- - target reportwindow
- - caller windowparameter
- - input parameter linked with passed parameter valueparameterValue
- -templateCode
- - target template codeoutputFileName
- - name for output filepublic void printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, @Nullable java.lang.String templateCode, @Nullable java.lang.String outputFileName)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output filepublic void printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)public void printReport(Report report, java.util.Map<java.lang.String,java.lang.Object> params, com.haulmont.cuba.gui.components.Frame window)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)window
- - caller windowpublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output filewindow
- - caller windowpublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output fileoutputType
- - output type for filewindow
- - caller windowpublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output filewindow
- - caller windowpublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output fileoutputType
- - output type for filewindow
- - caller windowpublic com.haulmont.yarg.reporting.ReportOutputDocument getReportResult(Report report, java.util.Map<java.lang.String,java.lang.Object> params, @Nullable java.lang.String templateCode)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codepublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputType
- - target output typepublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output filewindow
- - caller windowpublic 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)
report
- - target reportparams
- - report parameters (map keys should match with parameter aliases)templateCode
- - target template codeoutputFileName
- - name for output fileoutputType
- - output type for filewindow
- - caller windowpublic 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)
screenId
- - id of the screenuser
- - caller userinputValueMetaClass
- - meta class of report input parameterpublic 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)
report
- - target reporttemplateCode
- - target template codeoutputType
- - output type for filealias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic 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)
report
- - target reportalias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic void bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities, @Nullable com.haulmont.cuba.gui.components.Frame window)
report
- - target reportalias
- - inputParameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowpublic void bulkPrint(Report report, java.lang.String alias, java.util.Collection selectedEntities)
report
- - target reportalias
- - parameter aliasselectedEntities
- - list of selected entitiespublic 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)
report
- - target reportalias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic 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)
report
- - target reporttemplateCode
- - target template codeoutputType
- - output type for filealias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic void bulkPrintSync(Report report, java.lang.String alias, java.util.Collection selectedEntities, @Nullable com.haulmont.cuba.gui.components.Frame window)
report
- - target reportalias
- - inputParameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowpublic 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)
report
- - target reportalias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic 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)
report
- - target reporttemplateCode
- - target template codeoutputType
- - output type for filealias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowadditionalParameters
- - user-defined parameterspublic void bulkPrintBackground(Report report, java.lang.String alias, java.util.Collection selectedEntities, com.haulmont.cuba.gui.components.Frame window)
report
- - target reportalias
- - parameter aliasselectedEntities
- - list of selected entitieswindow
- - caller windowpublic boolean parameterMatchesMetaClass(ReportInputParameter parameter, com.haulmont.chile.core.model.MetaClass metaClass)
public boolean inputParametersRequiredByTemplates(Report report)
public boolean containsAlterableTemplate(Report report)
public boolean supportAlterableForTemplate(ReportTemplate template)