DynamicPDF by ceTe Software

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.

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.
 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.
 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 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.
 
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.

DynamicPDF by ceTe Software

API Reference for DynamicPDF™ for Java generated on December 20, 2005
© Copyright 2005, ceTe Software