java.lang.Object
- net.webpdf.wsclient.openapi.MetadataViewerPreferences

```
public class MetadataViewerPreferences
extends Object
```
Lists a set of further settings and definitions, that a Reader may honor, when displaying the document.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MetadataViewerPreferences.DuplexEnum`	The duplex settings initially suggested when opening the Reader's print dialog
`static class`	`MetadataViewerPreferences.NonFullScreenPageModeEnum`	When displaying a document in windowed mode, the Reader shall show the selected panel
`static class`	`MetadataViewerPreferences.PrintAreaEnum`	Selects the visible box, when displaying the document
`static class`	`MetadataViewerPreferences.PrintClipEnum`	Selects the visible box, when displaying the document
`static class`	`MetadataViewerPreferences.PrintScalingEnum`	The print scaling initially suggested when opening the Reader's print dialog
`static class`	`MetadataViewerPreferences.PrintTraySelectionEnum`	The print tray selection initially suggested when opening the Reader's print dialog
`static class`	`MetadataViewerPreferences.TextDirectionEnum`	Selects the predominant document's text writing/reading direction
`static class`	`MetadataViewerPreferences.ViewAreaEnum`	Selects the visible box, when displaying the document
`static class`	`MetadataViewerPreferences.ViewClipEnum`	Selects the visible box, when displaying the document

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_CENTER_WINDOW`
`static String`	`JSON_PROPERTY_DISPLAY_DOC_TITLE`
`static String`	`JSON_PROPERTY_DUPLEX`
`static String`	`JSON_PROPERTY_FIT_WINDOW`
`static String`	`JSON_PROPERTY_HIDE_MENU_BAR`
`static String`	`JSON_PROPERTY_HIDE_TOOLBAR`
`static String`	`JSON_PROPERTY_HIDE_WINDOW_U_I`
`static String`	`JSON_PROPERTY_NON_FULL_SCREEN_PAGE_MODE`
`static String`	`JSON_PROPERTY_NUM_COPIES`
`static String`	`JSON_PROPERTY_PRINT_AREA`
`static String`	`JSON_PROPERTY_PRINT_CLIP`
`static String`	`JSON_PROPERTY_PRINT_PAGE_RANGE`
`static String`	`JSON_PROPERTY_PRINT_SCALING`
`static String`	`JSON_PROPERTY_PRINT_TRAY_SELECTION`
`static String`	`JSON_PROPERTY_TEXT_DIRECTION`
`static String`	`JSON_PROPERTY_VIEW_AREA`
`static String`	`JSON_PROPERTY_VIEW_CLIP`

Constructor Summary

Constructors
Constructor Description

