|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseReport
public class JRBaseReport
| Field Summary | |
|---|---|
protected JRBand |
background
|
protected int |
bottomMargin
|
protected int |
columnCount
|
protected RunDirectionEnum |
columnDirection
|
protected JRBand |
columnFooter
|
protected JRBand |
columnHeader
|
protected int |
columnSpacing
|
protected int |
columnWidth
|
protected JRDataset[] |
datasets
Sub datasets of the report. |
protected JRReportFont |
defaultFont
|
protected JRStyle |
defaultStyle
|
protected JRSection |
detailSection
|
protected JRReportFont[] |
fonts
|
protected java.lang.String |
formatFactoryClass
|
protected boolean |
ignorePagination
|
protected java.util.Set |
importsSet
|
protected boolean |
isFloatColumnFooter
|
protected boolean |
isSummaryNewPage
|
protected boolean |
isSummaryWithPageHeaderAndFooter
|
protected boolean |
isTitleNewPage
|
protected java.lang.String |
language
|
protected JRBand |
lastPageFooter
|
protected int |
leftMargin
|
protected JRDataset |
mainDataset
The main dataset of the report. |
protected java.lang.String |
name
|
protected JRBand |
noData
|
protected OrientationEnum |
orientationValue
|
protected JRBand |
pageFooter
|
protected JRBand |
pageHeader
|
protected int |
pageHeight
|
protected int |
pageWidth
|
protected PrintOrderEnum |
printOrderValue
|
static java.lang.String |
PROPERTY_WHEN_NO_DATA_TYPE
|
protected int |
rightMargin
|
protected JRStyle[] |
styles
|
protected JRBand |
summary
|
protected JRReportTemplate[] |
templates
Report templates. |
protected JRBand |
title
|
protected int |
topMargin
|
protected WhenNoDataTypeEnum |
whenNoDataTypeValue
|
| Constructor Summary | |
|---|---|
JRBaseReport()
|
|
JRBaseReport(JRReport report)
|
|
JRBaseReport(JRReport report,
JRBaseObjectFactory factory)
Constructs a copy of a report. |
|
JRBaseReport(JRReport report,
JRExpressionCollector expressionCollector)
|
|
| Method Summary | |
|---|---|
protected void |
copyTemplates(JRReport report,
JRBaseObjectFactory factory)
|
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. |
JRReportFont |
getDefaultFont()
Deprecated. |
JRStyle |
getDefaultStyle()
Returns a default style. |
JRBand |
getDetail()
Deprecated. Replaced by getDetailSection(). |
JRSection |
getDetailSection()
|
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance. |
JRField[] |
getFields()
Gets an array of report fields. |
JRReportFont[] |
getFonts()
Deprecated. |
java.lang.String |
getFormatFactoryClass()
Gets the name of the class implementing the FormatFactory
interface to use with this report. |
JRGroup[] |
getGroups()
|
java.lang.String[] |
getImports()
Gets an array of imports (needed if report expression require additional classes in order to compile). |
java.lang.String |
getLanguage()
Gets the report language. |
JRBand |
getLastPageFooter()
|
int |
getLeftMargin()
|
JRDataset |
getMainDataset()
Returns the main report dataset. |
java.lang.String |
getName()
Gets the report name. |
JRBand |
getNoData()
|
byte |
getOrientation()
Deprecated. Replaced by getOrientationValue(). |
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. |
byte |
getPrintOrder()
Deprecated. Replaced by getPrintOrderValue(). |
PrintOrderEnum |
getPrintOrderValue()
Specifies whether columns will be filled horizontally or vertically. |
JRPropertiesMap |
getPropertiesMap()
Returns this object's properties map. |
java.lang.String |
getProperty(java.lang.String propName)
Gets a property value |
java.lang.String[] |
getPropertyNames()
Gets an array of report properties names. |
JRQuery |
getQuery()
|
java.lang.String |
getResourceBundle()
Gets the base name of the report associated resource bundle. |
int |
getRightMargin()
|
java.lang.String |
getScriptletClass()
|
JRScriptlet[] |
getScriptlets()
Gets an array of report scriptlets (excluding the scriptletClass one). |
JRSortField[] |
getSortFields()
Gets an array of sort report fields. |
JRStyle[] |
getStyles()
Gets an array of report styles. |
JRBand |
getSummary()
|
JRReportTemplate[] |
getTemplates()
Returns the list of report templates. |
JRBand |
getTitle()
|
int |
getTopMargin()
|
JRVariable[] |
getVariables()
Gets an array of report variables. |
byte |
getWhenNoDataType()
Deprecated. Replaced by getWhenNoDataTypeValue(). |
WhenNoDataTypeEnum |
getWhenNoDataTypeValue()
Specifies the report behavior in case of empty datasources. |
byte |
getWhenResourceMissingType()
Deprecated. Replaced by getWhenResourceMissingTypeValue(). |
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(java.lang.String propName)
|
void |
setProperty(java.lang.String propName,
java.lang.String value)
|
void |
setWhenNoDataType(byte whenNoDataType)
Deprecated. Replaced by setWhenNoDataType(WhenNoDataTypeEnum). |
void |
setWhenNoDataType(WhenNoDataTypeEnum whenNoDataTypeValue)
Sets the report behavior in case of empty datasources. |
void |
setWhenResourceMissingType(byte whenResourceMissingType)
Deprecated. Replaced by setWhenResourceMissingType(WhenResourceMissingTypeEnum). |
void |
setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
Sets the resource missing handling type. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_WHEN_NO_DATA_TYPE
protected java.lang.String name
protected java.lang.String language
protected int columnCount
protected PrintOrderEnum printOrderValue
protected RunDirectionEnum columnDirection
protected int pageWidth
protected int pageHeight
protected OrientationEnum orientationValue
protected WhenNoDataTypeEnum whenNoDataTypeValue
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 java.lang.String formatFactoryClass
protected java.util.Set importsSet
protected JRReportTemplate[] templates
protected JRReportFont defaultFont
protected JRReportFont[] fonts
protected JRStyle defaultStyle
protected JRStyle[] styles
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
| Constructor Detail |
|---|
public JRBaseReport()
public JRBaseReport(JRReport report,
JRExpressionCollector expressionCollector)
public JRBaseReport(JRReport report,
JRBaseObjectFactory factory)
public JRBaseReport(JRReport report)
| Method Detail |
|---|
protected void copyTemplates(JRReport report,
JRBaseObjectFactory factory)
public java.lang.String getName()
JRReport
getName in interface JRReportpublic java.lang.String getLanguage()
JRReport
getLanguage in interface JRReportpublic int getColumnCount()
JRReport
getColumnCount in interface JRReportpublic byte getPrintOrder()
getPrintOrderValue().
getPrintOrder in interface JRReportpublic PrintOrderEnum getPrintOrderValue()
JRReport
getPrintOrderValue in interface JRReportPrintOrderEnumpublic RunDirectionEnum getColumnDirection()
JRReport
getColumnDirection in interface JRReportRunDirectionEnumpublic int getPageWidth()
getPageWidth in interface JRReportpublic int getPageHeight()
getPageHeight in interface JRReportpublic byte getOrientation()
getOrientationValue().
getOrientation in interface JRReportpublic OrientationEnum getOrientationValue()
JRReport
getOrientationValue in interface JRReportOrientationEnumpublic byte getWhenNoDataType()
getWhenNoDataTypeValue().
getWhenNoDataType in interface JRReportpublic WhenNoDataTypeEnum getWhenNoDataTypeValue()
JRReport
getWhenNoDataTypeValue in interface JRReportpublic void setWhenNoDataType(byte whenNoDataType)
setWhenNoDataType(WhenNoDataTypeEnum).
setWhenNoDataType in interface JRReportpublic void setWhenNoDataType(WhenNoDataTypeEnum whenNoDataTypeValue)
JRReport
setWhenNoDataType in interface JRReportpublic int getColumnWidth()
getColumnWidth in interface JRReportpublic int getColumnSpacing()
JRReport
getColumnSpacing 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()
JRReport
isTitleNewPage in interface JRReportpublic boolean isSummaryNewPage()
JRReport
isSummaryNewPage in interface JRReportpublic boolean isSummaryWithPageHeaderAndFooter()
JRReport
isSummaryWithPageHeaderAndFooter in interface JRReportpublic boolean isFloatColumnFooter()
JRReport
isFloatColumnFooter in interface JRReportpublic java.lang.String getScriptletClass()
getScriptletClass in interface JRReportpublic java.lang.String getFormatFactoryClass()
JRReportFormatFactory
interface to use with this report.
getFormatFactoryClass in interface JRReportpublic java.lang.String getResourceBundle()
JRReport
getResourceBundle in interface JRReportpublic java.lang.String[] getPropertyNames()
JRReport
getPropertyNames in interface JRReportpublic java.lang.String getProperty(java.lang.String propName)
JRReport
getProperty in interface JRReportpropName - the property name
public void setProperty(java.lang.String propName,
java.lang.String value)
setProperty in interface JRReportpublic void removeProperty(java.lang.String propName)
removeProperty in interface JRReportpublic java.lang.String[] getImports()
JRReport
getImports in interface JRReportpublic JRReportFont getDefaultFont()
JRDefaultFontProvider
getDefaultFont in interface JRDefaultFontProviderpublic JRReportFont[] getFonts()
JRReport
getFonts in interface JRReportpublic JRStyle getDefaultStyle()
JRDefaultStyleProvider
getDefaultStyle in interface JRDefaultStyleProviderpublic JRStyle[] getStyles()
JRReport
getStyles in interface JRReportpublic JRScriptlet[] getScriptlets()
getScriptlets in interface JRReportpublic JRParameter[] getParameters()
getParameters in interface JRReportpublic JRQuery getQuery()
getQuery in interface JRReportpublic JRField[] getFields()
getFields in interface JRReportpublic JRSortField[] getSortFields()
getSortFields in interface JRReportpublic JRVariable[] getVariables()
getVariables in interface JRReportpublic JRGroup[] getGroups()
getGroups in interface JRReportpublic JRBand getBackground()
getBackground in interface JRReportpublic JRBand getTitle()
getTitle in interface JRReportpublic JRBand getPageHeader()
getPageHeader in interface JRReportpublic JRBand getColumnHeader()
getColumnHeader in interface JRReportpublic JRBand getDetail()
getDetailSection().
getDetail 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 byte getWhenResourceMissingType()
getWhenResourceMissingTypeValue().
getWhenResourceMissingType in interface JRReportpublic WhenResourceMissingTypeEnum getWhenResourceMissingTypeValue()
JRReport
getWhenResourceMissingTypeValue in interface JRReportpublic void setWhenResourceMissingType(byte whenResourceMissingType)
setWhenResourceMissingType(WhenResourceMissingTypeEnum).
setWhenResourceMissingType in interface JRReportpublic void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)
JRReport
setWhenResourceMissingType 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()
JRReport
getDatasets 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()
JRPropertiesHolder
hasProperties in interface JRPropertiesHolderpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap in interface JRPropertiesHolderpublic JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties 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()
getNoData in interface JRReportpublic JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport in interface JRChangeEventsSupport
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||