Prince

Object
- com.princexml.Prince

Direct Known Subclasses:

PrinceControl
```
public class Prince
extends Object
```
The main Prince class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`mBaseURL`
`protected boolean`	`mCompress`
`protected boolean`	`mDisallowAnnotate`
`protected boolean`	`mDisallowCopy`
`protected boolean`	`mDisallowModify`
`protected boolean`	`mDisallowPrint`
`protected boolean`	`mEmbedFonts`
`protected boolean`	`mEncrypt`
`protected String`	`mFallbackCMYKProfile`
`protected String`	`mFileRoot`
`protected boolean`	`mForceIdentityEncoding`
`protected String`	`mInputType`
`protected boolean`	`mJavaScript`
`protected int`	`mKeyBits`
`protected String`	`mOwnerPassword`
`protected String`	`mPDFOutputIntent`
`protected String`	`mPDFProfile`
`protected String`	`mPDFXMP`
`protected ArrayList<String>`	`mScripts`
`protected ArrayList<String>`	`mStyleSheets`
`protected boolean`	`mSubsetFonts`
`protected String`	`mUserPassword`
`protected boolean`	`mXInclude`

Constructor Summary

Constructors
Constructor and Description

Prince(String exePath)
Constructor for Prince.

Prince(String exePath, PrinceEvents events)
Constructor for Prince.

Constructors
Constructor and Description
`Prince(String exePath)` Constructor for Prince.
`Prince(String exePath, PrinceEvents events)` Constructor for Prince.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScript(String jsPath)` Add a JavaScript script that will be executed before conversion.
`void`	`addStyleSheet(String cssPath)` Add a CSS style sheet that will be applied to each document.
`void`	`clearScripts()` Clear all of the JavaScript scripts.
`void`	`clearStyleSheets()` Clear all of the CSS style sheets.
`boolean`	`convert(InputStream xmlInput, OutputStream pdfOutput)` Convert an XML or HTML file to a PDF file.
`boolean`	`convert(String xmlPath)` Convert an XML or HTML file to a PDF file.
`boolean`	`convert(String xmlPath, OutputStream pdfOutput)` Convert an XML or HTML file to a PDF file.
`boolean`	`convert(String xmlPath, String pdfPath)` Convert an XML or HTML file to a PDF file.
`boolean`	`convertMultiple(List xmlPaths, String pdfPath)` Convert multiple XML or HTML files to a PDF file.
`boolean`	`convertString(String html, OutputStream pdfOutput)` Convert an XML or HTML file to a PDF file.
`boolean`	`convertString(String html, String pdfPath)` Convert an XML or HTML file to a PDF file.
`protected List<String>`	`getBaseCommandLine()` Get the command line used to call Prince.
`protected List<String>`	`getJobCommandLine()` Get the command line used to call Prince.
`protected boolean`	`readMessages(BufferedReader reader)`
`void`	`setBaseURL(String baseurl)` Specify the base URL of the input document.
`void`	`setCompress(boolean compress)` Specify whether compression should be applied to the output PDF file.
`void`	`setDebug(boolean debug)` Enable logging of debug messages.
`void`	`setEmbedFonts(boolean embedFonts)` Specify whether fonts should be embedded in the output PDF file.
`void`	`setEncrypt(boolean encrypt)` Specify whether encryption should be applied to the output PDF file.
`void`	`setEncryptInfo(int keyBits, String userPassword, String ownerPassword, boolean disallowPrint, boolean disallowModify, boolean disallowCopy, boolean disallowAnnotate)` Set the parameters used for PDF encryption.
`void`	`setFallbackCMYKProfile(String fallbackProfile)` Specify the fallback CMYK ICC color profile.
`void`	`setFileRoot(String fileRoot)` Specify the root directory for absolute filenames.
`void`	`setForceIdentityEncoding(boolean forceIdentityEncoding)` Specify whether fonts should be forced to use identity encoding.
`void`	`setHTML(boolean html)` Specify whether documents should be parsed as HTML or XML/XHTML.
`void`	`setHttpPassword(String password)` Specify the password for HTTP basic authentication.
`void`	`setHttpProxy(String proxy)` Specify the URL for the HTTP proxy server, if needed.
`void`	`setHttpUsername(String username)` Specify the username for HTTP basic authentication.
`void`	`setInputType(String inputType)` Specify whether documents should be parsed as HTML or XML/XHTML.
`void`	`setJavaScript(boolean javascript)` Specify whether JavaScript scripts found in the document should be executed during document conversion.
`void`	`setLog(String logfile)` Specify a file that Prince should use to log error/warning messages.
`void`	`setNetwork(boolean network)` Specify whether network access is allowed for downloading HTTP resources.
`void`	`setOptions(String option)` Specify additional Prince command-line options.
`void`	`setOptions(String[] options)` Specify additional Prince command-line options.
`void`	`setPDFOutputIntent(String outputIntent)` Specify the PDF output intent ICC color profile.
`void`	`setPDFProfile(String profile)` Specify the PDF profile.
`void`	`setPDFXMP(String xmpFile)` Specify a PDF XMP metadata file.
`void`	`setSubsetFonts(boolean subsetFonts)` Specify whether embedded fonts should be subset to only include the glyphs that are actually used in the PDF file.
`void`	`setVerbose(boolean verbose)` Enable verbose logging of informative messages.
`void`	`setXInclude(boolean xinclude)` Specify whether XML Inclusions (XInclude) processing should be applied to input documents.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mStyleSheets
```
protected ArrayList<String> mStyleSheets
```
  - mScripts
```
protected ArrayList<String> mScripts
```
  - mInputType
```
protected String mInputType
```
  - mBaseURL
```
protected String mBaseURL
```
  - mFileRoot
```
protected String mFileRoot
```
  - mJavaScript
```
protected boolean mJavaScript
```
  - mXInclude
```
protected boolean mXInclude
```
  - mPDFProfile
```
protected String mPDFProfile
```
  - mPDFOutputIntent
```
protected String mPDFOutputIntent
```
  - mFallbackCMYKProfile
```
protected String mFallbackCMYKProfile
```
  - mPDFXMP
```
protected String mPDFXMP
```
  - mEmbedFonts
```
protected boolean mEmbedFonts
```
  - mSubsetFonts
```
protected boolean mSubsetFonts
```
  - mForceIdentityEncoding
```
protected boolean mForceIdentityEncoding
```
  - mCompress
```
protected boolean mCompress
```
  - mEncrypt
```
protected boolean mEncrypt
```
  - mKeyBits
```
protected int mKeyBits
```
  - mUserPassword
```
protected String mUserPassword
```
  - mOwnerPassword
```
protected String mOwnerPassword
```
  - mDisallowPrint
```
protected boolean mDisallowPrint
```
  - mDisallowModify
```
protected boolean mDisallowModify
```
  - mDisallowCopy
```
protected boolean mDisallowCopy
```
  - mDisallowAnnotate
```
protected boolean mDisallowAnnotate
```
- Constructor Detail
  - Prince
```
public Prince(String exePath)
```
    Constructor for Prince.
    
    Parameters:
    
    exePath - The path of the Prince executable. (For example, this may be C:\Program Files\Prince\engine\bin\prince.exe on Windows or /usr/bin/prince on Linux).
  - Prince
```
public Prince(String exePath,
              PrinceEvents events)
```
    Constructor for Prince.
    
    Parameters:
    
    exePath - The path of the Prince executable. (For example, this may be C:\Program Files\Prince\engine\bin\prince.exe on Windows or /usr/bin/prince on Linux).
    
    events - An instance of the PrinceEvents interface that will receive error/warning messages returned from Prince.
- Method Detail
  - addStyleSheet
```
public void addStyleSheet(String cssPath)
```
    Add a CSS style sheet that will be applied to each document.
    
    Parameters:
    
    cssPath - The filename of the CSS style sheet.
  - clearStyleSheets
```
public void clearStyleSheets()
```
    Clear all of the CSS style sheets.
  - addScript
```
public void addScript(String jsPath)
```
    Add a JavaScript script that will be executed before conversion.
    
    Parameters:
    
    jsPath - The filename of the JavaScript script.
  - clearScripts
```
public void clearScripts()
```
    Clear all of the JavaScript scripts.
  - setHTML
```
public void setHTML(boolean html)
```
    Specify whether documents should be parsed as HTML or XML/XHTML. By default, all documents will be parsed as XML/XHTML, unless they have a filename extension of ".html" or ".htm" and appear to contain HTML rather than XML or XHTML. This method provides a way to override this autodetection and insist that all documents should be parsed as HTML.
    This is also necessary if a HTML document is passed to Prince from an InputStream, as this has no filename and hence Prince will not check the extension and will always treat it as XML/XHTML unless this method has been called.
    
    Parameters:
    
    html - True if all documents should be treated as HTML, false otherwise.
  - setInputType
```
public void setInputType(String inputType)
```
    Specify whether documents should be parsed as HTML or XML/XHTML. By default, all documents will be parsed as XML/XHTML, unless they have a filename extension of ".html" or ".htm" and appear to contain HTML rather than XML or XHTML. This method provides a way to override this autodetection and insist that all documents should be parsed as HTML or XML.
    This is also necessary if a HTML document is passed to Prince from an InputStream, as this has no filename and hence Prince will not check the extension and will always treat it as XML/XHTML unless this method has been called.
    
    Parameters:
    
    inputType - "auto", "html", or "xml"
  - setLog
```
public void setLog(String logfile)
```
    Specify a file that Prince should use to log error/warning messages. If this method if not called or if null is specified as the filename then Prince will not write to any log. This method does not affect the operation of the PrinceEvents interface, which will also receive error/warning messages from Prince.
    
    Parameters:
    
    logfile - The filename that Prince should use to log error/warning messages, or null to disable logging.
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Enable verbose logging of informative messages.
    
    Parameters:
    
    verbose - True to enable verbose logging.
  - setDebug
```
public void setDebug(boolean debug)
```
    Enable logging of debug messages.
    
    Parameters:
    
    debug - True to enable debug logging.
  - setBaseURL
```
public void setBaseURL(String baseurl)
```
    Specify the base URL of the input document. This can be used to override the path of the input document, which is convenient when processing local copies of a document from a website. It is also helpful for specifying a base URL for documents that are provided via an InputStream, as these documents have no natural base URL.
    
    Parameters:
    
    baseurl - The base URL or path of the input document.
  - setFileRoot
```
public void setFileRoot(String fileRoot)
```
    Specify the root directory for absolute filenames. This can be used when converting a local file that uses absolute paths to refer to web resources. For example, /images/logo.jpg can be rewritten to /usr/share/images/logo.jpg by specifying "/usr/share" as the root.
    
    Parameters:
    
    fileRoot - The path to prepend to absolute filenames.
  - setJavaScript
```
public void setJavaScript(boolean javascript)
```
    Specify whether JavaScript scripts found in the document should be executed during document conversion. Scripts will not be executed by default unless explicitly enabled.
    
    Parameters:
    
    javascript - True to enable JavaScript script execution.
  - setXInclude
```
public void setXInclude(boolean xinclude)
```
    Specify whether XML Inclusions (XInclude) processing should be applied to input documents. XInclude processing will be performed by default unless explicitly disabled.
    
    Parameters:
    
    xinclude - False to disable XInclude processing.
  - setNetwork
```
public void setNetwork(boolean network)
```
    Specify whether network access is allowed for downloading HTTP resources. Network access is allowed by default unless explicitly disabled.
    
    Parameters:
    
    network - False to disable network access.
  - setHttpUsername
```
public void setHttpUsername(String username)
```
    Specify the username for HTTP basic authentication.
    
    Parameters:
    
    username - The username for HTTP basic authentication.
  - setHttpPassword
```
public void setHttpPassword(String password)
```
    Specify the password for HTTP basic authentication.
    
    Parameters:
    
    password - The password for HTTP basic authentication.
  - setHttpProxy
```
public void setHttpProxy(String proxy)
```
    Specify the URL for the HTTP proxy server, if needed.
    
    Parameters:
    
    proxy - The URL for the HTTP proxy server.
  - setPDFProfile
```
public void setPDFProfile(String profile)
```
    Specify the PDF profile.
    
    Parameters:
    
    profile - The PDF profile name, for example "PDF/A-1a", "PDF/X-4", or null if no specific PDF profile is required.
  - setPDFOutputIntent
```
public void setPDFOutputIntent(String outputIntent)
```
    Specify the PDF output intent ICC color profile.
    
    Parameters:
    
    outputIntent - The ICC color profile to use for the PDF output intent, or null if no specific output intent ICC profile is required.
  - setFallbackCMYKProfile
```
public void setFallbackCMYKProfile(String fallbackProfile)
```
    Specify the fallback CMYK ICC color profile.
    
    Parameters:
    
    fallbackProfile - The ICC color profile to use as a fallback for uncalibrated CMYK colors, or null if no specific fallback profile is required.
  - setPDFXMP
```
public void setPDFXMP(String xmpFile)
```
    Specify a PDF XMP metadata file.
    
    Parameters:
    
    xmpFile - The filename of the PDF XMP metadata file, or null if no PDF XMP metadata is required.
  - setEmbedFonts
```
public void setEmbedFonts(boolean embedFonts)
```
    Specify whether fonts should be embedded in the output PDF file. Fonts will be embedded by default unless explicitly disabled.
    
    Parameters:
    
    embedFonts - False to disable PDF font embedding.
  - setSubsetFonts
```
public void setSubsetFonts(boolean subsetFonts)
```
    Specify whether embedded fonts should be subset to only include the glyphs that are actually used in the PDF file. Embedded fonts will be subset by default unless this is explicitly disabled.
    
    Parameters:
    
    subsetFonts - False to disable subsetting of embedded fonts.
  - setForceIdentityEncoding
```
public void setForceIdentityEncoding(boolean forceIdentityEncoding)
```
    Specify whether fonts should be forced to use identity encoding.
    
    Parameters:
    
    forceIdentityEncoding - True to force identity encoding.
  - setCompress
```
public void setCompress(boolean compress)
```
    Specify whether compression should be applied to the output PDF file. Compression will be applied by default unless explicitly disabled.
    
    Parameters:
    
    compress - False to disable PDF compression.
  - setEncrypt
```
public void setEncrypt(boolean encrypt)
```
    Specify whether encryption should be applied to the output PDF file. Encryption will not be applied by default unless explicitly enabled.
    
    Parameters:
    
    encrypt - True to enable PDF encryption.
  - setEncryptInfo
```
public void setEncryptInfo(int keyBits,
                           String userPassword,
                           String ownerPassword,
                           boolean disallowPrint,
                           boolean disallowModify,
                           boolean disallowCopy,
                           boolean disallowAnnotate)
```
    Set the parameters used for PDF encryption. Calling this method will also enable PDF encryption, equivalent to calling setEncrypt(true).
    
    Parameters:
    
    keyBits - The size of the encryption key in bits (must be 40 or 128).
    
    userPassword - The user password for the encrypted PDF file.
    
    ownerPassword - The owner password for the encrypted PDF file.
    
    disallowPrint - True to disallow printing of the encrypted PDF file.
    
    disallowModify - True to disallow modification of the encrypted PDF file.
    
    disallowCopy - True to disallow copying from the encrypted PDF file.
    
    disallowAnnotate - True to disallow annotation of the encrypted PDF file.
    
    Throws:
    
    IllegalArgumentException - if keyBits is not 40 or 128.
  - setOptions
```
public void setOptions(String option)
```
    Specify additional Prince command-line options.
    
    Parameters:
    
    option - Additional command-line option, or null.
  - setOptions
```
public void setOptions(String[] options)
```
    Specify additional Prince command-line options.
    
    Parameters:
    
    options - Additional command-line options, or null.
  - convert
```
public boolean convert(String xmlPath)
                throws IOException
```
    Convert an XML or HTML file to a PDF file. The name of the output PDF file will be the same as the name of the input file but with an extension of ".pdf".
    
    Parameters:
    
    xmlPath - The filename of the input XML or HTML document.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convert
```
public boolean convert(String xmlPath,
                       String pdfPath)
                throws IOException
```
    Convert an XML or HTML file to a PDF file.
    
    Parameters:
    
    xmlPath - The filename of the input XML or HTML document.
    
    pdfPath - The filename of the output PDF file.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convertMultiple
```
public boolean convertMultiple(List xmlPaths,
                               String pdfPath)
                        throws IOException
```
    Convert multiple XML or HTML files to a PDF file.
    
    Parameters:
    
    xmlPaths - The filenames of the input XML or HTML documents.
    
    pdfPath - The filename of the output PDF file.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convert
```
public boolean convert(String xmlPath,
                       OutputStream pdfOutput)
                throws IOException
```
    Convert an XML or HTML file to a PDF file. This method is useful for servlets as it allows Prince to write the PDF output directly to the OutputStream of the servlet response.
    
    Parameters:
    
    xmlPath - The filename of the input XML or HTML document.
    
    pdfOutput - The OutputStream to which Prince will write the PDF output.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convert
```
public boolean convert(InputStream xmlInput,
                       OutputStream pdfOutput)
                throws IOException
```
    Convert an XML or HTML file to a PDF file. This method is useful for servlets as it allows Prince to write the PDF output directly to the OutputStream of the servlet response.
    Note that it may be helpful to specify a base URL or path for the input document using the setBaseURL() method. This allows relative URLs and paths in the document (eg. for images) to be resolved correctly.
    
    Parameters:
    
    xmlInput - The InputStream from which Prince will read the XML or HTML document.
    
    pdfOutput - The OutputStream to which Prince will write the PDF output.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convertString
```
public boolean convertString(String html,
                             String pdfPath)
                      throws IOException
```
    Convert an XML or HTML file to a PDF file. Note that it may be helpful to specify a base URL or path for the input document using the setBaseURL() method. This allows relative URLs and paths in the document (eg. for images) to be resolved correctly.
    
    Parameters:
    
    html - The HTML to convert, in the form of a String.
    
    pdfPath - The filename of the output PDF file.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - convertString
```
public boolean convertString(String html,
                             OutputStream pdfOutput)
                      throws IOException
```
    Convert an XML or HTML file to a PDF file. This method is useful for servlets as it allows Prince to process the input document from a string and write the PDF output directly to the OutputStream of the servlet response.
    Note that it may be helpful to specify a base URL or path for the input document using the setBaseURL() method. This allows relative URLs and paths in the document (eg. for images) to be resolved correctly.
    
    Parameters:
    
    html - The HTML to convert, in the form of a String.
    
    pdfOutput - The OutputStream to which Prince will write the PDF output.
    
    Returns:
    
    True if a PDF file was generated successfully.
    
    Throws:
    
    IOException
  - getBaseCommandLine
```
protected List<String> getBaseCommandLine()
```
    Get the command line used to call Prince. The command line is returned as a list of strings rather than a single string in order to avoid potential problems with arguments that contain spaces. getBaseCommandLine() includes only the executable path and basic options which are not job-specific, for use by PrinceControl.
  - getJobCommandLine
```
protected List<String> getJobCommandLine()
```
    Get the command line used to call Prince. The command line is returned as a list of strings rather than a single string in order to avoid potential problems with arguments that contain spaces. getJobCommandLine() extends getBaseCommandLine() and adds the job-specific options.
  - readMessages
```
protected boolean readMessages(BufferedReader reader)
                        throws IOException
```
    Throws:
    
    IOException

Class Prince

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

mStyleSheets

mScripts

mInputType

mBaseURL

mFileRoot

mJavaScript

mXInclude

mPDFProfile

mPDFOutputIntent

mFallbackCMYKProfile

mPDFXMP

mEmbedFonts

mSubsetFonts

mForceIdentityEncoding

mCompress

mEncrypt

mKeyBits

mUserPassword

mOwnerPassword

mDisallowPrint

mDisallowModify

mDisallowCopy

mDisallowAnnotate

Constructor Detail

Prince

Prince

Method Detail

addStyleSheet

clearStyleSheets

addScript

clearScripts

setHTML

setInputType

setLog

setVerbose

setDebug

setBaseURL

setFileRoot

setJavaScript

setXInclude

setNetwork

setHttpUsername

setHttpPassword

setHttpProxy

setPDFProfile

setPDFOutputIntent

setFallbackCMYKProfile

setPDFXMP

setEmbedFonts

setSubsetFonts

setForceIdentityEncoding

setCompress

setEncrypt

setEncryptInfo

setOptions

setOptions

convert

convert

convertMultiple

convert

convert

convertString

convertString

getBaseCommandLine

getJobCommandLine

readMessages