Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo

Modifier and Type	Field and Description
public static final String	SUB_TYPE This type of action this object represents.

Access	Constructor and Description
public	PDActionRemoteGoTo() Default constructor.
public	PDActionRemoteGoTo(COSDictionary The action dictionary. a) Constructor.

Method Summary

Modifier and Type	Method and Description
public COSBase	Returns: The D entry of the specific remote go-to action dictionary. getD() This will get the destination to jump to.
public PDFileSpecification	Returns: The F entry of the specific remote go-to action dictionary. getFile() This will get the file in which the destination is located.
public OpenMode	Returns: A flag specifying how to open the destination document. getOpenInNewWindow() This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.
public void	setD(COSBase The destination. d) This will set the destination to jump to.
public void	setFile(PDFileSpecification The file specification. fs) This will set the file in which the destination is located.
public void	setOpenInNewWindow(OpenMode The flag value. value) This will specify whether to open the destination document in a new window.

Inherited from org.apache.pdfbox.pdmodel.interactive.action.PDAction:: getCOSObject getNext getSubType getType setNext setSubType setType

SUB_TYPE	back to summary
public static final String SUB_TYPE This type of action this object represents.

PDActionRemoteGoTo	back to summary
public PDActionRemoteGoTo() Default constructor.

PDActionRemoteGoTo	back to summary
public PDActionRemoteGoTo(COSDictionary a) Constructor. Parameters a:COSDictionary The action dictionary.

Method Detail

getD	back to summary
public COSBase getD() This will get the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0. Returns:COSBase The D entry of the specific remote go-to action dictionary.

getD

back to summary

public COSBase getD()

This will get the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.

Returns:COSBase: The D entry of the specific remote go-to action dictionary.

getFile	back to summary
public PDFileSpecification getFile() throws IOException This will get the file in which the destination is located. Returns:PDFileSpecification The F entry of the specific remote go-to action dictionary. Exceptions IOException: If there is an error creating the file spec.

getFile

back to summary

public PDFileSpecification getFile() throws IOException

This will get the file in which the destination is located.

Returns:PDFileSpecification

The F entry of the specific remote go-to action dictionary.

Exceptions

IOException:: If there is an error creating the file spec.

getOpenInNewWindow	back to summary
public OpenMode getOpenInNewWindow() This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference. Returns:OpenMode A flag specifying how to open the destination document.

getOpenInNewWindow

back to summary

public OpenMode getOpenInNewWindow()

This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.

Returns:OpenMode: A flag specifying how to open the destination document.

setD	back to summary
public void setD(COSBase d) This will set the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0. Parameters d:COSBase The destination.

setD

back to summary

public void setD(COSBase d)

This will set the destination to jump to. If the value is an array defining an explicit destination, its first element must be a page number within the remote document rather than an indirect reference to a page object in the current document. The first page is numbered 0.

Parameters

d:COSBase: The destination.

setFile	back to summary
public void setFile(PDFileSpecification fs) This will set the file in which the destination is located. Parameters fs:PDFileSpecification The file specification.

setFile

back to summary

public void setFile(PDFileSpecification fs)

This will set the file in which the destination is located.

Parameters

fs:PDFileSpecification: The file specification.

setOpenInNewWindow	back to summary
public void setOpenInNewWindow(OpenMode value) This will specify whether to open the destination document in a new window. Parameters value:OpenMode The flag value.

setOpenInNewWindow

back to summary

public void setOpenInNewWindow(OpenMode value)

This will specify whether to open the destination document in a new window.

Parameters

value:OpenMode: The flag value.

public Class PDActionRemoteGoTo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail