Class OptionsType

  • All Implemented Interfaces:
    ParameterInterface

    public class OptionsType
    extends BaseToolboxType
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The options operation element can be used to change the way documents are displayed.
     
                     </p>
     
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Tip:</b>
                         For all hereby contained options, please consult the chapter "Display Options". This is especially important concerning the content format of headers and footers.
                     </p>
     

    Java class for OptionsType complex type

    .

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

    
     <complexType name="OptionsType">
       <complexContent>
         <extension base="{http://schema.webpdf.de/1.0/operation}BaseToolboxType">
           <all>
             <element name="pageTransitions" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice maxOccurs="unbounded">
                       <element name="add">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="pageTransition" type="{http://schema.webpdf.de/1.0/operation}TransitionType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="remove">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="transitionSelection" type="{http://schema.webpdf.de/1.0/operation}SelectionTransitionType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="background" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice>
                       <element name="add">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="colorBackground" type="{http://schema.webpdf.de/1.0/operation}ColorBackgroundType"/>
                                 <element name="imageBackground" type="{http://schema.webpdf.de/1.0/operation}ImageBackgroundType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="remove">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="backgroundSelection" type="{http://schema.webpdf.de/1.0/operation}SelectionBackgroundType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="headerFooter" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice>
                       <element name="add">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="headerFooterContent" type="{http://schema.webpdf.de/1.0/operation}HeaderFooterType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="remove">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="headerFooterSelection" type="{http://schema.webpdf.de/1.0/operation}SelectionHeaderFooterType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="boxes" minOccurs="0">
               <complexType>
                 <complexContent>
                   <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                     <choice maxOccurs="unbounded">
                       <element name="resize">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="boxesResize" type="{http://schema.webpdf.de/1.0/operation}BoxesResizeType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                       <element name="remove">
                         <complexType>
                           <complexContent>
                             <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                               <choice>
                                 <element name="boxesRemove" type="{http://schema.webpdf.de/1.0/operation}SelectionBoxType"/>
                               </choice>
                             </restriction>
                           </complexContent>
                         </complexType>
                       </element>
                     </choice>
                   </restriction>
                 </complexContent>
               </complexType>
             </element>
             <element name="viewerPreferences" type="{http://schema.webpdf.de/1.0/operation}ViewerPreferencesType" minOccurs="0"/>
           </all>
           <attribute name="pageLayout" type="{http://schema.webpdf.de/1.0/operation}PageLayoutType" default="singlePage" />
           <attribute name="initialView" type="{http://schema.webpdf.de/1.0/operation}InitialViewType" default="none" />
           <attribute name="magnification" type="{http://schema.webpdf.de/1.0/operation}MagnificationType" default="fitWidth" />
           <attribute name="magnificationZoom" default="100">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                 <minInclusive value="0"/>
                 <maxInclusive value="6400"/>
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="initialPage" default="1">
             <simpleType>
               <restriction base="{http://www.w3.org/2001/XMLSchema}int">
                 <minInclusive value="1"/>
               </restriction>
             </simpleType>
           </attribute>
           <attribute name="language" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
         </extension>
       </complexContent>
     </complexType>
     
    • Field Detail

      • pageTransitions

        protected OptionsType.PageTransitions pageTransitions
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to change the document's page transition animations. You can use multiple operations of this type in order to define various transitions for various page ranges in a single step.</p>
         
      • background

        protected OptionsType.Background background
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Adds a background layer to the document or removes it (the "add" and "remove" elements are mutually exclusive, i.e., you must select one or the other).</p>
         
      • headerFooter

        protected OptionsType.HeaderFooter headerFooter
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Adds a header and footer to the document or removes them (the "add" and "remove" elements are mutually exclusive, i.e., you must select one or the other).</p>
         
      • boxes

        protected OptionsType.Boxes boxes
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to modify the document's boxes.
         
                                         </p>
         
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Tip:</b>
                                             You can use multiple "resize" or "remove" operations in order to manipulate various boxes simultaneously in a single step.
                                         </p>
         
      • pageLayout

        protected PageLayoutType pageLayout
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the page layout when the PDF document is opened.
                                         <ul><li>singlePage = Individual pages</li><li>singlePageContinous = Continuous individual pages</li><li>twoPages = Page pairs</li><li>twoPagesContinous = Continuous page pairs</li></ul></p>
         
      • initialView

        protected InitialViewType initialView
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines which sub-windows will be opened when the PDF document is opened.
                                         <ul><li>none = No special view</li><li>outlines = Opens the "Bookmarks" tab</li><li>thumbnails = Opens the "Thumbnails" tab</li><li>fullscreen = Opens the document in full screen mode</li></ul></p>
         
      • magnification

        protected MagnificationType magnification
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the zoom settings according to a defined mode.
                                         <ul><li>none = Uses the application's default view</li><li>fitWidth = Page width</li><li>fitPage = Page dimensions</li><li>fitHeight = Page height</li><li>fitVisible = Page content width</li><li>fitActual = Uses the original page dimensions (100% zoom factor)</li><li>zoom = Sets an explicit magnification value</li></ul></p>
         
      • magnificationZoom

        protected Integer magnificationZoom
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 set the value for zooming.</p>
         
      • initialPage

        protected Integer initialPage
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the page that will be shown when the document is opened.</p>
         
      • language

        protected String language
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the language (and optionally the country) for the content of the document. The value is encoded as RFC 3066 (Tags for the Identification of Languages) and includes either the language only (e.g. "de") or the language and a country identifier (e.g. "de-DE").</p>
         
    • Constructor Detail

      • OptionsType

        public OptionsType()
    • Method Detail

      • getPageTransitions

        public OptionsType.PageTransitions getPageTransitions()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to change the document's page transition animations. You can use multiple operations of this type in order to define various transitions for various page ranges in a single step.</p>
         
        Returns:
        possible object is OptionsType.PageTransitions
      • isSetPageTransitions

        public boolean isSetPageTransitions()
      • getBackground

        public OptionsType.Background getBackground()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Adds a background layer to the document or removes it (the "add" and "remove" elements are mutually exclusive, i.e., you must select one or the other).</p>
         
        Returns:
        possible object is OptionsType.Background
      • isSetBackground

        public boolean isSetBackground()
      • getHeaderFooter

        public OptionsType.HeaderFooter getHeaderFooter()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Adds a header and footer to the document or removes them (the "add" and "remove" elements are mutually exclusive, i.e., you must select one or the other).</p>
         
        Returns:
        possible object is OptionsType.HeaderFooter
      • isSetHeaderFooter

        public boolean isSetHeaderFooter()
      • getBoxes

        public OptionsType.Boxes getBoxes()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to modify the document's boxes.
         
                                         </p>
         
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Tip:</b>
                                             You can use multiple "resize" or "remove" operations in order to manipulate various boxes simultaneously in a single step.
                                         </p>
         
        Returns:
        possible object is OptionsType.Boxes
      • isSetBoxes

        public boolean isSetBoxes()
      • isSetViewerPreferences

        public boolean isSetViewerPreferences()
      • getPageLayout

        public PageLayoutType getPageLayout()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the page layout when the PDF document is opened.
                                         <ul><li>singlePage = Individual pages</li><li>singlePageContinous = Continuous individual pages</li><li>twoPages = Page pairs</li><li>twoPagesContinous = Continuous page pairs</li></ul></p>
         
        Returns:
        possible object is PageLayoutType
      • isSetPageLayout

        public boolean isSetPageLayout()
      • getInitialView

        public InitialViewType getInitialView()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines which sub-windows will be opened when the PDF document is opened.
                                         <ul><li>none = No special view</li><li>outlines = Opens the "Bookmarks" tab</li><li>thumbnails = Opens the "Thumbnails" tab</li><li>fullscreen = Opens the document in full screen mode</li></ul></p>
         
        Returns:
        possible object is InitialViewType
      • isSetInitialView

        public boolean isSetInitialView()
      • getMagnification

        public MagnificationType getMagnification()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Sets the zoom settings according to a defined mode.
                                         <ul><li>none = Uses the application's default view</li><li>fitWidth = Page width</li><li>fitPage = Page dimensions</li><li>fitHeight = Page height</li><li>fitVisible = Page content width</li><li>fitActual = Uses the original page dimensions (100% zoom factor)</li><li>zoom = Sets an explicit magnification value</li></ul></p>
         
        Returns:
        possible object is MagnificationType
      • isSetMagnification

        public boolean isSetMagnification()
      • getMagnificationZoom

        public int getMagnificationZoom()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="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 set the value for zooming.</p>
         
        Returns:
        possible object is Integer
      • setMagnificationZoom

        public void setMagnificationZoom​(int value)
        Sets the value of the magnificationZoom property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getMagnificationZoom()
      • isSetMagnificationZoom

        public boolean isSetMagnificationZoom()
      • unsetMagnificationZoom

        public void unsetMagnificationZoom()
      • getInitialPage

        public int getInitialPage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Defines the page that will be shown when the document is opened.</p>
         
        Returns:
        possible object is Integer
      • setInitialPage

        public void setInitialPage​(int value)
        Sets the value of the initialPage property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getInitialPage()
      • isSetInitialPage

        public boolean isSetInitialPage()
      • unsetInitialPage

        public void unsetInitialPage()
      • getLanguage

        public String getLanguage()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p490833_="urn:jaxb.jvnet.org:plugin:simplify" xmlns:p603985_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p985611_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Specifies the language (and optionally the country) for the content of the document. The value is encoded as RFC 3066 (Tags for the Identification of Languages) and includes either the language only (e.g. "de") or the language and a country identifier (e.g. "de-DE").</p>
         
        Returns:
        possible object is String
      • setLanguage

        public void setLanguage​(String value)
        Sets the value of the language property.
        Parameters:
        value - allowed object is String
        See Also:
        getLanguage()
      • isSetLanguage

        public boolean isSetLanguage()