|
fop 0.91beta | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.fop.apps.FOUserAgent
The User Agent for fo. This user agent 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 java.lang.String |
DEFAULT_PAGE_HEIGHT
Defines the default page-height |
static java.lang.String |
DEFAULT_PAGE_WIDTH
Defines the default page-width |
static float |
DEFAULT_SOURCE_RESOLUTION
Defines the default source resolution (72dpi) for FOP |
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()
|
Method Summary | |
void |
addElementMapping(ElementMapping elementMapping)
Add the element mapping with the given class name. |
java.util.List |
getAdditionalElementMappings()
Returns the List of user-added ElementMapping class names |
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 |
FOEventHandler |
getFOEventHandlerOverride()
Returns the overriding FOEventHandler instance, if any. |
java.lang.String |
getKeywords()
Returns the keywords for the document |
LayoutManagerMaker |
getLayoutManagerMakerOverride()
Returns the overriding LayoutManagerMaker instance, if any. |
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()
Returns the parameters for PDF encryption. |
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 |
getUserConfig()
Get the user configuration. |
org.apache.avalon.framework.configuration.Configuration |
getUserRendererConfig(java.lang.String mimeType)
Returns the configuration subtree for a specific renderer. |
XMLHandlerRegistry |
getXMLHandlerRegistry()
|
void |
initUserConfig()
Initializes user agent settings from the user configuration file, if present: baseURL, resolution, default page size,... |
boolean |
isBreakIndentInheritanceOnReferenceAreaBoundary()
|
javax.xml.transform.Source |
resolveURI(java.lang.String uri)
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 |
setBreakIndentInheritanceOnReferenceAreaBoundary(boolean value)
Controls whether to enable a feature that breaks indent inheritance when crossing reference area boundaries. |
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 |
setLayoutManagerMakerOverride(LayoutManagerMaker lmMaker)
Sets an explicit LayoutManagerMaker instance which overrides the one defined by the AreaTreeHandler. |
void |
setOutputFile(java.io.File f)
Sets the output File. |
void |
setPageHeight(java.lang.String pageHeight)
Sets the page-height to use as fallback, in case page-height="auto" |
void |
setPageWidth(java.lang.String pageWidth)
Sets the page-width to use as fallback, in case page-width="auto" |
void |
setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams)
Sets the parameters for PDF encryption. |
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 |
setSourceResolution(int dpi)
Sets the source resolution in dpi. |
void |
setStrictValidation(boolean validateStrictly)
Activates strict XSL content model validation for FOP Default is false (FOP will continue processing where it can) |
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 uriResolver)
Sets the URI Resolver. |
void |
setUserConfig(org.apache.avalon.framework.configuration.Configuration userConfig)
Set the user configuration. |
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 |
public static final float DEFAULT_SOURCE_RESOLUTION
public static final float DEFAULT_TARGET_RESOLUTION
public static final java.lang.String DEFAULT_PAGE_HEIGHT
public static final java.lang.String DEFAULT_PAGE_WIDTH
protected java.lang.String producer
protected java.lang.String creator
protected java.util.Date creationDate
protected java.lang.String author
protected java.lang.String title
protected java.lang.String keywords
Constructor Detail |
public FOUserAgent()
Method Detail |
public void addElementMapping(ElementMapping elementMapping)
elementMapping
- the class name representing the element mapping.public java.util.List getAdditionalElementMappings()
public void setRendererOverride(Renderer renderer)
renderer
- the Renderer instance to usepublic Renderer getRendererOverride()
public void setFOEventHandlerOverride(FOEventHandler handler)
handler
- the FOEventHandler instancepublic FOEventHandler getFOEventHandlerOverride()
public void setStrictValidation(boolean validateStrictly)
validateStrictly
- true to turn on strict validationpublic boolean validateStrictly()
public boolean isBreakIndentInheritanceOnReferenceAreaBoundary()
public void setBreakIndentInheritanceOnReferenceAreaBoundary(boolean value)
This flag controls whether FOP will enable special code that breaks property inheritance for start-indent and end-indent when the evaluation of the inherited value would cross a reference area. This is described under http://wiki.apache.org/xmlgraphics-fop/IndentInheritance as is intended to improve interoperability with commercial FO implementations and to produce results that are more in line with the expectation of unexperienced FO users. Note: Enabling this features violates the XSL specification!
value
- true to enable the featurepublic void setLayoutManagerMakerOverride(LayoutManagerMaker lmMaker)
lmMaker
- the LayoutManagerMaker instancepublic LayoutManagerMaker getLayoutManagerMakerOverride()
public void setProducer(java.lang.String producer)
producer
- source of documentpublic java.lang.String getProducer()
public void setCreator(java.lang.String creator)
creator
- of documentpublic java.lang.String getCreator()
public void setCreationDate(java.util.Date creationDate)
creationDate
- date of documentpublic java.util.Date getCreationDate()
public void setAuthor(java.lang.String author)
author
- of documentpublic java.lang.String getAuthor()
public void setTitle(java.lang.String title)
title
- of documentpublic java.lang.String getTitle()
public void setKeywords(java.lang.String keywords)
keywords
- for the documentpublic java.lang.String getKeywords()
public java.util.Map getRendererOptions()
public void setUserConfig(org.apache.avalon.framework.configuration.Configuration userConfig)
userConfig
- configurationpublic org.apache.avalon.framework.configuration.Configuration getUserConfig()
public void initUserConfig() throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
- when there is an entry that
misses the required attributepublic org.apache.avalon.framework.configuration.Configuration getUserRendererConfig(java.lang.String mimeType)
mimeType
- MIME type of the rendererpublic void setBaseURL(java.lang.String baseURL)
baseURL
- base URLpublic java.lang.String getBaseURL()
public void setURIResolver(javax.xml.transform.URIResolver uriResolver)
uriResolver
- the new URI resolverpublic javax.xml.transform.URIResolver getURIResolver()
public PDFEncryptionParams getPDFEncryptionParams()
public void setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams)
pdfEncryptionParams
- the PDF encryption parameters, null to
disable PDF encryptionpublic javax.xml.transform.Source resolveURI(java.lang.String uri)
uri
- URI to accessSource
object, or null if the URI
cannot be resolved.FOURIResolver
public void setOutputFile(java.io.File f)
f
- the output Filepublic java.io.File getOutputFile()
public float getSourcePixelUnitToMillimeter()
getSourceResolution()
public float getTargetPixelUnitToMillimeter()
getTargetResolution()
public float getSourceResolution()
public float getTargetResolution()
public void setSourceResolution(int dpi)
dpi
- resolution in dpipublic void setTargetResolution(int dpi)
dpi
- resolution in dpipublic java.lang.String getPageHeight()
public void setPageHeight(java.lang.String pageHeight)
pageHeight
- page-height as a Stringpublic java.lang.String getPageWidth()
public void setPageWidth(java.lang.String pageWidth)
pageWidth
- page-width as a Stringpublic RendererFactory getRendererFactory()
public XMLHandlerRegistry getXMLHandlerRegistry()
|
fop 0.91beta | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |