All Packages from org.jfree.report.modules.gui.* to org.jfree.report.modules.parser.*

Home >> All >> org >> jfree >> report >> [ modules Javadoc ]

•	org.jfree.report.modules.gui.* (188)	•	org.jfree.report.modules.misc.* (28)
•	org.jfree.report.modules.output.* (141)	•	org.jfree.report.modules.parser.* (105)

• org.jfree.report.modules: Javadoc index of package org.jfree.report.modules.

Package Samples:

• org.jfree.report.modules.gui.config.xml: The configuration editor provides a gui to write the "jfreereport.properties" file that can be used to configure this library.
• org.jfree.report.modules.gui.converter.components: The report converter can be used to convert a simple report format definition into the extended report format.
• org.jfree.report.modules.gui.base.components: This module provides basic preview capabilities for JFreeReport.
• org.jfree.report.modules.output.pageable.base.operations: Support for the output targets that are page- and print oriented.
• org.jfree.report.modules.gui.print.resources: An AWT printing support module.
• org.jfree.report.modules.gui.plaintext.resources: An plain text export module.
• org.jfree.report.modules.gui.xls.resources: An excel export module.
• org.jfree.report.modules.gui.html.resources: An HTML export module.
• org.jfree.report.modules.gui.pdf.resources: An PDF export module.
• org.jfree.report.modules.gui.csv.resources: An CSV export module.
• org.jfree.report.modules.misc.survey: Module definitions:
• org.jfree.report.modules.gui.pdf
• org.jfree.report.modules.gui.base.resources
• org.jfree.report.modules.gui.base
• org.jfree.report.modules.gui.config.editor
• org.jfree.report.modules.gui.config.model
• org.jfree.report.modules.gui.config.resources
• org.jfree.report.modules.gui.config
• org.jfree.report.modules.gui.csv
• org.jfree.report.modules.gui.plaintext

Classes:

• BSHExpression: An expression that uses the BeanShell scripting framework to perform a scripted calculation. The expression itself is contained in a function called Object getValue() and this function is defined in the expression property. You have to overwrite the function getValue() to begin and to end your expression, but you are free to add your own functions to the script. By default, base Java core and extension packages are imported for you. They are: java.lang java.io java.util java.net java.awt java.awt.event javax.swing javax.swing.event An example in the XML format: (from report1.xml) // you may import ...
• AbstractModule: The abstract module provides a default implementation of the module interface. The module can be specified in an external property file. The file name of this specification defaults to "module.properties". This file is no real property file, it follows a more complex rule set. Lines starting with '#' are considered comments. Section headers start at the beginning of the line, section properties are indented with at least one whitespace. The first section is always the module info and contains the basic module properties like name, version and a short description. module-info: name: xls-export-gui ...
• HtmlFilesystem: The HtmlFilesystem provides an abstraction layer for the various storage methods implemented for the HtmlProducer. DirectoryHtmlFilesystem Writes the generated Html-File and the supplementary data files (images and external Stylesheet definition) into a directory. The data files can be written into a separated data directory. {link StreamHtmlFilesystem} Writes a single generated Html-File into the supplied stream. The Stylesheet is inlined in the html file, no other external data files are generated. Images, which are loaded from an valid URL are included in the file, any other images are ignored. ...
• PlainTextOutputTarget: An outputtarget, that generates plaintext. The text can be enriched with escape sequences for Epson- or IBM-Compatible printers. This target does not support images, shapes or different fonts. The output generation is needle-printer oriented, the pageformat is translated into a text page, graphics coordinates are aligned along the character grid of the text mode. It is assumed that all characters have the same width, proportional printing is not supported. The output mode is defined by supplying a suitable PrinterCommandSet. Depending on the target printer, you can supply several PrinterCommandSets: ...
• TableGrid: The TableGrid is used to collect all table cells and to finally create the TableGridLayout. The TableGrid stores TableCellData elements and collects their boundaries. The CellData-bounds are used to define the positions of the cells of the generated table. The TableGrid has two modes of operation. In the strict layoutmode, all bounds of the cells are used to define the generated cells. The strict layout mode tries to layout the cells in a way, that the generated results nearly equals the printed layout. If strict mode is disabled, only the origin of the TableCellData is used to define the generated ...
• SimplePageLayouter: A simple page layouter. This class replicates the 'old' behaviour of JFreeReport, simple and straightforward. Layout Constraints used: PageHeader, PageFooter: BandStyleSheet.DISPLAY_ON_FIRST_PAGE Defines whether a PageHeader or ~footer should be printed on the first page. PageHeader, PageFooter: BandStyleSheet.DISPLAY_ON_LAST_PAGE Defines whether a PageHeader or ~footer should be printed on the last page. A warning: For the PageHeader this works only if the ReportFooter has a pagebreak before printing. GroupHeader: BandStyleSheet.REPEAT_HEADER Defines whether this GroupHeader should be repeated ...
• HtmlProcessor: The HtmlProcessor handles the initialisation of the report writer and starts and manages the report process. The Html content is not written directly into an OutputStream. As Html-Files are able to use external references to include images and style information, the output target is provided using an abstract HtmlFilesystem. Depending on the implementation, the output is written into a directory, a ZipFile or a single Html-stream. This output target supports the generation of XHTML or HTML4 output. All recent browsers should be able to handle XHTML output. XHTML is standard XML code, so that any ...
• SurveyScaleExpression: An expression that takes values from one or more fields in the current row of the report, builds a SurveyScale instance that will present those values, and returns that instance as the expression result. The fields used by the expression are defined using properties named '0', '1', ... 'N', which need to be specified after the expression is created. These fields should contain java.lang.Number instances.The SurveyScale class implements the org.jfree.ui.Drawable interface, so it can be displayed using a org.jfree.report.DrawableElement .
• PageLayouter: The baseclass for all PageLayouter. A page layouter is the layoutmanager of an logical page. This layoutmanager is responsible for handling and detecting page breaks, for placing the various Root-Bands (bands that are contained directly in an report) on the page and for the global appeareance of an page (columns, band placement policy etc.) A PageLayouter for an Report is defined by the ReportProperty pageable.layoutManager by setting the classname of the page layouter. The specified class must contain an DefaultConstructor and must be an instance of PageLayouter. All PageLayouter may define a ...
• ReportStateList: The ReportState list stores a report states for the beginning of every page. The list is filled on repagination and read when a report or a page of the report is printed. Important: This list stores page start report states, not arbitary report states. These ReportStates are special: they can be reproduced by calling processPage on the report. Internally this list is organized as a list of WeakReferenceLists, where every WeakReferenceList stores a certain number of page states. The first 20 states are stored in an ordinary list with strong-references, so these states never get GarbageCollected ...
• PhysicalOperation: The base class for an operation that can be applied to an org.jfree.report.modules.output.pageable.base.OutputTarget . These operations are typically added to a org.jfree.report.modules.output.pageable.base.physicals.PhysicalPage in the process of being sent to the output target. Refer to the subclasses for some examples. A sequence of operations can be stored in a org.jfree.report.modules.output.pageable.base.Spool and replayed at any time.
• PDFOutputTarget: An output target for the report engine that generates a PDF file using the iText class library (see http://www.lowagie.com/iText , note that the URL is case-sensitive!). If the system property "org.jfree.report.modules.output.pageable.pdf.PDFOutputTarget.AUTOINIT" is set to "true", the PDF-FontFactory is automatically initialized when this class is loaded. Be aware that embedding many fonts will result in larger files. When using Unicode characters, you will have to adjust the encoding of this target to "Identity-H", to enable horizontal unicode printing. This will result in larger files. The Encoding ...
• PackageManager: The PackageManager is used to load and configure the modules of JFreeReport. Modules are used to extend the basic capabilities of JFreeReport by providing a simple plugin-interface. Modules provide a simple capability to remove unneeded functionality from the JFreeReport system and to reduce the overall code size. The modularisation provides a very strict way of removing unnecessary dependencies beween the various packages. The package manager can be used to add new modules to the system or to check the existence and state of installed modules. This class has been moved into JCommon and will be ...
• TableCellData: Encapsulates cell information, either style information or cell data, and the cell bounds. The cell bounds are used by the TableGridLayout to place the cell into a TableGrid . This class contains all data needed to successfully layout the table grid. The cell style information is dependent on the concrete implementation and not defined here.
• ResultSetTableModelFactory: Creates a TableModel which is backed up by a ResultSet . If the ResultSet is scrollable, a ScrollableResultSetTableModel is created, otherwise all data is copied from the ResultSet into a DefaultTableModel . The creation of a DefaultTableModel can be forced if the system property "org.jfree.report.modules.misc.tablemodel.TableFactoryMode" is set to "simple" .
• TableGridElement: The Element class encapsulates all TableCellData-object within a single grid cell. When the report is badly designed, cells may overlay. This will cause trouble when the table is printed later, so we do not accept multiple non-background TableCellData objects. TableCellData backgrounds can be combined to create complex background structures. Usually, the cell backgrounds must be merged before the cellbackground can be applied to the generated table. As this is dependent on the table implementation, we do not assume anything here, and just collect all backgrounds in the list.
• PDFSaveDialog: A dialog that is used to perform the printing of a report into a PDF file. It is primarily used to edit the properties of the org.jfree.report.modules.output.pageable.pdf.PDFOutputTarget before the target is used to print the report. The main method to call the dialog is PDFSaveDialog.savePDF(). Given a report and a pageformat, the dialog is shown and if the user approved the dialog, the pdf is saved using the settings made in the dialog.
• PackageSorter: Compares two modules for order. A module is considered less than an other module if the module is a required module of the compared module. Modules are considered equal if they have no relation. When sorting, we match this modules position against all dependent modules until all positions are stable. Circular references are evil and are filtered during the module loading process in the package manager. This class has been moved into JCommon and will be removed in version 0.8.5.
• ScrollableResultSetTableModel: A tableModel which is backed up by a java.sql.ResultSet. Use this to directly feed your database data into JFreeReport. If you have trouble using this TableModel and you have either enough memory or your query result is not huge, you may want to use ResultSetTableModelFactory.generateDefaultTableModel (ResultSet rs) . That implementation will read all data from the given ResultSet and keep that data in memory. Use the close() function to close the ResultSet contained in this model.
• BugFixProxyGraphics2D: This documents another sad chapter in Sun's java implementation. The tree cell renderer does not check the clipping of the painted graphics correctly. This bug seems to be related to the TreeCellRenderer's unability to display the defined (and drawn) background of the CellRenderers render component. A first hint of that bug can be found at http://www.cs.cf.ac.uk/Dave/HCI/HCI_Handout_CALLER/node155.html
• ElementFactory: The ElementFactory is responsible for creating ReportElements and is called by the ReportDefinitionContentHandler. For details on the format of the parser have a look at the DTD supplied in the distribution or on http://jfreereport.sourceforge.net/ This factory uses the deprecated element classes. These classes will get not extension for new features and as soon as the discrepancy between implemented and possible features gets too huge, this parser will be discontinued.
• HtmlProducer: The TableProducer is responsible for creating the produced Table. After the writer has finished the band layout process, the layouted bands are forwarded into the TableProducer. The TableProducer coordinates the cell creation process and collects the generated TableCellData. The raw CellData objects are later transformed into a TableGridLayout. The generated HTML code is cached and written after the last cell was created, to insert the StyleSheet into the html header.
• CSVTableProcessor: The CSVTableProcessor coordinates the output for the layouted CSV output. The bands are layouted and the layouted contents are printed into the csv-file. For data oriented csv output try the org.jfree.report.targets.csv.CSVProcessor . The used writer is not closed after the processing, the caller is responsible to close the writer. The CellSeparator can be used to alter the separator character, f.i. to create tab-separated files.
• OperationModule: The base class for an operation module. Operation modules can be either specific modules for a certain specialized type of content ("text/plain", for instance) or a module can be a generic handler for a certain group of content ("text/*"). While a generic handler may not be as performant as a specialized handler, that handler may be useful for displaying at least some of the content. todo 090 add support for generic handlers to the operation factory.
• TableWriter: The TableWriter is the content creation function used to collect the cell data. After the layouting is done, the layouted bands are forwarded to the TableProducer. The virtual page has an unlimited size, only when a manual pagebreak is encountered, a new page is started. This can be used to f.i. to create separate sheets in Excel-Workbooks, the detailed semantics depend on concrete implementation of the TableProducer. This writer is not thread-safe.

Home | Contact Us | Privacy Policy | Terms of Service