com.itextpdf.layout.element

Class Link

java.lang.Object

com.itextpdf.layout.ElementPropertyContainer<T>

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

com.itextpdf.layout.element.Text

com.itextpdf.layout.element.Link

All Implemented Interfaces:

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 com.itextpdf.layout.element.Text

tagProperties, text

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.itextpdf.layout.element.Text

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

Methods inherited from class com.itextpdf.layout.element.AbstractElement

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

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

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

Constructor Detail

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 Detail

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()

Overrides:

makeNewRenderer in class Text