|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IHtmlToPdfTransformer
Interface for an html to pdf transformer.
Nested Class Summary | |
---|---|
static class |
IHtmlToPdfTransformer.CConvertException
An exception indicating a conversion error. |
static class |
IHtmlToPdfTransformer.CHeaderFooter
Represent a Header or a Footer |
static class |
IHtmlToPdfTransformer.PageSize
A class to setup the size of a pdf page. |
Field Summary | |
---|---|
static IHtmlToPdfTransformer.PageSize |
A0L
A0 landscape size |
static IHtmlToPdfTransformer.PageSize |
A0P
A0 portrait size |
static IHtmlToPdfTransformer.PageSize |
A10L
A10 landscape size |
static IHtmlToPdfTransformer.PageSize |
A10P
A10 portrait size |
static IHtmlToPdfTransformer.PageSize |
A11L
A11 landscape size |
static IHtmlToPdfTransformer.PageSize |
A11P
A11 portrait size |
static IHtmlToPdfTransformer.PageSize |
A12L
A12 landscape size |
static IHtmlToPdfTransformer.PageSize |
A12P
A12 portrait size |
static IHtmlToPdfTransformer.PageSize |
A13L
A13 landscape size |
static IHtmlToPdfTransformer.PageSize |
A13P
A13 portrait size |
static IHtmlToPdfTransformer.PageSize |
A14L
A14 landscape size |
static IHtmlToPdfTransformer.PageSize |
A14P
A14 portrait size |
static IHtmlToPdfTransformer.PageSize |
A1L
A1 landscape size |
static IHtmlToPdfTransformer.PageSize |
A1P
A1 portrait size |
static IHtmlToPdfTransformer.PageSize |
A2L
A2 landscape size |
static IHtmlToPdfTransformer.PageSize |
A2P
A2 portrait size |
static IHtmlToPdfTransformer.PageSize |
A3L
A3 landscape size |
static IHtmlToPdfTransformer.PageSize |
A3P
A3 portrait size |
static IHtmlToPdfTransformer.PageSize |
A4L
A4 landscape size |
static IHtmlToPdfTransformer.PageSize |
A4P
A4 portrait size |
static IHtmlToPdfTransformer.PageSize |
A5L
A5 landscape size |
static IHtmlToPdfTransformer.PageSize |
A5P
A5 portrait size |
static IHtmlToPdfTransformer.PageSize |
A6L
A6 landscape size |
static IHtmlToPdfTransformer.PageSize |
A6P
A6 portrait size |
static IHtmlToPdfTransformer.PageSize |
A7L
A7 landscape size |
static IHtmlToPdfTransformer.PageSize |
A7P
A7 portrait size |
static IHtmlToPdfTransformer.PageSize |
A8L
A8 landscape size |
static IHtmlToPdfTransformer.PageSize |
A8P
A8 portrait size |
static IHtmlToPdfTransformer.PageSize |
A9L
A9 landscape size |
static IHtmlToPdfTransformer.PageSize |
A9P
A9 portrait size |
static java.lang.String |
DEFAULT_PDF_RENDERER
Default PDF renderer class, use flying sauce to render HTML. |
static java.lang.String |
FLYINGSAUCER_PDF_RENDERER
PDF renderer class, use Flying Saucer Project to render HTML. |
static java.lang.String |
FOP_TTF_FONT_PATH
Path to TTF font for embedding with FOP |
static IHtmlToPdfTransformer.PageSize |
JUNIOR_LEGALL
JUNIOR LEGAL landscape size |
static IHtmlToPdfTransformer.PageSize |
JUNIOR_LEGALP
JUNIOR LEGAL portrait size |
static IHtmlToPdfTransformer.PageSize |
LEGALL
LEGAL landscape size |
static IHtmlToPdfTransformer.PageSize |
LEGALP
LEGAL portrait size |
static IHtmlToPdfTransformer.PageSize |
LETTERL
LETTER landscape size |
static IHtmlToPdfTransformer.PageSize |
LETTERP
LETTER portrait size |
static java.lang.String |
PDF_ALLOW_ASSEMBLY
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_COPY
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_DEGRADED_PRINTING
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_FILLIN
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_MODIFT_ANNOTATIONS
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_MODIFY_CONTENTS
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_PRINTING
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_ALLOW_SCREEN_READERS
The operation permitted when the document is opened with the user password. |
static java.lang.String |
PDF_AUTHOR
Set this property to set the pdf author metadata. |
static java.lang.String |
PDF_CREATOR
Set this property to set the pdf creator metadata. |
static java.lang.String |
PDF_ENCRYPTION_PASSWORD
Set this property with the desired password of pdf encryption. |
static java.lang.String |
PDF_PRODUCER
Set this property to set the pdf producer metadata. |
static java.lang.String |
PDF_RENDERER_CLASS
name of a custom pdf renderer class. |
static java.lang.String |
PDF_SIGNING_KEYSTORE_PASSWORD
set it with the password to open the keystore |
static java.lang.String |
PDF_SIGNING_LOCATION
set it with the location of the signing |
static java.lang.String |
PDF_SIGNING_PRIVATE_KEY_FILE
set it with the path to the file containing the private key |
static java.lang.String |
PDF_SIGNING_PRIVATE_KEY_PASSWORD
set it with the password to get the private key |
static java.lang.String |
PDF_SIGNING_REASON
set it with a reason for the signing |
static java.lang.String |
PDF_TITLE
Set this property to set the pdf title metadata. |
static java.lang.String |
USE_PDF_ENCRYPTION
Set this property to true to allow encryption of the PDF |
static java.lang.String |
USE_PDF_SELF_SIGNING
default to true. |
static java.lang.String |
USE_PDF_SIGNING
set to true to sign a document with a certificate PDF_SIGNING_PRIVATE_KEY_PASSWORD, PDF_SIGNING_KEYSTORE_PASSWORD, PDF_SIGNING_PRIVATE_KEY_FILE must be set. |
static java.lang.String |
VERSION
YaHP Converter version |
Method Summary | |
---|---|
void |
transform(java.io.InputStream in,
java.lang.String urlForBase,
IHtmlToPdfTransformer.PageSize size,
java.util.List hf,
java.util.Map properties,
java.io.OutputStream out)
Transform the html document in the inputstream to a pdf in the outputstream |
Field Detail |
---|
static final IHtmlToPdfTransformer.PageSize A0L
static final IHtmlToPdfTransformer.PageSize A0P
static final IHtmlToPdfTransformer.PageSize A10L
static final IHtmlToPdfTransformer.PageSize A10P
static final IHtmlToPdfTransformer.PageSize A11L
static final IHtmlToPdfTransformer.PageSize A11P
static final IHtmlToPdfTransformer.PageSize A12L
static final IHtmlToPdfTransformer.PageSize A12P
static final IHtmlToPdfTransformer.PageSize A13L
static final IHtmlToPdfTransformer.PageSize A13P
static final IHtmlToPdfTransformer.PageSize A14L
static final IHtmlToPdfTransformer.PageSize A14P
static final IHtmlToPdfTransformer.PageSize A1L
static final IHtmlToPdfTransformer.PageSize A1P
static final IHtmlToPdfTransformer.PageSize A2L
static final IHtmlToPdfTransformer.PageSize A2P
static final IHtmlToPdfTransformer.PageSize A3L
static final IHtmlToPdfTransformer.PageSize A3P
static final IHtmlToPdfTransformer.PageSize LETTERL
static final IHtmlToPdfTransformer.PageSize LETTERP
static final IHtmlToPdfTransformer.PageSize LEGALL
static final IHtmlToPdfTransformer.PageSize LEGALP
static final IHtmlToPdfTransformer.PageSize JUNIOR_LEGALL
static final IHtmlToPdfTransformer.PageSize JUNIOR_LEGALP
static final IHtmlToPdfTransformer.PageSize A4L
static final IHtmlToPdfTransformer.PageSize A4P
static final IHtmlToPdfTransformer.PageSize A5L
static final IHtmlToPdfTransformer.PageSize A5P
static final IHtmlToPdfTransformer.PageSize A6L
static final IHtmlToPdfTransformer.PageSize A6P
static final IHtmlToPdfTransformer.PageSize A7L
static final IHtmlToPdfTransformer.PageSize A7P
static final IHtmlToPdfTransformer.PageSize A8L
static final IHtmlToPdfTransformer.PageSize A8P
static final IHtmlToPdfTransformer.PageSize A9L
static final IHtmlToPdfTransformer.PageSize A9P
static final java.lang.String DEFAULT_PDF_RENDERER
static final java.lang.String FLYINGSAUCER_PDF_RENDERER
static final java.lang.String FOP_TTF_FONT_PATH
static final java.lang.String PDF_ALLOW_ASSEMBLY
static final java.lang.String PDF_ALLOW_COPY
static final java.lang.String PDF_ALLOW_DEGRADED_PRINTING
static final java.lang.String PDF_ALLOW_FILLIN
static final java.lang.String PDF_ALLOW_MODIFT_ANNOTATIONS
static final java.lang.String PDF_ALLOW_MODIFY_CONTENTS
static final java.lang.String PDF_ALLOW_PRINTING
static final java.lang.String PDF_ALLOW_SCREEN_READERS
static final java.lang.String PDF_AUTHOR
static final java.lang.String PDF_CREATOR
static final java.lang.String PDF_ENCRYPTION_PASSWORD
static final java.lang.String PDF_PRODUCER
static final java.lang.String PDF_RENDERER_CLASS
static final java.lang.String PDF_SIGNING_KEYSTORE_PASSWORD
static final java.lang.String PDF_SIGNING_LOCATION
static final java.lang.String PDF_SIGNING_PRIVATE_KEY_FILE
static final java.lang.String PDF_SIGNING_PRIVATE_KEY_PASSWORD
static final java.lang.String PDF_SIGNING_REASON
static final java.lang.String PDF_TITLE
static final java.lang.String USE_PDF_ENCRYPTION
static final java.lang.String USE_PDF_SELF_SIGNING
static final java.lang.String USE_PDF_SIGNING
static final java.lang.String VERSION
Method Detail |
---|
void transform(java.io.InputStream in, java.lang.String urlForBase, IHtmlToPdfTransformer.PageSize size, java.util.List hf, java.util.Map properties, java.io.OutputStream out) throws IHtmlToPdfTransformer.CConvertException
in
- html document streamurlForBase
- base url of the documentsize
- pdf document page sizehf
- header-footer listproperties
- pdf renderer properties listout
- out stream to the pdf file precondition: in != null
precondition: urlForBase != null precondition: size != null
precondition: != null precondition: properties != null
precondition: out != null
IHtmlToPdfTransformer.CConvertException
- if a conversion exception occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |