public class FopFactory extends Object implements org.apache.xmlgraphics.image.loader.ImageContext
Modifier and Type | Method and Description |
---|---|
void |
addElementMapping(org.apache.fop.fo.ElementMapping elementMapping)
Add the element mapping with the given class name.
|
String |
getBaseURL()
Returns the base URL.
|
ColorSpace |
getColorSpace(String baseUri,
String iccProfileSrc)
Create (if needed) and return an ICC ColorSpace instance.
|
org.apache.fop.util.ContentHandlerFactoryRegistry |
getContentHandlerFactoryRegistry() |
org.apache.fop.fo.ElementMappingRegistry |
getElementMappingRegistry() |
String |
getFontBaseURL()
Deprecated.
use getFontManager().setFontBaseURL(fontBase) instead
|
org.apache.fop.fonts.FontCache |
getFontCache()
Deprecated.
use getFontManager().getFontCache() instead
|
org.apache.fop.fonts.FontManager |
getFontManager()
Returns the font manager.
|
FOURIResolver |
getFOURIResolver()
Returns the FO URI Resolver.
|
org.apache.fop.hyphenation.HyphenationTreeResolver |
getHyphenationTreeResolver() |
String |
getHyphenBaseURL() |
Set |
getIgnoredNamespace() |
org.apache.fop.render.ImageHandlerRegistry |
getImageHandlerRegistry() |
org.apache.xmlgraphics.image.loader.ImageManager |
getImageManager()
Returns the image manager.
|
org.apache.fop.layoutmgr.LayoutManagerMaker |
getLayoutManagerMakerOverride()
Returns the overriding LayoutManagerMaker instance, if any.
|
String |
getPageHeight()
Gets the default page-height to use as fallback,
in case page-height="auto"
|
String |
getPageWidth()
Gets the default page-width to use as fallback,
in case page-width="auto"
|
org.apache.fop.render.RendererFactory |
getRendererFactory() |
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() |
URIResolver |
getURIResolver()
Returns the URI Resolver.
|
org.apache.avalon.framework.configuration.Configuration |
getUserConfig()
Get the user configuration.
|
org.apache.fop.render.XMLHandlerRegistry |
getXMLHandlerRegistry() |
void |
ignoreNamespace(String namespaceURI)
Adds a namespace to the set of ignored namespaces.
|
void |
ignoreNamespaces(Collection namespaceURIs)
Adds a collection of namespaces to the set of ignored namespaces.
|
boolean |
isBase14KerningEnabled()
Deprecated.
use getFontManager().isBase14KerningEnabled() instead
|
boolean |
isBreakIndentInheritanceOnReferenceAreaBoundary() |
boolean |
isNamespaceIgnored(String namespaceURI)
Indicates whether a namespace URI is on the ignored list.
|
Fop |
newFop(FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
newFop(String outputFormat)
Returns a new
Fop instance. |
Fop |
newFop(String outputFormat,
FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
newFop(String outputFormat,
FOUserAgent userAgent,
OutputStream stream)
Returns a new
Fop instance. |
Fop |
newFop(String outputFormat,
OutputStream stream)
Returns a new
Fop instance. |
FOUserAgent |
newFOUserAgent()
Returns a new FOUserAgent instance.
|
static FopFactory |
newInstance()
Returns a new FopFactory instance.
|
Source |
resolveURI(String href,
String baseUri)
Attempts to resolve the given URI.
|
void |
setBase14KerningEnabled(boolean value)
Deprecated.
use getFontManager().setBase14KerningEnabled(boolean) instead
|
void |
setBaseURL(String base)
Sets the base URL.
|
void |
setBreakIndentInheritanceOnReferenceAreaBoundary(boolean value)
Controls whether to enable a feature that breaks indent inheritance when crossing
reference area boundaries.
|
void |
setFontBaseURL(String fontBase)
Deprecated.
use getFontManager().setFontBaseURL(fontBase) instead
|
void |
setHyphenationTreeResolver(org.apache.fop.hyphenation.HyphenationTreeResolver hyphResolver)
Sets the HyphenationTreeResolver to be used for resolving user-supplied hyphenation files.
|
void |
setHyphenBaseURL(String hyphenBase)
Sets the hyphen base URL.
|
void |
setLayoutManagerMakerOverride(org.apache.fop.layoutmgr.LayoutManagerMaker lmMaker)
Sets an explicit LayoutManagerMaker instance which overrides the one
defined by the AreaTreeHandler.
|
void |
setPageHeight(String pageHeight)
Sets the page-height to use as fallback, in case
page-height="auto"
|
void |
setPageWidth(String pageWidth)
Sets the page-width to use as fallback, in case
page-width="auto"
|
void |
setSourceResolution(float dpi)
Sets the source resolution in dpi.
|
void |
setSourceResolution(int dpi)
Sets the source resolution in dpi.
|
void |
setStrictUserConfigValidation(boolean strictUserConfigValidation)
Is the user configuration to be validated?
|
void |
setStrictValidation(boolean validateStrictly)
Activates strict XSL content model validation for FOP
Default is false (FOP will continue processing where it can)
|
void |
setTargetResolution(float dpi)
Sets the source resolution in dpi.
|
void |
setURIResolver(URIResolver uriResolver)
Sets the URI Resolver.
|
void |
setUseCache(boolean useCache)
Deprecated.
use getFontManager().setUseCache(boolean) instead
|
void |
setUserConfig(org.apache.avalon.framework.configuration.Configuration userConfig)
Set the user configuration.
|
void |
setUserConfig(File userConfigFile)
Set the user configuration.
|
void |
setUserConfig(String uri)
Set the user configuration from an URI.
|
boolean |
useCache()
Deprecated.
use getFontManager().useCache() instead
|
boolean |
validateStrictly()
Returns whether FOP is strictly validating input XSL
|
boolean |
validateUserConfigStrictly()
Is the user configuration to be validated?
|
public static FopFactory newInstance()
public FOUserAgent newFOUserAgent()
FOPException
public Fop newFop(String outputFormat) throws FOPException
Fop
instance. FOP will be configured with a default user agent
instance.
MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
use the constants defined in MimeConstants
.
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").FOPException
- when the constructor failspublic Fop newFop(String outputFormat, FOUserAgent userAgent) throws FOPException
Fop
instance. Use this factory method if you want to configure this
very rendering run, i.e. if you want to set some metadata like the title and author of the
document you want to render. In that case, create a new FOUserAgent
instance using newFOUserAgent()
.
MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
use the constants defined in MimeConstants
.
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").userAgent
- the user agent that will be used to control the rendering runFOPException
- when the constructor failspublic Fop newFop(String outputFormat, OutputStream stream) throws FOPException
Fop
instance. FOP will be configured with a default user agent
instance. Use this factory method if your output type requires an output stream.
MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
use the constants defined in MimeConstants
.
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").stream
- the output streamFOPException
- when the constructor failspublic Fop newFop(String outputFormat, FOUserAgent userAgent, OutputStream stream) throws FOPException
Fop
instance. Use this factory method if your output type
requires an output stream and you want to configure this very rendering run,
i.e. if you want to set some metadata like the title and author of the document
you want to render. In that case, create a new FOUserAgent
instance
using newFOUserAgent()
.
MIME types are used to select the output format (ex. "application/pdf" for PDF). You can
use the constants defined in MimeConstants
.
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").userAgent
- the user agent that will be used to control the rendering runstream
- the output streamFOPException
- when the constructor failspublic Fop newFop(FOUserAgent userAgent) throws FOPException
Fop
instance. Use this factory method if you want to supply your
own Renderer
or
FOEventHandler
instance instead of the default ones created internally by FOP.userAgent
- the user agent that will be used to control the rendering runFOPException
- when the constructor failspublic org.apache.fop.render.RendererFactory getRendererFactory()
public org.apache.fop.render.XMLHandlerRegistry getXMLHandlerRegistry()
public org.apache.fop.render.ImageHandlerRegistry getImageHandlerRegistry()
public org.apache.fop.fo.ElementMappingRegistry getElementMappingRegistry()
public org.apache.fop.util.ContentHandlerFactoryRegistry getContentHandlerFactoryRegistry()
public org.apache.xmlgraphics.image.loader.ImageManager getImageManager()
public void addElementMapping(org.apache.fop.fo.ElementMapping elementMapping)
elementMapping
- the class name representing the element mapping.public void setLayoutManagerMakerOverride(org.apache.fop.layoutmgr.LayoutManagerMaker lmMaker)
lmMaker
- the LayoutManagerMaker instancepublic org.apache.fop.layoutmgr.LayoutManagerMaker getLayoutManagerMakerOverride()
public void setBaseURL(String base) throws MalformedURLException
base
- the base URLMalformedURLException
- if there's a problem with a file URLpublic String getBaseURL()
public void setFontBaseURL(String fontBase) throws MalformedURLException
fontBase
- font base URLMalformedURLException
- if there's a problem with a file URLpublic String getFontBaseURL()
public String getHyphenBaseURL()
public void setHyphenBaseURL(String hyphenBase) throws MalformedURLException
hyphenBase
- hythen base URLMalformedURLException
- if there's a problem with a file URLpublic void setURIResolver(URIResolver uriResolver)
uriResolver
- the new URI resolverpublic URIResolver getURIResolver()
public FOURIResolver getFOURIResolver()
public org.apache.fop.hyphenation.HyphenationTreeResolver getHyphenationTreeResolver()
public void setHyphenationTreeResolver(org.apache.fop.hyphenation.HyphenationTreeResolver hyphResolver)
hyphResolver
- the HyphenationTreeResolver instancepublic 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 boolean isBase14KerningEnabled()
public void setBase14KerningEnabled(boolean value)
value
- true if kerning should be activatedpublic float getSourceResolution()
getSourceResolution
in interface org.apache.xmlgraphics.image.loader.ImageContext
public float getSourcePixelUnitToMillimeter()
getSourceResolution()
public void setSourceResolution(float dpi)
dpi
- resolution in dpipublic float getTargetResolution()
public float getTargetPixelUnitToMillimeter()
getTargetResolution()
public void setTargetResolution(float dpi)
dpi
- resolution in dpipublic void setSourceResolution(int dpi)
dpi
- resolution in dpipublic String getPageHeight()
public void setPageHeight(String pageHeight)
pageHeight
- page-height as a Stringpublic String getPageWidth()
public void setPageWidth(String pageWidth)
pageWidth
- page-width as a Stringpublic void ignoreNamespace(String namespaceURI)
namespaceURI
- the namespace URIpublic void ignoreNamespaces(Collection namespaceURIs)
namespaceURIs
- the namespace URIspublic boolean isNamespaceIgnored(String namespaceURI)
namespaceURI
- the namespace URIpublic Set getIgnoredNamespace()
public void setUserConfig(File userConfigFile) throws SAXException, IOException
userConfigFile
- the configuration fileIOException
- if an I/O error occursSAXException
- if a parsing error occurspublic void setUserConfig(String uri) throws SAXException, IOException
uri
- the URI to the configuration fileIOException
- if an I/O error occursSAXException
- if a parsing error occurspublic void setUserConfig(org.apache.avalon.framework.configuration.Configuration userConfig) throws FOPException
userConfig
- configurationFOPException
- if a configuration problem occurspublic org.apache.avalon.framework.configuration.Configuration getUserConfig()
public void setStrictUserConfigValidation(boolean strictUserConfigValidation)
strictUserConfigValidation
- strict user config validationpublic boolean validateUserConfigStrictly()
public void setUseCache(boolean useCache)
useCache
- use cache or notpublic boolean useCache()
public org.apache.fop.fonts.FontCache getFontCache()
public org.apache.fop.fonts.FontManager getFontManager()
public Source resolveURI(String href, String baseUri)
href
- URI to accessbaseUri
- the base URI to resolve againstSource
object, or null if the URI
cannot be resolved.FOURIResolver
public ColorSpace getColorSpace(String baseUri, String iccProfileSrc)
baseUri
- a base URI to resolve relative URIsiccProfileSrc
- ICC Profile source to return a ColorSpace forCopyright © 2010 - 2020 Adobe. All Rights Reserved