com.pdf_tools.fourheights.pdftoolbox.pdf.navigation

Class ViewerSettings

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.ViewerSettings

public class ViewerSettings
extends NativeObject

Method Summary

Modifier and Type	Method and Description
static ViewerSettings	copy(Document targetDocument, ViewerSettings viewerSettings) Copy viewer settings
static ViewerSettings	createDynamicObject(long handle)
ViewerNavigationPane	getActivePane() The initially visible side pane when opening the document in a viewer.
boolean	getDisplayDocumentTitle() If true then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.
boolean	getFullScreen() If true then opening the document will make the viewer try to enter full screen mode.
boolean	getHideMenubar() If true then opening the document will instruct the viewer to hide it's menu bar.
boolean	getHideToolbar() If true then opening the document will instruct the viewer to hide it's toolbar.
PageDisplay	getPageDisplay() The positional arrangment for displaying pages when opening the document in a viewer.
void	setActivePane(ViewerNavigationPane value) The initially visible side pane when opening the document in a viewer.
void	setDisplayDocumentTitle(boolean value) If true then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.
void	setFullScreen(boolean value) If true then opening the document will make the viewer try to enter full screen mode.
void	setHideMenubar(boolean value) If true then opening the document will instruct the viewer to hide it's menu bar.
void	setHideToolbar(boolean value) If true then opening the document will instruct the viewer to hide it's toolbar.
void	setPageDisplay(PageDisplay value) The positional arrangment for displaying pages when opening the document in a viewer.

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDynamicObject

public static ViewerSettings createDynamicObject(long handle)

copy

public static ViewerSettings copy(Document targetDocument,
                                  ViewerSettings viewerSettings)
                           throws java.io.IOException,
                                  ConformanceException

Copy viewer settings

The newly created viewer settings are associated with the target document, but not yet used as the document's viewer settings.

Parameters:

targetDocument - the output document with which the returned object is associated

viewerSettings - the viewer settings of a different document

Returns:

a viewer settings object with the same content, but associated with the current document.

Throws:

ConformanceException - The conformance level of the source document is not compatible with the conformance level of the target document.

java.lang.IllegalArgumentException - if the targetDocument argument is null

java.lang.IllegalArgumentException - if the targetDocument argument has already been closed

java.lang.IllegalArgumentException - if the targetDocument argument is read-only

java.lang.IllegalArgumentException - if the viewerSettings argument is not associated with an input document

java.lang.IllegalArgumentException - if the viewerSettings argument is null

java.lang.IllegalArgumentException - if the viewerSettings object has already been closed

java.io.IOException - Error reading from the stream

getPageDisplay

public PageDisplay getPageDisplay()

The positional arrangment for displaying pages when opening the document in a viewer. If null then the viewer acts according to it's default behavior.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setPageDisplay

public void setPageDisplay(PageDisplay value)

The positional arrangment for displaying pages when opening the document in a viewer. If null then the viewer acts according to it's default behavior.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getActivePane

public ViewerNavigationPane getActivePane()

The initially visible side pane when opening the document in a viewer. If null then the viewer acts according to it's default behavior.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setActivePane

public void setActivePane(ViewerNavigationPane value)

The initially visible side pane when opening the document in a viewer. If null then the viewer acts according to it's default behavior.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getFullScreen

public boolean getFullScreen()

If true then opening the document will make the viewer try to enter full screen mode.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setFullScreen

public void setFullScreen(boolean value)

If true then opening the document will make the viewer try to enter full screen mode.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getHideToolbar

public boolean getHideToolbar()

If true then opening the document will instruct the viewer to hide it's toolbar.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setHideToolbar

public void setHideToolbar(boolean value)

If true then opening the document will instruct the viewer to hide it's toolbar.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getHideMenubar

public boolean getHideMenubar()

If true then opening the document will instruct the viewer to hide it's menu bar.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setHideMenubar

public void setHideMenubar(boolean value)

If true then opening the document will instruct the viewer to hide it's menu bar.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only

getDisplayDocumentTitle

public boolean getDisplayDocumentTitle()

If true then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.

Throws:

java.lang.IllegalStateException - if the document has already been closed

setDisplayDocumentTitle

public void setDisplayDocumentTitle(boolean value)

If true then opening the document will instruct the viewer to display the document's title from the metadata instead of it's file name.

Throws:

java.lang.IllegalStateException - if the document has already been closed

java.lang.UnsupportedOperationException - if the document is read-only