com.qoppa.pdf.actions

Class GotoPageRemoteAction

java.lang.Object

com.qoppa.pdf.actions.Action

com.qoppa.pdf.actions.GotoPageRemoteAction

public class GotoPageRemoteAction
extends Action

Action that tells the viewer to go to a page in a different PDF document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_TYPE_DESCRIPTION

Fields inherited from class com.qoppa.pdf.actions.Action

OPEN_EXISTING_WINDOW, OPEN_NEW_WINDOW, OPEN_USER_PREFERENCE

Constructor Summary

Constructors

Constructor and Description
GotoPageRemoteAction(String fileName, int pageNumber) Constructs the action with a target document and a page number.
GotoPageRemoteAction(String fileName, int pageNumber, int zoomMode) Constructs an action to go to another PDF document, with an option for the zoom mode.
GotoPageRemoteAction(String fileName, String destinationName) Constructs an action to go to another PDF document with a named destination.

Method Summary

Modifier and Type	Method and Description
String	getActionType() Returns the action type.
String	getActionTypeDesc() Returns the action type description
String	getDestinationName() Returns the destination name associated with this action, or null if there isn't one.
String	getFileName() Gets the target document file name in the PDF file specification format.
int	getNewWindow() A flag specifying whether to open the destination document in a new window.
int	getPageNumber() Gets the target page number.
int	getZoomMode() Returns the zoom mode.
boolean	isNewWindow() Deprecated. Use getNewWindow()
void	setDestinationName(String destinationName) Set the destination name this action should go to
void	setNewWindow(boolean newWindow) Deprecated. Use setNewWindow(int)
void	setNewWindow(int newWindow) A flag specifying whether to open the destination document in a new window.
void	setZoomMode(int zoomMode) Sets the zoom mode.
String	toString() Returns the description of the action.

Methods inherited from class com.qoppa.pdf.actions.Action

getNextAction, setNextAction

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACTION_TYPE_DESCRIPTION

public static String ACTION_TYPE_DESCRIPTION

Constructor Detail

GotoPageRemoteAction

public GotoPageRemoteAction(String fileName,
                            int pageNumber)

Constructs the action with a target document and a page number.

Parameters:

fileName - The name of the file to launch following the PDF file specification format.

• /r/pdfdocs/spec.pdf for OS path name r:\pdfdocs\spec.pdf
• //pdfdocs/spec.pdf for OS path name \pdfdocs\spec.pdf
• any path not starting with / is a path relative to the PDF document file path

pageNumber - The target page.

GotoPageRemoteAction

public GotoPageRemoteAction(String fileName,
                            int pageNumber,
                            int zoomMode)

Constructs an action to go to another PDF document, with an option for the zoom mode.

Parameters:

fileName - The name of the file to launch following the PDF file specification format.

pageNumber - The target page.

zoomMode - The zoom mode. This can be one of the pre-defined values in the GotoPageAction class: ZOOM_FIT, ZOOM_FIT_HORIZONTAL, ZOOM_FIT_VERTICAL, ZOOM_EXPLICIT, ZOOM_RETAIN

GotoPageRemoteAction

public GotoPageRemoteAction(String fileName,
                            String destinationName)

Constructs an action to go to another PDF document with a named destination.

Parameters:

fileName - The name of the file to launch following the PDF file specification format.

destinationName - String representing the named destination from the document this action should use

Method Detail

getPageNumber

public int getPageNumber()

Gets the target page number.

Returns:

The target page number.

getFileName

public String getFileName()

Gets the target document file name in the PDF file specification format.

Returns:

The target document file name.

getActionType

public String getActionType()

Returns the action type.

Specified by:

getActionType in class Action

Returns:

The action type.

getActionTypeDesc

public String getActionTypeDesc()

Returns the action type description

Specified by:

getActionTypeDesc in class Action

toString

public String toString()

Returns the description of the action.

Overrides:

toString in class Object

getZoomMode

public int getZoomMode()

Returns the zoom mode. The mode tells the viewer how to set the scale after setting the target page. There are values to tell the viewer to fit to width, fit to height, etc.

Returns:

The value of the zoom mode, one of the predefined constants in this class (ZOOM_*)

setZoomMode

public void setZoomMode(int zoomMode)

Sets the zoom mode. The mode tells the viewer how to set the scale after setting the target page. The calling application should use one of the predefined constants in this class: ZOOM_FIT, ZOOM_RETAIN, etc.

Parameters:

zoomMode - The new value of the zoom mode.

setNewWindow

public void setNewWindow(boolean newWindow)

Deprecated. Use setNewWindow(int)

A flag specifying whether to open the destination document in a new window. If this flag is false, the destination document replaces the current document in the same window.

Parameters:

newWindow -

isNewWindow

public boolean isNewWindow()

Deprecated. Use getNewWindow()

A flag specifying whether to open the destination document in a new window. If this flag is false, the destination document replaces the current document in the same window.

Returns:

The value of the new window flag.

setNewWindow

public void setNewWindow(int newWindow)

A flag specifying whether to open the destination document in a new window. The document can be opened in a new window, replace the current document in the same window, or behave in accordance with the current user preference.

Parameters:

newWindow - The value of the new window flag. One of Action.OPEN_EXISTING_WINDOW, Action.OPEN_NEW_WINDOW, Action.OPEN_USER_PREFERENCE.

getNewWindow

public int getNewWindow()

A flag specifying whether to open the destination document in a new window. The document can be opened in a new window, replace the current document in the same window, or behave in accordance with the current user preference.

Returns:

The value of the new window flag. One of Action.OPEN_EXISTING_WINDOW, Action.OPEN_NEW_WINDOW, Action.OPEN_USER_PREFERENCE.

setDestinationName

public void setDestinationName(String destinationName)

Set the destination name this action should go to

Parameters:

destinationName - name of the destination for this goto action

getDestinationName

public String getDestinationName()

Returns the destination name associated with this action, or null if there isn't one.

Returns:

The name of the destination