Package net.webpdf.wsclient.openapi
Class OperationConverterHtml
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationConverterHtml
-
public class OperationConverterHtml extends Object
These settings are only used for HTML (e.g. websites) and HTML-based documents (e.g. e-mails).
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ADJUST_FONTSstatic StringJSON_PROPERTY_BASE_U_R_Lstatic StringJSON_PROPERTY_DOWNLOAD_IMAGESstatic StringJSON_PROPERTY_TEMPLATE_DATAstatic StringJSON_PROPERTY_USE_AS_TEMPLATEstatic StringJSON_PROPERTY_USE_BACKGROUND
-
Constructor Summary
Constructors Constructor Description OperationConverterHtml()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationConverterHtmladjustFonts(Boolean adjustFonts)OperationConverterHtmlbaseURL(String baseURL)OperationConverterHtmldownloadImages(Boolean downloadImages)booleanequals(Object o)@Nullable BooleangetAdjustFonts()If \"true\", then the font specifications \"Arial\", \"Helvetica\" and \"Sans-Serif\" in HTML documents and e-mails (which are based on HTML) are automatically replaced by the \"Arial Unicode MS\" font.@Nullable StringgetBaseURL()Used to define the URL used as a basis for all URLs in the HTML document that are not defined as absolute URLs.@Nullable BooleangetDownloadImages()If \"true\", then the images of an e-mail or an HTML document are downloaded automatically.@Nullable OperationTemplateDatagetTemplateData()Get templateData@Nullable BooleangetUseAsTemplate()If \"true\", the HTML document will be interpreted as a template, i.e., the system will search for variables in the HTML and replace them with the data passed in \"templateData\".@Nullable BooleangetUseBackground()If \"true\", the background defined in the HTML document will be output in the PDF document as well.inthashCode()voidsetAdjustFonts(Boolean adjustFonts)voidsetBaseURL(String baseURL)voidsetDownloadImages(Boolean downloadImages)voidsetTemplateData(OperationTemplateData templateData)voidsetUseAsTemplate(Boolean useAsTemplate)voidsetUseBackground(Boolean useBackground)OperationConverterHtmltemplateData(OperationTemplateData templateData)StringtoString()OperationConverterHtmluseAsTemplate(Boolean useAsTemplate)OperationConverterHtmluseBackground(Boolean useBackground)
-
-
-
Field Detail
-
JSON_PROPERTY_ADJUST_FONTS
public static final String JSON_PROPERTY_ADJUST_FONTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BASE_U_R_L
public static final String JSON_PROPERTY_BASE_U_R_L
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DOWNLOAD_IMAGES
public static final String JSON_PROPERTY_DOWNLOAD_IMAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TEMPLATE_DATA
public static final String JSON_PROPERTY_TEMPLATE_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USE_AS_TEMPLATE
public static final String JSON_PROPERTY_USE_AS_TEMPLATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_USE_BACKGROUND
public static final String JSON_PROPERTY_USE_BACKGROUND
- See Also:
- Constant Field Values
-
-
Method Detail
-
adjustFonts
public OperationConverterHtml adjustFonts(Boolean adjustFonts)
-
getAdjustFonts
@Nullable public @Nullable Boolean getAdjustFonts()
If \"true\", then the font specifications \"Arial\", \"Helvetica\" and \"Sans-Serif\" in HTML documents and e-mails (which are based on HTML) are automatically replaced by the \"Arial Unicode MS\" font. The improves the appearance of the typeface in the PDF result.- Returns:
- adjustFonts
-
setAdjustFonts
public void setAdjustFonts(Boolean adjustFonts)
-
baseURL
public OperationConverterHtml baseURL(String baseURL)
-
getBaseURL
@Nullable public @Nullable String getBaseURL()
Used to define the URL used as a basis for all URLs in the HTML document that are not defined as absolute URLs.- Returns:
- baseURL
-
setBaseURL
public void setBaseURL(String baseURL)
-
downloadImages
public OperationConverterHtml downloadImages(Boolean downloadImages)
-
getDownloadImages
@Nullable public @Nullable Boolean getDownloadImages()
If \"true\", then the images of an e-mail or an HTML document are downloaded automatically. This option could slow down the conversion considerably if there are many images contained or if, for example, e-mail documents are converted in which the images can no longer be invoked.- Returns:
- downloadImages
-
setDownloadImages
public void setDownloadImages(Boolean downloadImages)
-
templateData
public OperationConverterHtml templateData(OperationTemplateData templateData)
-
getTemplateData
@Nullable public @Nullable OperationTemplateData getTemplateData()
Get templateData- Returns:
- templateData
-
setTemplateData
public void setTemplateData(OperationTemplateData templateData)
-
useAsTemplate
public OperationConverterHtml useAsTemplate(Boolean useAsTemplate)
-
getUseAsTemplate
@Nullable public @Nullable Boolean getUseAsTemplate()
If \"true\", the HTML document will be interpreted as a template, i.e., the system will search for variables in the HTML and replace them with the data passed in \"templateData\". The document will not be converted to HTML format until after this step is completed. This means that by using the HTML document as a template together with passed data, you can obtain a dynamically generated PDF document.- Returns:
- useAsTemplate
-
setUseAsTemplate
public void setUseAsTemplate(Boolean useAsTemplate)
-
useBackground
public OperationConverterHtml useBackground(Boolean useBackground)
-
getUseBackground
@Nullable public @Nullable Boolean getUseBackground()
If \"true\", the background defined in the HTML document will be output in the PDF document as well. If \"false\", the background will be hidden.- Returns:
- useBackground
-
setUseBackground
public void setUseBackground(Boolean useBackground)
-
-