Package com.compdfkit.core.annotation

Class CPDFLinkAnnotation

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.CPDFLinkAnnotation

public class CPDFLinkAnnotation
extends CPDFAnnotation

A link annotation represents an action to be performed.

Nested Class Summary

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.Flags, CPDFAnnotation.PSOAnnotationState, CPDFAnnotation.Type

Method Summary

Modifier and Type	Method	Description
void	close()	When the object is no longer in use, call this method to release resources.
CPDFDestination	getDestination(CPDFDocument document)	Gets link information of document.
CPDFAction	getLinkAction()	Gets the response action of the link annotation.
RectF	getRect()	Gets annotation rectangle.
boolean	setDestination(CPDFDocument document, CPDFDestination destination)	Sets link information of document.
boolean	setLinkAction(CPDFAction action)	Sets the response action of the link annotation.
boolean	setRect(RectF rect)	Sets annotation rectangle.
boolean	updateAp()	Updates annotation appearance.

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, createReplyAnnotation, createReplyStateAnnotation, getContent, getCreationDate, getFlags, getMainAnnotNM, getName, getRecentlyModifyDate, getReplies, getState, getTitle, getType, hasAp, isAllowCorrectAnnotationAp, isExitMainAnnot, isHidden, isLocked, isMarkedStateAnnot, isReplyAnnot, isReviewStateAnnot, isValid, removeFromPage, removeFromPageIncludeReplyAnnot, setAllowCorrectAnnotationAp, setContent, setCreationDate, setFlags, setHidden, setLocked, setMarkedAnnotState, setName, setRecentlyModifyDate, setReviewAnnotState, setState, setTitle

Methods inherited from class java.lang.Object

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

Method Details

setLinkAction

public boolean setLinkAction(CPDFAction action)

Sets the response action of the link annotation. There are multiple subtypes of the response action, and different response actions are determined according to CPDFAction.ActionType The action type can be obtained throughCPDFAction.getActionType(), more: CPDFAction

Parameters:

action - Response action of the link annotation.

Returns:

Returns whether to successfully set the response action of the link annotation.

getLinkAction

public CPDFAction getLinkAction()

Gets the response action of the link annotation. There are multiple subtypes of the response action, and different response actions are determined according to CPDFAction.ActionType The action type can be obtained throughCPDFAction.getActionType(), more: CPDFAction

Returns:

Returns the response action of the link annotation, more: CPDFAction

getDestination

public CPDFDestination getDestination(CPDFDocument document)

Gets link information of document.

Parameters:

document - This class is about CPDFDocument, one CPDFDocument class for one document.

Returns:

Returns link information of document.

See Also:

• CPDFDocument
• CPDFDestination

setDestination

public boolean setDestination(CPDFDocument document,
 CPDFDestination destination)

Sets link information of document.

Parameters:

document - This class is about CPDFDocument, one CPDFDocument class for one document.

destination - destination information.

Returns:

Whether to successfully set link information of document.

setRect

public boolean setRect(RectF rect)

Sets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Overrides:

setRect in class CPDFAnnotation

Parameters:

rect - Rectangle on the page.

Returns:

Returns whether to successfully set annotation rectangle.

getRect

public RectF getRect()

Gets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Overrides:

getRect in class CPDFAnnotation

Returns:

Returns rectangle on the page.

close

public void close()

When the object is no longer in use, call this method to release resources.

Overrides:

close in class CPDFAnnotation

updateAp

public boolean updateAp()

Updates annotation appearance. Call this function to update annotation appearance after modifying annotation attribute.

Returns:

Returns whether to successfully update annotation appearance.