Package net.webpdf.wsclient.schema.operation

Class SplitType

  • All Implemented Interfaces:
    ParameterInterface
    public class SplitType
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 split operation element can be used to split documents.
 
                 </p>
 
     <?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"><b>Important:</b>
                     Acroforms are correctly split, but contained XFA data are removed.
                 </p>

    Java class for SplitType complex type

    .

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

    
 <complexType name="SplitType">
   <complexContent>
     <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
       <attribute name="mode" type="{http://schema.webpdf.de/1.0/operation}SplitModeType" default="last" />
       <attribute name="pages" type="{http://www.w3.org/2001/XMLSchema}string" default="1" />
       <attribute name="startPage" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="fileNameTemplate" type="{http://www.w3.org/2001/XMLSchema}string" default="page[%d]" />
       <attribute name="singleFileAsZip" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • mode

        protected SplitModeType mode
         <?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">Defines the mode used to split the PDF document.
                                 <ul><li>last = Last page - Uses "pages" to define the last page that will be contained in the new PDF document.</li><li>first = First page - Uses "pages" to define the first page that will be contained in the new PDF document.</li><li>list = List of pages - Uses "pages" to define a list of pages that should be extracted from the document. A single PDF document will be created on the basis of this list.</li><li>single = Selected pages - Uses the "pages" attribute to define a list of pages that should be extracted from the document. And creates a ZIP file with the corresponding pages.</li><li>each = Every nth page - Uses the "pages" attribute to define the interval at which pages should be extracted. The "startPage" attribute is used to define the page on which the process will start. The result will be a ZIP file.</li><li>group = Group pages - Multiple pages will be added to a single PDF document. The "pages" attribute can be used to define how many pages will be saved in a single PDF document. The "startPage" attribute is used to define the page on which the process will start. The result will be a ZIP file.</li><li>burst = Ungroup pages - A new PDF document will be generated from each page. The result will be a ZIP file.</li></ul></p>

      • 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">Defines which page(s) should be used for the split operation. The page number can be an individual page, a page range, or a list (separated with commas) (e.g. "1,5-6,9"). The "mode" attribute defines whether a single page or a range of pages can be used: With "last" and "first," an individual page is specified; with "list," a list of pages can be used.</p>

      • startPage

        protected Integer startPage
         <?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 for "each" and "group" in the "mode" attribute.</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">If the "split" operation generates a ZIP document (please refer to "mode"), this template can be used to define the file name of the PDF document in the ZIP document. The "%d" placeholder must be used in the template in order to define the PDF document page.</p>

      • singleFileAsZip

        protected Boolean singleFileAsZip
         <?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">Only mode with "single", "burst", "each", or "group".
                                 The returned pages will be generated as a ZIP file even if selection is used to select only one single file. You can change this behaviour by setting this option to "false". In this case, the page will not be zipped, and will instead be returned directly as is. However, this will only work if selection has been used to select one page and one page only.
                             </p>

    • Constructor Detail

      • SplitType

        public SplitType()

    • Method Detail

      • getMode

        public SplitModeType getMode()
         <?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">Defines the mode used to split the PDF document.
                                 <ul><li>last = Last page - Uses "pages" to define the last page that will be contained in the new PDF document.</li><li>first = First page - Uses "pages" to define the first page that will be contained in the new PDF document.</li><li>list = List of pages - Uses "pages" to define a list of pages that should be extracted from the document. A single PDF document will be created on the basis of this list.</li><li>single = Selected pages - Uses the "pages" attribute to define a list of pages that should be extracted from the document. And creates a ZIP file with the corresponding pages.</li><li>each = Every nth page - Uses the "pages" attribute to define the interval at which pages should be extracted. The "startPage" attribute is used to define the page on which the process will start. The result will be a ZIP file.</li><li>group = Group pages - Multiple pages will be added to a single PDF document. The "pages" attribute can be used to define how many pages will be saved in a single PDF document. The "startPage" attribute is used to define the page on which the process will start. The result will be a ZIP file.</li><li>burst = Ungroup pages - A new PDF document will be generated from each page. The result will be a ZIP file.</li></ul></p>
        Returns:
        possible object is SplitModeType

      • isSetMode

        public boolean isSetMode()

      • 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">Defines which page(s) should be used for the split operation. The page number can be an individual page, a page range, or a list (separated with commas) (e.g. "1,5-6,9"). The "mode" attribute defines whether a single page or a range of pages can be used: With "last" and "first," an individual page is specified; with "list," a list of pages can be used.</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()

      • getStartPage

        public int getStartPage()
         <?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 for "each" and "group" in the "mode" attribute.</p>
        Returns:
        possible object is Integer

      • setStartPage

        public void setStartPage​(int value)
        Sets the value of the startPage property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getStartPage()

      • isSetStartPage

        public boolean isSetStartPage()

      • unsetStartPage

        public void unsetStartPage()

      • 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">If the "split" operation generates a ZIP document (please refer to "mode"), this template can be used to define the file name of the PDF document in the ZIP document. The "%d" placeholder must be used in the template in order to define the PDF document page.</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()

      • isSingleFileAsZip

        public boolean isSingleFileAsZip()
         <?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">Only mode with "single", "burst", "each", or "group".
                                 The returned pages will be generated as a ZIP file even if selection is used to select only one single file. You can change this behaviour by setting this option to "false". In this case, the page will not be zipped, and will instead be returned directly as is. However, this will only work if selection has been used to select one page and one page only.
                             </p>
        Returns:
        possible object is Boolean

      • setSingleFileAsZip

        public void setSingleFileAsZip​(boolean value)
        Sets the value of the singleFileAsZip property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isSingleFileAsZip()

      • isSetSingleFileAsZip

        public boolean isSetSingleFileAsZip()

      • unsetSingleFileAsZip

        public void unsetSingleFileAsZip()