Package org.apache.fop.apps
Interface FopFactoryConfig
-
- All Known Implementing Classes:
FopFactoryBuilder.FopFactoryConfigImpl
public interface FopFactoryConfigThe configuration data for aFopFactoryinstance.
-
-
Field Summary
Fields Modifier and Type Field Description static booleanDEFAULT_BREAK_INDENT_INHERITANCEDefines if FOP should use an alternative rule to determine text indentsstatic java.lang.StringDEFAULT_PAGE_HEIGHTDefines the default page-heightstatic java.lang.StringDEFAULT_PAGE_WIDTHDefines the default page-widthstatic floatDEFAULT_SOURCE_RESOLUTIONDefines the default source resolution (72dpi) for FOPstatic booleanDEFAULT_STRICT_FO_VALIDATIONDefines if FOP should use strict validation for FO and user configstatic booleanDEFAULT_STRICT_USERCONFIG_VALIDATIONDefines if FOP should validate the user config strictlystatic floatDEFAULT_TARGET_RESOLUTIONDefines the default target resolution (72dpi) for FOP
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.net.URIgetBaseURI()The base URI from which URIs are resolved against.org.apache.xmlgraphics.image.loader.impl.AbstractImageSessionContext.FallbackResolvergetFallbackResolver()Controls the mechanisms that are used in the event thatSourceused for resources couldn't be read.FontManagergetFontManager()Returns the font manager.java.util.Map<java.lang.String,java.lang.String>getHyphenationPatternNames()InternalResourceResolvergetHyphenationResourceResolver()java.util.Set<java.lang.String>getIgnoredNamespaces()org.apache.xmlgraphics.image.loader.ImageManagergetImageManager()Returns the image manager.LayoutManagerMakergetLayoutManagerMakerOverride()Returns the overriding LayoutManagerMaker instance, if any.java.lang.StringgetPageHeight()Gets the default page-height to use as fallback, in case page-height="auto"java.lang.StringgetPageWidth()Gets the default page-width to use as fallback, in case page-width="auto"org.apache.xmlgraphics.io.ResourceResolvergetResourceResolver()The URI resolver used through-out FOP for controlling all file access.floatgetSourceResolution()floatgetTargetResolution()ConfigurationgetUserConfig()Returns the AvalonConfigurationobject.booleanisAccessibilityEnabled()Whether accessibility features are switched on.booleanisBreakIndentInheritanceOnReferenceAreaBoundary()booleanisComplexScriptFeaturesEnabled()booleanisKeepEmptyTags()booleanisNamespaceIgnored(java.lang.String namespace)Indicates whether a namespace URI is on the ignored list.booleanpreferRenderer()booleanvalidateStrictly()Returns whether FOP is strictly validating input XSLbooleanvalidateUserConfigStrictly()Is the user configuration to be validated?
-
-
-
Field Detail
-
DEFAULT_BREAK_INDENT_INHERITANCE
static final boolean DEFAULT_BREAK_INDENT_INHERITANCE
Defines if FOP should use an alternative rule to determine text indents- See Also:
- Constant Field Values
-
DEFAULT_STRICT_USERCONFIG_VALIDATION
static final boolean DEFAULT_STRICT_USERCONFIG_VALIDATION
Defines if FOP should validate the user config strictly- See Also:
- Constant Field Values
-
DEFAULT_STRICT_FO_VALIDATION
static final boolean DEFAULT_STRICT_FO_VALIDATION
Defines if FOP should use strict validation for FO and user config- See Also:
- Constant Field Values
-
DEFAULT_PAGE_WIDTH
static final java.lang.String DEFAULT_PAGE_WIDTH
Defines the default page-width- See Also:
- Constant Field Values
-
DEFAULT_PAGE_HEIGHT
static final java.lang.String DEFAULT_PAGE_HEIGHT
Defines the default page-height- See Also:
- Constant Field Values
-
DEFAULT_SOURCE_RESOLUTION
static final float DEFAULT_SOURCE_RESOLUTION
Defines the default source resolution (72dpi) for FOP- See Also:
- Constant Field Values
-
DEFAULT_TARGET_RESOLUTION
static final float DEFAULT_TARGET_RESOLUTION
Defines the default target resolution (72dpi) for FOP- See Also:
- Constant Field Values
-
-
Method Detail
-
isAccessibilityEnabled
boolean isAccessibilityEnabled()
Whether accessibility features are switched on.- Returns:
- true if accessibility features have been requested
-
isKeepEmptyTags
boolean isKeepEmptyTags()
-
getLayoutManagerMakerOverride
LayoutManagerMaker getLayoutManagerMakerOverride()
Returns the overriding LayoutManagerMaker instance, if any.- Returns:
- the overriding LayoutManagerMaker or null
-
getResourceResolver
org.apache.xmlgraphics.io.ResourceResolver getResourceResolver()
The URI resolver used through-out FOP for controlling all file access.- Returns:
- the URI resolver
-
getBaseURI
java.net.URI getBaseURI()
The base URI from which URIs are resolved against.- Returns:
- the base URI
-
validateStrictly
boolean validateStrictly()
Returns whether FOP is strictly validating input XSL- Returns:
- true of strict validation turned on, false otherwise
-
validateUserConfigStrictly
boolean validateUserConfigStrictly()
Is the user configuration to be validated?- Returns:
- if the user configuration should be validated
-
isBreakIndentInheritanceOnReferenceAreaBoundary
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)
-
getSourceResolution
float getSourceResolution()
- Returns:
- the resolution for resolution-dependent input
-
getTargetResolution
float getTargetResolution()
- Returns:
- the resolution for resolution-dependent output
-
getPageHeight
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
-
getPageWidth
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
-
getIgnoredNamespaces
java.util.Set<java.lang.String> getIgnoredNamespaces()
- Returns:
- the set of namespaces that are ignored by FOP
-
isNamespaceIgnored
boolean isNamespaceIgnored(java.lang.String namespace)
Indicates whether a namespace URI is on the ignored list.- Parameters:
namespace- the namespace URI- Returns:
- true if the namespace is ignored by FOP
-
getUserConfig
Configuration getUserConfig()
Returns the AvalonConfigurationobject.- Returns:
- the Avalon config object
-
preferRenderer
boolean preferRenderer()
- See Also:
RendererFactory.isRendererPreferred()
-
getFontManager
FontManager getFontManager()
Returns the font manager.- Returns:
- the font manager
-
getImageManager
org.apache.xmlgraphics.image.loader.ImageManager getImageManager()
Returns the image manager.- Returns:
- the image manager
-
isComplexScriptFeaturesEnabled
boolean isComplexScriptFeaturesEnabled()
-
getHyphenationPatternNames
java.util.Map<java.lang.String,java.lang.String> getHyphenationPatternNames()
- Returns:
- the hyphenation pattern names
-
getHyphenationResourceResolver
InternalResourceResolver getHyphenationResourceResolver()
-
getFallbackResolver
org.apache.xmlgraphics.image.loader.impl.AbstractImageSessionContext.FallbackResolver getFallbackResolver()
Controls the mechanisms that are used in the event thatSourceused for resources couldn't be read.- Returns:
- the fallback resolver
-
-