Package com.itextpdf.text

Class Anchor

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Element>

com.itextpdf.text.Phrase

com.itextpdf.text.Anchor

All Implemented Interfaces:

Element, TextElementArray, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Element>, java.util.Collection<Element>, java.util.List<Element>, java.util.RandomAccess

public class Anchor
extends Phrase

An Anchor can be a reference or a destination of a reference.

An Anchor is a special kind of Phrase. It is constructed in the same way.

Example:

 Anchor anchor = new Anchor("this is a link");
 anchor.setName("LINK");
 anchor.setReference("http://www.lowagie.com");
 

See Also:

Element, Phrase, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	name	This is the name of the Anchor.
protected java.lang.String	reference	This is the reference of the Anchor.
private static long	serialVersionUID

Fields inherited from class com.itextpdf.text.Phrase

font, hyphenation, leading, multipliedLeading, tabSettings

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.itextpdf.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, BODY, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CHAPTER, CHUNK, CREATIONDATE, CREATOR, DIV, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LANGUAGE, LIST, LISTITEM, MARKED, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, SECTION, SUBJECT, TITLE, WRITABLE_DIRECT, YMARK

Constructor Summary

Constructors

Constructor	Description
Anchor()	Constructs an Anchor without specifying a leading.
Anchor(float leading)	Constructs an Anchor with a certain leading.
Anchor(float leading, Chunk chunk)	Constructs an Anchor with a certain Chunk and a certain leading.
Anchor(float leading, java.lang.String string)	Constructs an Anchor with a certain leading and a certain String.
Anchor(float leading, java.lang.String string, Font font)	Constructs an Anchor with a certain leading, a certain String and a certain Font.
Anchor(Chunk chunk)	Constructs an Anchor with a certain Chunk.
Anchor(Phrase phrase)	Constructs an Anchor with a certain Phrase.
Anchor(java.lang.String string)	Constructs an Anchor with a certain String.
Anchor(java.lang.String string, Font font)	Constructs an Anchor with a certain String and a certain Font.

Method Summary

Modifier and Type	Method	Description
protected boolean	applyAnchor(Chunk chunk, boolean notGotoOK, boolean localDestination)	Applies the properties of the Anchor to a Chunk.
java.util.List<Chunk>	getChunks()	Gets all the chunks in this element.
java.lang.String	getName()	Returns the name of this Anchor.
java.lang.String	getReference()	Gets the reference of this Anchor.
java.net.URL	getUrl()	Gets the reference of this Anchor.
boolean	process(ElementListener listener)	Processes the element by adding it (or the different parts) to an ElementListener.
void	setName(java.lang.String name)	Sets the name of this Anchor.
void	setReference(java.lang.String reference)	Sets the reference of this Anchor.
int	type()	Gets the type of the text element.

Methods inherited from class com.itextpdf.text.Phrase

add, add, add, addAll, addChunk, addSpecial, getContent, getFont, getHyphenation, getInstance, getInstance, getInstance, getLeading, getMultipliedLeading, getTabSettings, getTotalLeading, hasLeading, isContent, isEmpty, isNestable, setFont, setHyphenation, setLeading, setLeading, setMultipliedLeading, setTabSettings, trim

Methods inherited from class java.util.ArrayList

addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface com.itextpdf.text.Element

toString

Methods inherited from interface java.util.List

containsAll

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

name

protected java.lang.String name

This is the name of the Anchor.

reference

protected java.lang.String reference

This is the reference of the Anchor.

Constructor Detail

Anchor

public Anchor()

Constructs an Anchor without specifying a leading.

Anchor

public Anchor(float leading)

Constructs an Anchor with a certain leading.

Parameters:

leading - the leading

Anchor

public Anchor(Chunk chunk)

Constructs an Anchor with a certain Chunk.

Parameters:

chunk - a Chunk

Anchor

public Anchor(java.lang.String string)

Constructs an Anchor with a certain String.

Parameters:

string - a String

Anchor

public Anchor(java.lang.String string,
              Font font)

Constructs an Anchor with a certain String and a certain Font.

Parameters:

string - a String

font - a Font

Anchor

public Anchor(float leading,
              Chunk chunk)

Constructs an Anchor with a certain Chunk and a certain leading.

Parameters:

leading - the leading

chunk - a Chunk

Anchor

public Anchor(float leading,
              java.lang.String string)

Constructs an Anchor with a certain leading and a certain String.

Parameters:

leading - the leading

string - a String

Anchor

public Anchor(float leading,
              java.lang.String string,
              Font font)

Constructs an Anchor with a certain leading, a certain String and a certain Font.

Parameters:

leading - the leading

string - a String

font - a Font

Anchor

public Anchor(Phrase phrase)

Constructs an Anchor with a certain Phrase.

Parameters:

phrase - a Phrase

Method Detail

process

public boolean process(ElementListener listener)

Processes the element by adding it (or the different parts) to an ElementListener.

Specified by:

process in interface Element

Overrides:

process in class Phrase

Parameters:

listener - an ElementListener

Returns:

true if the element was processed successfully

getChunks

public java.util.List<Chunk> getChunks()

Gets all the chunks in this element.

Specified by:

getChunks in interface Element

Overrides:

getChunks in class Phrase

Returns:

an ArrayList

applyAnchor

protected boolean applyAnchor(Chunk chunk,
                              boolean notGotoOK,
                              boolean localDestination)

Applies the properties of the Anchor to a Chunk.

Parameters:

chunk - the Chunk (part of the Anchor)

notGotoOK - if true, this chunk will determine the local destination

localDestination - true if the chunk is a local goto and the reference a local destination

Returns:

the value of notGotoOK or false, if a previous Chunk was used to determine the local destination

type

public int type()

Gets the type of the text element.

Specified by:

type in interface Element

Overrides:

type in class Phrase

Returns:

a type

setName

public void setName(java.lang.String name)

Sets the name of this Anchor.

Parameters:

name - a new name

setReference

public void setReference(java.lang.String reference)

Sets the reference of this Anchor.

Parameters:

reference - a new reference

getName

public java.lang.String getName()

Returns the name of this Anchor.

Returns:

a name

getReference

public java.lang.String getReference()

Gets the reference of this Anchor.

Returns:

a reference

getUrl

public java.net.URL getUrl()

Gets the reference of this Anchor.

Returns:

an URL