java.lang.Object
- net.webpdf.wsclient.schema.operation.BaseToolboxType
- - net.webpdf.wsclient.schema.operation.OptionsType

All Implemented Interfaces:: ParameterInterface

public class OptionsType
extends BaseToolboxType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns:p179664_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p388603_="https://jakarta.ee/xml/ns/jaxb" xmlns:p96940_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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:p179664_="http://jaxb2-commons.dev.java.net/basic/simplify" xmlns:p388603_="https://jakarta.ee/xml/ns/jaxb" xmlns:p96940_="http://jaxb2-commons.dev.java.net/basic/inheritance" 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>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OptionsType.Background`	Java class for anonymous complex type.
`static class`	`OptionsType.Boxes`	Java class for anonymous complex type.
`static class`	`OptionsType.HeaderFooter`	Java class for anonymous complex type.
`static class`	`OptionsType.PageTransitions`	Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field	Description
`protected OptionsType.Background`	`background`
`protected OptionsType.Boxes`	`boxes`
`protected OptionsType.HeaderFooter`	`headerFooter`
`protected Integer`	`initialPage`
`protected InitialViewType`	`initialView`
`protected String`	`language`
`protected MagnificationType`	`magnification`
`protected Integer`	`magnificationZoom`
`protected PageLayoutType`	`pageLayout`
`protected OptionsType.PageTransitions`	`pageTransitions`
`protected ViewerPreferencesType`	`viewerPreferences`

Constructor Summary

Constructors
Constructor Description

OptionsType()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OptionsType.Background`	`getBackground()`	Gets the value of the background property.
`OptionsType.Boxes`	`getBoxes()`	Gets the value of the boxes property.
`OptionsType.HeaderFooter`	`getHeaderFooter()`	Gets the value of the headerFooter property.
`int`	`getInitialPage()`	Gets the value of the initialPage property.
`InitialViewType`	`getInitialView()`	Gets the value of the initialView property.
`String`	`getLanguage()`	Gets the value of the language property.
`MagnificationType`	`getMagnification()`	Gets the value of the magnification property.
`int`	`getMagnificationZoom()`	Gets the value of the magnificationZoom property.
`PageLayoutType`	`getPageLayout()`	Gets the value of the pageLayout property.
`OptionsType.PageTransitions`	`getPageTransitions()`	Gets the value of the pageTransitions property.
`ViewerPreferencesType`	`getViewerPreferences()`	Gets the value of the viewerPreferences property.
`boolean`	`isSetBackground()`
`boolean`	`isSetBoxes()`
`boolean`	`isSetHeaderFooter()`
`boolean`	`isSetInitialPage()`
`boolean`	`isSetInitialView()`
`boolean`	`isSetLanguage()`
`boolean`	`isSetMagnification()`
`boolean`	`isSetMagnificationZoom()`
`boolean`	`isSetPageLayout()`
`boolean`	`isSetPageTransitions()`
`boolean`	`isSetViewerPreferences()`
`void`	`setBackground(OptionsType.Background value)`	Sets the value of the background property.
`void`	`setBoxes(OptionsType.Boxes value)`	Sets the value of the boxes property.
`void`	`setHeaderFooter(OptionsType.HeaderFooter value)`	Sets the value of the headerFooter property.
`void`	`setInitialPage(int value)`	Sets the value of the initialPage property.
`void`	`setInitialView(InitialViewType value)`	Sets the value of the initialView property.
`void`	`setLanguage(String value)`	Sets the value of the language property.
`void`	`setMagnification(MagnificationType value)`	Sets the value of the magnification property.
`void`	`setMagnificationZoom(int value)`	Sets the value of the magnificationZoom property.
`void`	`setPageLayout(PageLayoutType value)`	Sets the value of the pageLayout property.
`void`	`setPageTransitions(OptionsType.PageTransitions value)`	Sets the value of the pageTransitions property.
`void`	`setViewerPreferences(ViewerPreferencesType value)`	Sets the value of the viewerPreferences property.
`void`	`unsetInitialPage()`
`void`	`unsetMagnificationZoom()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pageTransitions
```
protected OptionsType.PageTransitions pageTransitions
```
  - background
```
protected OptionsType.Background background
```
  - headerFooter
```
protected OptionsType.HeaderFooter headerFooter
```
  - boxes
```
protected OptionsType.Boxes boxes
```
  - viewerPreferences
```
protected ViewerPreferencesType viewerPreferences
```
  - pageLayout
```
protected PageLayoutType pageLayout
```
  - initialView
```
protected InitialViewType initialView
```
  - magnification
```
protected MagnificationType magnification
```
  - magnificationZoom
```
protected Integer magnificationZoom
```
  - initialPage
```
protected Integer initialPage
```
  - language
```
protected String language
```
- Constructor Detail
  - OptionsType
```
public OptionsType()
```
- Method Detail
  - getPageTransitions
```
public OptionsType.PageTransitions getPageTransitions()
```
    Gets the value of the pageTransitions property.
    
    Returns:
    
    possible object is OptionsType.PageTransitions
  - setPageTransitions
```
public void setPageTransitions(OptionsType.PageTransitions value)
```
    Sets the value of the pageTransitions property.
    
    Parameters:
    
    value - allowed object is OptionsType.PageTransitions
  - isSetPageTransitions
```
public boolean isSetPageTransitions()
```
  - getBackground
```
public OptionsType.Background getBackground()
```
    Gets the value of the background property.
    
    Returns:
    
    possible object is OptionsType.Background
  - setBackground
```
public void setBackground(OptionsType.Background value)
```
    Sets the value of the background property.
    
    Parameters:
    
    value - allowed object is OptionsType.Background
  - isSetBackground
```
public boolean isSetBackground()
```
  - getHeaderFooter
```
public OptionsType.HeaderFooter getHeaderFooter()
```
    Gets the value of the headerFooter property.
    
    Returns:
    
    possible object is OptionsType.HeaderFooter
  - setHeaderFooter
```
public void setHeaderFooter(OptionsType.HeaderFooter value)
```
    Sets the value of the headerFooter property.
    
    Parameters:
    
    value - allowed object is OptionsType.HeaderFooter
  - isSetHeaderFooter
```
public boolean isSetHeaderFooter()
```
  - getBoxes
```
public OptionsType.Boxes getBoxes()
```
    Gets the value of the boxes property.
    
    Returns:
    
    possible object is OptionsType.Boxes
  - setBoxes
```
public void setBoxes(OptionsType.Boxes value)
```
    Sets the value of the boxes property.
    
    Parameters:
    
    value - allowed object is OptionsType.Boxes
  - isSetBoxes
```
public boolean isSetBoxes()
```
  - getViewerPreferences
```
public ViewerPreferencesType getViewerPreferences()
```
    Gets the value of the viewerPreferences property.
    
    Returns:
    
    possible object is ViewerPreferencesType
  - setViewerPreferences
```
public void setViewerPreferences(ViewerPreferencesType value)
```
    Sets the value of the viewerPreferences property.
    
    Parameters:
    
    value - allowed object is ViewerPreferencesType
  - isSetViewerPreferences
```
public boolean isSetViewerPreferences()
```
  - getPageLayout
```
public PageLayoutType getPageLayout()
```
    Gets the value of the pageLayout property.
    
    Returns:
    
    possible object is PageLayoutType
  - setPageLayout
```
public void setPageLayout(PageLayoutType value)
```
    Sets the value of the pageLayout property.
    
    Parameters:
    
    value - allowed object is PageLayoutType
  - isSetPageLayout
```
public boolean isSetPageLayout()
```
  - getInitialView
```
public InitialViewType getInitialView()
```
    Gets the value of the initialView property.
    
    Returns:
    
    possible object is InitialViewType
  - setInitialView
```
public void setInitialView(InitialViewType value)
```
    Sets the value of the initialView property.
    
    Parameters:
    
    value - allowed object is InitialViewType
  - isSetInitialView
```
public boolean isSetInitialView()
```
  - getMagnification
```
public MagnificationType getMagnification()
```
    Gets the value of the magnification property.
    
    Returns:
    
    possible object is MagnificationType
  - setMagnification
```
public void setMagnification(MagnificationType value)
```
    Sets the value of the magnification property.
    
    Parameters:
    
    value - allowed object is MagnificationType
  - isSetMagnification
```
public boolean isSetMagnification()
```
  - getMagnificationZoom
```
public int getMagnificationZoom()
```
    Gets the value of the magnificationZoom property.
    
    Returns:
    
    possible object is Integer
  - setMagnificationZoom
```
public void setMagnificationZoom(int value)
```
    Sets the value of the magnificationZoom property.
    
    Parameters:
    
    value - allowed object is Integer
  - isSetMagnificationZoom
```
public boolean isSetMagnificationZoom()
```
  - unsetMagnificationZoom
```
public void unsetMagnificationZoom()
```
  - getInitialPage
```
public int getInitialPage()
```
    Gets the value of the initialPage property.
    
    Returns:
    
    possible object is Integer
  - setInitialPage
```
public void setInitialPage(int value)
```
    Sets the value of the initialPage property.
    
    Parameters:
    
    value - allowed object is Integer
  - isSetInitialPage
```
public boolean isSetInitialPage()
```
  - unsetInitialPage
```
public void unsetInitialPage()
```
  - getLanguage
```
public String getLanguage()
```
    Gets the value of the language property.
    
    Returns:
    
    possible object is String
  - setLanguage
```
public void setLanguage(String value)
```
    Sets the value of the language property.
    
    Parameters:
    
    value - allowed object is String
  - isSetLanguage
```
public boolean isSetLanguage()
```

Class OptionsType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pageTransitions

background

headerFooter

boxes

viewerPreferences

pageLayout

initialView

magnification

magnificationZoom

initialPage

language

Constructor Detail

OptionsType

Method Detail

getPageTransitions

setPageTransitions

isSetPageTransitions

getBackground

setBackground

isSetBackground

getHeaderFooter

setHeaderFooter

isSetHeaderFooter

getBoxes

setBoxes

isSetBoxes

getViewerPreferences

setViewerPreferences

isSetViewerPreferences

getPageLayout

setPageLayout

isSetPageLayout

getInitialView

setInitialView

isSetInitialView

getMagnification

setMagnification

isSetMagnification

getMagnificationZoom

setMagnificationZoom

isSetMagnificationZoom

unsetMagnificationZoom

getInitialPage

setInitialPage

isSetInitialPage

unsetInitialPage

getLanguage

setLanguage

isSetLanguage