com.cete.dynamicpdf
Class ViewerPreferences

java.lang.Object
  com.cete.dynamicpdf.ViewerPreferences

public class ViewerPreferences
extends java.lang.Object

Represents the viewer preferences for a document.

Licensing:
This class is a DynamicPDF Generator Community Edition feature.

View Example

Method Summary

void	draw(DocumentWriter writer) Draws the encrypter viewer preferences dictionary to the given DocumentWriter object.
boolean	getCenterWindow() A flag specifying whether the document�s window will be positioned in the center of the screen.
boolean	getDisplayDocTitle() A flag specifying whether the window�s title bar will display the document title taken from the Title entry of the document of the PDF file containing the document.
Duplex	getDuplex() Gets the default duplex printing mode for the document.
boolean	getFitWindow() A flag specifying whether the document�s window will be resized to fit the size of the first displayed page.
boolean	getHideMenubar() A flag specifying whether the viewer application�s menu bar is hidden when the document is active.
boolean	getHideToolbar() A flag specifying whether the viewer application�s tool bars were hidden when the document is active.
boolean	getHideWindowUI() A flag specifying whether the user interface elements in the document�s window (such as scrollbars and navigation controls), were hidden leaving only the document�s contents displayed.
NonFullScreenPageMode	getNonFullScreenPageMode() Gets the page mode when the documents page mode is set to full screen.
boolean	getNoPrintScaling() Gets scaling of the print document.
int	getNumberOfCOpies() Gets the default number of copies to be printed.
PickTrayByPdfSize	getPickTrayByPdfSize() Gets the printing tray should be picked based on the size of the PDF document.
PageBoundary	getPrintArea() Gets the print area for the document.
PageBoundary	getPrintClip() Gets the print clip area for the document.
int[]	getPrintPageRange() Gets the default page ranges to be used for printing.
boolean	getRightToLeft() Gets a flag specifying if right to left text is predominately used by this document.
PageBoundary	getViewArea() Gets the view area for the document.
PageBoundary	getViewClip() Gets the view clip area for the document.
void	setCenterWindow(boolean centerWindow) A flag to position the document�s window in the center of the screen.
void	setDisplayDocTitle(boolean displayDocTitle) A flag to specify the window�s title bar should display the document title taken from the Title entry of the document of the PDF file containing the document.
void	setDuplex(Duplex value) Sets the default duplex printing mode for the document..
void	setFitWindow(boolean fitWindow) A flag to resize the document�s window to fit the size of the first displayed page.
void	setHideMenubar(boolean hideMenubar) A flag to hide the viewer application�s menu bar when the document is active.
void	setHideToolbar(boolean hideToolbar) A flag to hide the viewer application�s tool bars when the document is active.
void	setHideWindowUI(boolean hideWindowUI) A flag to hide user interface elements in the document�s window (such as scrollbars and navigation controls), leaving only the document�s contents displayed.
void	setNonFullScreenPageMode(NonFullScreenPageMode value) Specifys the page mode when the documents page mode is set to full screen.
void	setNoPrintScaling(boolean value) Sets scaling of the print document.
void	setNumberOfCOpies(int value) Specifies the default number of copies to be printed.
void	setPickTrayByPdfSize(PickTrayByPdfSize value) Specifies if the printing tray should be picked based on the size of the PDF document.
void	setPrintArea(PageBoundary value) Sets the print area for the document.
void	setPrintClip(PageBoundary value) Sets the print clip area for the document.
void	setPrintPageRange(int[] value) Sets the default page ranges to be used for printing.
void	setRightToLeft(boolean value) Sets a flag specifying right to left text to predominately use by this document.
void	setViewArea(PageBoundary value) Sets the view area for the document.
void	setViewClip(PageBoundary value) Sets the view clip area for the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

draw

public void draw(DocumentWriter writer)

Draws the encrypter viewer preferences dictionary to the given DocumentWriter object.

Parameters:

writer - the DocumentWriter object to receive the output.

See Also:

DocumentWriter

setHideToolbar

public void setHideToolbar(boolean hideToolbar)

A flag to hide the viewer application�s tool bars when the document is active.

Parameters:

hideToolbar - the boolean value indicating whether to hide the viewer application's toolbar.

getHideToolbar

public boolean getHideToolbar()

A flag specifying whether the viewer application�s tool bars were hidden when the document is active.

Returns:

the boolean value indicating whether the viewer application's toolbar is hidden.

setHideMenubar

public void setHideMenubar(boolean hideMenubar)

A flag to hide the viewer application�s menu bar when the document is active.

Parameters:

hideMenubar - the boolean value indicating whether to hide the viewer application's menubar.

getHideMenubar

public boolean getHideMenubar()

A flag specifying whether the viewer application�s menu bar is hidden when the document is active.

Returns:

the boolean value indicating whether the viewer application's menubar is hidden.

setHideWindowUI

public void setHideWindowUI(boolean hideWindowUI)

A flag to hide user interface elements in the document�s window (such as scrollbars and navigation controls), leaving only the document�s contents displayed.

Parameters:

hideWindowUI - the boolean value indicating whether to hide the user interface elements in the document�s window.

getHideWindowUI

public boolean getHideWindowUI()

A flag specifying whether the user interface elements in the document�s window (such as scrollbars and navigation controls), were hidden leaving only the document�s contents displayed.

Returns:

the boolean value indicating whether the user interface elements in the document�s window were hidden.

setFitWindow

public void setFitWindow(boolean fitWindow)

