Class PDViewerPreferences
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
- All Implemented Interfaces:
COSObjectable
This is the document viewing preferences.
- Version:
- $Revision: 1.3 $
- Author:
- Ben Litchfield
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Enumeration containing all valid values for boundaries.static enum
Enumeration containing all valid values for duplex.static enum
Enumeration containing all valid values for NonFullScreenPageMode.static enum
Enumeration containing all valid values for printscaling.static enum
Enumeration containing all valid values for ReadingDirection. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.static final String
Deprecated.usePDViewerPreferences.BOUNDARY
insteadstatic final String
Deprecated.usePDViewerPreferences.BOUNDARY
insteadstatic final String
Deprecated.usePDViewerPreferences.BOUNDARY
insteadstatic final String
Deprecated.usePDViewerPreferences.BOUNDARY
insteadstatic final String
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadstatic final String
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadstatic final String
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadstatic final String
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadstatic final String
Deprecated.usePDViewerPreferences.READING_DIRECTION
insteadstatic final String
Deprecated.usePDViewerPreferences.READING_DIRECTION
instead -
Constructor Summary
ConstructorsConstructorDescriptionConstructor that is used for a preexisting dictionary. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get the center window preference.boolean
Get the display doc title preference.boolean
Get the fit window preference.Convert this standard java object to a COS object.This will get the underlying dictionary that this object wraps.Get the Duplex preference.Get the non full screen page mode preference.Get the PrintArea preference.Get the PrintClip preference.Get the PrintScaling preference.Get the reading direction preference.Get the ViewArea preference.Get the ViewClip preference.boolean
Get the menubar preference.boolean
Get the toolbar preference.boolean
Get the window UI preference.void
setCenterWindow
(boolean value) Set the center window preference.void
setDisplayDocTitle
(boolean value) Set the display doc title preference.void
Set the Duplex preference.void
setFitWindow
(boolean value) Set the fit window preference.void
setHideMenubar
(boolean value) Set the menubar preference.void
setHideToolbar
(boolean value) Set the toolbar preference.void
setHideWindowUI
(boolean value) Set the window UI preference.void
setNonFullScreenPageMode
(String value) Deprecated.void
Set the non full screen page mode preference.void
setPrintArea
(String value) Deprecated.void
Set the PrintArea preference.void
setPrintClip
(String value) Deprecated.void
Set the PrintClip preference.void
Set the PrintScaling preference.void
setReadingDirection
(String value) Deprecated.void
Set the reading direction preference.void
setViewArea
(String value) Deprecated.void
Set the ViewArea preference.void
setViewClip
(String value) Deprecated.void
Set the ViewClip preference.
-
Field Details
-
NON_FULL_SCREEN_PAGE_MODE_USE_NONE
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadFrom PDF Reference: "Neither document outline nor thumbnail images visible".- See Also:
-
NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadFrom PDF Reference: "Document outline visible".- See Also:
-
NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadFrom PDF Reference: "Thumbnail images visible".- See Also:
-
NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT
Deprecated.usePDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
insteadFrom PDF Reference: "Optional content group panel visible".- See Also:
-
READING_DIRECTION_L2R
Deprecated.usePDViewerPreferences.READING_DIRECTION
insteadReading direction.- See Also:
-
READING_DIRECTION_R2L
Deprecated.usePDViewerPreferences.READING_DIRECTION
insteadReading direction.- See Also:
-
BOUNDARY_MEDIA_BOX
Deprecated.usePDViewerPreferences.BOUNDARY
insteadBoundary constant.- See Also:
-
BOUNDARY_CROP_BOX
Deprecated.usePDViewerPreferences.BOUNDARY
insteadBoundary constant.- See Also:
-
BOUNDARY_BLEED_BOX
Deprecated.usePDViewerPreferences.BOUNDARY
insteadBoundary constant.- See Also:
-
BOUNDARY_TRIM_BOX
Deprecated.usePDViewerPreferences.BOUNDARY
insteadBoundary constant.- See Also:
-
BOUNDARY_ART_BOX
Deprecated.usePDViewerPreferences.BOUNDARY
insteadBoundary constant.- See Also:
-
-
Constructor Details
-
PDViewerPreferences
Constructor that is used for a preexisting dictionary.- Parameters:
dic
- The underlying dictionary.
-
-
Method Details
-
getDictionary
This will get the underlying dictionary that this object wraps.- Returns:
- The underlying info dictionary.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
hideToolbar
public boolean hideToolbar()Get the toolbar preference.- Returns:
- the toolbar preference.
-
setHideToolbar
public void setHideToolbar(boolean value) Set the toolbar preference.- Parameters:
value
- Set the toolbar preference.
-
hideMenubar
public boolean hideMenubar()Get the menubar preference.- Returns:
- the menubar preference.
-
setHideMenubar
public void setHideMenubar(boolean value) Set the menubar preference.- Parameters:
value
- Set the menubar preference.
-
hideWindowUI
public boolean hideWindowUI()Get the window UI preference.- Returns:
- the window UI preference.
-
setHideWindowUI
public void setHideWindowUI(boolean value) Set the window UI preference.- Parameters:
value
- Set the window UI preference.
-
fitWindow
public boolean fitWindow()Get the fit window preference.- Returns:
- the fit window preference.
-
setFitWindow
public void setFitWindow(boolean value) Set the fit window preference.- Parameters:
value
- Set the fit window preference.
-
centerWindow
public boolean centerWindow()Get the center window preference.- Returns:
- the center window preference.
-
setCenterWindow
public void setCenterWindow(boolean value) Set the center window preference.- Parameters:
value
- Set the center window preference.
-
displayDocTitle
public boolean displayDocTitle()Get the display doc title preference.- Returns:
- the display doc title preference.
-
setDisplayDocTitle
public void setDisplayDocTitle(boolean value) Set the display doc title preference.- Parameters:
value
- Set the display doc title preference.
-
getNonFullScreenPageMode
Get the non full screen page mode preference.- Returns:
- the non full screen page mode preference.
-
setNonFullScreenPageMode
Set the non full screen page mode preference.- Parameters:
value
- Set the non full screen page mode preference.
-
setNonFullScreenPageMode
Deprecated.Set the non full screen page mode preference.- Parameters:
value
- Set the non full screen page mode preference.
-
getReadingDirection
Get the reading direction preference.- Returns:
- the reading direction preference.
-
setReadingDirection
Set the reading direction preference.- Parameters:
value
- Set the reading direction preference.
-
setReadingDirection
Deprecated.Set the reading direction preference.- Parameters:
value
- Set the reading direction preference.
-
getViewArea
Get the ViewArea preference. See BOUNDARY enumeration.- Returns:
- the ViewArea preference.
-
setViewArea
Deprecated.Set the ViewArea preference. See BOUNDARY_XXX constants.- Parameters:
value
- Set the ViewArea preference.
-
setViewArea
Set the ViewArea preference. See BOUNDARY enumeration.- Parameters:
value
- Set the ViewArea preference.
-
getViewClip
Get the ViewClip preference. See BOUNDARY enumeration.- Returns:
- the ViewClip preference.
-
setViewClip
Set the ViewClip preference. See BOUNDARY enumeration.- Parameters:
value
- Set the ViewClip preference.
-
setViewClip
Deprecated.Set the ViewClip preference. See BOUNDARY_XXX constants.- Parameters:
value
- Set the ViewClip preference.
-
getPrintArea
Get the PrintArea preference. See BOUNDARY enumeration.- Returns:
- the PrintArea preference.
-
setPrintArea
Deprecated.Set the PrintArea preference. See BOUNDARY_XXX constants.- Parameters:
value
- Set the PrintArea preference.
-
setPrintArea
Set the PrintArea preference. See BOUNDARY enumeration.- Parameters:
value
- Set the PrintArea preference.
-
getPrintClip
Get the PrintClip preference. See BOUNDARY enumeration.- Returns:
- the PrintClip preference.
-
setPrintClip
Deprecated.Set the PrintClip preference. See BOUNDARY_XXX constants.- Parameters:
value
- Set the PrintClip preference.
-
setPrintClip
Set the PrintClip preference. See BOUNDARY enumeration.- Parameters:
value
- Set the PrintClip preference.
-
getDuplex
Get the Duplex preference. See DUPLEX enumeration.- Returns:
- the Duplex preference.
-
setDuplex
Set the Duplex preference. See DUPLEX enumeration.- Parameters:
value
- Set the Duplex preference.
-
getPrintScaling
Get the PrintScaling preference. See PRINT_SCALING enumeration.- Returns:
- the PrintScaling preference.
-
setPrintScaling
Set the PrintScaling preference. See PRINT_SCALING enumeration.- Parameters:
value
- Set the PrintScaling preference.
-
PDViewerPreferences.BOUNDARY
instead