|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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_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 horizontalyy (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_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()
|
JRBand |
getDetail()
|
JRField[] |
getFields()
|
JRReportFont[] |
getFonts()
Gets an array of report fonts. |
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()
|
java.lang.String |
getName()
Gets the report name. |
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()
|
JRBand |
getSummary()
|
JRBand |
getTitle()
|
int |
getTopMargin()
|
JRVariable[] |
getVariables()
|
byte |
getWhenNoDataType()
Specifies the report behaviour in case of empty datasources. |
byte |
getWhenResourceMissingType()
Returns the resource missing handling type. |
boolean |
isFloatColumnFooter()
Specifie 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 |
isSummaryNewPage()
Specifies if the summary section will be printed on a separate last page. |
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 behaviour in case of empty datasources. |
void |
setWhenResourceMissingType(byte whenResourceMissingType)
Sets the resource missing handling type. |
Methods inherited from interface net.sf.jasperreports.engine.JRDefaultFontProvider |
getDefaultFont |
Field Detail |
public static final java.lang.String LANGUAGE_JAVA
public static final byte PRINT_ORDER_VERTICAL
public static final byte PRINT_ORDER_HORIZONTAL
public static final byte ORIENTATION_PORTRAIT
public static final byte ORIENTATION_LANDSCAPE
public static final byte WHEN_NO_DATA_TYPE_NO_PAGES
public static final byte WHEN_NO_DATA_TYPE_BLANK_PAGE
public static final byte WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
public static final byte WHEN_RESOURCE_MISSING_TYPE_NULL
public static final byte WHEN_RESOURCE_MISSING_TYPE_EMPTY
public static final byte WHEN_RESOURCE_MISSING_TYPE_KEY
public static final byte WHEN_RESOURCE_MISSING_TYPE_ERROR
Method Detail |
public java.lang.String getName()
public java.lang.String getLanguage()
public int getColumnCount()
public byte getPrintOrder()
PRINT_ORDER_VERTICAL,
,
PRINT_ORDER_HORIZONTAL
public int getPageWidth()
public int getPageHeight()
public byte getOrientation()
public byte getWhenNoDataType()
public void setWhenNoDataType(byte whenNoDataType)
public int getColumnWidth()
public int getColumnSpacing()
public int getLeftMargin()
public int getRightMargin()
public int getTopMargin()
public int getBottomMargin()
public boolean isTitleNewPage()
public boolean isSummaryNewPage()
public boolean isFloatColumnFooter()
public java.lang.String getScriptletClass()
public java.lang.String getResourceBundle()
public java.lang.String[] getPropertyNames()
public java.lang.String getProperty(java.lang.String name)
name
- the property namepublic void setProperty(java.lang.String name, java.lang.String value)
public void removeProperty(java.lang.String name)
public java.lang.String[] getImports()
public JRReportFont[] getFonts()
public JRParameter[] getParameters()
public JRQuery getQuery()
public JRField[] getFields()
public JRVariable[] getVariables()
public JRGroup[] getGroups()
public JRBand getBackground()
public JRBand getTitle()
public JRBand getPageHeader()
public JRBand getColumnHeader()
public JRBand getDetail()
public JRBand getColumnFooter()
public JRBand getPageFooter()
public JRBand getLastPageFooter()
public JRBand getSummary()
public byte getWhenResourceMissingType()
public void setWhenResourceMissingType(byte whenResourceMissingType)
whenResourceMissingType
- the resource missing handling type
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |