Class Link

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<Text>

com.itextpdf.layout.element.AbstractElement<Text>

com.itextpdf.layout.element.Text

com.itextpdf.layout.element.Link

All Implemented Interfaces:

IAbstractElement, IElement, ILeafElement, IPropertyContainer, IAccessibleElement

public class Link
extends Text

A clickable piece of Text which contains a link annotation dictionary. The concept is largely similar to that of the HTML anchor tag.

Field Summary

Fields inherited from class Text

tagProperties, text

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
Link(String text, PdfAction action)	Creates a Link which can execute an action.
Link(String text, PdfLinkAnnotation linkAnnotation)	Creates a Link with a fully constructed link annotation dictionary.
Link(String text, PdfDestination destination)	Creates a Link to another location in the document.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
PdfLinkAnnotation	getLinkAnnotation()	Gets the link annotation dictionary associated with this link.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.

Methods inherited from class Text

disableOtfFeatures, getHorizontalScaling, getText, getTextRise, setHorizontalScaling, setNeutralRole, setSkew, setText, setTextRise

Methods inherited from class AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class Object

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

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Details

Link

public Link(String text,
 PdfLinkAnnotation linkAnnotation)

Creates a Link with a fully constructed link annotation dictionary.

Parameters:

text - the textual contents of the link

linkAnnotation - a PdfLinkAnnotation

Link

public Link(String text,
 PdfAction action)

Creates a Link which can execute an action.

Parameters:

text - the textual contents of the link

action - a PdfAction

Link

public Link(String text,
 PdfDestination destination)

Creates a Link to another location in the document.

Parameters:

text - the textual contents of the link

destination - a PdfDestination

Method Details

getLinkAnnotation

public PdfLinkAnnotation getLinkAnnotation()

Gets the link annotation dictionary associated with this link.

Returns:

a PdfLinkAnnotation

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Description copied from interface: IAccessibleElement

Gets the accessibility properties. See also IAccessibleElement.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

Overrides:

getAccessibilityProperties in class Text

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

protected IRenderer makeNewRenderer()

Description copied from class: AbstractElement

Creates a new renderer instance.

Overrides:

makeNewRenderer in class Text

Returns:

new IRenderer