MetadataViewerPreferences()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MetadataViewerPreferences`	`centerWindow(Boolean centerWindow)`
`MetadataViewerPreferences`	`displayDocTitle(Boolean displayDocTitle)`
`MetadataViewerPreferences`	`duplex(MetadataViewerPreferences.DuplexEnum duplex)`
`boolean`	`equals(Object o)`
`MetadataViewerPreferences`	`fitWindow(Boolean fitWindow)`
`@Nullable Boolean`	`getCenterWindow()`	The Reader's window shall be positioned at the center of the screen, when opening the document.
`@Nullable Boolean`	`getDisplayDocTitle()`	Instead of the file name the reader shall display the title of the document in it's title bar.
`@Nullable MetadataViewerPreferences.DuplexEnum`	`getDuplex()`	The duplex settings initially suggested when opening the Reader's print dialog
`@Nullable Boolean`	`getFitWindow()`	The dimensions of the Reader's window shall adapt to the first displayed page of the document.
`@Nullable Boolean`	`getHideMenuBar()`	The Reader's menu bar shall be hidden, when opening the document.
`@Nullable Boolean`	`getHideToolbar()`	The Reader's toolbars shall be hidden, when opening the document.
`@Nullable Boolean`	`getHideWindowUI()`	The Reader's navigation controls (such as scrollbars) shall be hidden, when opening the document.
`@Nullable MetadataViewerPreferences.NonFullScreenPageModeEnum`	`getNonFullScreenPageMode()`	When displaying a document in windowed mode, the Reader shall show the selected panel
`@Nullable Integer`	`getNumCopies()`	The number of copies initially suggested, when opening the Reader's print dialog.
`@Nullable MetadataViewerPreferences.PrintAreaEnum`	`getPrintArea()`	Selects the visible box, when displaying the document
`@Nullable MetadataViewerPreferences.PrintClipEnum`	`getPrintClip()`	Selects the visible box, when displaying the document
`@Nullable String`	`getPrintPageRange()`	Selects the page range, that shall initially be suggested for printing, when opening the Reader's print dialog.
`@Nullable MetadataViewerPreferences.PrintScalingEnum`	`getPrintScaling()`	The print scaling initially suggested when opening the Reader's print dialog
`@Nullable MetadataViewerPreferences.PrintTraySelectionEnum`	`getPrintTraySelection()`	The print tray selection initially suggested when opening the Reader's print dialog
`@Nullable MetadataViewerPreferences.TextDirectionEnum`	`getTextDirection()`	Selects the predominant document's text writing/reading direction
`@Nullable MetadataViewerPreferences.ViewAreaEnum`	`getViewArea()`	Selects the visible box, when displaying the document
`@Nullable MetadataViewerPreferences.ViewClipEnum`	`getViewClip()`	Selects the visible box, when displaying the document
`int`	`hashCode()`
`MetadataViewerPreferences`	`hideMenuBar(Boolean hideMenuBar)`
`MetadataViewerPreferences`	`hideToolbar(Boolean hideToolbar)`
`MetadataViewerPreferences`	`hideWindowUI(Boolean hideWindowUI)`
`MetadataViewerPreferences`	`nonFullScreenPageMode(MetadataViewerPreferences.NonFullScreenPageModeEnum nonFullScreenPageMode)`
`MetadataViewerPreferences`	`numCopies(Integer numCopies)`
`MetadataViewerPreferences`	`printArea(MetadataViewerPreferences.PrintAreaEnum printArea)`
`MetadataViewerPreferences`	`printClip(MetadataViewerPreferences.PrintClipEnum printClip)`
`MetadataViewerPreferences`	`printPageRange(String printPageRange)`
`MetadataViewerPreferences`	`printScaling(MetadataViewerPreferences.PrintScalingEnum printScaling)`
`MetadataViewerPreferences`	`printTraySelection(MetadataViewerPreferences.PrintTraySelectionEnum printTraySelection)`
`void`	`setCenterWindow(Boolean centerWindow)`
`void`	`setDisplayDocTitle(Boolean displayDocTitle)`
`void`	`setDuplex(MetadataViewerPreferences.DuplexEnum duplex)`
`void`	`setFitWindow(Boolean fitWindow)`
`void`	`setHideMenuBar(Boolean hideMenuBar)`
`void`	`setHideToolbar(Boolean hideToolbar)`
`void`	`setHideWindowUI(Boolean hideWindowUI)`
`void`	`setNonFullScreenPageMode(MetadataViewerPreferences.NonFullScreenPageModeEnum nonFullScreenPageMode)`
`void`	`setNumCopies(Integer numCopies)`
`void`	`setPrintArea(MetadataViewerPreferences.PrintAreaEnum printArea)`
`void`	`setPrintClip(MetadataViewerPreferences.PrintClipEnum printClip)`
`void`	`setPrintPageRange(String printPageRange)`
`void`	`setPrintScaling(MetadataViewerPreferences.PrintScalingEnum printScaling)`
`void`	`setPrintTraySelection(MetadataViewerPreferences.PrintTraySelectionEnum printTraySelection)`
`void`	`setTextDirection(MetadataViewerPreferences.TextDirectionEnum textDirection)`
`void`	`setViewArea(MetadataViewerPreferences.ViewAreaEnum viewArea)`
`void`	`setViewClip(MetadataViewerPreferences.ViewClipEnum viewClip)`
`MetadataViewerPreferences`	`textDirection(MetadataViewerPreferences.TextDirectionEnum textDirection)`
`String`	`toString()`
`MetadataViewerPreferences`	`viewArea(MetadataViewerPreferences.ViewAreaEnum viewArea)`
`MetadataViewerPreferences`	`viewClip(MetadataViewerPreferences.ViewClipEnum viewClip)`

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

- Field Detail
  - JSON_PROPERTY_CENTER_WINDOW
```
public static final String JSON_PROPERTY_CENTER_WINDOW
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DISPLAY_DOC_TITLE
```
public static final String JSON_PROPERTY_DISPLAY_DOC_TITLE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DUPLEX
```
public static final String JSON_PROPERTY_DUPLEX
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FIT_WINDOW
```
public static final String JSON_PROPERTY_FIT_WINDOW
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HIDE_MENU_BAR
```
public static final String JSON_PROPERTY_HIDE_MENU_BAR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HIDE_TOOLBAR
```
public static final String JSON_PROPERTY_HIDE_TOOLBAR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HIDE_WINDOW_U_I
```
public static final String JSON_PROPERTY_HIDE_WINDOW_U_I
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NON_FULL_SCREEN_PAGE_MODE
```
public static final String JSON_PROPERTY_NON_FULL_SCREEN_PAGE_MODE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NUM_COPIES
```
public static final String JSON_PROPERTY_NUM_COPIES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINT_AREA
```
public static final String JSON_PROPERTY_PRINT_AREA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINT_CLIP
```
public static final String JSON_PROPERTY_PRINT_CLIP
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINT_PAGE_RANGE
```
public static final String JSON_PROPERTY_PRINT_PAGE_RANGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINT_SCALING
```
public static final String JSON_PROPERTY_PRINT_SCALING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PRINT_TRAY_SELECTION
```
public static final String JSON_PROPERTY_PRINT_TRAY_SELECTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TEXT_DIRECTION
```
public static final String JSON_PROPERTY_TEXT_DIRECTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VIEW_AREA
```
public static final String JSON_PROPERTY_VIEW_AREA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VIEW_CLIP
```
public static final String JSON_PROPERTY_VIEW_CLIP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataViewerPreferences
```
public MetadataViewerPreferences()
```
- Method Detail
  - centerWindow
