Package org.apache.fop.apps

Class FOUserAgent

  • @Deprecated(since="2021-03-01")
public class FOUserAgent
extends Object
    Deprecated.
    Avoid using this package provided OOTB and migrate code a newer version which you can deploy as part of your project.
    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 Detail

      • DEFAULT_TARGET_RESOLUTION

        public static final float DEFAULT_TARGET_RESOLUTION
        Deprecated.
        Defines the default target resolution (72dpi) for FOP
        See Also:
        Constant Field Values

    • Constructor Detail

      • FOUserAgent

        public FOUserAgent​(FopFactory factory)
        Deprecated.
        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()
        Deprecated.
        Returns:
        the associated FopFactory instance

      • setDocumentHandlerOverride

        public void setDocumentHandlerOverride​(org.apache.fop.render.intermediate.IFDocumentHandler documentHandler)
        Deprecated.
        Sets an explicit document handler to use which overrides the one that would be selected by default.
        Parameters:
        documentHandler - the document handler instance to use

      • getDocumentHandlerOverride

        public org.apache.fop.render.intermediate.IFDocumentHandler getDocumentHandlerOverride()
        Deprecated.
        Returns the overriding IFDocumentHandler instance, if any.
        Returns:
        the overriding document handler or null

      • setRendererOverride

        public void setRendererOverride​(org.apache.fop.render.Renderer renderer)
        Deprecated.
        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 org.apache.fop.render.Renderer getRendererOverride()
        Deprecated.
        Returns the overriding Renderer instance, if any.
        Returns:
        the overriding Renderer or null

      • setFOEventHandlerOverride

        public void setFOEventHandlerOverride​(org.apache.fop.fo.FOEventHandler handler)
        Deprecated.
        Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting.
        Parameters:
        handler - the FOEventHandler instance

      • getFOEventHandlerOverride

        public org.apache.fop.fo.FOEventHandler getFOEventHandlerOverride()
        Deprecated.
        Returns the overriding FOEventHandler instance, if any.
        Returns:
        the overriding FOEventHandler or null

      • setProducer

        public void setProducer​(String producer)
        Deprecated.
        Sets the producer of the document.
        Parameters:
        producer - source of document

      • getProducer

        public String getProducer()
        Deprecated.
        Returns the producer of the document
        Returns:
        producer name

      • setCreator

        public void setCreator​(String creator)
        Deprecated.
        Sets the creator of the document.
        Parameters:
        creator - of document

      • getCreator

        public String getCreator()
        Deprecated.
        Returns the creator of the document
        Returns:
        creator name

      • setCreationDate

        public void setCreationDate​(Date creationDate)
        Deprecated.
        Sets the creation date of the document.
        Parameters:
        creationDate - date of document

      • getCreationDate

        public Date getCreationDate()
        Deprecated.
        Returns the creation date of the document
        Returns:
        creation date of document

      • setAuthor

        public void setAuthor​(String author)
        Deprecated.
        Sets the author of the document.
        Parameters:
        author - of document

      • getAuthor

        public String getAuthor()
        Deprecated.
        Returns the author of the document
        Returns:
        author name

      • setTitle

        public void setTitle​(String title)
        Deprecated.
        Sets the title of the document. This will override any title coming from an fo:title element.
        Parameters:
        title - of document

      • getTitle

        public String getTitle()
        Deprecated.
        Returns the title of the document
        Returns:
        title name

      • setSubject

        public void setSubject​(String subject)
        Deprecated.
        Sets the subject of the document.
        Parameters:
        subject - of document

      • getSubject

        public String getSubject()
        Deprecated.
        Returns the subject of the document
        Returns:
        the subject

      • setKeywords

        public void setKeywords​(String keywords)
        Deprecated.
        Sets the keywords for the document.
        Parameters:
        keywords - for the document

      • getKeywords

        public String getKeywords()
        Deprecated.
        Returns the keywords for the document
        Returns:
        the keywords

      • getRendererOptions

        public Map getRendererOptions()
        Deprecated.
        Returns the renderer options
        Returns:
        renderer options

      • setBaseURL

        public void setBaseURL​(String baseUrl)
        Deprecated.
        Sets the base URL.
        Parameters:
        baseUrl - base URL

      • setFontBaseURL

        public void setFontBaseURL​(String fontBaseUrl)
        Deprecated.
        Use FontManager.setFontBaseURL(String) instead.
        Sets font base URL.
        Parameters:
        fontBaseUrl - font base URL

      • getBaseURL

        public String getBaseURL()
        Deprecated.
        Returns the base URL.
        Returns:
        the base URL

      • setURIResolver

        public void setURIResolver​(URIResolver resolver)
        Deprecated.
        Sets the URI Resolver.
        Parameters:
        resolver - the new URI resolver

      • getURIResolver

        public URIResolver getURIResolver()
        Deprecated.
        Returns the URI Resolver.
        Returns:
        the URI Resolver

      • resolveURI

        public Source resolveURI​(String uri)
        Deprecated.
        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 Source resolveURI​(String href,
                         String base)
        Deprecated.
        Attempts to resolve the given URI. Will use the configured resolver and if not successful fall back to the default resolver.
        Parameters:
        href - 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​(File f)
        Deprecated.
        Sets the output File.
        Parameters:
        f - the output File

      • getOutputFile

        public File getOutputFile()
        Deprecated.
        Gets the output File.
        Returns:
        the output File

      • getTargetPixelUnitToMillimeter

        public float getTargetPixelUnitToMillimeter()
        Deprecated.
        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()
        Deprecated.
        Returns:
        the resolution for resolution-dependant output

      • setTargetResolution

        public void setTargetResolution​(float dpi)
        Deprecated.
        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

      • setTargetResolution

        public void setTargetResolution​(int dpi)
        Deprecated.
        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

      • getImageSessionContext

        public org.apache.xmlgraphics.image.loader.ImageSessionContext getImageSessionContext()
        Deprecated.
        Returns the image session context for the image package.
        Returns:
        the ImageSessionContext instance for this rendering run

      • getFontBaseURL

        public String getFontBaseURL()
        Deprecated.
        Use FontManager.getFontBaseURL() instead. This method is not used by FOP.
        Returns the font base URL.
        Returns:
        the font base URL

      • getSourcePixelUnitToMillimeter

        public float getSourcePixelUnitToMillimeter()
        Deprecated.
        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()
        Deprecated.
        Returns:
        the resolution for resolution-dependant input

      • getPageHeight

        public String getPageHeight()
        Deprecated.
        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 String getPageWidth()
        Deprecated.
        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()
        Deprecated.
        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()
        Deprecated.
        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 org.apache.fop.render.RendererFactory getRendererFactory()
        Deprecated.
        Returns:
        the RendererFactory

      • getXMLHandlerRegistry

        public org.apache.fop.render.XMLHandlerRegistry getXMLHandlerRegistry()
        Deprecated.
        Returns:
        the XML handler registry

      • setLocatorEnabled

        public void setLocatorEnabled​(boolean enableLocator)
        Deprecated.
        Controls the use of SAXLocators to provide location information in error messages.
        Parameters:
        enableLocator - false if SAX Locators should be disabled

      • isLocatorEnabled

        public boolean isLocatorEnabled()
        Deprecated.
        Checks if the use of Locators is enabled
        Returns:
        true if context information should be stored on each node in the FO tree.

      • getEventBroadcaster

        public org.apache.fop.events.EventBroadcaster getEventBroadcaster()
        Deprecated.
        Returns the event broadcaster that control events sent inside a processing run. Clients can register event listeners with the event broadcaster to listen for events that occur while a document is being processed.
        Returns:
        the event broadcaster.

      • isConserveMemoryPolicyEnabled

        public boolean isConserveMemoryPolicyEnabled()
        Deprecated.
        Check whether memory-conservation is enabled.
        Returns:
        true if FOP is to conserve as much as possible

      • setConserveMemoryPolicy

        public void setConserveMemoryPolicy​(boolean conserveMemoryPolicy)
        Deprecated.
        Control whether memory-conservation should be enabled
        Parameters:
        conserveMemoryPolicy - the cachingEnabled to set

      • setAccessibility

        public void setAccessibility​(boolean accessibility)
        Deprecated.
        Activates accessibility (for output formats that support it).
        Parameters:
        accessibility - true to enable accessibility support

      • isAccessibilityEnabled

        public boolean isAccessibilityEnabled()
        Deprecated.
        Check if accessibility is enabled.
        Returns:
        true if accessibility is enabled

      • setStructureTree

        public void setStructureTree​(org.apache.fop.accessibility.StructureTree structureTree)
        Deprecated.
        Sets the document's structure tree, for use by accessible output formats.
        Parameters:
        structureTree - a simplified version of the FO tree, retaining only its logical structure

      • getStructureTree

        public org.apache.fop.accessibility.StructureTree getStructureTree()
        Deprecated.
        Returns the document's structure tree, for use by accessible output formats.
        Returns:
        a simplified version of the FO tree, retaining only its logical structure