Java Doc for JRReport.java in » Report » jasperreports-2.0.1 » net » sf » jasperreports » engine » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Report » jasperreports 2.0.1 » net.sf.jasperreports.engine

Source Cross Reference Class Diagram Java Document (Java Doc)

net.sf.jasperreports.engine .JRReport

All known Subclasses:   net.sf.jasperreports.engine.base .JRBaseReport,
JRReport
public interface JRReport extends JRDefaultFontProvider,JRDefaultStyleProvider,JRPropertiesHolder(Code)
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.
author:
   Teodor Danciu (teodord@users.sourceforge.net)
version:
   $Id: JRReport.java 1797 2007-07-30 09:38:35Z teodord $

Field Summary
final public static String LANGUAGE_GROOVY
     A constant used to specify that the language used by expressions is Groovy.
final public static String LANGUAGE_JAVA
     A constant used to specify that the language used by expressions is Java.
final public static byte ORIENTATION_LANDSCAPE
     Specifies a landscape orientation.
final public static byte ORIENTATION_PORTRAIT
     Specifies a portrait orientation.
final public static byte PRINT_ORDER_HORIZONTAL
     Specifies that columns in a report should be filled horizontalyy (columns are filled proportionally).
final public 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).
final public static byte WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
     Specifies that in case of empty datasources, all sections except detail will displayed.
final public 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.
final public static byte WHEN_NO_DATA_TYPE_NO_DATA_SECTION
     Specifies that in case of empty datasources, the NoData section will be displayed.
final public static byte WHEN_NO_DATA_TYPE_NO_PAGES
     Specifies that in case of empty datasources, there will be an empty report.
final public static byte WHEN_RESOURCE_MISSING_TYPE_EMPTY
     Return empty string when a resource is missing.
final public static byte WHEN_RESOURCE_MISSING_TYPE_ERROR
     Throw an exception when a resource is missing.
final public static byte WHEN_RESOURCE_MISSING_TYPE_KEY
     Return the key when a resource is missing.
final public static byte WHEN_RESOURCE_MISSING_TYPE_NULL
     Return NULL when a resource is missing.

Method Summary
public JRBand getBackground()

public int getBottomMargin()

public int getColumnCount()

public JRBand getColumnFooter()

public JRBand getColumnHeader()

public int getColumnSpacing()
     Specifies the space between columns on the same page.
public int getColumnWidth()

public JRDataset[] getDatasets()
     Returns the datasets of this report.
public JRBand getDetail()

public JRField[] getFields()

public JRReportFont[] getFonts()
     Gets an array of report fonts.
public String getFormatFactoryClass()
     Gets the name of the class implementing the net.sf.jasperreports.engine.util.FormatFactory FormatFactory interface to use with this report.
public JRGroup[] getGroups()

public String[] getImports()
     Gets an array of imports (needed if report expression require additional classes in order to compile).
public String getLanguage()
     Gets the report language.
public JRBand getLastPageFooter()

public int getLeftMargin()

public JRDataset getMainDataset()
     Returns the main report dataset.
public String getName()
     Gets the report name.
public JRBand getNoData()

public byte getOrientation()

public JRBand getPageFooter()

public JRBand getPageHeader()

public int getPageHeight()

public int getPageWidth()

public JRParameter[] getParameters()

public byte getPrintOrder()
     Specifies whether columns will be filled horizontally or vertically.
public String getProperty(String name)

public String[] getPropertyNames()
     Gets an array of report properties names.
public JRQuery getQuery()

public String getResourceBundle()
     Gets the base name of the report associated resource bundle.
public int getRightMargin()

public String getScriptletClass()

public JRSortField[] getSortFields()

public JRStyle[] getStyles()
     Gets an array of report styles.
public JRBand getSummary()

public JRReportTemplate[] getTemplates()
     Returns the list of report templates.
public JRBand getTitle()

public int getTopMargin()

public JRVariable[] getVariables()

public byte getWhenNoDataType()
     Specifies the report behaviour in case of empty datasources.
public byte getWhenResourceMissingType()
     Returns the resource missing handling type.
