Package net.webpdf.wsclient.schema.operation

Class ConverterHtmlType

  • public class ConverterHtmlType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">These settings are only used for HTML (e.g. websites) and HTML-based documents (e.g. e-mails).</p>

    Java class for ConverterHtmlType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="ConverterHtmlType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <all>
         <element name="templateData" type="{http://schema.webpdf.de/1.0/operation}TemplateDataType" minOccurs="0"/>
         <element name="errorReport" type="{http://schema.webpdf.de/1.0/operation}ConverterHtmlErrorReportType" minOccurs="0"/>
       </all>
       <attribute name="downloadImages" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="adjustFonts" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="baseURL" type="{http://www.w3.org/2001/XMLSchema}anyURI" default="" />
       <attribute name="useAsTemplate" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="useBackground" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="preferCSSPageSize" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="imageMode" type="{http://schema.webpdf.de/1.0/operation}ConverterHtmlImageModeType" default="base64" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • errorReport

        protected ConverterHtmlErrorReportType errorReport
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
                             This parameter specifies whether HTML content errors should be detected and, if so, whether a report should be provided along with the error code. The report is created only if at least one error was found. If the parameter is not specified, then any errors that may occur in the HTML document will not be detected and will be silently ignored.
                             <p><b>Important:</b>
                                 This parameter refers only to the content of the passed HTML document and not to the web service call itself.
                             </p></p>

      • downloadImages

        protected Boolean downloadImages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • adjustFonts

        protected Boolean adjustFonts
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • baseURL

        protected String baseURL
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • useAsTemplate

        protected Boolean useAsTemplate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • useBackground

        protected Boolean useBackground
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • preferCSSPageSize

        protected Boolean preferCSSPageSize
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
                     </p>

      • imageMode

        protected ConverterHtmlImageModeType imageMode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This defines how downloaded images are inserted into the HTML content (with reference to the <code>&lt;downloadImages&gt;</code> parameter). When referencing large images in the HTML content, it is recommended to use <code>&lt;file&gt;</code> to reduce the size of the HTML file and speed up the rendering of the HTML.
                         <ul><li>base64 = embed images as BASE64 content</li><li>file = embed images as file links to local temporary files</li></ul></p>

    • Constructor Detail

      • ConverterHtmlType

        public ConverterHtmlType()

    • Method Detail

      • setTemplateData

        public void setTemplateData​(TemplateDataType value)
        Sets the value of the templateData property.
        Parameters:
        value - allowed object is TemplateDataType

      • isSetTemplateData

        public boolean isSetTemplateData()

      • getErrorReport

        public ConverterHtmlErrorReportType getErrorReport()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
                             This parameter specifies whether HTML content errors should be detected and, if so, whether a report should be provided along with the error code. The report is created only if at least one error was found. If the parameter is not specified, then any errors that may occur in the HTML document will not be detected and will be silently ignored.
                             <p><b>Important:</b>
                                 This parameter refers only to the content of the passed HTML document and not to the web service call itself.
                             </p></p>
        Returns:
        possible object is ConverterHtmlErrorReportType

      • isSetErrorReport

        public boolean isSetErrorReport()

      • isDownloadImages

        public boolean isDownloadImages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setDownloadImages

        public void setDownloadImages​(boolean value)
        Sets the value of the downloadImages property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isDownloadImages()

      • isSetDownloadImages

        public boolean isSetDownloadImages()

      • unsetDownloadImages

        public void unsetDownloadImages()

      • isAdjustFonts

        public boolean isAdjustFonts()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setAdjustFonts

        public void setAdjustFonts​(boolean value)
        Sets the value of the adjustFonts property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isAdjustFonts()

      • isSetAdjustFonts

        public boolean isSetAdjustFonts()

      • unsetAdjustFonts

        public void unsetAdjustFonts()

      • getBaseURL

        public String getBaseURL()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is String

      • setBaseURL

        public void setBaseURL​(String value)
        Sets the value of the baseURL property.
        Parameters:
        value - allowed object is String
        See Also:
        getBaseURL()

      • isSetBaseURL

        public boolean isSetBaseURL()

      • isUseAsTemplate

        public boolean isUseAsTemplate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setUseAsTemplate

        public void setUseAsTemplate​(boolean value)
        Sets the value of the useAsTemplate property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isUseAsTemplate()

      • isSetUseAsTemplate

        public boolean isSetUseAsTemplate()

      • unsetUseAsTemplate

        public void unsetUseAsTemplate()

      • isUseBackground

        public boolean isUseBackground()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is Boolean

      • setUseBackground

        public void setUseBackground​(boolean value)
        Sets the value of the useBackground property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isUseBackground()

      • isSetUseBackground

        public boolean isSetUseBackground()

      • unsetUseBackground

        public void unsetUseBackground()

      • isPreferCSSPageSize

        public boolean isPreferCSSPageSize()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.
                     </p>
        Returns:
        possible object is Boolean

      • setPreferCSSPageSize

        public void setPreferCSSPageSize​(boolean value)
        Sets the value of the preferCSSPageSize property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isPreferCSSPageSize()

      • isSetPreferCSSPageSize

        public boolean isSetPreferCSSPageSize()

      • unsetPreferCSSPageSize

        public void unsetPreferCSSPageSize()

      • getImageMode

        public ConverterHtmlImageModeType getImageMode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p310440_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p351123_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This defines how downloaded images are inserted into the HTML content (with reference to the <code>&lt;downloadImages&gt;</code> parameter). When referencing large images in the HTML content, it is recommended to use <code>&lt;file&gt;</code> to reduce the size of the HTML file and speed up the rendering of the HTML.
                         <ul><li>base64 = embed images as BASE64 content</li><li>file = embed images as file links to local temporary files</li></ul></p>
        Returns:
        possible object is ConverterHtmlImageModeType

      • isSetImageMode

        public boolean isSetImageMode()