```
public MetadataViewerPreferences centerWindow(Boolean centerWindow)
```
  - getCenterWindow
```
@Nullable
public @Nullable Boolean getCenterWindow()
```
    The Reader's window shall be positioned at the center of the screen, when opening the document.
    
    Returns:
    
    centerWindow
  - setCenterWindow
```
public void setCenterWindow(Boolean centerWindow)
```
  - displayDocTitle
```
public MetadataViewerPreferences displayDocTitle(Boolean displayDocTitle)
```
  - getDisplayDocTitle
```
@Nullable
public @Nullable Boolean getDisplayDocTitle()
```
    Instead of the file name the reader shall display the title of the document in it's title bar.
    
    Returns:
    
    displayDocTitle
  - setDisplayDocTitle
```
public void setDisplayDocTitle(Boolean displayDocTitle)
```
  - duplex
```
public MetadataViewerPreferences duplex(MetadataViewerPreferences.DuplexEnum duplex)
```
  - getDuplex
```
@Nullable
public @Nullable MetadataViewerPreferences.DuplexEnum getDuplex()
```
    The duplex settings initially suggested when opening the Reader's print dialog. * none = The Reader shall use it's default suggestion. * simplex = The Reader shall suggest simplex printing. * duplexFlipShortEdge = The Reader shall suggest duplex printing, flipping pages over the shorter edge. * duplexFlipLongEdge = The Reader shall suggest duplex printing, flipping pages over the longer edge.
    
    Returns:
    
    duplex
  - setDuplex
```
public void setDuplex(MetadataViewerPreferences.DuplexEnum duplex)
```
  - fitWindow
```
public MetadataViewerPreferences fitWindow(Boolean fitWindow)
```
  - getFitWindow
```
@Nullable
public @Nullable Boolean getFitWindow()
```
    The dimensions of the Reader's window shall adapt to the first displayed page of the document.
    
    Returns:
    
    fitWindow
  - setFitWindow
```
public void setFitWindow(Boolean fitWindow)
```
  - hideMenuBar
```
public MetadataViewerPreferences hideMenuBar(Boolean hideMenuBar)
```
  - getHideMenuBar
```
@Nullable
public @Nullable Boolean getHideMenuBar()
```
    The Reader's menu bar shall be hidden, when opening the document.
    
    Returns:
    
    hideMenuBar
  - setHideMenuBar
```
public void setHideMenuBar(Boolean hideMenuBar)
```
  - hideToolbar
```
public MetadataViewerPreferences hideToolbar(Boolean hideToolbar)
```
  - getHideToolbar
```
@Nullable
public @Nullable Boolean getHideToolbar()
```
    The Reader's toolbars shall be hidden, when opening the document.
    
    Returns:
    
    hideToolbar
  - setHideToolbar
```
public void setHideToolbar(Boolean hideToolbar)
```
  - hideWindowUI
```
public MetadataViewerPreferences hideWindowUI(Boolean hideWindowUI)
```
  - getHideWindowUI
