org.pdfbox.pdmodel.interactive.viewerpreferences

Class PDViewerPreferences

Implemented Interfaces:
COSObjectable

public class PDViewerPreferences
extends java.lang.Object
implements COSObjectable

This is the document viewing preferences.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Field Summary

static String
BOUNDARY_ART_BOX
Boundary constant.
static String
BOUNDARY_BLEED_BOX
Boundary constant.
static String
BOUNDARY_CROP_BOX
Boundary constant.
static String
BOUNDARY_MEDIA_BOX
Boundary constant.
static String
BOUNDARY_TRIM_BOX
Boundary constant.
static String
NON_FULL_SCREEN_PAGE_MODE_USE_NONE
From PDF Reference: "Neither document outline nor thumbnail images visible".
static String
NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT
From PDF Reference: "Optional content group panel visible".
static String
NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES
From PDF Reference: "Document outline visible".
static String
NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS
From PDF Reference: "Thumbnail images visible".
static String
READING_DIRECTION_L2R
Reading direction.
static String
READING_DIRECTION_R2L
Reading direction.

Constructor Summary

PDViewerPreferences(COSDictionary dic)
Constructor that is used for a preexisting dictionary.

Method Summary

boolean
centerWindow()
Get the center window preference.
boolean
displayDocTitle()
Get the display doc title preference.
boolean
fitWindow()
Get the fit window preference.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
COSDictionary
getDictionary()
This will get the underlying dictionary that this object wraps.
String
getNonFullScreenPageMode()
Get the non full screen page mode preference.
String
getPrintArea()
Get the PrintArea preference.
String
getPrintClip()
Get the PrintClip preference.
String
getReadingDirection()
Get the reading direction preference.
String
getViewArea()
Get the ViewArea preference.
String
getViewClip()
Get the ViewClip preference.
boolean
hideMenubar()
Get the menubar preference.
boolean
hideToolbar()
Get the toolbar preference.
boolean
hideWindowUI()
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
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)
Set the non full screen page mode preference.
void
setPrintArea(String value)
Set the PrintArea preference.
void
setPrintClip(String value)
Set the PrintClip preference.
void
setReadingDirection(String value)
Set the reading direction preference.
void
setViewArea(String value)
Set the ViewArea preference.
void
setViewClip(String value)
Set the ViewClip preference.

Field Details

BOUNDARY_ART_BOX

public static final String BOUNDARY_ART_BOX
Boundary constant.

BOUNDARY_BLEED_BOX

public static final String BOUNDARY_BLEED_BOX
Boundary constant.

BOUNDARY_CROP_BOX

public static final String BOUNDARY_CROP_BOX
Boundary constant.

BOUNDARY_MEDIA_BOX

public static final String BOUNDARY_MEDIA_BOX
Boundary constant.

BOUNDARY_TRIM_BOX

public static final String BOUNDARY_TRIM_BOX
Boundary constant.

NON_FULL_SCREEN_PAGE_MODE_USE_NONE

public static final String NON_FULL_SCREEN_PAGE_MODE_USE_NONE
From PDF Reference: "Neither document outline nor thumbnail images visible".

NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT

public static final String NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT
From PDF Reference: "Optional content group panel visible".

NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES

public static final String NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES
From PDF Reference: "Document outline visible".

NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS

public static final String NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS
From PDF Reference: "Thumbnail images visible".

READING_DIRECTION_L2R

public static final String READING_DIRECTION_L2R
Reading direction.

READING_DIRECTION_R2L

public static final String READING_DIRECTION_R2L
Reading direction.

Constructor Details

PDViewerPreferences

public PDViewerPreferences(COSDictionary dic)
Constructor that is used for a preexisting dictionary.
Parameters:
dic - The underlying dictionary.

Method Details

centerWindow

public boolean centerWindow()
Get the center window preference.
Returns:
the center window preference.

displayDocTitle

public boolean displayDocTitle()
Get the display doc title preference.
Returns:
the display doc title preference.

fitWindow

public boolean fitWindow()
Get the fit window preference.
Returns:
the fit window preference.

getCOSObject

public COSBase getCOSObject()
Convert this standard java object to a COS object.
Specified by:
getCOSObject in interface COSObjectable
Returns:
The cos object that matches this Java object.

getDictionary

public COSDictionary getDictionary()
This will get the underlying dictionary that this object wraps.
Returns:
The underlying info dictionary.

getNonFullScreenPageMode

public String getNonFullScreenPageMode()
Get the non full screen page mode preference.
Returns:
the non full screen page mode preference.

getPrintArea

public String getPrintArea()
Get the PrintArea preference. See BOUNDARY_XXX constants.
Returns:
the PrintArea preference.

getPrintClip

public String getPrintClip()
Get the PrintClip preference. See BOUNDARY_XXX constants.
Returns:
the PrintClip preference.

getReadingDirection

public String getReadingDirection()
Get the reading direction preference.
Returns:
the reading direction preference.

getViewArea

public String getViewArea()
Get the ViewArea preference. See BOUNDARY_XXX constants.
Returns:
the ViewArea preference.

getViewClip

public String getViewClip()
Get the ViewClip preference. See BOUNDARY_XXX constants.
Returns:
the ViewClip preference.

hideMenubar

public boolean hideMenubar()
Get the menubar preference.
Returns:
the menubar preference.

hideToolbar

public boolean hideToolbar()
Get the toolbar preference.
Returns:
the toolbar preference.

hideWindowUI

public boolean hideWindowUI()
Get the window UI preference.
Returns:
the window UI preference.

setCenterWindow

public void setCenterWindow(boolean value)
Set the center window preference.
Parameters:
value - Set the center window preference.

setDisplayDocTitle

public void setDisplayDocTitle(boolean value)
Set the display doc title preference.
Parameters:
value - Set the display doc title preference.

setFitWindow

public void setFitWindow(boolean value)
Set the fit window preference.
Parameters:
value - Set the fit window preference.

setHideMenubar

public void setHideMenubar(boolean value)
Set the menubar preference.
Parameters:
value - Set the menubar preference.

setHideToolbar

public void setHideToolbar(boolean value)
Set the toolbar preference.
Parameters:
value - Set the toolbar preference.

setHideWindowUI

public void setHideWindowUI(boolean value)
Set the window UI preference.
Parameters:
value - Set the window UI preference.

setNonFullScreenPageMode

public void setNonFullScreenPageMode(String value)
Set the non full screen page mode preference.
Parameters:
value - Set the non full screen page mode preference.

setPrintArea

public void setPrintArea(String value)
Set the PrintArea preference. See BOUNDARY_XXX constants.
Parameters:
value - Set the PrintArea preference.

setPrintClip

public void setPrintClip(String value)
Set the PrintClip preference. See BOUNDARY_XXX constants.
Parameters:
value - Set the PrintClip preference.

setReadingDirection

public void setReadingDirection(String value)
Set the reading direction preference.
Parameters:
value - Set the reading direction preference.

setViewArea

public void setViewArea(String value)
Set the ViewArea preference. See BOUNDARY_XXX constants.
Parameters:
value - Set the ViewArea preference.

setViewClip

public void setViewClip(String value)
Set the ViewClip preference. See BOUNDARY_XXX constants.
Parameters:
value - Set the ViewClip preference.