Package net.webpdf.wsclient.openapi

Class OperationConverterHtml

  • public class OperationConverterHtml
extends Object
    These settings are only used for HTML (e.g. websites) and HTML-based documents (e.g. e-mails).

    • Constructor Detail

      • OperationConverterHtml

        public OperationConverterHtml()

    • Method Detail

      • 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)

      • getBaseURL

        @Nullable
public @Nullable String getBaseURL()
        Used to define the URL that will be the base for all URLs in the HTML document that are not defined as absolute URLs. The URL must be absolute and contain a scheme (e.g. 'http' or 'https'); the scheme 'file' is not allowed.
        Returns:
        baseURL

      • setBaseURL

        public void setBaseURL​(String baseURL)

      • getDownloadImages

        @Nullable
public @Nullable Boolean getDownloadImages()
        If \"true\", then externally referenced images of the HTML document are downloaded and inserted into the document. If false, the images are not downloaded and the external references to the image are removed, leaving already embedded images intact.
        Returns:
        downloadImages

      • setDownloadImages

        public void setDownloadImages​(Boolean downloadImages)

      • getImageMode

        @Nullable
public @Nullable OperationConverterHtml.ImageModeEnum getImageMode()
        This defines how downloaded images are inserted into the HTML content (with reference to the `<downloadImages>` parameter). When referencing large images in the HTML content, it is recommended to use `<file>` to reduce the size of the HTML file and speed up the rendering of the HTML. * base64 = embed images as BASE64 content * file = embed images as file links to local temporary files
        Returns:
        imageMode

      • getPreferCSSPageSize

        @Nullable
public @Nullable Boolean getPreferCSSPageSize()
        If \"true\", then the page size and margins are preferentially used from the CSS. Otherwise, the sizes from the passed page parameter are used. The values can also be only partially overwritten, so that e.g. the page size is determined by the parameter values and the page margins are defined in the CSS.
        Returns:
        preferCSSPageSize

      • setPreferCSSPageSize

        public void setPreferCSSPageSize​(Boolean preferCSSPageSize)

      • getTemplateData

        @Nullable
public @Nullable OperationTemplateData getTemplateData()
        Get templateData
        Returns:
        templateData

      • 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)

      • 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)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object