A flag to resize the document�s window to fit the size of the first displayed page.

Parameters:

fitWindow - the boolean value to resize the document�s window to fit the size of the first displayed page.fit

getFitWindow

public boolean getFitWindow()

A flag specifying whether the document�s window will be resized to fit the size of the first displayed page.

Returns:

the boolean value indicating whether the document�s window will be resized to fit the size of the first displayed page.

setCenterWindow

public void setCenterWindow(boolean centerWindow)

A flag to position the document�s window in the center of the screen.

Parameters:

centerWindow - the boolean value to position the document�s window in the center of the screen.

getCenterWindow

public boolean getCenterWindow()

A flag specifying whether the document�s window will be positioned in the center of the screen.

Returns:

the boolean value specifying whether the document�s window will be positioned in the center of the screen.

setDisplayDocTitle

public void setDisplayDocTitle(boolean displayDocTitle)

A flag to specify the window�s title bar should display the document title taken from the Title entry of the document of the PDF file containing the document. This does not affect the title bar of most web browsers. The title bar in most web browsers will display the file's URL and ignor this setting.

Parameters:

displayDocTitle - the boolean value to specify the window�s title bar should display the document title .

getDisplayDocTitle

public boolean getDisplayDocTitle()

A flag specifying whether the window�s title bar will display the document title taken from the Title entry of the document of the PDF file containing the document. This does not affect the title bar of most web browsers. The title bar in most web browsers will display the file's URL and ignore this setting.

Returns:

the boolean value specifying whether the window�s title bar will display the document title.

getNonFullScreenPageMode

public NonFullScreenPageMode getNonFullScreenPageMode()

Gets the page mode when the documents page mode is set to full screen.

Returns:

the page mode when the documents page mode is set to full screen.

setNonFullScreenPageMode

public void setNonFullScreenPageMode(NonFullScreenPageMode value)

Specifys the page mode when the documents page mode is set to full screen. This value is ignored if the documents page mode is not set to full screen.

Parameters:

value - the page mode when the documents page mode is set to full screen.

getRightToLeft

public boolean getRightToLeft()

Gets a flag specifying if right to left text is predominately used by this document. This does not affect the right to left property of text objects for text added to the document.

Returns:

the right to left property of the document.

setRightToLeft

public void setRightToLeft(boolean value)

Sets a flag specifying right to left text to predominately use by this document. This does not affect the right to left property of text objects for text added to the document.

Parameters:

value - the right to left property of the document.

getViewArea

public PageBoundary getViewArea()

Gets the view area for the document.

Returns:

the view area for the document.

setViewArea

public void setViewArea(PageBoundary value)

Sets the view area for the document.

Parameters:

value - the view area for the document.

getViewClip

public PageBoundary getViewClip()

Gets the view clip area for the document.

Returns:

the view clip area for the document.

setViewClip

public void setViewClip(PageBoundary value)

Sets the view clip area for the document.

Parameters:

value - the view clip area for the document.

getPrintArea

public PageBoundary getPrintArea()

Gets the print area for the document.

Returns:

the print area for the document.

setPrintArea

public void setPrintArea(PageBoundary value)

Sets the print area for the document.

Parameters:

value - the print area for the document.

getPrintClip

public PageBoundary getPrintClip()

Gets the print clip area for the document.

Returns:

the print clip area for the document.

setPrintClip

public void setPrintClip(PageBoundary value)

Sets the print clip area for the document.

Parameters:

value - the print clip area for the document.

getNoPrintScaling

public boolean getNoPrintScaling()

Gets scaling of the print document.

Returns:

scaling of the print document.

setNoPrintScaling

public void setNoPrintScaling(boolean value)

Sets scaling of the print document.

Parameters:

value - scaling of the print document.

getDuplex

public Duplex getDuplex()

Gets the default duplex printing mode for the document. This feature is only recognized by Acrobat 8 or greater.

Returns:

the default duplex printing mode for the document.

setDuplex

public void setDuplex(Duplex value)

Sets the default duplex printing mode for the document.. This feature is only recognized by Acrobat 8 or greater.

Parameters:

value - the default duplex printing mode for the document.

getPrintPageRange

public int[] getPrintPageRange()

Gets the default page ranges to be used for printing. This feature is only recognized by Acrobat 8 or greater.

Returns:

the default page ranges to be used for printing.

setPrintPageRange

public void setPrintPageRange(int[] value)

Sets the default page ranges to be used for printing. This feature is only recognized by Acrobat 8 or greater.

Parameters:

value - the default page ranges to be used for printing.

getPickTrayByPdfSize

public PickTrayByPdfSize getPickTrayByPdfSize()

Gets the printing tray should be picked based on the size of the PDF document. This feature is only recognized by Acrobat 8 or greater.

Returns:

the printing tray should be picked based on the size of the PDF document.

setPickTrayByPdfSize

public void setPickTrayByPdfSize(PickTrayByPdfSize value)

Specifies if the printing tray should be picked based on the size of the PDF document. This feature is only recognized by Acrobat 8 or greater.

Parameters:

value - the printing tray should be picked based on the size of the PDF document.

getNumberOfCOpies

public int getNumberOfCOpies()

Gets the default number of copies to be printed. This feature is only recognized by Acrobat 8 or greater.

Returns:

the default number of copies to be printed.

setNumberOfCOpies

public void setNumberOfCOpies(int value)

Specifies the default number of copies to be printed. This feature is only recognized by Acrobat 8 or greater.

Parameters:

value - the default number of copies to be printed.