railo.commons.pdf
Class PDFDocument

java.lang.Object
  extended by railo.commons.pdf.PDFDocument

public final class PDFDocument
extends Object


Field Summary
static int ENC_128BIT
           
static int ENC_40BIT
           
static int ENC_NONE
           
static int FONT_EMBED_NO
           
static int FONT_EMBED_SELECCTIVE
           
static int FONT_EMBED_YES
           
static Dimension PAGETYPE_A0
           
static Dimension PAGETYPE_A1
           
static Dimension PAGETYPE_A10
           
static Dimension PAGETYPE_A2
           
static Dimension PAGETYPE_A3
           
static Dimension PAGETYPE_A4
           
static Dimension PAGETYPE_A5
           
static Dimension PAGETYPE_A6
           
static Dimension PAGETYPE_A7
           
static Dimension PAGETYPE_A8
           
static Dimension PAGETYPE_A9
           
static Dimension PAGETYPE_B4
           
static Dimension PAGETYPE_B4_JIS
           
static Dimension PAGETYPE_B5
           
static Dimension PAGETYPE_B5_JIS
           
static Dimension PAGETYPE_CUSTOM
           
static Dimension PAGETYPE_HALFLETTER
           
static Dimension PAGETYPE_ISOB0
           
static Dimension PAGETYPE_ISOB1
           
static Dimension PAGETYPE_ISOB2
           
static Dimension PAGETYPE_ISOB3
           
static Dimension PAGETYPE_ISOB4
           
static Dimension PAGETYPE_ISOB5
           
static Dimension PAGETYPE_LEDGER
           
static Dimension PAGETYPE_LEGAL
           
static Dimension PAGETYPE_LETTER
           
static Dimension PAGETYPE_NOTE
           
static Dimension PAGETYPE_TABLOID
           
static double UNIT_FACTOR_CM
           
static double UNIT_FACTOR_IN
           
static double UNIT_FACTOR_POINT
           
 
Constructor Summary
PDFDocument()
           
 
Method Summary
 String getAuthPassword()
           
 String getAuthUser()
           
 boolean getBookmark()
           
 PDFPageMark getFooter()
           
 PDFPageMark getHeader()
           
 boolean getHtmlBookmark()
           
 boolean getLocalUrl()
           
 String getName()
           
 String getProxypassword()
           
 int getProxyport()
           
 String getProxyserver()
           
 String getProxyuser()
           
 String getUserAgent()
           
 boolean hasProxy()
           
 byte[] render(Dimension dimension, double unitFactor, PageContext pc, boolean generateOutlines)
           
 void setAuthPassword(String authPassword)
           
 void setAuthUser(String authUser)
           
 void setBody(String body)
           
 void setBookmark(boolean bookmark)
           
 void setFontembed(int fontembed)
           
 void setFooter(PDFPageMark footer)
           
 void setHeader(PDFPageMark header)
           
 void setHtmlBookmark(boolean htmlBookmark)
           
 void setLocalUrl(boolean localUrl)
           
 void setMarginbottom(double marginbottom)
           
 void setMarginleft(double marginleft)
           
 void setMarginright(double marginright)
           
 void setMargintop(double margintop)
           
 void setMimetype(String strMimetype)
           
 void setName(String name)
           
 void setProxypassword(String proxypassword)
          set the value password When required by a proxy server, a valid password.
 void setProxyport(int proxyport)
          set the value proxyport The port number on the proxy server from which the object is requested.
 void setProxyserver(String proxyserver)
          set the value proxyserver Host name or IP address of a proxy server.
 void setProxyuser(String proxyuser)
          set the value username When required by a proxy server, a valid username.
 void setSrc(String src)
           
 void setSrcfile(Resource srcfile)
           
 void setUserAgent(String userAgent)
           
static int toPoint(double value, double unitFactor)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PAGETYPE_ISOB5

public static final Dimension PAGETYPE_ISOB5

PAGETYPE_ISOB4

public static final Dimension PAGETYPE_ISOB4

PAGETYPE_ISOB3

public static final Dimension PAGETYPE_ISOB3

PAGETYPE_ISOB2

public static final Dimension PAGETYPE_ISOB2

PAGETYPE_ISOB1

public static final Dimension PAGETYPE_ISOB1

PAGETYPE_ISOB0

public static final Dimension PAGETYPE_ISOB0

PAGETYPE_HALFLETTER

public static final Dimension PAGETYPE_HALFLETTER

PAGETYPE_LETTER

public static final Dimension PAGETYPE_LETTER

PAGETYPE_TABLOID

public static final Dimension PAGETYPE_TABLOID

PAGETYPE_LEDGER

public static final Dimension PAGETYPE_LEDGER

PAGETYPE_NOTE

public static final Dimension PAGETYPE_NOTE

PAGETYPE_LEGAL

public static final Dimension PAGETYPE_LEGAL

PAGETYPE_A10

public static final Dimension PAGETYPE_A10

PAGETYPE_A9

public static final Dimension PAGETYPE_A9

PAGETYPE_A8

public static final Dimension PAGETYPE_A8

PAGETYPE_A7

public static final Dimension PAGETYPE_A7

PAGETYPE_A6

public static final Dimension PAGETYPE_A6

PAGETYPE_A5

public static final Dimension PAGETYPE_A5

PAGETYPE_A4

