com.itextpdf.kernel.pdf.annot

Class PdfLinkAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfLinkAnnotation

All Implemented Interfaces:

Serializable

public class PdfLinkAnnotation
extends PdfAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PdfName	Invert
static PdfName	None Highlight modes.
static PdfName	Outline
static PdfName	Push

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Constructor and Description
PdfLinkAnnotation(PdfDictionary pdfObject)
PdfLinkAnnotation(Rectangle rect)

Method Summary

Modifier and Type	Method and Description
PdfObject	getDestinationObject()
PdfName	getHighlightMode()
PdfName	getSubtype() Gets a PdfName which value is a subtype of this annotation.
PdfDictionary	getUriActionObject()
PdfLinkAnnotation	removeAction()
PdfLinkAnnotation	removeDestination()
PdfLinkAnnotation	setAction(PdfAction action) Sets a PdfAction to this annotation which will be performed when the annotation is activated.
PdfLinkAnnotation	setAction(PdfDictionary action)
PdfLinkAnnotation	setDestination(PdfDestination destination)
PdfLinkAnnotation	setDestination(PdfObject destination)
PdfLinkAnnotation	setHighlightMode(PdfName hlMode)
PdfLinkAnnotation	setUriAction(PdfAction action)
PdfLinkAnnotation	setUriAction(PdfDictionary action)

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getBorderStyle, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setBorderStyle, setBorderStyle, setColor, setColor, setColor, setContents, setContents, setDashPattern, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setQuadPoints, setRectangle, setRolloverAppearance, setRolloverAppearance, setStructParentIndex, setTitle

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Field Detail

None

public static final PdfName None

Highlight modes.

Invert

public static final PdfName Invert

Outline

public static final PdfName Outline

Push

public static final PdfName Push

Constructor Detail

PdfLinkAnnotation

public PdfLinkAnnotation(PdfDictionary pdfObject)

PdfLinkAnnotation

public PdfLinkAnnotation(Rectangle rect)

Method Detail

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, “Annotation Types” for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

getDestinationObject

public PdfObject getDestinationObject()

setDestination

public PdfLinkAnnotation setDestination(PdfObject destination)

setDestination

public PdfLinkAnnotation setDestination(PdfDestination destination)

removeDestination

public PdfLinkAnnotation removeDestination()

setAction

public PdfLinkAnnotation setAction(PdfDictionary action)

setAction

public PdfLinkAnnotation setAction(PdfAction action)

Description copied from class: PdfAnnotation

Sets a PdfAction to this annotation which will be performed when the annotation is activated.

Overrides:

setAction in class PdfAnnotation

Parameters:

action - PdfAction to set to this annotation.

Returns:

this PdfAnnotation instance.

removeAction

public PdfLinkAnnotation removeAction()

getHighlightMode

public PdfName getHighlightMode()

setHighlightMode

public PdfLinkAnnotation setHighlightMode(PdfName hlMode)

getUriActionObject

public PdfDictionary getUriActionObject()

setUriAction

public PdfLinkAnnotation setUriAction(PdfDictionary action)

setUriAction

public PdfLinkAnnotation setUriAction(PdfAction action)