com.qoppa.pdf
Interface DocumentViewPrefs

public interface DocumentViewPrefs

This class is a container for the viewer preferences of a PDF document.

Author:

Qoppa Software

Field Summary

static String	APPDEFAULT Setting for the Print Scaling viewer preference: Applications should use the current print scaling
static String	DUPLEXFLIPLONGEDGE Setting for the Duplex viewer preference: Duplex and flip on the long edge of the sheet
static String	DUPLEXFLIPSHORTEDGE Setting for the Duplex viewer preference: Duplex and flip on the short edge of the sheet
static String	L2R Setting for the Direction viewer preference: Left to right
static String	NONE Setting for the Print Scaling viewer preference: Print dialog should reflect no page scaling
static String	R2L Setting for the Direction viewer preference: Right to left
static String	SIMPLEX Setting for the Duplex viewer preference: Print single-sided
static String	USENONE Setting for the NonFullScreen Page Mode viewer preference: Neither document outline nor thumbnail images visible
static String	USEOC Setting for the NonFullScreen Page Mode viewer preference: Optional content group panel visible
static String	USEOUTLINES Setting for the NonFullScreen Page Mode viewer preference: Document outline visible
static String	USETHUMBS Setting for the NonFullScreen Page Mode viewer preference: Thumbnail images visible

Method Summary

boolean	getCenterWindow() Returns the Center Window viewer preference in the document.
String	getDirection() Returns the Direction viewer preference in the document.
boolean	getDisplayDocTitle() Returns the Display Doc Title viewer preference in the document.
String	getDuplex() Returns the Duplex viewer preference in the document.
boolean	getFitWindow() Returns the Fit Window viewer preference in the document.
boolean	getHideMenubar() Returns the Hide Menubar viewer preference in the document.
boolean	getHideToolbar() Returns the Hide Toolbar viewer preference in the document.
boolean	getHideWindowUI() Returns the Hide Window UI viewer preference in the document.
String	getNonFullScreenPageMode() Returns the NonFullscreen Page Mode viewer preference in the document.
int	getNumCopies() Returns the NumCopies viewer preference in the document.
boolean	getPickTrayByPDFSize() Returns the Pick Tray by PDF Size viewer preference in the document.
String	getPrintScaling() Returns the Print Scaling viewer preference in the document.
void	setCenterWindow(boolean value) Sets the Center Window viewer preference in the document.
void	setDirection(String value) Sets the Direction viewer preference in the document.
void	setDisplayDocTitle(boolean value) Sets the Display Doc Title viewer preference in the document.
void	setDuplex(String value) Sets the Duplex viewer preference in the document.
void	setFitWindow(boolean value) Sets the Fit Window viewer preference in the document.
void	setHideMenubar(boolean value) Sets the Hide Menubar viewer preference in the document.
void	setHideToolbar(boolean value) Sets the Hide Toolbar viewer preference in the document.
void	setHideWindowUI(boolean value) Sets the Hide Window UI viewer preference in the document.
void	setNonFullScreenPageMode(String value) Sets the NonFullScreen Page Mode viewer preference in the document.
void	setNumCopies(int value) Sets the NumCopies viewer preference in the document.
void	setPickTrayByPDFSize(boolean value) Sets the Pick Tray by PDF Size viewer preference in the document.
void	setPrintScaling(String value) Sets the Print Scaling viewer preference in the document.

Field Detail

USENONE

static final String USENONE

Setting for the NonFullScreen Page Mode viewer preference: Neither document outline nor thumbnail images visible

See Also:

Constant Field Values

USEOUTLINES

static final String USEOUTLINES

Setting for the NonFullScreen Page Mode viewer preference: Document outline visible

See Also:

Constant Field Values

USETHUMBS

static final String USETHUMBS

Setting for the NonFullScreen Page Mode viewer preference: Thumbnail images visible

See Also:

Constant Field Values

USEOC

static final String USEOC

Setting for the NonFullScreen Page Mode viewer preference: Optional content group panel visible

See Also:

Constant Field Values

L2R

static final String L2R

Setting for the Direction viewer preference: Left to right

See Also:

Constant Field Values

R2L

static final String R2L

Setting for the Direction viewer preference: Right to left

See Also:

Constant Field Values

NONE

static final String NONE

Setting for the Print Scaling viewer preference: Print dialog should reflect no page scaling

See Also:

Constant Field Values

APPDEFAULT

static final String APPDEFAULT

Setting for the Print Scaling viewer preference: Applications should use the current print scaling

See Also:

Constant Field Values

SIMPLEX

static final String SIMPLEX

Setting for the Duplex viewer preference: Print single-sided

See Also:

Constant Field Values

DUPLEXFLIPSHORTEDGE

static final String DUPLEXFLIPSHORTEDGE

Setting for the Duplex viewer preference: Duplex and flip on the short edge of the sheet

See Also:

Constant Field Values

DUPLEXFLIPLONGEDGE

static final String DUPLEXFLIPLONGEDGE