```
@Nullable
public @Nullable Boolean getHideWindowUI()
```
    The Reader's navigation controls (such as scrollbars) shall be hidden, when opening the document.
    
    Returns:
    
    hideWindowUI
  - setHideWindowUI
```
public void setHideWindowUI(Boolean hideWindowUI)
```
  - nonFullScreenPageMode
```
public MetadataViewerPreferences nonFullScreenPageMode(MetadataViewerPreferences.NonFullScreenPageModeEnum nonFullScreenPageMode)
```
  - getNonFullScreenPageMode
```
@Nullable
public @Nullable MetadataViewerPreferences.NonFullScreenPageModeEnum getNonFullScreenPageMode()
```
    When displaying a document in windowed mode, the Reader shall show the selected panel. * none = No panel shall be opened. * outlines = The document's outlines shall be displayed. * thumbnails = The document's page thumbnails shall be shown. * optionalContents = document's layers (OCGs - Optional Content Groups) shall be displayed.
    
    Returns:
    
    nonFullScreenPageMode
  - setNonFullScreenPageMode
```
public void setNonFullScreenPageMode(MetadataViewerPreferences.NonFullScreenPageModeEnum nonFullScreenPageMode)
```
  - numCopies
```
public MetadataViewerPreferences numCopies(Integer numCopies)
```
  - getNumCopies
```
@Nullable
public @Nullable Integer getNumCopies()
```
    The number of copies initially suggested, when opening the Reader's print dialog. minimum: 1
    
    Returns:
    
    numCopies
  - setNumCopies
```
public void setNumCopies(Integer numCopies)
```
  - printArea
```
public MetadataViewerPreferences printArea(MetadataViewerPreferences.PrintAreaEnum printArea)
```
  - getPrintArea
```
@Nullable
public @Nullable MetadataViewerPreferences.PrintAreaEnum getPrintArea()
```
    Selects the visible box, when displaying the document. * media\\_box = The page's physical dimensions. * crop\\_box = The visible (printable) page area. * bleed\\_box = Untrimmed content position on the page (content dimensions plus trim box). * trim\\_box = Trimmed content position on the page (final content dimensions). * art\\_box = Position for special page content (images).
    
    Returns:
    
    printArea
  - setPrintArea
```
public void setPrintArea(MetadataViewerPreferences.PrintAreaEnum printArea)
```
  - printClip
```
public MetadataViewerPreferences printClip(MetadataViewerPreferences.PrintClipEnum printClip)
```
  - getPrintClip
```
@Nullable
public @Nullable MetadataViewerPreferences.PrintClipEnum getPrintClip()
```
    Selects the visible box, when displaying the document. * media\\_box = The page's physical dimensions. * crop\\_box = The visible (printable) page area. * bleed\\_box = Untrimmed content position on the page (content dimensions plus trim box). * trim\\_box = Trimmed content position on the page (final content dimensions). * art\\_box = Position for special page content (images).
    
    Returns:
    
    printClip
  - setPrintClip
```
public void setPrintClip(MetadataViewerPreferences.PrintClipEnum printClip)
```
  - printPageRange
```
public MetadataViewerPreferences printPageRange(String printPageRange)
```
  - getPrintPageRange
