Package org.pentaho.reporting.engine.classic.core.layout.output

Class AbstractOutputProcessorMetaData

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.output.AbstractOutputProcessorMetaData

All Implemented Interfaces:

OutputProcessorMetaData

Direct Known Subclasses:

CSVOutputProcessorMetaData, ExcelOutputProcessorMetaData, GenericOutputProcessorMetaData, GraphicsOutputProcessorMetaData, HtmlOutputProcessorMetaData, PdfOutputProcessorMetaData, RTFOutputProcessorMetaData, StreamGraphicsOutputProcessorMetaData, TextOutputProcessorMetaData, XmlPageOutputProcessorMetaData, XmlTableOutputProcessorMetaData

public abstract class AbstractOutputProcessorMetaData
extends Object
implements OutputProcessorMetaData

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractOutputProcessorMetaData.ReusableFontContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOutputProcessorMetaData()
protected	AbstractOutputProcessorMetaData(org.pentaho.reporting.libraries.fonts.registry.FontStorage fontStorage)

Method Summary

Modifier and Type	Method	Description
protected void	addFeature(OutputProcessorFeature.BooleanOutputProcessorFeature feature)
void	commit()
protected boolean	getAutoCorrectFontMetrics()
ExtendedBaselineInfo	getBaselineInfo(int codePoint, StyleSheet styleSheet)
org.pentaho.reporting.libraries.base.config.Configuration	getConfiguration()
org.pentaho.reporting.libraries.fonts.registry.FontMetrics	getFontMetrics(String fontFamily, double fontSize, boolean bold, boolean italics, String encoding, boolean embedded, boolean antiAliasing)	Computes the font-metrics using the given properties.
org.pentaho.reporting.libraries.fonts.registry.FontMetrics	getFontMetrics(StyleSheet styleSheet)	Returns the font metrics for the font specified in the style sheet.
protected org.pentaho.reporting.libraries.fonts.registry.FontRegistry	getFontRegistry()
protected org.pentaho.reporting.libraries.fonts.registry.FontStorage	getFontStorage()
String	getNormalizedFontFamilyName(String name)
double	getNumericFeatureValue(OutputProcessorFeature.NumericOutputProcessorFeature feature)
void	initialize(org.pentaho.reporting.libraries.base.config.Configuration configuration)
boolean	isContentSupported(Object content)
boolean	isExtraContentElement(StyleSheet style, ReportAttributeMap attributes)	Checks whether this element provides some extra content that is not part of the visible layout structure.
boolean	isFeatureSupported(OutputProcessorFeature.BooleanOutputProcessorFeature feature)
protected void	removeFeature(OutputProcessorFeature.BooleanOutputProcessorFeature feature)
protected void	setFamilyMapping(String family, String name)
protected void	setNumericFeatureValue(OutputProcessorFeature.NumericOutputProcessorFeature feature, double value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.layout.output.OutputProcessorMetaData

getExportDescriptor

Constructor Detail

AbstractOutputProcessorMetaData

protected AbstractOutputProcessorMetaData()

AbstractOutputProcessorMetaData

protected AbstractOutputProcessorMetaData(org.pentaho.reporting.libraries.fonts.registry.FontStorage fontStorage)

Method Detail

initialize

public void initialize(org.pentaho.reporting.libraries.base.config.Configuration configuration)

Specified by:

initialize in interface OutputProcessorMetaData

getConfiguration

public org.pentaho.reporting.libraries.base.config.Configuration getConfiguration()

Specified by:

getConfiguration in interface OutputProcessorMetaData

setFamilyMapping

protected void setFamilyMapping(String family,
                                String name)

addFeature

protected void addFeature(OutputProcessorFeature.BooleanOutputProcessorFeature feature)

removeFeature

protected void removeFeature(OutputProcessorFeature.BooleanOutputProcessorFeature feature)

isFeatureSupported

public boolean isFeatureSupported(OutputProcessorFeature.BooleanOutputProcessorFeature feature)

Specified by:

isFeatureSupported in interface OutputProcessorMetaData

setNumericFeatureValue

protected void setNumericFeatureValue(OutputProcessorFeature.NumericOutputProcessorFeature feature,
                                      double value)

getNumericFeatureValue

public double getNumericFeatureValue(OutputProcessorFeature.NumericOutputProcessorFeature feature)

Specified by:

getNumericFeatureValue in interface OutputProcessorMetaData

isContentSupported

public boolean isContentSupported(Object content)

Specified by:

isContentSupported in interface OutputProcessorMetaData

getFontRegistry

protected org.pentaho.reporting.libraries.fonts.registry.FontRegistry getFontRegistry()

getFontStorage

protected org.pentaho.reporting.libraries.fonts.registry.FontStorage getFontStorage()

getNormalizedFontFamilyName

public String getNormalizedFontFamilyName(String name)

Specified by:

getNormalizedFontFamilyName in interface OutputProcessorMetaData

Parameters:

name - the raw name, maybe null.

Returns:

the normalized name, but never null.

getFontMetrics

public org.pentaho.reporting.libraries.fonts.registry.FontMetrics getFontMetrics(String fontFamily,
                                                                                 double fontSize,
                                                                                 boolean bold,
                                                                                 boolean italics,
                                                                                 String encoding,
                                                                                 boolean embedded,
                                                                                 boolean antiAliasing)
                                                                          throws IllegalArgumentException

Computes the font-metrics using the given properties.

This method is a implementation detail. Use it in an output target, but be aware that it may change between releases.

Parameters:

fontFamily - the font family.

fontSize - the font size.

bold - a flag indicating whether the font should be displayed in bold.

italics - a flag indicating whether the font should be displayed in italics.

encoding - a valid font encoding, can be null to use the default.

embedded - a flag indicating whether the font is intended for embedded use.

antiAliasing - a flag indicating whether the font should be rendered in aliased mode.

Returns:

the font metrics, never null.

Throws:

IllegalArgumentException - if the font family was invalid and no default family could be located.

getAutoCorrectFontMetrics

protected boolean getAutoCorrectFontMetrics()

getBaselineInfo

public ExtendedBaselineInfo getBaselineInfo(int codePoint,
                                            StyleSheet styleSheet)

Specified by:

getBaselineInfo in interface OutputProcessorMetaData

getFontMetrics

public org.pentaho.reporting.libraries.fonts.registry.FontMetrics getFontMetrics(StyleSheet styleSheet)
                                                                          throws IllegalArgumentException

Returns the font metrics for the font specified in the style sheet.

NOTE: This method will throw an IllegalArgumentException if the specified font family can not be found and the default font family can not be found

Specified by:

getFontMetrics in interface OutputProcessorMetaData

Parameters:

styleSheet - ths style sheet from which the font information will be extracted

Returns:

FontMetrics for the specified font. If the font family can not be found, the FontMetrics for the default font family will be returned

Throws:

IllegalArgumentException - indicated the font metrics could not be determined (this is thrown since methods depending upon this method can not handle a null return).

commit

public void commit()

Specified by:

commit in interface OutputProcessorMetaData

isExtraContentElement

public boolean isExtraContentElement(StyleSheet style,
                                     ReportAttributeMap attributes)

Checks whether this element provides some extra content that is not part of the visible layout structure. This can be embedded scripts, anchors etc.

Specified by:

isExtraContentElement in interface OutputProcessorMetaData

Parameters:

style -

attributes -

Returns: