Package net.webpdf.parameter.schema.extraction.info

Class ViewerPreferencesType

  • public class ViewerPreferencesType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Lists a set of further settings and definitions, that a Reader may honor, when displaying the document.</p>

    Java class for ViewerPreferencesType complex type

    .

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

    
 <complexType name="ViewerPreferencesType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="hideToolbar" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="hideMenuBar" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="hideWindowUI" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="fitWindow" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="centerWindow" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="displayDocTitle" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="nonFullScreenPageMode" type="{http://schema.webpdf.de/1.0/extraction/info}NonFullScreenPageModeType" default="none" />
       <attribute name="textDirection" type="{http://schema.webpdf.de/1.0/extraction/info}TextDirectionType" default="leftToRight" />
       <attribute name="viewArea" type="{http://schema.webpdf.de/1.0/extraction/info}BoxSelectionType" default="cropBox" />
       <attribute name="viewClip" type="{http://schema.webpdf.de/1.0/extraction/info}BoxSelectionType" default="cropBox" />
       <attribute name="printArea" type="{http://schema.webpdf.de/1.0/extraction/info}BoxSelectionType" default="cropBox" />
       <attribute name="printClip" type="{http://schema.webpdf.de/1.0/extraction/info}BoxSelectionType" default="cropBox" />
       <attribute name="printScaling" type="{http://schema.webpdf.de/1.0/extraction/info}PrintScaleType" default="readerDefault" />
       <attribute name="duplex" type="{http://schema.webpdf.de/1.0/extraction/info}DuplexType" default="none" />
       <attribute name="printTraySelection" type="{http://schema.webpdf.de/1.0/extraction/info}PrintTraySelectionType" default="readerDefault" />
       <attribute name="printPageRange" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="numCopies" default="1">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • hideToolbar

        protected Boolean hideToolbar
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's toolbars shall be hidden, when opening the document.</p>

      • hideMenuBar

        protected Boolean hideMenuBar
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's menu bar shall be hidden, when opening the document.</p>

      • hideWindowUI

        protected Boolean hideWindowUI
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's navigation controls (such as scrollbars) shall be hidden, when opening the document.</p>

      • fitWindow

        protected Boolean fitWindow
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The dimensions of the Reader's window shall adapt to the first displayed page of the document.</p>

      • centerWindow

        protected Boolean centerWindow
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's window shall be positioned at the center of the screen, when opening the document.</p>

      • displayDocTitle

        protected Boolean displayDocTitle
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Instead of the file name the reader shall display the title of the document in it's title bar.</p>

      • nonFullScreenPageMode

        protected NonFullScreenPageModeType nonFullScreenPageMode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When displaying the document in windowed mode, the Reader shall show the selected panel.
                         <ul><li>none = No panel shall be opened.</li><li>outlines = The document's outlines shall be displayed.</li><li>thumbnails = The document's page thumbnails shall be shown.</li><li>optionalContents = document's layers (OCGs - Optional Content Groups) shall be displayed.</li></ul></p>

      • textDirection

        protected TextDirectionType textDirection
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the predominant document's text writing/reading direction.
                         <ul><li>leftToRight or</li><li>rightToLeft</li></ul></p>

      • viewArea

        protected BoxSelectionType viewArea
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the visible box, when displaying the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>

      • viewClip

        protected BoxSelectionType viewClip
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the box contents shall be cropped at, when displaying the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>

      • printArea

        protected BoxSelectionType printArea
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the visible box, when printing the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>

      • printClip

        protected BoxSelectionType printClip
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the box contents shall be cropped at, when printing the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>

      • printScaling

        protected PrintScaleType printScaling
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The print scaling initially suggested when opening the Reader's print dialog.
                         <ul><li>readerDefault = The Reader shall use it's default suggestion.</li><li>byPDFSize = The Reader shall suggest to not scale the document during printing.</li></ul></p>

      • duplex

        protected DuplexType duplex
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The duplex settings initially suggested when opening the Reader's print dialog.
                         <ul><li>none = The Reader shall use it's default suggestion.</li><li>simplex = The Reader shall suggest simplex printing.</li><li>duplexFlipShortEdge = The Reader shall suggest duplex printing, flipping pages over the shorter edge.</li><li>duplexFlipLongEdge = The Reader shall suggest duplex printing, flipping pages over the longer edge.</li></ul></p>

      • printTraySelection

        protected PrintTraySelectionType printTraySelection
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The print tray selection initially suggested when opening the Reader's print dialog.
                         <ul><li>readerDefault = The Reader shall use it's default suggestion.</li><li>byPDFSize = The Reader shall select a print tray, that matches the PDF's page dimensions.</li></ul></p>

      • printPageRange

        protected String printPageRange
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the page range, that shall initially be suggested for printing, when opening the Reader's print dialog.
 
                         The page number can be an individual page, a page range, or a list (separated with commas) (e.g., "1,5-6,9"). To specify "all pages," use an asterisk ("*").
                     </p>

      • numCopies

        protected Integer numCopies
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of copies initially suggested, when opening the Reader's print dialog.</p>

    • Constructor Detail

      • ViewerPreferencesType

        public ViewerPreferencesType()

    • Method Detail

      • isHideToolbar

        public boolean isHideToolbar()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's toolbars shall be hidden, when opening the document.</p>
        Returns:
        possible object is Boolean

      • setHideToolbar

        public void setHideToolbar​(Boolean value)
        Sets the value of the hideToolbar property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHideToolbar()

      • isHideMenuBar

        public boolean isHideMenuBar()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's menu bar shall be hidden, when opening the document.</p>
        Returns:
        possible object is Boolean

      • setHideMenuBar

        public void setHideMenuBar​(Boolean value)
        Sets the value of the hideMenuBar property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHideMenuBar()

      • isHideWindowUI

        public boolean isHideWindowUI()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's navigation controls (such as scrollbars) shall be hidden, when opening the document.</p>
        Returns:
        possible object is Boolean

      • setHideWindowUI

        public void setHideWindowUI​(Boolean value)
        Sets the value of the hideWindowUI property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isHideWindowUI()

      • isFitWindow

        public boolean isFitWindow()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The dimensions of the Reader's window shall adapt to the first displayed page of the document.</p>
        Returns:
        possible object is Boolean

      • setFitWindow

        public void setFitWindow​(Boolean value)
        Sets the value of the fitWindow property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isFitWindow()

      • isCenterWindow

        public boolean isCenterWindow()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The Reader's window shall be positioned at the center of the screen, when opening the document.</p>
        Returns:
        possible object is Boolean

      • setCenterWindow

        public void setCenterWindow​(Boolean value)
        Sets the value of the centerWindow property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isCenterWindow()

      • isDisplayDocTitle

        public boolean isDisplayDocTitle()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Instead of the file name the reader shall display the title of the document in it's title bar.</p>
        Returns:
        possible object is Boolean

      • setDisplayDocTitle

        public void setDisplayDocTitle​(Boolean value)
        Sets the value of the displayDocTitle property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isDisplayDocTitle()

      • getNonFullScreenPageMode

        public NonFullScreenPageModeType getNonFullScreenPageMode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">When displaying the document in windowed mode, the Reader shall show the selected panel.
                         <ul><li>none = No panel shall be opened.</li><li>outlines = The document's outlines shall be displayed.</li><li>thumbnails = The document's page thumbnails shall be shown.</li><li>optionalContents = document's layers (OCGs - Optional Content Groups) shall be displayed.</li></ul></p>
        Returns:
        possible object is NonFullScreenPageModeType

      • getTextDirection

        public TextDirectionType getTextDirection()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the predominant document's text writing/reading direction.
                         <ul><li>leftToRight or</li><li>rightToLeft</li></ul></p>
        Returns:
        possible object is TextDirectionType

      • getViewArea

        public BoxSelectionType getViewArea()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the visible box, when displaying the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>
        Returns:
        possible object is BoxSelectionType

      • getViewClip

        public BoxSelectionType getViewClip()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the box contents shall be cropped at, when displaying the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>
        Returns:
        possible object is BoxSelectionType

      • getPrintArea

        public BoxSelectionType getPrintArea()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the visible box, when printing the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>
        Returns:
        possible object is BoxSelectionType

      • getPrintClip

        public BoxSelectionType getPrintClip()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the box contents shall be cropped at, when printing the document.
                         <ul><li>media_box = The page's physical dimensions.</li><li>crop_box = The visible (printable) page area.</li><li>bleed_box = Untrimmed content position on the page (content dimensions plus trim box).</li><li>trim_box = Trimmed content position on the page (final content dimensions).</li><li>art_box = Position for special page content (images).</li></ul></p>
        Returns:
        possible object is BoxSelectionType

      • getPrintScaling

        public PrintScaleType getPrintScaling()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The print scaling initially suggested when opening the Reader's print dialog.
                         <ul><li>readerDefault = The Reader shall use it's default suggestion.</li><li>byPDFSize = The Reader shall suggest to not scale the document during printing.</li></ul></p>
        Returns:
        possible object is PrintScaleType

      • getDuplex

        public DuplexType getDuplex()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The duplex settings initially suggested when opening the Reader's print dialog.
                         <ul><li>none = The Reader shall use it's default suggestion.</li><li>simplex = The Reader shall suggest simplex printing.</li><li>duplexFlipShortEdge = The Reader shall suggest duplex printing, flipping pages over the shorter edge.</li><li>duplexFlipLongEdge = The Reader shall suggest duplex printing, flipping pages over the longer edge.</li></ul></p>
        Returns:
        possible object is DuplexType

      • setDuplex

        public void setDuplex​(DuplexType value)
        Sets the value of the duplex property.
        Parameters:
        value - allowed object is DuplexType
        See Also:
        getDuplex()

      • getPrintTraySelection

        public PrintTraySelectionType getPrintTraySelection()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The print tray selection initially suggested when opening the Reader's print dialog.
                         <ul><li>readerDefault = The Reader shall use it's default suggestion.</li><li>byPDFSize = The Reader shall select a print tray, that matches the PDF's page dimensions.</li></ul></p>
        Returns:
        possible object is PrintTraySelectionType

      • getPrintPageRange

        public String getPrintPageRange()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">Selects the page range, that shall initially be suggested for printing, when opening the Reader's print dialog.
 
                         The page number can be an individual page, a page range, or a list (separated with commas) (e.g., "1,5-6,9"). To specify "all pages," use an asterisk ("*").
                     </p>
        Returns:
        possible object is String

      • setPrintPageRange

        public void setPrintPageRange​(String value)
        Sets the value of the printPageRange property.
        Parameters:
        value - allowed object is String
        See Also:
        getPrintPageRange()

      • getNumCopies

        public int getNumCopies()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The number of copies initially suggested, when opening the Reader's print dialog.</p>
        Returns:
        possible object is Integer

      • setNumCopies

        public void setNumCopies​(Integer value)
        Sets the value of the numCopies property.
        Parameters:
        value - allowed object is Integer
        See Also:
        getNumCopies()