public class PDFEmbeddedGotoActionTarget
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static PDFEmbeddedGotoActionTarget |
create(java.lang.String relationship,
java.lang.String fileName,
java.lang.String destName,
java.lang.String annotName,
int pageIndex,
int annotIndex)
Create a new target object.
|
int |
getAnnotIndex()
Get annotation index of current target.
|
java.lang.String |
getAnnotName()
Get annotation name of current target.
|
java.lang.String |
getDestName()
Get destination name of current target.
|
java.lang.String |
getFileName()
Get file name of current target.
|
long |
getHandle() |
PDFEmbeddedGotoActionTarget |
getNextTarget()
Get next target.
|
int |
getPageIndex()
Get page index of current target.
|
java.lang.String |
getRelationship()
Get relationship of current target.
|
void |
release()
Release all resources of current
PDFEmbeddedGotoActionTarget object. |
void |
setAnnotIndex(int annotIndex)
Set annotation index of current target.
|
void |
setAnnotName(java.lang.String annotName)
Set annotation name of current target.
|
void |
setDestName(java.lang.String destName)
Set destination name of current target.
|
void |
setFileName(java.lang.String fileName)
Set filename of current target.
|
void |
setNextTarget(PDFEmbeddedGotoActionTarget target)
Set next target of current target.
|
void |
setPageIndex(int pageIndex)
Set page index of current target.
|
void |
setRelationship(java.lang.String relationship)
Set relationship between current document and the target document.
|
public long getHandle()
public static PDFEmbeddedGotoActionTarget create(java.lang.String relationship, java.lang.String fileName, java.lang.String destName, java.lang.String annotName, int pageIndex, int annotIndex) throws PDFException
relationship
- Relationship between current document and the target document.fileName
- Name of the file in the EmbeddedFiles
name tree.
Please refer to section 3.6.3 in PDF Reference 1.7.destName
- A named destination in target document that provides the page index of the file attachment annotation.annotName
- Value of NM in the annotation dictionary.pageIndex
- Page index(zero-based) in target document containing the file attachment annotation.
It should use destname
when parameter pageindex
is -1.annotIndex
- Annotation index(zero-based) of the page specified by parameter pageindex
.
It should use annotname
when parameter annotindex
is -1.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public PDFEmbeddedGotoActionTarget getNextTarget() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setNextTarget(PDFEmbeddedGotoActionTarget target) throws PDFException
target
- The specified target to set.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public java.lang.String getRelationship() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setRelationship(java.lang.String relationship) throws PDFException
relationship
- Relationship between current document and the target document.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public java.lang.String getFileName() throws PDFException
EmbeddedFiles
name tree.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setFileName(java.lang.String fileName) throws PDFException
fileName
- The specified file name.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public java.lang.String getDestName() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setDestName(java.lang.String destName) throws PDFException
destName
- A named destination in target document that provides the page
index of the file attachment annotation.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public java.lang.String getAnnotName() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setAnnotName(java.lang.String annotName) throws PDFException
annotName
- Value of NM in the annotation dictionary.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public int getPageIndex() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setPageIndex(int pageIndex) throws PDFException
pageIndex
- Page index(zero-based) in target document containing the file attachment annotation.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public int getAnnotIndex() throws PDFException
PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void setAnnotIndex(int annotIndex) throws PDFException
annotIndex
- The current annotation index(zero-based).PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void release() throws PDFException
PDFEmbeddedGotoActionTarget
object.PDFException
- For more definitions please see definitions
PDFException.ERRCODE_XXX
.PDFException