Setting for the Duplex viewer preference: Duplex and flip on the long edge of the sheet

See Also:

Constant Field Values

Method Detail

getHideToolbar

boolean getHideToolbar()

Returns the Hide Toolbar viewer preference in the document.

Returns:

The Hide Toolbar viewer preference.

setHideToolbar

void setHideToolbar(boolean value)
                    throws PDFException

Sets the Hide Toolbar viewer preference in the document.

Parameters:

value - The Hide Toolbar viewer preference.

Throws:

PDFException

getHideMenubar

boolean getHideMenubar()

Returns the Hide Menubar viewer preference in the document.

Returns:

The Hide Menubar viewer preference.

setHideMenubar

void setHideMenubar(boolean value)
                    throws PDFException

Sets the Hide Menubar viewer preference in the document.

Parameters:

value - The Hide Menubar viewer preference.

Throws:

PDFException

getHideWindowUI

boolean getHideWindowUI()

Returns the Hide Window UI viewer preference in the document.

Returns:

The Hide Window UI viewer preference.

setHideWindowUI

void setHideWindowUI(boolean value)
                     throws PDFException

Sets the Hide Window UI viewer preference in the document.

Parameters:

value - The Hide Window UI viewer preference.

Throws:

PDFException

getFitWindow

boolean getFitWindow()

Returns the Fit Window viewer preference in the document.

Returns:

The Fit Window viewer preference.

setFitWindow

void setFitWindow(boolean value)
                  throws PDFException

Sets the Fit Window viewer preference in the document.

Parameters:

value - The Fit Window viewer preference.

Throws:

PDFException

getCenterWindow

boolean getCenterWindow()

Returns the Center Window viewer preference in the document.

Returns:

The Center Window viewer preference.

setCenterWindow

void setCenterWindow(boolean value)
                     throws PDFException

Sets the Center Window viewer preference in the document.

Parameters:

value - The Center Window viewer preference.

Throws:

PDFException

getDisplayDocTitle

boolean getDisplayDocTitle()

Returns the Display Doc Title viewer preference in the document.

Returns:

The Display Doc Title viewer preference.

setDisplayDocTitle

void setDisplayDocTitle(boolean value)
                        throws PDFException

Sets the Display Doc Title viewer preference in the document.

Parameters:

value - The Display Doc Title viewer preference.

Throws:

PDFException

getNonFullScreenPageMode

String getNonFullScreenPageMode()

Returns the NonFullscreen Page Mode viewer preference in the document.

Returns:

The NonFullscreen Page Mode viewer preference.

setNonFullScreenPageMode

void setNonFullScreenPageMode(String value)
                              throws PDFException

Sets the NonFullScreen Page Mode viewer preference in the document. The calling application should use one of the predefined constants: USENONE, USEOUTLINES, USETHUMBS, or USEOC.

Parameters:

value - The NonFullscreen Page Mode viewer preference.

Throws:

PDFException

getDirection

String getDirection()

Returns the Direction viewer preference in the document.

Returns:

The Direction viewer preference.

setDirection

void setDirection(String value)
                  throws PDFException

Sets the Direction viewer preference in the document. The calling application should use one of the predefined constants: L2R or R2L.

Parameters:

value - The Direction viewer preference.

Throws:

PDFException

getPrintScaling

String getPrintScaling()

Returns the Print Scaling viewer preference in the document.

Returns:

The Print Scaling viewer preference.

setPrintScaling

void setPrintScaling(String value)
                     throws PDFException

Sets the Print Scaling viewer preference in the document. The calling application should use one of the predefined constants: NONE or APPDEFAULT.

Parameters:

value - The Print Scaling viewer preference.

Throws:

PDFException

getDuplex

String getDuplex()

Returns the Duplex viewer preference in the document.

Returns:

The Duplex viewer preference.

setDuplex

void setDuplex(String value)
               throws PDFException

Sets the Duplex viewer preference in the document. The calling application should use one of the predefined constants: SIMPLEX, DUPLEXFLIPSHORTEDGE, or DUPLEXFLIPLONGEDGE.

Parameters:

value - The Duplex viewer preference.

Throws:

PDFException

getPickTrayByPDFSize

boolean getPickTrayByPDFSize()

Returns the Pick Tray by PDF Size viewer preference in the document.

Returns:

The Pick Tray by PDF Size viewer preference.

setPickTrayByPDFSize

void setPickTrayByPDFSize(boolean value)
                          throws PDFException

Sets the Pick Tray by PDF Size viewer preference in the document.

Parameters:

value - The Pick Tray by PDF Size viewer preference.

Throws:

PDFException

getNumCopies

int getNumCopies()

Returns the NumCopies viewer preference in the document.

Returns:

The NumCopies viewer preference.

setNumCopies

void setNumCopies(int value)
                  throws PDFException

Sets the NumCopies viewer preference in the document. Supported values are the integers 2 through 5.

Parameters:

value - The NumCopies viewer preference.

Throws:

PDFException