```
@Nullable
public @Nullable String getPrintPageRange()
```
    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 (\"\\*\").
    
    Returns:
    
    printPageRange
  - setPrintPageRange
```
public void setPrintPageRange(String printPageRange)
```
  - printScaling
```
public MetadataViewerPreferences printScaling(MetadataViewerPreferences.PrintScalingEnum printScaling)
```
  - getPrintScaling
```
@Nullable
public @Nullable MetadataViewerPreferences.PrintScalingEnum getPrintScaling()
```
    The print scaling initially suggested when opening the Reader's print dialog. * readerDefault = The Reader shall use it's default suggestion. * byPDFSize = The Reader shall suggest to not scale the document during printing.
    
    Returns:
    
    printScaling
  - setPrintScaling
```
public void setPrintScaling(MetadataViewerPreferences.PrintScalingEnum printScaling)
```
  - printTraySelection
```
public MetadataViewerPreferences printTraySelection(MetadataViewerPreferences.PrintTraySelectionEnum printTraySelection)
```
  - getPrintTraySelection
```
@Nullable
public @Nullable MetadataViewerPreferences.PrintTraySelectionEnum getPrintTraySelection()
```
    The print tray selection initially suggested when opening the Reader's print dialog. * readerDefault = The Reader shall use it's default suggestion. * byPDFSize = The Reader shall select a print tray, that matches the PDF's page dimensions.
    
    Returns:
    
    printTraySelection
  - setPrintTraySelection
```
public void setPrintTraySelection(MetadataViewerPreferences.PrintTraySelectionEnum printTraySelection)
```
  - textDirection
```
public MetadataViewerPreferences textDirection(MetadataViewerPreferences.TextDirectionEnum textDirection)
```
  - getTextDirection
```
@Nullable
public @Nullable MetadataViewerPreferences.TextDirectionEnum getTextDirection()
```
    Selects the predominant document's text writing/reading direction. * leftToRight or * rightToLeft
    
    Returns:
    
    textDirection
  - setTextDirection
```
public void setTextDirection(MetadataViewerPreferences.TextDirectionEnum textDirection)
```
  - viewArea
```
public MetadataViewerPreferences viewArea(MetadataViewerPreferences.ViewAreaEnum viewArea)
```
  - getViewArea
```
@Nullable
public @Nullable MetadataViewerPreferences.ViewAreaEnum getViewArea()
```
    Selects the visible box, when displaying the document. * media\\_box = The page's physical dimensions. * crop\\_box = The visible (printable) page area. * bleed\\_box = Untrimmed content position on the page (content dimensions plus trim box). * trim\\_box = Trimmed content position on the page (final content dimensions). * art\\_box = Position for special page content (images).
    
    Returns:
    
    viewArea
  - setViewArea
```
public void setViewArea(MetadataViewerPreferences.ViewAreaEnum viewArea)
```
  - viewClip
```
public MetadataViewerPreferences viewClip(MetadataViewerPreferences.ViewClipEnum viewClip)
```
  - getViewClip
```
@Nullable
public @Nullable MetadataViewerPreferences.ViewClipEnum getViewClip()
```
    Selects the visible box, when displaying the document. * media\\_box = The page's physical dimensions. * crop\\_box = The visible (printable) page area. * bleed\\_box = Untrimmed content position on the page (content dimensions plus trim box). * trim\\_box = Trimmed content position on the page (final content dimensions). * art\\_box = Position for special page content (images).
    
    Returns:
    
    viewClip
  - setViewClip
```
public void setViewClip(MetadataViewerPreferences.ViewClipEnum viewClip)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MetadataViewerPreferences

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_CENTER_WINDOW

JSON_PROPERTY_DISPLAY_DOC_TITLE

JSON_PROPERTY_DUPLEX

JSON_PROPERTY_FIT_WINDOW

JSON_PROPERTY_HIDE_MENU_BAR

JSON_PROPERTY_HIDE_TOOLBAR

JSON_PROPERTY_HIDE_WINDOW_U_I

JSON_PROPERTY_NON_FULL_SCREEN_PAGE_MODE

JSON_PROPERTY_NUM_COPIES

JSON_PROPERTY_PRINT_AREA

JSON_PROPERTY_PRINT_CLIP

JSON_PROPERTY_PRINT_PAGE_RANGE

JSON_PROPERTY_PRINT_SCALING

JSON_PROPERTY_PRINT_TRAY_SELECTION

JSON_PROPERTY_TEXT_DIRECTION

JSON_PROPERTY_VIEW_AREA

JSON_PROPERTY_VIEW_CLIP

Constructor Detail

MetadataViewerPreferences

Method Detail

centerWindow

getCenterWindow

setCenterWindow

displayDocTitle

getDisplayDocTitle

setDisplayDocTitle

duplex

getDuplex

setDuplex

fitWindow

getFitWindow

setFitWindow

hideMenuBar

getHideMenuBar

setHideMenuBar

hideToolbar

getHideToolbar

setHideToolbar

hideWindowUI

getHideWindowUI

setHideWindowUI

nonFullScreenPageMode

getNonFullScreenPageMode

setNonFullScreenPageMode

numCopies

getNumCopies

setNumCopies

printArea

getPrintArea

setPrintArea

printClip

getPrintClip

setPrintClip

printPageRange

getPrintPageRange

setPrintPageRange

printScaling

getPrintScaling

setPrintScaling

printTraySelection

getPrintTraySelection

setPrintTraySelection

textDirection

getTextDirection

setTextDirection

viewArea

getViewArea

setViewArea

viewClip

getViewClip

setViewClip

equals

hashCode