Package org.faceless.publisher.output.svg

Class SVGReportOutput

java.lang.Object

org.faceless.publisher.output.svg.SVGReportOutput

All Implemented Interfaces:

org.faceless.publisher.output.ReportCanvasContext, ReportOutput, org.faceless.publisher.type.EnvSource

public class SVGReportOutput
extends Object

A ReportOutput that writes the output to one or more SVG files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SVGReportOutput.OutputHandler	An interface which can be set on an SVGReportOutput to control where the individual pages are written.

Constructor Summary

Constructors

Constructor	Description
SVGReportOutput()

Method Summary

Modifier and Type	Method	Description
void	free(org.faceless.publisher.type.AbstractNode node)	Inform the output that the specified node has been freed
MediaType	getMediaType()	Return the type of object that would be written by ReportOutput.write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.
SVGReportOutput.OutputHandler	getOutputHandler()	Return the OutputHandler set by setOutputHandler(org.faceless.publisher.output.svg.SVGReportOutput.OutputHandler).
boolean	isPageBlank()	Return true if the current page is blank
void	markPage()	Record that this page is not blank
void	setOutputHandler(SVGReportOutput.OutputHandler handler)	Set an SVGReportOutput.OutputHandler for this SVGOutputStream.
void	write(OutputStream out)	Write the SVG output to the specified stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SVGReportOutput

public SVGReportOutput()

Method Details

write

public void write(OutputStream out)
           throws IOException

Write the SVG output to the specified stream. If an OutputHandler has been set, that will be used instead and the OutputStream supplied to this method will be ignored.

Otherwise, if the "pagination" method specifies individual pages, they will be written to the supplied OutputStream as as zip file. Other pagination methods will generate a single SVG file written to the supplied OutputStream.

Parameters:

out - the OutputStream to write to.

Throws:

IOException - if generated when writing.

setOutputHandler

public void setOutputHandler(SVGReportOutput.OutputHandler handler)

Set an SVGReportOutput.OutputHandler for this SVGOutputStream. An OutputHandler may be specified to customize the way the SVG is written, allowing individual pages to be written to individual OutputStreams.

Parameters:

handler - the OutputHandler to use, or null to use the default

See Also:

• write(OutputStream)

getOutputHandler

public SVGReportOutput.OutputHandler getOutputHandler()

Return the OutputHandler set by setOutputHandler(org.faceless.publisher.output.svg.SVGReportOutput.OutputHandler).

Returns:

the OutputHandler, or null if the default is used.

See Also:

• write(OutputStream)

getMediaType

public MediaType getMediaType()

Description copied from interface: ReportOutput

Return the type of object that would be written by ReportOutput.write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.

free

public void free(org.faceless.publisher.type.AbstractNode node)

Inform the output that the specified node has been freed

Specified by:

free in interface ReportOutput

isPageBlank

public boolean isPageBlank()

Return true if the current page is blank

Specified by:

isPageBlank in interface ReportOutput

markPage

public void markPage()

Record that this page is not blank

Specified by:

markPage in interface org.faceless.publisher.output.ReportCanvasContext

Specified by:

markPage in interface ReportOutput