public 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.
public boolean isIgnorePagination()
     Decides whether to use pagination when filling the report.
public boolean isSummaryNewPage()
     Specifies if the summary section will be printed on a separate last page.
public boolean isTitleNewPage()
     Specifies if the title section will be printed on a separate initial page.
public void removeProperty(String name)

public void setProperty(String name, String value)

public void setWhenNoDataType(byte whenNoDataType)
     Sets the report behaviour in case of empty datasources.
public void setWhenResourceMissingType(byte whenResourceMissingType)
     Sets the resource missing handling type.

Field Detail
LANGUAGE_GROOVY
final public static String LANGUAGE_GROOVY(Code)
A constant used to specify that the language used by expressions is Groovy.

LANGUAGE_JAVA
final public static String LANGUAGE_JAVA(Code)
A constant used to specify that the language used by expressions is Java.

ORIENTATION_LANDSCAPE
final public static byte ORIENTATION_LANDSCAPE(Code)
Specifies a landscape orientation. This is used mostly to inform printers of page layouts.

ORIENTATION_PORTRAIT
final public static byte ORIENTATION_PORTRAIT(Code)
Specifies a portrait orientation. This is used mostly to inform printers of page layouts.

PRINT_ORDER_HORIZONTAL
final public static byte PRINT_ORDER_HORIZONTAL(Code)
Specifies that columns in a report should be filled horizontalyy (columns are filled proportionally).

PRINT_ORDER_VERTICAL
final public static byte PRINT_ORDER_VERTICAL(Code)
Specifies that columns in a report should be filled vertically (fill an entire column and then go to the next one).

WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
final public static byte WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL(Code)
Specifies that in case of empty datasources, all sections except detail will displayed.

WHEN_NO_DATA_TYPE_BLANK_PAGE
final public static byte WHEN_NO_DATA_TYPE_BLANK_PAGE(Code)
Specifies that in case of empty datasources, there will be a report with just one blank page.

WHEN_NO_DATA_TYPE_NO_DATA_SECTION
final public static byte WHEN_NO_DATA_TYPE_NO_DATA_SECTION(Code)
Specifies that in case of empty datasources, the NoData section will be displayed.

WHEN_NO_DATA_TYPE_NO_PAGES
final public static byte WHEN_NO_DATA_TYPE_NO_PAGES(Code)
Specifies that in case of empty datasources, there will be an empty report.

WHEN_RESOURCE_MISSING_TYPE_EMPTY
final public static byte WHEN_RESOURCE_MISSING_TYPE_EMPTY(Code)
Return empty string when a resource is missing.

WHEN_RESOURCE_MISSING_TYPE_ERROR
final public static byte WHEN_RESOURCE_MISSING_TYPE_ERROR(Code)
Throw an exception when a resource is missing.

WHEN_RESOURCE_MISSING_TYPE_KEY
final public static byte WHEN_RESOURCE_MISSING_TYPE_KEY(Code)
Return the key when a resource is missing.

WHEN_RESOURCE_MISSING_TYPE_NULL
final public static byte WHEN_RESOURCE_MISSING_TYPE_NULL(Code)
Return NULL when a resource is missing.

Method Detail
getBackground
public JRBand getBackground()(Code)

getBottomMargin
public int getBottomMargin()(Code)

getColumnCount
public int getColumnCount()(Code)
Gets the number of columns on each page

getColumnFooter
public JRBand getColumnFooter()(Code)

getColumnHeader
public JRBand getColumnHeader()(Code)

getColumnSpacing
public int getColumnSpacing()(Code)
Specifies the space between columns on the same page.

getColumnWidth
public int getColumnWidth()(Code)

getDatasets
public JRDataset[] getDatasets()(Code)
Returns the datasets of this report. the datasets of this report

getDetail
public JRBand getDetail()(Code)

getFields
public JRField[] getFields()(Code)

getFonts
public JRReportFont[] getFonts()(Code)
Gets an array of report fonts.

