Package net.webpdf.wsclient.schema.operation

Class ImageType

  • All Implemented Interfaces:
    ParameterInterface
    public class ImageType
extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The image operation element can be used to export a document as an image.</p>

    Java class for ImageType complex type

    .

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

    
 <complexType name="ImageType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <choice>
         <element name="png" type="{http://schema.webpdf.de/1.0/operation}PngType"/>
         <element name="tiff" type="{http://schema.webpdf.de/1.0/operation}TiffType"/>
         <element name="jpeg" type="{http://schema.webpdf.de/1.0/operation}JpegType"/>
         <element name="gif" type="{http://schema.webpdf.de/1.0/operation}GifType"/>
         <element name="bmp" type="{http://schema.webpdf.de/1.0/operation}BmpType"/>
         <element name="svg" type="{http://schema.webpdf.de/1.0/operation}SvgType"/>
       </choice>
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="1" />
       <attribute name="fileNameTemplate" type="{http://www.w3.org/2001/XMLSchema}string" default="page[%d]" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • pages

        protected String pages
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number or page range (e.g., "1,5-6,9") that should be converted to an image file format. If only a single page is defined, the image file will be returned directly. If a range of pages is declared, then the call will return a ZIP file containing all the exported pages. The name of the individual image file (when multiple pages are exported) is defined with the "fileNameTemplate" attribute.
                                 The "tif" format is an exception when exporting multiple pages. When using this format, the "multipage" attribute can be used to define whether a multipage TIFF will be generated or whether the individual pages will be exported to a ZIP file (as with the other image file formats).
                             </p>

      • fileNameTemplate

        protected String fileNameTemplate
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">When exporting multiple pages, this parameter is used to define the file name that will be used for the generated image files in the ZIP file. The file name must include the string "%d". This string will be replaced with a consecutive number in the file name.</p>

    • Constructor Detail

      • ImageType

        public ImageType()

    • Method Detail

      • getPng

        public PngType getPng()
        Gets the value of the png property.
        Returns:
        possible object is PngType

      • setPng

        public void setPng​(PngType value)
        Sets the value of the png property.
        Parameters:
        value - allowed object is PngType

      • isSetPng

        public boolean isSetPng()

      • getTiff

        public TiffType getTiff()
        Gets the value of the tiff property.
        Returns:
        possible object is TiffType

      • setTiff

        public void setTiff​(TiffType value)
        Sets the value of the tiff property.
        Parameters:
        value - allowed object is TiffType

      • isSetTiff

        public boolean isSetTiff()

      • getJpeg

        public JpegType getJpeg()
        Gets the value of the jpeg property.
        Returns:
        possible object is JpegType

      • setJpeg

        public void setJpeg​(JpegType value)
        Sets the value of the jpeg property.
        Parameters:
        value - allowed object is JpegType

      • isSetJpeg

        public boolean isSetJpeg()

      • getGif

        public GifType getGif()
        Gets the value of the gif property.
        Returns:
        possible object is GifType

      • setGif

        public void setGif​(GifType value)
        Sets the value of the gif property.
        Parameters:
        value - allowed object is GifType

      • isSetGif

        public boolean isSetGif()

      • getBmp

        public BmpType getBmp()
        Gets the value of the bmp property.
        Returns:
        possible object is BmpType

      • setBmp

        public void setBmp​(BmpType value)
        Sets the value of the bmp property.
        Parameters:
        value - allowed object is BmpType

      • isSetBmp

        public boolean isSetBmp()

      • getSvg

        public SvgType getSvg()
        Gets the value of the svg property.
        Returns:
        possible object is SvgType

      • setSvg

        public void setSvg​(SvgType value)
        Sets the value of the svg property.
        Parameters:
        value - allowed object is SvgType

      • isSetSvg

        public boolean isSetSvg()

      • getPages

        public String getPages()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to define the page number or page range (e.g., "1,5-6,9") that should be converted to an image file format. If only a single page is defined, the image file will be returned directly. If a range of pages is declared, then the call will return a ZIP file containing all the exported pages. The name of the individual image file (when multiple pages are exported) is defined with the "fileNameTemplate" attribute.
                                 The "tif" format is an exception when exporting multiple pages. When using this format, the "multipage" attribute can be used to define whether a multipage TIFF will be generated or whether the individual pages will be exported to a ZIP file (as with the other image file formats).
                             </p>
        Returns:
        possible object is String

      • setPages

        public void setPages​(String value)
        Sets the value of the pages property.
        Parameters:
        value - allowed object is String
        See Also:
        getPages()

      • isSetPages

        public boolean isSetPages()

      • getFileNameTemplate

        public String getFileNameTemplate()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">When exporting multiple pages, this parameter is used to define the file name that will be used for the generated image files in the ZIP file. The file name must include the string "%d". This string will be replaced with a consecutive number in the file name.</p>
        Returns:
        possible object is String

      • setFileNameTemplate

        public void setFileNameTemplate​(String value)
        Sets the value of the fileNameTemplate property.
        Parameters:
        value - allowed object is String
        See Also:
        getFileNameTemplate()

      • isSetFileNameTemplate

        public boolean isSetFileNameTemplate()