org.apache.fop.apps
Class FOUserAgent

java.lang.Object
  org.apache.fop.apps.FOUserAgent

public class FOUserAgent

extends java.lang.Object

This is the user agent for FOP. It is the entity through which you can interact with the XSL-FO processing and is used by the processing to obtain user configurable options.

Renderer specific extensions (that do not produce normal areas on the output) will be done like so:
The extension will create an area, custom if necessary
this area will be added to the user agent with a key
the renderer will know keys for particular extensions
eg. bookmarks will be held in a special hierarchical area representing the title and bookmark structure
These areas may contain resolvable areas that will be processed with other resolvable areas

Field Summary

protected java.lang.String	author Author of the content of the document.
protected java.util.Date	creationDate Creation Date: Override of the date the document was created.
protected java.lang.String	creator Creator: Metadata element for the user that created the document.
static float	DEFAULT_TARGET_RESOLUTION Defines the default target resolution (72dpi) for FOP
protected java.lang.String	keywords Set of keywords applicable to this document.
protected java.lang.String	producer Producer: Metadata element for the system/software that produces the document.
protected java.lang.String	title Title of the document.

Constructor Summary

FOUserAgent()
Deprecated. Provided for compatibility only. Please use the methods from FopFactory to construct FOUserAgent instances!

FOUserAgent(FopFactory factory)
Main constructor.

Method Summary

protected void	configure(org.apache.avalon.framework.configuration.Configuration cfg) Configures the FOUserAgent through the factory's configuration.
java.lang.String	getAuthor() Returns the author of the document
java.lang.String	getBaseURL() Returns the base URL.
java.util.Date	getCreationDate() Returns the creation date of the document
java.lang.String	getCreator() Returns the creator of the document
FopFactory	getFactory()
FOEventHandler	getFOEventHandlerOverride() Returns the overriding FOEventHandler instance, if any.
java.lang.String	getFontBaseURL()
java.lang.String	getKeywords() Returns the keywords for the document
java.io.File	getOutputFile() Gets the output File.
java.lang.String	getPageHeight() Gets the default page-height to use as fallback, in case page-height="auto"
java.lang.String	getPageWidth() Gets the default page-width to use as fallback, in case page-width="auto"
PDFEncryptionParams	getPDFEncryptionParams() Deprecated. Use (PDFEncryptionParams)getRendererOptions().get("encryption-params") instead.
java.lang.String	getProducer() Returns the producer of the document
RendererFactory	getRendererFactory()
java.util.Map	getRendererOptions() Returns the renderer options
Renderer	getRendererOverride() Returns the overriding Renderer instance, if any.
float	getSourcePixelUnitToMillimeter() Returns the conversion factor from pixel units to millimeters.
float	getSourceResolution()
float	getTargetPixelUnitToMillimeter() Returns the conversion factor from pixel units to millimeters.
float	getTargetResolution()
java.lang.String	getTitle() Returns the title of the document
javax.xml.transform.URIResolver	getURIResolver() Returns the URI Resolver.
org.apache.avalon.framework.configuration.Configuration	getUserRendererConfig(java.lang.String mimeType) Returns the configuration subtree for a specific renderer.
XMLHandlerRegistry	getXMLHandlerRegistry()
boolean	isBreakIndentInheritanceOnReferenceAreaBoundary()
javax.xml.transform.Source	resolveURI(java.lang.String uri) Attempts to resolve the given URI.
javax.xml.transform.Source	resolveURI(java.lang.String uri, java.lang.String base) Attempts to resolve the given URI.
void	setAuthor(java.lang.String author) Sets the author of the document.
void	setBaseURL(java.lang.String baseURL) Sets the base URL.
void	setCreationDate(java.util.Date creationDate) Sets the creation date of the document.
void	setCreator(java.lang.String creator) Sets the creator of the document.
void	setFOEventHandlerOverride(FOEventHandler handler) Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting.
void	setKeywords(java.lang.String keywords) Sets the keywords for the document.
void	setOutputFile(java.io.File f) Sets the output File.
void	setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams) Deprecated. Use getRendererOptions().put("encryption-params", new PDFEncryptionParams(..)) instead or set every parameter separately: getRendererOptions().put("noprint", Boolean.TRUE).
void	setProducer(java.lang.String producer) Sets the producer of the document.
void	setRendererOverride(Renderer renderer) Sets an explicit renderer to use which overrides the one defined by the render type setting.
void	setTargetResolution(int dpi) Sets the target resolution in dpi.
void	setTitle(java.lang.String title) Sets the title of the document.
void	setURIResolver(javax.xml.transform.URIResolver resolver) Sets the URI Resolver.
boolean	validateStrictly() Returns whether FOP is strictly validating input XSL

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TARGET_RESOLUTION

