|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRReport
An abstract representation of a Jasper report. This interface is inherited by all report implementations (designs, compiled reports, filled reports). It only contains constants and getters and setters for the most common report properties and elements.
Field Summary | |
---|---|
static java.lang.String |
LANGUAGE_GROOVY
A constant used to specify that the language used by expressions is Groovy. |
static java.lang.String |
LANGUAGE_JAVA
A constant used to specify that the language used by expressions is Java. |
static byte |
ORIENTATION_LANDSCAPE
Specifies a landscape orientation. |
static byte |
ORIENTATION_PORTRAIT
Specifies a portrait orientation. |
static byte |
PRINT_ORDER_HORIZONTAL
Specifies that columns in a report should be filled horizontally (columns are filled proportionally). |
static byte |
PRINT_ORDER_VERTICAL
Specifies that columns in a report should be filled vertically (fill an entire column and then go to the next one). |
static byte |
WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
Specifies that in case of empty datasources, all sections except detail will displayed. |
static byte |
WHEN_NO_DATA_TYPE_BLANK_PAGE
Specifies that in case of empty datasources, there will be a report with just one blank page. |
static byte |
WHEN_NO_DATA_TYPE_NO_DATA_SECTION
Specifies that in case of empty datasources, the NoData section will be displayed. |
static byte |
WHEN_NO_DATA_TYPE_NO_PAGES
Specifies that in case of empty datasources, there will be an empty report. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_EMPTY
Return empty string when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_ERROR
Throw an exception when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_KEY
Return the key when a resource is missing. |
static byte |
WHEN_RESOURCE_MISSING_TYPE_NULL
Return NULL when a resource is missing. |
Method Summary | |
---|---|
JRBand |
getBackground()
|
int |
getBottomMargin()
|
int |
getColumnCount()
Gets the number of columns on each page |
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. |
JRBand |
getDetail()
Deprecated. Replaced by getDetailSection() . |
JRSection |
getDetailSection()
|
JRField[] |
getFields()
|
JRReportFont[] |
getFonts()
Gets an array of report fonts. |
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()
|
JRBand |
getPageFooter()
|
JRBand |
getPageHeader()
|
int |
getPageHeight()
|
int |
getPageWidth()
|
JRParameter[] |
getParameters()
|
byte |
getPrintOrder()
Specifies whether columns will be filled horizontally or vertically. |
java.lang.String |
getProperty(java.lang.String name)
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()
|
JRSortField[] |
getSortFields()
|
JRStyle[] |
getStyles()
Gets an array of report styles. |
JRBand |
getSummary()
|
JRReportTemplate[] |
getTemplates()
Returns the list of report templates. |
JRBand |
getTitle()
|
int |
getTopMargin()
|
JRVariable[] |
getVariables()
|
byte |
getWhenNoDataType()
Specifies the report behavior in case of empty datasources. |
byte |
getWhenResourceMissingType()
Returns the resource missing handling type. |
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 name)
|
void |
setProperty(java.lang.String name,
java.lang.String value)
|
void |
setWhenNoDataType(byte whenNoDataType)
Sets the report behavior in case of empty datasources. |
void |
setWhenResourceMissingType(byte whenResourceMissingType)
Sets the resource missing handling type. |
Methods inherited from interface net.sf.jasperreports.engine.JRDefaultStyleProvider |
---|
getDefaultStyle |
Methods inherited from interface net.sf.jasperreports.engine.JRDefaultFontProvider |
---|
getDefaultFont |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Field Detail |
---|
static final java.lang.String LANGUAGE_JAVA
static final java.lang.String LANGUAGE_GROOVY
static final byte PRINT_ORDER_VERTICAL
static final byte PRINT_ORDER_HORIZONTAL
static final byte ORIENTATION_PORTRAIT
static final byte ORIENTATION_LANDSCAPE
static final byte WHEN_NO_DATA_TYPE_NO_PAGES
static final byte WHEN_NO_DATA_TYPE_BLANK_PAGE
static final byte WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
static final byte WHEN_NO_DATA_TYPE_NO_DATA_SECTION
static final byte WHEN_RESOURCE_MISSING_TYPE_NULL
static final byte WHEN_RESOURCE_MISSING_TYPE_EMPTY
static final byte WHEN_RESOURCE_MISSING_TYPE_KEY
static final byte WHEN_RESOURCE_MISSING_TYPE_ERROR
Method Detail |
---|
java.lang.String getName()
java.lang.String getLanguage()
int getColumnCount()
byte getPrintOrder()
PRINT_ORDER_VERTICAL,
,
PRINT_ORDER_HORIZONTAL
int getPageWidth()
int getPageHeight()
byte getOrientation()
byte getWhenNoDataType()
void setWhenNoDataType(byte whenNoDataType)
int getColumnWidth()
int getColumnSpacing()
int getLeftMargin()
int getRightMargin()
int getTopMargin()
int getBottomMargin()
boolean isTitleNewPage()
boolean isSummaryNewPage()
boolean isSummaryWithPageHeaderAndFooter()
boolean isFloatColumnFooter()
java.lang.String getScriptletClass()
java.lang.String getFormatFactoryClass()
FormatFactory
interface to use with this report.
java.lang.String getResourceBundle()
java.lang.String[] getPropertyNames()
java.lang.String getProperty(java.lang.String name)
name
- the property namevoid setProperty(java.lang.String name, java.lang.String value)
void removeProperty(java.lang.String name)
java.lang.String[] getImports()
JRReportFont[] getFonts()
JRStyle[] getStyles()
JRScriptlet[] getScriptlets()
JRParameter[] getParameters()
JRQuery getQuery()
JRField[] getFields()
JRSortField[] getSortFields()
JRVariable[] getVariables()
JRGroup[] getGroups()
JRBand getBackground()
JRBand getTitle()
JRBand getPageHeader()
JRBand getColumnHeader()
JRBand getDetail()
getDetailSection()
.
JRSection getDetailSection()
JRBand getColumnFooter()
JRBand getPageFooter()
JRBand getLastPageFooter()
JRBand getSummary()
JRBand getNoData()
byte getWhenResourceMissingType()
void setWhenResourceMissingType(byte whenResourceMissingType)
whenResourceMissingType
- the resource missing handling typeJRDataset getMainDataset()
The main report dataset consists of all parameters, fields, variables and groups of the report.
JRDataset[] getDatasets()
boolean isIgnorePagination()
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.
JRReportTemplate[] getTemplates()
template
.
Templates include styles which can be used in the report.
The order in which the templates are included in the report is important:
null
if noneJRTemplate
,
JRParameter.REPORT_TEMPLATES
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |