|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseReport
net.sf.jasperreports.engine.design.JasperDesign
public class JasperDesign
JasperDesign is used for in-memory representation of a report design. Instances of this class can be easily created from an XML template and viceversa. It contains all report properties and report elements in their design time state.
The main reason for using this class is for modifying report templates at run time. Although using compiled reports is usually recommended, sometimes people need to dinamically change a report design.
JRXmlLoader
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
PROPERTY_BACKGROUND
|
static java.lang.String |
PROPERTY_BOTTOM_MARGIN
|
static java.lang.String |
PROPERTY_COLUMN_COUNT
|
static java.lang.String |
PROPERTY_COLUMN_DIRECTION
|
static java.lang.String |
PROPERTY_COLUMN_FOOTER
|
static java.lang.String |
PROPERTY_COLUMN_HEADER
|
static java.lang.String |
PROPERTY_COLUMN_SPACING
|
static java.lang.String |
PROPERTY_COLUMN_WIDTH
|
static java.lang.String |
PROPERTY_DATASETS
|
static java.lang.String |
PROPERTY_DEFAULT_FONT
|
static java.lang.String |
PROPERTY_DEFAULT_STLYE
|
static java.lang.String |
PROPERTY_DETAIL
|
static java.lang.String |
PROPERTY_FLOAT_COLUMN_FOOTER
|
static java.lang.String |
PROPERTY_FONTS
|
static java.lang.String |
PROPERTY_FORMAT_FACTORY_CLASS
|
static java.lang.String |
PROPERTY_IGNORE_PAGINATION
|
static java.lang.String |
PROPERTY_IMPORTS
|
static java.lang.String |
PROPERTY_LANGUAGE
|
static java.lang.String |
PROPERTY_LAST_PAGE_FOOTER
|
static java.lang.String |
PROPERTY_LEFT_MARGIN
|
static java.lang.String |
PROPERTY_MAIN_DATASET
|
static java.lang.String |
PROPERTY_NAME
|
static java.lang.String |
PROPERTY_NO_DATA
|
static java.lang.String |
PROPERTY_ORIENTATION
|
static java.lang.String |
PROPERTY_PAGE_FOOTER
|
static java.lang.String |
PROPERTY_PAGE_HEADER
|
static java.lang.String |
PROPERTY_PAGE_HEIGHT
|
static java.lang.String |
PROPERTY_PAGE_WIDTH
|
static java.lang.String |
PROPERTY_PRINT_ORDER
|
static java.lang.String |
PROPERTY_RIGHT_MARGIN
|
static java.lang.String |
PROPERTY_STYLES
|
static java.lang.String |
PROPERTY_SUMMARY
|
static java.lang.String |
PROPERTY_SUMMARY_NEW_PAGE
|
static java.lang.String |
PROPERTY_SUMMARY_WITH_PAGE_HEADER_AND_FOOTER
|
static java.lang.String |
PROPERTY_TEMPLATES
|
static java.lang.String |
PROPERTY_TITLE
|
static java.lang.String |
PROPERTY_TITLE_NEW_PAGE
|
static java.lang.String |
PROPERTY_TOP_MARGIN
|
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseReport |
---|
background, bottomMargin, columnCount, columnDirection, columnFooter, columnHeader, columnSpacing, columnWidth, datasets, defaultFont, defaultStyle, detailSection, fonts, formatFactoryClass, ignorePagination, importsSet, isFloatColumnFooter, isSummaryNewPage, isSummaryWithPageHeaderAndFooter, isTitleNewPage, language, lastPageFooter, leftMargin, mainDataset, name, noData, orientationValue, pageFooter, pageHeader, pageHeight, pageWidth, printOrderValue, PROPERTY_WHEN_NO_DATA_TYPE, rightMargin, styles, summary, templates, title, topMargin, whenNoDataTypeValue |
Constructor Summary | |
---|---|
JasperDesign()
Constructs a JasperDesign object and fills it with the default variables and parameters. |
Method Summary | |
---|---|
void |
addDataset(int index,
JRDesignDataset dataset)
Inserts a sub dataset at specified position into the report. |
void |
addDataset(JRDesignDataset dataset)
Adds a sub dataset to the report. |
void |
addField(JRField field)
|
void |
addFont(JRReportFont reportFont)
Deprecated. |
void |
addGroup(JRDesignGroup group)
Gets a map of report groups. |
void |
addImport(java.lang.String value)
Adds an import (needed if report expression require additional classes in order to compile). |
void |
addParameter(JRParameter parameter)
Adds a report parameter. |
void |
addScriptlet(JRScriptlet scriptlet)
Adds a report scriplet. |
void |
addSortField(JRSortField sortField)
|
void |
addStyle(int index,
JRStyle style)
Inserts a report style, that can be referenced by report elements, at specified position. |
void |
addStyle(JRStyle style)
Adds a report style, that can be referenced by report elements. |
void |
addTemplate(int index,
JRReportTemplate template)
Inserts a report template at specified position. |
void |
addTemplate(JRReportTemplate template)
Adds a report template. |
void |
addVariable(JRDesignVariable variable)
|
protected java.util.List |
getCrosstabs()
|
java.util.Map |
getDatasetMap()
Returns the sub datasets of the report indexed by name. |
JRDataset[] |
getDatasets()
Returns the datasets of this report. |
java.util.List |
getDatasetsList()
Returns the list of report sub datasets. |
java.util.Collection |
getExpressions()
Returns a collection of all report expressions. |
java.util.List |
getFieldsList()
Gets a list of report fields. |
java.util.Map |
getFieldsMap()
Gets a map of report fields. |
JRExpression |
getFilterExpression()
Returns the main dataset filter expression. |
JRReportFont[] |
getFonts()
Deprecated. |
java.util.List |
getFontsList()
Deprecated. |
java.util.Map |
getFontsMap()
Deprecated. |
java.util.List |
getGroupsList()
Gets an array of report groups. |
java.util.Map |
getGroupsMap()
Gets a list of report groups. |
JRDesignDataset |
getMainDesignDataset()
Returns the main report dataset. |
java.util.List |
getParametersList()
Gets a list of report parameters (including built-in ones). |
java.util.Map |
getParametersMap()
Gets a map of report parameters (including built-in ones). |
java.util.List |
getScriptletsList()
Gets a list of report scriptlets (excluding the one specified by scriptletClass). |
java.util.Map |
getScriptletsMap()
Gets a map of report scriptlets (excluding the one specified by scriptletClass). |
java.util.List |
getSortFieldsList()
Gets a list of sort report fields. |
JRStyle[] |
getStyles()
Gets an array of report level styles. |
java.util.List |
getStylesList()
Gets a list of report level styles. |
java.util.Map |
getStylesMap()
|
JRReportTemplate[] |
getTemplates()
Returns the list of report templates. |
java.util.List<JRReportTemplate> |
getTemplatesList()
Returns the list of report templates defined in the report. |
java.util.List |
getVariablesList()
Gets a list of report variables. |
java.util.Map |
getVariablesMap()
Gets a map of report variables. |
void |
preprocess()
Performs preliminary processing and calculations prior to compilation. |
JRDataset |
removeDataset(JRDataset dataset)
Removes a sub dataset from the report. |
JRDataset |
removeDataset(java.lang.String datasetName)
Removes a sub dataset from the report. |
JRField |
removeField(JRField field)
|
JRField |
removeField(java.lang.String fieldName)
|
JRReportFont |
removeFont(JRReportFont reportFont)
Deprecated. |
JRReportFont |
removeFont(java.lang.String propName)
Deprecated. |
JRGroup |
removeGroup(JRGroup group)
|
JRGroup |
removeGroup(java.lang.String groupName)
Removes a new group from the report design. |
void |
removeImport(java.lang.String value)
Removes an import. |
JRParameter |
removeParameter(JRParameter parameter)
Removes a report parameter. |
JRParameter |
removeParameter(java.lang.String parameterName)
Removes a report parameter, based on its name. |
JRScriptlet |
removeScriptlet(JRScriptlet scriptlet)
Removes a report scriptlet. |
JRScriptlet |
removeScriptlet(java.lang.String scriptletName)
Removes a report scriptlet, based on its name. |
JRSortField |
removeSortField(JRSortField sortField)
|
JRSortField |
removeSortField(java.lang.String fieldName)
|
JRStyle |
removeStyle(JRStyle style)
Removes a report style from the list. |
JRStyle |
removeStyle(java.lang.String styleName)
Removes a report style from the list, based on the style name. |
boolean |
removeTemplate(JRReportTemplate template)
Removes a report template. |
JRVariable |
removeVariable(JRVariable variable)
|
JRVariable |
removeVariable(java.lang.String variableName)
|
void |
resetDefaultStyle()
|
void |
setBackground(JRBand background)
Sets the background band. |
protected void |
setBandOrigin(JRBand band,
BandTypeEnum type)
|
protected void |
setBandOrigin(JRBand band,
byte type)
Deprecated. Replaced by setBandOrigin(JRBand, BandTypeEnum) . |
void |
setBottomMargin(int bottomMargin)
Sets the top margin. |
void |
setColumnCount(int columnCount)
Specifies the number of report columns. |
void |
setColumnDirection(RunDirectionEnum columnDirection)
Sets the column direction. |
void |
setColumnFooter(JRBand columnFooter)
Sets the column footer band. |
void |
setColumnHeader(JRBand columnHeader)
Sets the column header band. |
void |
setColumnSpacing(int columnSpacing)
Sets the spacing between columns. |
void |
setColumnWidth(int columnWidth)
Sets the column width. |
void |
setDefaultFont(JRReportFont font)
Deprecated. |
void |
setDefaultStyle(JRStyle style)
|
void |
setDetail(JRBand detail)
Deprecated. Replaced by JRBaseReport.getDetailSection() . |
void |
setFilterExpression(JRExpression expression)
Sets the main dataset filter expression. |
void |
setFloatColumnFooter(boolean isFloatColumnFooter)
Flag used to specify if the column footer section should be printed at the bottom of the column or if it should immediately follow the last detail or group footer printed on the current column. |
void |
setFormatFactoryClass(java.lang.String formatFactoryClass)
|
void |
setIgnorePagination(boolean ignorePagination)
Sets the value of the ignore pagination flag. |
void |
setLanguage(java.lang.String language)
Specifies the language used for report expressions (Java or Groovy). |
void |
setLastPageFooter(JRBand lastPageFooter)
Sets the last page footer band. |
void |
setLeftMargin(int leftMargin)
Sets the left margin. |
void |
setMainDataset(JRDesignDataset dataset)
Sets the main report dataset. |
void |
setName(java.lang.String name)
Sets the report name. |
void |
setNoData(JRBand noData)
Sets the noData band. |
void |
setOrientation(byte orientation)
Deprecated. Replaced by setOrientation(OrientationEnum) . |
void |
setOrientation(OrientationEnum orientationValue)
Sets the report orientation. |
void |
setPageFooter(JRBand pageFooter)
Sets the page footer band. |
void |
setPageHeader(JRBand pageHeader)
Sets the page header band. |
void |
setPageHeight(int pageHeight)
Sets page height (including margins etc.). |
void |
setPageWidth(int pageWidth)
Sets page width (including margins etc.). |
void |
setPrintOrder(byte printOrder)
Deprecated. Replaced by setPrintOrder(PrintOrderEnum) . |
void |
setPrintOrder(PrintOrderEnum printOrderValue)
Sets the print order. |
void |
setQuery(JRDesignQuery query)
Specifies the report query. |
void |
setResourceBundle(java.lang.String resourceBundle)
Sets the base name of the report associated resource bundle. |
void |
setRightMargin(int rightMargin)
Sets the right margin. |
void |
setScriptletClass(java.lang.String scriptletClass)
Sets the detail section. |
protected void |
setSectionOrigin(JRSection section,
BandTypeEnum type)
|
protected void |
setSectionOrigin(JRSection section,
byte type)
Deprecated. Replaced by setSectionOrigin(JRSection, BandTypeEnum) . |
void |
setSummary(JRBand summary)
Sets the summary band. |
void |
setSummaryNewPage(boolean isSummaryNewPage)
Flag used to specify if the summary section should be printed on a separate last page. |
void |
setSummaryWithPageHeaderAndFooter(boolean isSummaryWithPageHeaderAndFooter)
Flag used to specify if the summary section should be accompanied by the page header and footer. |
void |
setTitle(JRBand title)
Sets the title band. |
void |
setTitleNewPage(boolean isTitleNewPage)
Flag used to specify if the title section should be printed on a separate initial page. |
void |
setTopMargin(int topMargin)
Sets the top margin. |
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_BACKGROUND
public static final java.lang.String PROPERTY_BOTTOM_MARGIN
public static final java.lang.String PROPERTY_COLUMN_COUNT
public static final java.lang.String PROPERTY_COLUMN_FOOTER
public static final java.lang.String PROPERTY_COLUMN_HEADER
public static final java.lang.String PROPERTY_COLUMN_SPACING
public static final java.lang.String PROPERTY_COLUMN_WIDTH
public static final java.lang.String PROPERTY_DATASETS
public static final java.lang.String PROPERTY_DEFAULT_FONT
public static final java.lang.String PROPERTY_DEFAULT_STLYE
public static final java.lang.String PROPERTY_DETAIL
public static final java.lang.String PROPERTY_FLOAT_COLUMN_FOOTER
public static final java.lang.String PROPERTY_FONTS
public static final java.lang.String PROPERTY_FORMAT_FACTORY_CLASS
public static final java.lang.String PROPERTY_IGNORE_PAGINATION
public static final java.lang.String PROPERTY_IMPORTS
public static final java.lang.String PROPERTY_LANGUAGE
public static final java.lang.String PROPERTY_LAST_PAGE_FOOTER
public static final java.lang.String PROPERTY_LEFT_MARGIN
public static final java.lang.String PROPERTY_MAIN_DATASET
public static final java.lang.String PROPERTY_NAME
public static final java.lang.String PROPERTY_NO_DATA
public static final java.lang.String PROPERTY_ORIENTATION
public static final java.lang.String PROPERTY_PAGE_FOOTER
public static final java.lang.String PROPERTY_PAGE_HEADER
public static final java.lang.String PROPERTY_PAGE_HEIGHT
public static final java.lang.String PROPERTY_PAGE_WIDTH
public static final java.lang.String PROPERTY_PRINT_ORDER
public static final java.lang.String PROPERTY_COLUMN_DIRECTION
public static final java.lang.String PROPERTY_RIGHT_MARGIN
public static final java.lang.String PROPERTY_STYLES
public static final java.lang.String PROPERTY_SUMMARY
public static final java.lang.String PROPERTY_SUMMARY_NEW_PAGE
public static final java.lang.String PROPERTY_SUMMARY_WITH_PAGE_HEADER_AND_FOOTER
public static final java.lang.String PROPERTY_TEMPLATES
public static final java.lang.String PROPERTY_TITLE
public static final java.lang.String PROPERTY_TITLE_NEW_PAGE
public static final java.lang.String PROPERTY_TOP_MARGIN
Constructor Detail |
---|
public JasperDesign()
Method Detail |
---|
public void setName(java.lang.String name)
public void setLanguage(java.lang.String language)
public void setColumnCount(int columnCount)
public void setPrintOrder(byte printOrder)
setPrintOrder(PrintOrderEnum)
.
public void setPrintOrder(PrintOrderEnum printOrderValue)
VERTICAL,
,
HORIZONTAL
public void setColumnDirection(RunDirectionEnum columnDirection)
public void setPageWidth(int pageWidth)
public void setPageHeight(int pageHeight)
public void setOrientation(byte orientation)
setOrientation(OrientationEnum)
.
public void setOrientation(OrientationEnum orientationValue)
ORIENTATION_PORTRAIT,
,
ORIENTATION_LANDSCAPE
public void setColumnWidth(int columnWidth)
public void setColumnSpacing(int columnSpacing)
public void setLeftMargin(int leftMargin)
public void setRightMargin(int rightMargin)
public void setTopMargin(int topMargin)
public void setBottomMargin(int bottomMargin)
public void setBackground(JRBand background)
public void setTitle(JRBand title)
public void setTitleNewPage(boolean isTitleNewPage)
isTitleNewPage
- true if the title section should be displayed on a separate initial page, false if
it will be displayed on the first page along with other sections.public void setSummary(JRBand summary)
public void setNoData(JRBand noData)
public void setSummaryNewPage(boolean isSummaryNewPage)
isSummaryNewPage
- true if the summary section should be displayed on a separate last page, false if
it will be displayed on the last page along with other sections, if there is enough space.public void setSummaryWithPageHeaderAndFooter(boolean isSummaryWithPageHeaderAndFooter)
isSummaryWithPageHeaderAndFooter
- true if the summary section should be displayed on pages that have the page header and footer,
false if it will be displayed on pages without header and footer.public void setFloatColumnFooter(boolean isFloatColumnFooter)
public void setPageHeader(JRBand pageHeader)
public void setPageFooter(JRBand pageFooter)
public void setLastPageFooter(JRBand lastPageFooter)
public void setColumnHeader(JRBand columnHeader)
public void setColumnFooter(JRBand columnFooter)
public void setDetail(JRBand detail)
JRBaseReport.getDetailSection()
.
public void setScriptletClass(java.lang.String scriptletClass)
public void setFormatFactoryClass(java.lang.String formatFactoryClass)
public void setResourceBundle(java.lang.String resourceBundle)
public void addImport(java.lang.String value)
public void removeImport(java.lang.String value)
public void setDefaultFont(JRReportFont font)
public JRReportFont[] getFonts()
getFonts
in interface JRReport
getFonts
in class JRBaseReport
public java.util.List getFontsList()
public java.util.Map getFontsMap()
public void addFont(JRReportFont reportFont) throws JRException
JRException
public JRReportFont removeFont(java.lang.String propName)
public JRReportFont removeFont(JRReportFont reportFont)
public void resetDefaultStyle()
public void setDefaultStyle(JRStyle style)
public JRStyle[] getStyles()
getStyles
in interface JRReport
getStyles
in class JRBaseReport
public java.util.List getStylesList()
public java.util.Map getStylesMap()
public void addStyle(JRStyle style) throws JRException
JRException
public void addStyle(int index, JRStyle style) throws JRException
JRException
public JRStyle removeStyle(java.lang.String styleName)
public JRStyle removeStyle(JRStyle style)
public java.util.List getScriptletsList()
public java.util.Map getScriptletsMap()
public void addScriptlet(JRScriptlet scriptlet) throws JRException
JRException
public JRScriptlet removeScriptlet(java.lang.String scriptletName)
public JRScriptlet removeScriptlet(JRScriptlet scriptlet)
public java.util.List getParametersList()
public java.util.Map getParametersMap()
public void addParameter(JRParameter parameter) throws JRException
JRException
public JRParameter removeParameter(java.lang.String parameterName)
public JRParameter removeParameter(JRParameter parameter)
public void setQuery(JRDesignQuery query)
public java.util.List getFieldsList()
public java.util.Map getFieldsMap()
public void addField(JRField field) throws JRException
JRException
public JRField removeField(java.lang.String fieldName)
public JRField removeField(JRField field)
public java.util.List getSortFieldsList()
public void addSortField(JRSortField sortField) throws JRException
JRException
public JRSortField removeSortField(java.lang.String fieldName)
public JRSortField removeSortField(JRSortField sortField)
public java.util.List getVariablesList()
public java.util.Map getVariablesMap()
public void addVariable(JRDesignVariable variable) throws JRException
JRException
public JRVariable removeVariable(java.lang.String variableName)
public JRVariable removeVariable(JRVariable variable)
public java.util.List getGroupsList()
public java.util.Map getGroupsMap()
public void addGroup(JRDesignGroup group) throws JRException
JRException
public JRGroup removeGroup(java.lang.String groupName)
public JRGroup removeGroup(JRGroup group)
public java.util.Collection getExpressions()
public JRDataset[] getDatasets()
JRReport
getDatasets
in interface JRReport
getDatasets
in class JRBaseReport
public java.util.List getDatasetsList()
JRDesignDataset
objectspublic java.util.Map getDatasetMap()
public void addDataset(JRDesignDataset dataset) throws JRException
dataset
- the dataset
JRException
public void addDataset(int index, JRDesignDataset dataset) throws JRException
index
- the positiondataset
- the dataset
JRException
public JRDataset removeDataset(java.lang.String datasetName)
datasetName
- the dataset name
public JRDataset removeDataset(JRDataset dataset)
dataset
- the dataset to be removed
public JRDesignDataset getMainDesignDataset()
public void setMainDataset(JRDesignDataset dataset)
This method can be used as an alternative to setting the parameters, fields, etc directly on the report.
dataset
- the datasetpublic void preprocess()
protected java.util.List getCrosstabs()
public void setIgnorePagination(boolean ignorePagination)
ignorePagination
- whether to ignore pagination when generating the reportJRReport.isIgnorePagination()
public JRExpression getFilterExpression()
JRDataset.getFilterExpression()
public void setFilterExpression(JRExpression expression)
expression
- the boolean expression to use as main dataset filter expressionJRDesignDataset.setFilterExpression(JRExpression)
,
JRDataset.getFilterExpression()
public void addTemplate(JRReportTemplate template)
template
- the template to add.getTemplates()
public void addTemplate(int index, JRReportTemplate template)
index
- the template position.template
- the template to insert.getTemplates()
public boolean removeTemplate(JRReportTemplate template)
template
- the template to remove
true
if and only if the template has been found and removedpublic JRReportTemplate[] getTemplates()
JRReport
template
.
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 JRReport
getTemplates
in class JRBaseReport
null
if noneJRTemplate
,
JRParameter.REPORT_TEMPLATES
public java.util.List<JRReportTemplate> getTemplatesList()
JRReportTemplate
objects for the reportgetTemplates()
,
addTemplate(JRReportTemplate)
protected void setBandOrigin(JRBand band, byte type)
setBandOrigin(JRBand, BandTypeEnum)
.
protected void setSectionOrigin(JRSection section, byte type)
setSectionOrigin(JRSection, BandTypeEnum)
.
protected void setBandOrigin(JRBand band, BandTypeEnum type)
protected void setSectionOrigin(JRSection section, BandTypeEnum type)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |