Java Doc for FOUserAgent.java in » Graphic-Library » fop » org » apache » fop » apps » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Graphic Library » fop » org.apache.fop.apps

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.fop.apps .FOUserAgent

FOUserAgent
public class FOUserAgent (Code)
	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
final public static float	DEFAULT_TARGET_RESOLUTION
protected String	author Author of the content of the document.
protected Date	creationDate Creation Date: Override of the date the document was created.
protected String	creator Creator: Metadata element for the user that created the document.
protected String	keywords Set of keywords applicable to this document.
protected String	producer Producer: Metadata element for the system/software that produces the document.
protected String	title Title of the document.

Constructor Summary
public	FOUserAgent()
public	FOUserAgent(FopFactory factory) Main constructor.

Method Summary
public String	getAuthor()
public String	getBaseURL() Returns the base URL.
public Date	getCreationDate()
public String	getCreator()
public FOEventHandler	getFOEventHandlerOverride() Returns the overriding FOEventHandler instance, if any.
public FopFactory	getFactory()
public String	getFontBaseURL()
public String	getKeywords()
public File	getOutputFile() Gets the output File.
public PDFEncryptionParams	getPDFEncryptionParams() Returns the parameters for PDF encryption.
public String	getPageHeight()
public String	getPageWidth()
public String	getProducer()
public RendererFactory	getRendererFactory()
public Map	getRendererOptions()
public Renderer	getRendererOverride() Returns the overriding Renderer instance, if any.
public float	getSourcePixelUnitToMillimeter() Returns the conversion factor from pixel units to millimeters.
public float	getSourceResolution()
public float	getTargetPixelUnitToMillimeter() Returns the conversion factor from pixel units to millimeters.
public float	getTargetResolution()
public String	getTitle()
public URIResolver	getURIResolver() Returns the URI Resolver.
public XMLHandlerRegistry	getXMLHandlerRegistry()
public boolean	isBreakIndentInheritanceOnReferenceAreaBoundary()
public boolean	isLocatorEnabled()
public Source	resolveURI(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 A javax.xml.transform.Source object, or null if the URIcannot be resolved.
public Source	resolveURI(String href, String base) 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 Parameters: base - the base URI to resolve against A javax.xml.transform.Source object, or null if the URIcannot be resolved.
public void	setAuthor(String author) Sets the author of the document.
public void	setBaseURL(String baseUrl) Sets the base URL.
public void	setCreationDate(Date creationDate) Sets the creation date of the document.
public void	setCreator(String creator) Sets the creator of the document.
public void	setFOEventHandlerOverride(FOEventHandler handler) Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting.
public void	setFontBaseURL(String fontBaseUrl)
public void	setKeywords(String keywords) Sets the keywords for the document.
public void	setLocatorEnabled(boolean enableLocator) Controls the use of SAXLocators to provide location information in error messages.
public void	setOutputFile(File f) Sets the output File.
public void	setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams) Sets the parameters for PDF encryption.
public void	setProducer(String producer) Sets the producer of the document.
public void	setRendererOverride(Renderer renderer) Sets an explicit renderer to use which overrides the one defined by the render type setting.
public void	setTargetResolution(float dpi) Sets the target resolution in dpi.
public void	setTargetResolution(int dpi) Sets the target resolution in dpi.
public void	setTitle(String title) Sets the title of the document.
public void	setURIResolver(URIResolver resolver) Sets the URI Resolver.
public boolean	validateStrictly()

Field Detail

DEFAULT_TARGET_RESOLUTION
final public static float DEFAULT_TARGET_RESOLUTION(Code)
	Defines the default target resolution (72dpi) for FOP

author
protected String author(Code)
	Author of the content of the document.

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

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

keywords
protected String keywords(Code)
	Set of keywords applicable to this document.

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

title
protected String title(Code)
	Title of the document.

Constructor Detail

FOUserAgent
public FOUserAgent() throws FOPException(Code)
	Default constructor See Also: org.apache.fop.apps.FopFactory

FOUserAgent
public FOUserAgent(FopFactory factory)(Code)
	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: org.apache.fop.apps.FopFactory

Method Detail

getAuthor
public String getAuthor()(Code)
	Returns the author of the document author name

getBaseURL
public String getBaseURL()(Code)
	Returns the base URL. the base URL

getCreationDate
public Date getCreationDate()(Code)
	Returns the creation date of the document creation date of document

getCreator
public String getCreator()(Code)
	Returns the creator of the document creator name

