org.jfree.report.modules.output.table.html: public class: HtmlProcessor

org.jfree.report.modules.output.table.html
public class: HtmlProcessor [javadoc | source]

java.lang.Object
   org.jfree.report.modules.output.table.base.TableProcessor
      org.jfree.report.modules.output.table.html.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 XML parser is able to read and parse the generated output.

If not specified otherwise, this Processor uses the System Encoding as output enconding, or UTF-8 if no system encoding is defined. When generating XHTML output, make sure that your parser supports your selected encoding, all JAXP compatible parsers must support at least UTF-8 and US-ASCII encoding.

Also see:

HtmlFilesystem

author: Thomas - Morgner

Field Summary
public static final String	CONFIGURATION_PREFIX	The configuration prefix when reading the configuration settings from the report configuration.

Fields inherited from org.jfree.report.modules.output.table.base.TableProcessor:
STRICT_TABLE_LAYOUT, STRICT_TABLE_LAYOUT_DEFAULT, STRICT_LAYOUT

Constructor:

Constructor:
public HtmlProcessor(JFreeReport report) throws FunctionInitializeException, ReportProcessingException { super(report); } Creates a new HtmlProcessor, which generates HTML4 output and uses the standard file encoding. Parameters: `report` - the report that should be processed. Throws: `ReportProcessingException` - if the report initialization failed `FunctionInitializeException` - if the table writer initialization failed.
public HtmlProcessor(JFreeReport report, boolean useXHTML) throws FunctionInitializeException, ReportProcessingException { super(report); setGenerateXHTML(useXHTML); } Creates a new HtmlProcessor, which uses the standard file encoding. Parameters: `report` - the report that should be processed. `useXHTML` - true, if XML output should be generated, false for HTML4 compatible output. Throws: `ReportProcessingException` - if the report initialization failed `FunctionInitializeException` - if the table writer initialization failed.

 public HtmlProcessor(JFreeReport report) throws FunctionInitializeException, ReportProcessingException {
                                          
    super(report);
}

Creates a new HtmlProcessor, which generates HTML4 output and uses the standard file encoding.

Parameters:

report - the report that should be processed.

Throws:

ReportProcessingException - if the report initialization failed

FunctionInitializeException - if the table writer initialization failed.

 public HtmlProcessor(JFreeReport report,
    boolean useXHTML) throws FunctionInitializeException, ReportProcessingException {
    super(report);
    setGenerateXHTML(useXHTML);
}

Creates a new HtmlProcessor, which uses the standard file encoding.

Parameters:

report - the report that should be processed.

useXHTML - true, if XML output should be generated, false for HTML4 compatible output.

Throws:

ReportProcessingException - if the report initialization failed

FunctionInitializeException - if the table writer initialization failed.

Method from org.jfree.report.modules.output.table.html.HtmlProcessor Summary:
createDummyProducer, createProducer, getFilesystem, getReportConfigurationPrefix, isGenerateXHTML, setFilesystem, setGenerateXHTML

Methods from org.jfree.report.modules.output.table.base.TableProcessor:
addRepaginationListener, checkInterrupted, configure, createDummyProducer, createProducer, fireStateUpdate, getProperties, getProperty, getProperty, getPropertyNames, getReport, getReportConfigurationPrefix, getTableWriter, isHandleInterruptedState, isStrictLayout, processReport, removeRepaginationListener, setHandleInterruptedState, setProperty, setStrictLayout

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.modules.output.table.html.HtmlProcessor Detail:
protected TableProducer createDummyProducer() { return new HtmlProducer (new HtmlLayoutInfo(false, getReport().getDefaultPageFormat()), isStrictLayout()); } Creates a dummy TableProducer. The TableProducer is responsible to compute the layout.
protected TableProducer createProducer(TableLayoutInfo gridLayoutBounds) { return new HtmlProducer(getFilesystem(), (HtmlLayoutInfo) gridLayoutBounds); } Creates a TableProducer. The TableProducer is responsible to create the table.
public HtmlFilesystem getFilesystem() { return filesystem; } Gets the HTMLFilesystem, which should be used, or null, if no filesystem is defined yet.
protected String getReportConfigurationPrefix() { return CONFIGURATION_PREFIX; } Gets the report configuration prefix for that processor. This prefix defines how to map the property names into the global report configuration.
public boolean isGenerateXHTML() { return getProperty(HtmlProducer.GENERATE_XHTML, "false").equals("true"); } Gets the XHTML flag.
public void setFilesystem(HtmlFilesystem filesystem) { this.filesystem = filesystem; } Defines the HTMLFileSystem, that should be used to store the content.
public void setGenerateXHTML(boolean useXHTML) { setProperty(HtmlProducer.GENERATE_XHTML, String.valueOf(useXHTML)); } Defines the XHTML flag. Set to true, to generate XHTML output, false for HTML4 compatible code.

Method from org.jfree.report.modules.output.table.html.HtmlProcessor Detail:

 protected TableProducer createDummyProducer() {
    return new HtmlProducer
        (new HtmlLayoutInfo(false, getReport().getDefaultPageFormat()), isStrictLayout());
}

Creates a dummy TableProducer. The TableProducer is responsible to compute the layout.

 protected TableProducer createProducer(TableLayoutInfo gridLayoutBounds) {
    return new HtmlProducer(getFilesystem(), (HtmlLayoutInfo) gridLayoutBounds);
}

Creates a TableProducer. The TableProducer is responsible to create the table.

 public HtmlFilesystem getFilesystem() {
    return filesystem;
}

Gets the HTMLFilesystem, which should be used, or null, if no filesystem is defined yet.

 protected String getReportConfigurationPrefix() {
    return CONFIGURATION_PREFIX;
}

Gets the report configuration prefix for that processor. This prefix defines how to map the property names into the global report configuration.

 public boolean isGenerateXHTML() {
    return getProperty(HtmlProducer.GENERATE_XHTML, "false").equals("true");
}

Gets the XHTML flag.

 public  void setFilesystem(HtmlFilesystem filesystem) {
    this.filesystem = filesystem;
}

Defines the HTMLFileSystem, that should be used to store the content.

 public  void setGenerateXHTML(boolean useXHTML) {
    setProperty(HtmlProducer.GENERATE_XHTML, String.valueOf(useXHTML));
}

Defines the XHTML flag. Set to true, to generate XHTML output, false for HTML4 compatible code.