public static final float DEFAULT_TARGET_RESOLUTION

Defines the default target resolution (72dpi) for FOP

See Also:

Constant Field Values

producer

protected java.lang.String producer

Producer: Metadata element for the system/software that produces the document. (Some renderers can store this in the document.)

creator

protected java.lang.String creator

Creator: Metadata element for the user that created the document. (Some renderers can store this in the document.)

creationDate

protected java.util.Date creationDate

Creation Date: Override of the date the document was created. (Some renderers can store this in the document.)

author

protected java.lang.String author

Author of the content of the document.

title

protected java.lang.String title

Title of the document.

keywords

protected java.lang.String keywords

Set of keywords applicable to this document.

Constructor Detail

FOUserAgent

public FOUserAgent()

Deprecated. Provided for compatibility only. Please use the methods from FopFactory to construct FOUserAgent instances!

Default constructor

See Also:

FopFactory

FOUserAgent

public FOUserAgent(FopFactory factory)

Main constructor. This constructor should not be called directly. Please use the methods from FopFactory to construct FOUserAgent instances!

Parameters:

factory - the factory that provides environment-level information

See Also:

FopFactory

Method Detail

getFactory

public FopFactory getFactory()

Returns:

the associated FopFactory instance

setRendererOverride

public void setRendererOverride(Renderer renderer)

Sets an explicit renderer to use which overrides the one defined by the render type setting.

Parameters:

renderer - the Renderer instance to use

getRendererOverride

public Renderer getRendererOverride()

Returns the overriding Renderer instance, if any.

Returns:

the overriding Renderer or null

setFOEventHandlerOverride

public void setFOEventHandlerOverride(FOEventHandler handler)

Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting.

Parameters:

handler - the FOEventHandler instance

getFOEventHandlerOverride

public FOEventHandler getFOEventHandlerOverride()

Returns the overriding FOEventHandler instance, if any.

Returns:

the overriding FOEventHandler or null

setProducer

public void setProducer(java.lang.String producer)

Sets the producer of the document.

Parameters:

producer - source of document

getProducer

public java.lang.String getProducer()

Returns the producer of the document

Returns:

producer name

setCreator

public void setCreator(java.lang.String creator)

Sets the creator of the document.

Parameters:

creator - of document

getCreator

public java.lang.String getCreator()

Returns the creator of the document

Returns:

creator name

setCreationDate

public void setCreationDate(java.util.Date creationDate)

Sets the creation date of the document.

Parameters:

creationDate - date of document

getCreationDate

public java.util.Date getCreationDate()

Returns the creation date of the document

Returns:

creation date of document

setAuthor

public void setAuthor(java.lang.String author)

Sets the author of the document.

Parameters:

author - of document

getAuthor

public java.lang.String getAuthor()

Returns the author of the document

Returns:

author name

setTitle

public void setTitle(java.lang.String title)

Sets the title of the document. This will override any title coming from an fo:title element.

Parameters:

title - of document

getTitle

public java.lang.String getTitle()

Returns the title of the document

Returns:

title name

setKeywords

public void setKeywords(java.lang.String keywords)

Sets the keywords for the document.

Parameters:

keywords - for the document

getKeywords

public java.lang.String getKeywords()

Returns the keywords for the document

Returns:

the keywords

getRendererOptions

public java.util.Map getRendererOptions()

Returns the renderer options

Returns:

renderer options

configure

protected void configure(org.apache.avalon.framework.configuration.Configuration cfg)

Configures the FOUserAgent through the factory's configuration.

Parameters:

cfg - Avalon Configuration Object

See Also:

Configurable

getUserRendererConfig

public org.apache.avalon.framework.configuration.Configuration getUserRendererConfig(java.lang.String mimeType)

Returns the configuration subtree for a specific renderer.

Parameters:

mimeType - MIME type of the renderer

Returns:

the requested configuration subtree, null if there's no configuration

setBaseURL