getFOEventHandlerOverride
public FOEventHandler getFOEventHandlerOverride()(Code)
	Returns the overriding FOEventHandler instance, if any. the overriding FOEventHandler or null

getFactory
public FopFactory getFactory()(Code)
	the associated FopFactory instance

getFontBaseURL
public String getFontBaseURL()(Code)
	the font base URL

getKeywords
public String getKeywords()(Code)
	Returns the keywords for the document the keywords

getOutputFile
public File getOutputFile()(Code)
	Gets the output File. the output File

getPDFEncryptionParams
public PDFEncryptionParams getPDFEncryptionParams()(Code)
	Returns the parameters for PDF encryption. the PDF encryption parameters, null if not applicable

getPageHeight
public String getPageHeight()(Code)
	Gets the default page-height to use as fallback, in case page-height="auto" the page-height, as a String See Also: FopFactory.getPageHeight

getPageWidth
public String getPageWidth()(Code)
	Gets the default page-width to use as fallback, in case page-width="auto" the page-width, as a String See Also: FopFactory.getPageWidth

getProducer
public String getProducer()(Code)
	Returns the producer of the document producer name

getRendererFactory
public RendererFactory getRendererFactory()(Code)
	the RendererFactory

getRendererOptions
public Map getRendererOptions()(Code)
	Returns the renderer options renderer options

getRendererOverride
public Renderer getRendererOverride()(Code)
	Returns the overriding Renderer instance, if any. the overriding Renderer or null

getSourcePixelUnitToMillimeter
public float getSourcePixelUnitToMillimeter()(Code)
	Returns the conversion factor from pixel units to millimeters. This depends on the desired source resolution. float conversion factor See Also: FOUserAgent.getSourceResolution()

getSourceResolution
public float getSourceResolution()(Code)
	the resolution for resolution-dependant input

getTargetPixelUnitToMillimeter
public float getTargetPixelUnitToMillimeter()(Code)
	Returns the conversion factor from pixel units to millimeters. This depends on the desired target resolution. float conversion factor See Also: FOUserAgent.getTargetResolution()

getTargetResolution
public float getTargetResolution()(Code)
	the resolution for resolution-dependant output

getTitle
public String getTitle()(Code)
	Returns the title of the document title name

getURIResolver
public URIResolver getURIResolver()(Code)
	Returns the URI Resolver. the URI Resolver

getXMLHandlerRegistry
public XMLHandlerRegistry getXMLHandlerRegistry()(Code)
	the XML handler registry

isBreakIndentInheritanceOnReferenceAreaBoundary
public boolean isBreakIndentInheritanceOnReferenceAreaBoundary()(Code)
	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

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

resolveURI
public Source resolveURI(String uri)(Code)
	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 A javax.xml.transform.Source object, or null if the URIcannot be resolved. See Also: org.apache.fop.apps.FOURIResolver

resolveURI
public Source resolveURI(String href, String base)(Code)
	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 Parameters: base - the base URI to resolve against A javax.xml.transform.Source object, or null if the URIcannot be resolved. See Also: org.apache.fop.apps.FOURIResolver

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

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

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

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

setFOEventHandlerOverride
public void setFOEventHandlerOverride(FOEventHandler handler)(Code)
	Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting. Parameters: handler - the FOEventHandler instance

setFontBaseURL
public void setFontBaseURL(String fontBaseUrl)(Code)
	sets font base URL Parameters: fontBaseUrl - font base URL

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

setLocatorEnabled
public void setLocatorEnabled(boolean enableLocator)(Code)
	Controls the use of SAXLocators to provide location information in error messages. Parameters: enableLocator - `false` if SAX Locators should be disabled true if context information should be stored on each node in the FO tree.

setOutputFile
public void setOutputFile(File f)(Code)
	Sets the output File. Parameters: f - the output File

setPDFEncryptionParams
public void setPDFEncryptionParams(PDFEncryptionParams pdfEncryptionParams)(Code)
	Sets the parameters for PDF encryption. Parameters: pdfEncryptionParams - the PDF encryption parameters, null todisable PDF encryption

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

setRendererOverride
public void setRendererOverride(Renderer renderer)(Code)
	Sets an explicit renderer to use which overrides the one defined by the render type setting. Parameters: renderer - the Renderer instance to use

setTargetResolution
public void setTargetResolution(float dpi)(Code)
	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)(Code)
	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

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

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

validateStrictly
public boolean validateStrictly()(Code)
	Returns whether FOP is strictly validating input XSL true of strict validation turned on, false otherwise See Also: FopFactory.validateStrictly

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.