public static final Dimension PAGETYPE_A4

PAGETYPE_A3

public static final Dimension PAGETYPE_A3

PAGETYPE_A2

public static final Dimension PAGETYPE_A2

PAGETYPE_A1

public static final Dimension PAGETYPE_A1

PAGETYPE_A0

public static final Dimension PAGETYPE_A0

PAGETYPE_B4

public static final Dimension PAGETYPE_B4

PAGETYPE_B5

public static final Dimension PAGETYPE_B5

PAGETYPE_B4_JIS

public static final Dimension PAGETYPE_B4_JIS

PAGETYPE_B5_JIS

public static final Dimension PAGETYPE_B5_JIS

PAGETYPE_CUSTOM

public static final Dimension PAGETYPE_CUSTOM

ENC_NONE

public static final int ENC_NONE
See Also:
Constant Field Values

ENC_40BIT

public static final int ENC_40BIT
See Also:
Constant Field Values

ENC_128BIT

public static final int ENC_128BIT
See Also:
Constant Field Values

FONT_EMBED_NO

public static final int FONT_EMBED_NO
See Also:
Constant Field Values

FONT_EMBED_YES

public static final int FONT_EMBED_YES
See Also:
Constant Field Values

FONT_EMBED_SELECCTIVE

public static final int FONT_EMBED_SELECCTIVE
See Also:
Constant Field Values

UNIT_FACTOR_CM

public static final double UNIT_FACTOR_CM
See Also:
Constant Field Values

UNIT_FACTOR_IN

public static final double UNIT_FACTOR_IN
See Also:
Constant Field Values

UNIT_FACTOR_POINT

public static final double UNIT_FACTOR_POINT
See Also:
Constant Field Values
Constructor Detail

PDFDocument

public PDFDocument()
Method Detail

setHeader

public void setHeader(PDFPageMark header)

setFooter

public void setFooter(PDFPageMark footer)

setMarginbottom

public void setMarginbottom(double marginbottom)
Parameters:
marginbottom - the marginbottom to set

setMarginleft

public void setMarginleft(double marginleft)
Parameters:
marginleft - the marginleft to set

setMarginright

public void setMarginright(double marginright)
Parameters:
marginright - the marginright to set

setMargintop

public void setMargintop(double margintop)
Parameters:
margintop - the margintop to set

setMimetype

public void setMimetype(String strMimetype)
Parameters:
mimetype - the mimetype to set

setProxyserver

public void setProxyserver(String proxyserver)
set the value proxyserver Host name or IP address of a proxy server.

Parameters:
proxyserver - value to set

setProxyport

public void setProxyport(int proxyport)
set the value proxyport The port number on the proxy server from which the object is requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.

Parameters:
proxyport - value to set

setProxyuser

public void setProxyuser(String proxyuser)
set the value username When required by a proxy server, a valid username.

Parameters:
proxyuser - value to set

setProxypassword

public void setProxypassword(String proxypassword)
set the value password When required by a proxy server, a valid password.

Parameters:
proxypassword - value to set

setSrc

public void setSrc(String src)
            throws PDFException
Parameters:
src -
Throws:
PDFException

setSrcfile

public void setSrcfile(Resource srcfile)
                throws PDFException
Parameters:
srcfile - the srcfile to set
Throws:
PDFException

setBody

public void setBody(String body)

render

public byte[] render(Dimension dimension,
                     double unitFactor,
                     PageContext pc,
                     boolean generateOutlines)
              throws PageException,
                     IOException
Throws:
PageException
IOException

toPoint

public static int toPoint(double value,
                          double unitFactor)

getHeader

public PDFPageMark getHeader()

getFooter

public PDFPageMark getFooter()

setFontembed

public void setFontembed(int fontembed)

getName

public String getName()
Returns:
the name

setName

public void setName(String name)
Parameters:
name - the name to set

getAuthUser

public String getAuthUser()
Returns:
the authUser

setAuthUser

public void setAuthUser(String authUser)
Parameters:
authUser - the authUser to set

getAuthPassword

public String getAuthPassword()
Returns:
the authPassword

setAuthPassword

public void setAuthPassword(String authPassword)
Parameters:
authPassword - the authPassword to set

getUserAgent

public String getUserAgent()
Returns:
the userAgent

setUserAgent

public void setUserAgent(String userAgent)
Parameters:
userAgent - the userAgent to set

getProxyserver

public String getProxyserver()
Returns:
the proxyserver

getProxyport

public int getProxyport()
Returns:
the proxyport

getProxyuser

public String getProxyuser()
Returns:
the proxyuser

getProxypassword

public String getProxypassword()
Returns:
the proxypassword

hasProxy

public boolean hasProxy()

getLocalUrl

public boolean getLocalUrl()
Returns:
the localUrl

setLocalUrl

public void setLocalUrl(boolean localUrl)
Parameters:
localUrl - the localUrl to set

getBookmark

public boolean getBookmark()
Returns:
the bookmark

setBookmark

public void setBookmark(boolean bookmark)
Parameters:
bookmark - the bookmark to set

getHtmlBookmark

public boolean getHtmlBookmark()
Returns:
the htmlBookmark

setHtmlBookmark

public void setHtmlBookmark(boolean htmlBookmark)
Parameters:
htmlBookmark - the htmlBookmark to set


Copyright © 2012 Railo