public void setBaseURL(java.lang.String baseURL)

Sets the base URL.

Parameters:

baseURL - base URL

getBaseURL

public java.lang.String getBaseURL()

Returns the base URL.

Returns:

the base URL

setURIResolver

public void setURIResolver(javax.xml.transform.URIResolver resolver)

Sets the URI Resolver.

Parameters:

resolver - the new URI resolver

getURIResolver

public javax.xml.transform.URIResolver getURIResolver()

Returns the URI Resolver.

Returns:

the URI Resolver

getPDFEncryptionParams

public PDFEncryptionParams getPDFEncryptionParams()

Deprecated. Use (PDFEncryptionParams)getRendererOptions().get("encryption-params") instead.

Returns the parameters for PDF encryption.

Returns:

the PDF encryption parameters, null if not applicable

setPDFEncryptionParams

public void setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams)

Deprecated. Use getRendererOptions().put("encryption-params", new PDFEncryptionParams(..)) instead or set every parameter separately: getRendererOptions().put("noprint", Boolean.TRUE).

Sets the parameters for PDF encryption.

Parameters:

pdfEncryptionParams - the PDF encryption parameters, null to disable PDF encryption

resolveURI

public javax.xml.transform.Source resolveURI(java.lang.String uri)

Attempts to resolve the given URI. Will use the configured resolver and if not successful fall back to the default resolver.

Parameters:

uri - URI to access

Returns:

A Source object, or null if the URI cannot be resolved.

See Also:

FOURIResolver

resolveURI

public javax.xml.transform.Source resolveURI(java.lang.String uri,
                                             java.lang.String base)

Attempts to resolve the given URI. Will use the configured resolver and if not successful fall back to the default resolver.

Parameters:

uri - URI to access

base - the base URI to resolve against

Returns:

A Source object, or null if the URI cannot be resolved.

See Also:

FOURIResolver

setOutputFile

public void setOutputFile(java.io.File f)

Sets the output File.

Parameters:

f - the output File

getOutputFile

public java.io.File getOutputFile()

Gets the output File.

Returns:

the output File

getTargetPixelUnitToMillimeter

public float getTargetPixelUnitToMillimeter()

Returns the conversion factor from pixel units to millimeters. This depends on the desired target resolution.

Returns:

float conversion factor

See Also:

getTargetResolution()

getTargetResolution

public float getTargetResolution()

Returns:

the resolution for resolution-dependant output

setTargetResolution

public void setTargetResolution(int dpi)

Sets the target resolution in dpi. This value defines the target resolution of bitmap images generated by the bitmap renderers (such as the TIFF renderer) and of bitmap images generated by filter effects in Apache Batik.

Parameters:

dpi - resolution in dpi

getFontBaseURL

public java.lang.String getFontBaseURL()

Returns:

the font base URL

getSourcePixelUnitToMillimeter

public float getSourcePixelUnitToMillimeter()

Returns the conversion factor from pixel units to millimeters. This depends on the desired source resolution.

Returns:

float conversion factor

See Also:

getSourceResolution()

getSourceResolution

public float getSourceResolution()

Returns:

the resolution for resolution-dependant input

getPageHeight

public java.lang.String getPageHeight()

Gets the default page-height to use as fallback, in case page-height="auto"

Returns:

the page-height, as a String

See Also:

FopFactory.getPageHeight()

getPageWidth

public java.lang.String getPageWidth()

Gets the default page-width to use as fallback, in case page-width="auto"

Returns:

the page-width, as a String

See Also:

FopFactory.getPageWidth()

validateStrictly

public boolean validateStrictly()

Returns whether FOP is strictly validating input XSL

Returns:

true of strict validation turned on, false otherwise

See Also:

FopFactory.validateStrictly()

isBreakIndentInheritanceOnReferenceAreaBoundary

public boolean isBreakIndentInheritanceOnReferenceAreaBoundary()

Returns:

true if the indent inheritance should be broken when crossing reference area boundaries (for more info, see the javadoc for the relative member variable)

See Also:

FopFactory.isBreakIndentInheritanceOnReferenceAreaBoundary()

getRendererFactory

public RendererFactory getRendererFactory()

Returns:

the RendererFactory

getXMLHandlerRegistry

public XMLHandlerRegistry getXMLHandlerRegistry()

Returns:

the XML handler registry