org.jfree.report.modules.output.pageable.base
Interface OutputTarget

All Known Implementing Classes:

AbstractOutputTarget

public interface OutputTarget

extends LayoutSupport

An interface that defines the methods that must be supported by a report output target. JFreeReport currently implements three targets: one for Graphics2D (screen and printer), one for Acrobat PDF files and an other target for PlainText output.

Author:

David Gilbert

Field Summary

static java.lang.String	AUTHOR Literal text for the 'author' property name.
static java.lang.String	TITLE Literal text for the 'title' property name.

Method Summary

void	close() Closes the target.
void	configure(org.jfree.util.Configuration config) Configures the output target.
java.lang.String	getExportDescription()
java.lang.String	getProperty(java.lang.String property) Returns the value of the specified property.
java.lang.String	getProperty(java.lang.String property, java.lang.String defaultValue) Returns the value of the specified property.
boolean	isOpen() Returns true if the target is open, and false otherwise.
void	open() Opens the target.
void	printPage(MetaPage content, PageDefinition page, int index)
void	setProperty(java.lang.String property, java.lang.String value) Defines a property for this target.
void	setReport(ReportDefinition reportDefinition)

Methods inherited from interface org.jfree.report.layout.LayoutSupport

createTextSizeCalculator, getCache, getContentFactory, getHorizontalAlignmentBorder, getInternalHorizontalAlignmentBorder, getInternalVerticalAlignmentBorder, getVerticalAlignmentBorder, isImageResolutionMappingActive

Field Detail

TITLE

public static final java.lang.String TITLE

Literal text for the 'title' property name.

AUTHOR

public static final java.lang.String AUTHOR

Literal text for the 'author' property name.

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String property,
                                    java.lang.String defaultValue)

Returns the value of the specified property. If the property is not found, the defaultValue is returned.

Parameters:

property - the property name (or key).

defaultValue - the default value.

Returns:

the property value.

Throws:

java.lang.NullPointerException - if property is null.

getProperty

public java.lang.String getProperty(java.lang.String property)

Returns the value of the specified property. If the property is not found, null is returned.

Parameters:

property - the property name (or key).

Returns:

the property value.

Throws:

java.lang.NullPointerException - if property is null.

setProperty

public void setProperty(java.lang.String property,
                        java.lang.String value)

Defines a property for this target.

Properties provide a mechanism for configuring a target. For example, you can add title and author information to a PDF report using the 'title' and 'author' properties.

Parameters:

property - the property name (key).

value - the property value (use null to remove an existing property).

open

public void open()
          throws OutputTargetException

Opens the target.

Throws:

OutputTargetException - if there is some problem opening the target.

isOpen

public boolean isOpen()

Returns true if the target is open, and false otherwise.

Returns:

true or false.

close

public void close()

Closes the target.

printPage

public void printPage(MetaPage content,
                      PageDefinition page,
                      int index)
               throws OutputTargetException

configure

public void configure(org.jfree.util.Configuration config)

Configures the output target.

Parameters:

config - the configuration.

getExportDescription

public java.lang.String getExportDescription()

setReport

public void setReport(ReportDefinition reportDefinition)