Overview

See:
Description

Packages

com.reportmill
com.reportmill.base
com.reportmill.datasource
com.reportmill.graphics
com.reportmill.shape
com.reportmill.shape.graph
com.reportmill.text

Overview

ReportMill's API is remarkably simple and easy to use. In fact, most developers shouldn't need this JavaDoc documentation at all. Most developers will only use the following two sets of API, documented completely in the Basic API document, found on the support page.

Generate XML Dataset

This first step is optional, but to facilitate template design, it's handy to have an XML description of your dataset. You can get this with a single line of code:

new RMXMLWriter().writeObject(myObjects, "MyDataset.xml");

Once you have an XML description of your objects, you can drag that into an empty ReportMill document, to have access to ReportMill's powerful drag and drop template design features (along with useful report previews). However, you can choose to skip this step and simply enter all template keys by hand (assuming you're familiar with the public methods and fields of the objects in your target dataset). This is simply a matter of typing keys surrounded by the @ sign: @title@.

Generate Report

The second and final step is to simply load and generate a report from your target dataset:

RMDocument template = new RMDocument(aSource);
RMDocument report = template.generateReport(myObjects);
report.writePDF("MyReport.pdf");

Using this JavaDoc

This JavaDoc has been provided for those that choose to explore the lower levels of ReportMill's functionality or those who have extraordinary reporting needs. We recommend you start with the following classes:

RMDocument: This is generally the center piece of all ReportMill interaction.
RMShape: This is the foundation of all graphic elements in ReportMill.
RMText: This is the most common and most useful RMShape subclass.
RMTable, RMTableRow: These are ReportMill's most powerful reporting elements
RMXString: This is the basis for ReportMill's rich text system and represents a String with attributes (font, color, etc.).
RMFont, RMColor, RMFormat, RMParagraph: The most common RMXString attributes.