getFormatFactoryClass
public String getFormatFactoryClass()(Code)
Gets the name of the class implementing the net.sf.jasperreports.engine.util.FormatFactory FormatFactory interface to use with this report.

getGroups
public JRGroup[] getGroups()(Code)

getImports
public String[] getImports()(Code)
Gets an array of imports (needed if report expression require additional classes in order to compile).

getLanguage
public String getLanguage()(Code)
Gets the report language. Should be Java or Groovy.

getLastPageFooter
public JRBand getLastPageFooter()(Code)

getLeftMargin
public int getLeftMargin()(Code)

getMainDataset
public JRDataset getMainDataset()(Code)
Returns the main report dataset.
The main report dataset consists of all parameters, fields, variables and groups of the report. the main report dataset

getName
public String getName()(Code)
Gets the report name.

getNoData
public JRBand getNoData()(Code)

getOrientation
public byte getOrientation()(Code)

getPageFooter
public JRBand getPageFooter()(Code)

getPageHeader
public JRBand getPageHeader()(Code)

getPageHeight
public int getPageHeight()(Code)

getPageWidth
public int getPageWidth()(Code)

getParameters
public JRParameter[] getParameters()(Code)

getPrintOrder
public byte getPrintOrder()(Code)
Specifies whether columns will be filled horizontally or vertically.
See Also:   JRReport
See Also:    PRINT_ORDER_VERTICAL,
See Also:   JRReport
See Also:    PRINT_ORDER_HORIZONTAL

getProperty
public String getProperty(String name)(Code)
Gets a property value
Parameters:
  name - the property name

getPropertyNames
public String[] getPropertyNames()(Code)
Gets an array of report properties names.

getQuery
public JRQuery getQuery()(Code)

getResourceBundle
public String getResourceBundle()(Code)
Gets the base name of the report associated resource bundle.

getRightMargin
public int getRightMargin()(Code)

getScriptletClass
public String getScriptletClass()(Code)

getSortFields
public JRSortField[] getSortFields()(Code)

getStyles
public JRStyle[] getStyles()(Code)
Gets an array of report styles.

getSummary
public JRBand getSummary()(Code)

getTemplates
public JRReportTemplate[] getTemplates()(Code)
Returns the list of report templates.
A report template is an expression which resolves at runtime to a JRTemplate template . Templates include styles which can be used in the report.
The order in which the templates are included in the report is important:

A style's parent must appear before the style itself.

A style overrides styles with the same name that are placed before it. Also, report styles override templates styles with the same name.

the list of report templates, or null if none
See Also:   JRTemplate
See Also:   JRParameter.REPORT_TEMPLATES

getTitle
public JRBand getTitle()(Code)

getTopMargin
public int getTopMargin()(Code)

getVariables
public JRVariable[] getVariables()(Code)

getWhenNoDataType
public byte getWhenNoDataType()(Code)
Specifies the report behaviour in case of empty datasources.

getWhenResourceMissingType
public byte getWhenResourceMissingType()(Code)
Returns the resource missing handling type.

isFloatColumnFooter
public boolean isFloatColumnFooter()(Code)
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.

isIgnorePagination
public boolean isIgnorePagination()(Code)
Decides whether to use pagination when filling the report.
If set to true the report will be generated on one long page.
The design attribute can be overridden at fill time by the JRParameter.IS_IGNORE_PAGINATION IS_IGNORE_PAGINATION parameter. whether to use pagination when filling the report

isSummaryNewPage
public boolean isSummaryNewPage()(Code)
Specifies if the summary section will be printed on a separate last page.

isTitleNewPage
public boolean isTitleNewPage()(Code)
Specifies if the title section will be printed on a separate initial page.

removeProperty
public void removeProperty(String name)(Code)

setProperty
public void setProperty(String name, String value)(Code)

setWhenNoDataType
public void setWhenNoDataType(byte whenNoDataType)(Code)
Sets the report behaviour in case of empty datasources.

setWhenResourceMissingType
public void setWhenResourceMissingType(byte whenResourceMissingType)(Code)
Sets the resource missing handling type.
Parameters:
  whenResourceMissingType - the resource missing handling type

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.