public class JRBaseReport extends Object implements JRReport, Serializable, JRChangeEventsSupport
JRReport interface.JRReport,
Serialized FormLANGUAGE_GROOVY, LANGUAGE_JAVA| Constructor and Description |
|---|
JRBaseReport()
Deprecated.
Replaced by
JasperDesign.JasperDesign(). |
JRBaseReport(JRReport report) |
JRBaseReport(JRReport report,
JRBaseObjectFactory factory)
Constructs a copy of a report.
|
JRBaseReport(JRReport report,
JRExpressionCollector expressionCollector) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
copyTemplates(JRReport report,
JRBaseObjectFactory factory) |
JRBand[] |
getAllBands() |
JRBand |
getBackground() |
int |
getBottomMargin() |
int |
getColumnCount()
Gets the number of columns on each page
|
RunDirectionEnum |
getColumnDirection()
Specifies whether columns will be filled from left to right or from right to left.
|
JRBand |
getColumnFooter() |
JRBand |
getColumnHeader() |
int |
getColumnSpacing()
Specifies the space between columns on the same page.
|
int |
getColumnWidth() |
JRDataset[] |
getDatasets()
Returns the datasets of this report.
|
JRStyle |
getDefaultStyle()
Returns a default style.
|
JRSection |
getDetailSection() |
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance.
|
JRField[] |
getFields()
Gets an array of report fields.
|
String |
getFormatFactoryClass()
Gets the name of the class implementing the
FormatFactory
interface to use with this report. |
JRGroup[] |
getGroups() |
String[] |
getImports()
Gets an array of imports (needed if report expression require additional classes in order to compile).
|
String |
getLanguage()
Gets the report language.
|
JRBand |
getLastPageFooter() |
int |
getLeftMargin() |
JRDataset |
getMainDataset()
Returns the main report dataset.
|
String |
getName()
Gets the report name.
|
JRBand |
getNoData() |
OrientationEnum |
getOrientationValue()
Specifies whether document pages will be rendered in a portrait or landscape layout.
|
JRBand |
getPageFooter() |
JRBand |
getPageHeader() |
int |
getPageHeight() |
int |
getPageWidth() |
JRParameter[] |
getParameters()
Gets an array of report parameters (including built-in ones).
|
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults
for this object.
|
PrintOrderEnum |
getPrintOrderValue()
Specifies whether columns will be filled horizontally or vertically.
|
JRPropertiesMap |
getPropertiesMap()
Returns this object's properties map.
|
String |
getProperty(String propName)
Gets a property value
|
String[] |
getPropertyNames()
Gets an array of report properties names.
|
JRQuery |
getQuery() |
String |
getResourceBundle()
Gets the base name of the report associated resource bundle.
|
int |
getRightMargin() |
String |
getScriptletClass() |
JRScriptlet[] |
getScriptlets()
Gets an array of report scriptlets (excluding the scriptletClass one).
|
SectionTypeEnum |
getSectionType()
Specifies whether report sections are made of bands or of parts.
|
JRSortField[] |
getSortFields()
Gets an array of sort report fields.
|
StyleResolver |
getStyleResolver()
Returns a style resolver.
|
JRStyle[] |
getStyles()
Gets an array of report styles.
|
JRBand |
getSummary() |
JRReportTemplate[] |
getTemplates()
Returns the list of report templates.
|
JRBand |
getTitle() |
int |
getTopMargin() |
UUID |
getUUID() |
JRVariable[] |
getVariables()
Gets an array of report variables.
|
WhenNoDataTypeEnum |
getWhenNoDataTypeValue()
Specifies the report behavior in case of empty datasources.
|
WhenResourceMissingTypeEnum |
getWhenResourceMissingTypeValue()
Returns the resource missing handling type.
|
boolean |
hasProperties()
Checks whether the object has any properties.
|
boolean |
isFloatColumnFooter()
Specifies if the column footer section will be printed at the bottom of the column or if it
will immediately follow the last detail or group footer printed on the current column.
|
boolean |
isIgnorePagination()
Decides whether to use pagination when filling the report.
|
boolean |
isSummaryNewPage()
Specifies if the summary section will be printed on a separate last page.
|
boolean |
isSummaryWithPageHeaderAndFooter()
Specifies if the summary section will be accompanied by the page header and footer.
|
boolean |
isTitleNewPage()
Specifies if the title section will be printed on a separate initial page.
|
void |
removeProperty(String propName) |
void |
setJasperReportsContext(JasperReportsContext jasperReportsContext) |
void |
setProperty(String propName,
String value) |
void |
setSectionType(SectionTypeEnum sectionType) |
void |
setWhenNoDataType(WhenNoDataTypeEnum whenNoDataTypeValue)
Sets the report behavior in case of empty datasources.
|
void |
setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
Sets the resource missing handling type.
|
public static final String PROPERTY_WHEN_NO_DATA_TYPE
public static final String PROPERTY_SECTION_TYPE
protected String name
protected String language
protected int columnCount
protected PrintOrderEnum printOrderValue
protected RunDirectionEnum columnDirection
protected int pageWidth
protected int pageHeight
protected OrientationEnum orientationValue
protected WhenNoDataTypeEnum whenNoDataTypeValue
protected SectionTypeEnum sectionType
protected int columnWidth
protected int columnSpacing
protected int leftMargin
protected int rightMargin
protected int topMargin
protected int bottomMargin
protected boolean isTitleNewPage
protected boolean isSummaryNewPage
protected boolean isSummaryWithPageHeaderAndFooter
protected boolean isFloatColumnFooter
protected boolean ignorePagination
protected String formatFactoryClass
protected JRReportTemplate[] templates
protected JRStyle defaultStyle
protected JRStyle[] styles
protected transient StyleResolver styleResolver
protected JRDataset mainDataset
protected JRDataset[] datasets
protected JRBand background
protected JRBand title
protected JRBand pageHeader
protected JRBand columnHeader
protected JRSection detailSection
protected JRBand columnFooter
protected JRBand pageFooter
protected JRBand lastPageFooter
protected JRBand summary
protected JRBand noData
public JRBaseReport()
JasperDesign.JasperDesign().public JRBaseReport(JRReport report, JRExpressionCollector expressionCollector)
public JRBaseReport(JRReport report, JRBaseObjectFactory factory)
public JRBaseReport(JRReport report)
protected void copyTemplates(JRReport report, JRBaseObjectFactory factory)
public void setJasperReportsContext(JasperReportsContext jasperReportsContext)
public String getLanguage()
JRReportgetLanguage in interface JRReportpublic int getColumnCount()
JRReportgetColumnCount in interface JRReportpublic PrintOrderEnum getPrintOrderValue()
JRReportgetPrintOrderValue in interface JRReportPrintOrderEnumpublic RunDirectionEnum getColumnDirection()
JRReportgetColumnDirection in interface JRReportRunDirectionEnumpublic int getPageWidth()
getPageWidth in interface JRReportpublic int getPageHeight()
getPageHeight in interface JRReportpublic OrientationEnum getOrientationValue()
JRReportgetOrientationValue in interface JRReportOrientationEnumpublic WhenNoDataTypeEnum getWhenNoDataTypeValue()
JRReportgetWhenNoDataTypeValue in interface JRReportpublic void setWhenNoDataType(WhenNoDataTypeEnum whenNoDataTypeValue)
JRReportsetWhenNoDataType in interface JRReportpublic SectionTypeEnum getSectionType()
JRReportgetSectionType in interface JRReportSectionTypeEnumpublic void setSectionType(SectionTypeEnum sectionType)
public int getColumnWidth()
getColumnWidth in interface JRReportpublic int getColumnSpacing()
JRReportgetColumnSpacing in interface JRReportpublic int getLeftMargin()
getLeftMargin in interface JRReportpublic int getRightMargin()
getRightMargin in interface JRReportpublic int getTopMargin()
getTopMargin in interface JRReportpublic int getBottomMargin()
getBottomMargin in interface JRReportpublic boolean isTitleNewPage()
JRReportisTitleNewPage in interface JRReportpublic boolean isSummaryNewPage()
JRReportisSummaryNewPage in interface JRReportpublic boolean isSummaryWithPageHeaderAndFooter()
JRReportisSummaryWithPageHeaderAndFooter in interface JRReportpublic boolean isFloatColumnFooter()
JRReportisFloatColumnFooter in interface JRReportpublic String getScriptletClass()
getScriptletClass in interface JRReportpublic String getFormatFactoryClass()
JRReportFormatFactory
interface to use with this report.getFormatFactoryClass in interface JRReportpublic String getResourceBundle()
JRReportgetResourceBundle in interface JRReportpublic String[] getPropertyNames()
JRReportgetPropertyNames in interface JRReportpublic String getProperty(String propName)
JRReportgetProperty in interface JRReportpropName - the property namepublic void setProperty(String propName, String value)
setProperty in interface JRReportpublic void removeProperty(String propName)
removeProperty in interface JRReportpublic String[] getImports()
JRReportgetImports in interface JRReportpublic JRStyle getDefaultStyle()
JRDefaultStyleProvidergetDefaultStyle in interface JRDefaultStyleProviderpublic JRStyle[] getStyles()
JRReportpublic StyleResolver getStyleResolver()
JRDefaultStyleProvidergetStyleResolver in interface JRDefaultStyleProviderpublic JRScriptlet[] getScriptlets()
getScriptlets in interface JRReportpublic JRParameter[] getParameters()
getParameters in interface JRReportpublic JRField[] getFields()
public JRSortField[] getSortFields()
getSortFields in interface JRReportpublic JRVariable[] getVariables()
getVariables in interface JRReportpublic JRBand getBackground()
getBackground in interface JRReportpublic JRBand getPageHeader()
getPageHeader in interface JRReportpublic JRBand getColumnHeader()
getColumnHeader in interface JRReportpublic JRSection getDetailSection()
getDetailSection in interface JRReportpublic JRBand getColumnFooter()
getColumnFooter in interface JRReportpublic JRBand getPageFooter()
getPageFooter in interface JRReportpublic JRBand getLastPageFooter()
getLastPageFooter in interface JRReportpublic JRBand getSummary()
getSummary in interface JRReportpublic WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue()
JRReportgetWhenResourceMissingTypeValue in interface JRReportpublic void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
JRReportsetWhenResourceMissingType in interface JRReportwhenResourceMissingType - the resource missing handling typepublic JRDataset getMainDataset()
JRReportThe main report dataset consists of all parameters, fields, variables and groups of the report.
getMainDataset in interface JRReportpublic JRDataset[] getDatasets()
JRReportgetDatasets in interface JRReportpublic boolean isIgnorePagination()
JRReport
If set to true the report will be generated on one long page.
The design attribute can be overridden at fill time by the IS_IGNORE_PAGINATION
parameter.
isIgnorePagination in interface JRReportpublic boolean hasProperties()
JRPropertiesHolderhasProperties in interface JRPropertiesHolderpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHoldergetPropertiesMap in interface JRPropertiesHolderpublic JRPropertiesHolder getParentProperties()
JRPropertiesHoldergetParentProperties in interface JRPropertiesHoldernull if no parentpublic JRReportTemplate[] getTemplates()
JRReporttemplate.
Templates include styles which can be used in the report.
The order in which the templates are included in the report is important:
getTemplates in interface JRReportnull if noneJRTemplate,
JRParameter.REPORT_TEMPLATESpublic JRBand getNoData()
public JRBand[] getAllBands()
public UUID getUUID()
getUUID in interface JRIdentifiablepublic JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupportgetEventSupport in interface JRChangeEventsSupportCopyright © 2017. All rights reserved.