| Home >> All >> org >> jfree >> [ report Javadoc ] |
Page 1 2
• org.jfree.report: Javadoc index of package org.jfree.report.
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.filter.templates: Support for the creation of 'filter chains' used to transform data objects into other forms for presentation on reports.
• 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.demo.invoice: Classes making up the demonstration application for the JFreeReport Class Library.
• 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.elementfactory: Main classes in the JFreeReport class library.
• 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.demo.cards
• org.jfree.report.demo.helper
• org.jfree.report.demo.form
• org.jfree.report.demo.resources
• org.jfree.report.demo.conditionalgroup
• org.jfree.report.demo
Classes:
• ReportProperties: The report properties is a hashtable with string keys. ReportProperties are bound to a report as a general purpose storage. ReportProperties bound to a JFreeReport object are visible to all generated report-state chains. A ReportState will inherit all ReportProperties bound to the JFreeReport-object when the ReportState.StartState object is created. Properties bound to the report definition after the report state is created are not visible to the ReportState and its children. ReportProperties bound to a ReportState are not visible to the report definition (the JFreeReport object), but are visible ...
• CSVTokenizer: The csv tokenizer class allows an application to break a Comma Separated Value format into tokens. The tokenization method is much simpler than the one used by the StringTokenizer class. The CSVTokenizer methods do not distinguish among identifiers, numbers, and quoted strings, nor do they recognize and skip comments. The set of separator (the characters that separate tokens) may be specified either at creation time or on a per-token basis. An instance of CSVTokenizer behaves in one of two ways, depending on whether it was created with the returnSeparators flag having the value true or false : ...
• 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 ...
• JFreeReport: This class co-ordinates the process of generating a report from a TableModel . The report is made up of 'bands', which are used repeatedly as necessary to generate small sections of the report. Accessing the bands and the elements: The different bands can be accessed using the main report definition (this class): the report header and footer can be reached by using getReportHeader() and getReportFooter() the page header and page footer can be reached by using getPageHeader() and getPageFooter() the item band is reachable with getItemBand() Groups can be queried using getGroup(int groupLevel) . ...
• TotalGroupSumQuotientFunction: A report function that calculates the quotient of two summed fields (columns) from the TableModel. This function produces a global total. The total sum of the group is known when the group processing starts and the report is not performing a prepare-run. The sum is calculated in the prepare run and recalled in the printing run. The function can be used in two ways: to calculate a quotient for the entire report; to calculate a quotient within a particular group; This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances ...
• TotalGroupSumQuotientPercentFunction: A report function that calculates the quotient of two summed fields (columns) from the TableModel. This function produces a global total. The total sum of the group is known when the group processing starts and the report is not performing a prepare-run. The sum is calculated in the prepare run and recalled in the printing run. The function can be used in two ways: to calculate a quotient for the entire report; to calculate a quotient within a particular group; This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances ...
• ElementVisibilitySwitchFunction: A function that alternates between true and false for each item within a group. The functions value affects a defined elements visibility. If the function evaluates to true, the named element is visible, else the element is invisible. Elements in JFreeReport do not define their own background color attribute. To create a background, you would place a rectangle shape element behind the element. The ElementVisibilitySwitchFunction is used to trigger the visibility of an named element. If the element is your background, you will get the alternating effect. The ElementVisibilitySwitchFunction defines ...
• 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. ...
• WeakReferenceList: The WeakReference list uses java.lang.ref.WeakReference s to store its contents. In contrast to the WeakHashtable, this list knows how to restore missing content, so that garbage collected elements can be restored when they are accessed. By default this list can contain 25 elements, where the first element is stored using a strong reference, which is not garbage collected. Restoring the elements is not implemented, concrete implementations will have to override the restoreChild(int) method. The getMaxChildCount method defines the maxmimum number of children in the list. When more than maxChildCount ...
• Band: A report band is a collection which can contain other Report-Elements. A band contains a list of elements to be displayed, and represents one section of a report (the report header or footer, the page header or footer, the group header or footer, or the items within a group). The elements in a report band can contain fixed values, field values from the dataset, or function values. The elements are not required to have unique names. This implementation is not synchronized, to take care that you externally synchronize it when using multiple threads. A band's contents should not be modified after ...
• 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: ...
• StaticLayoutManager: An implementation of the BandLayoutManager interface. Rule: Bands can have minimum, max and pref size defined. These values are hints for the layout container, no restrictions. If min and pref are '0', they are ignored. MaxSize is never ignored. Elements that have the "dynamic" flag set, are checked for their content-bounds. This operation is expensive, so this is only done if really needed. The dynamic flag will influence the height of an element, a valid width must be already set. Invisible elements within the layouted band are not evaluated. This layout manager will ignore invisible child bands ...
• 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 ...
• TotalGroupSumFunction: A report function that calculates the sum of one field (column) from the TableModel. This function produces a global total. The total sum of the group is known when the group processing starts and the report is not performing a prepare-run. The sum is calculated in the prepare run and recalled in the printing run. The function can be used in two ways: to calculate a sum for the entire report; to calculate a sum within a particular group; This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances using a java.text.DecimalFormat. ...
• 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 .
• StaticShapeElementFactory: A factory to produce static shape elements. The shapes must not contain negative coordinates and should start at (0,0). The factory does not scale shapes which have a negative width or height. This behaviour was valid for JFreeReport versions up to version 0.8.3 and is highly dangerous. The shape is considered immutable. The static utility methods provided in that class try to map negative values of lines and rectangles in the createLineShapeElement and createRectangleElement to preserve the old behaviour. The static method createShapeElement(String, Color, Stroke, Shape, boolean, boolean) 55 extracts ...
• 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 ...
• TextFormatExpression: A TextFormatExpression uses a java.text.MessageFormat to concat and format one or more values evaluated from an expression, function or report datasource. The TextFormatExpression uses the pattern property to define the global format-pattern used when evaluating the expression. The dataRow fields used to fill the expressions placeholders are defined in a list of properties where the property-names are numbers. The property counting starts at "0". The Syntax of the pattern property is explained in java.text.MessageFormat. Example: Invoice for your order from {0, date, EEE, MMM d, yyyy} printdat ...
• ItemSumFunction: A report function that calculates the sum of one field (column) from the TableModel. This function produces a running total, no global total. For a global sum, use the TotalGroupSumFunction function. The function can be used in two ways: to calculate a sum for the entire report; to calculate a sum within a particular group; This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances using a java.text.DecimalFormat. The function undestands two parameters, the field parameter is required and denotes the name of an ItemBand-field ...
• TotalCalculationFunction: A report function that stores the result of a calculation for a group or the complete report. The field value, that was read when the group finished, is stored and returned when the group gets active again in a higher processing level. This function can be used to calculate total values for a group, f.I. a TotalMax for the group, which returns the maximum value encountered for that field in the current group. The computed values are available to all bands of the group. The function undestands two parameters, the field parameter is required and denotes the name of an ItemBand-field which gets summed ...
• ItemAvgFunction: A report function that calculates the average of one field (column) from the TableModel. This function produces a running total, no global total. The function can be used in two ways: to calculate an average value for the entire report; to calculate an average value within a particular group; This function expects its input values to be either java.lang.Number instances or Strings that can be parsed to java.lang.Number instances using a java.text.DecimalFormat. The function undestands two parameters, the field parameter is required and denotes the name of an ItemBand-field which gets summed up. ...
| Home | Contact Us | Privacy Policy | Terms of Service |