Package com.gitlab.pdftk_java.com.lowagie.text

Class Anchor

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList

com.gitlab.pdftk_java.com.lowagie.text.Phrase

com.gitlab.pdftk_java.com.lowagie.text.Anchor

All Implemented Interfaces:

Element, MarkupAttributes, TextElementArray, Serializable, Cloneable, Iterable, Collection, List, RandomAccess

public class Anchor
extends Phrase
implements TextElementArray, MarkupAttributes

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
static String	ANCHOR	This is the anchor tag.
protected String	name	This is the name of the Anchor.
protected String	reference	This is the reference of the Anchor.

Fields inherited from class com.gitlab.pdftk_java.com.lowagie.text.Phrase

font, leading, markupAttributes

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.gitlab.pdftk_java.com.lowagie.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

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, String string)	Constructs an Anchor with a certain leading and a certain String.
Anchor(float leading, 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(String string)	Constructs an Anchor with a certain String.
Anchor(String string, Font font)	Constructs an Anchor with a certain String and a certain Font.
Anchor(Properties attributes)	Returns an Anchor that has been constructed taking in account the value of some attributes.

Method Summary

Modifier and Type	Method	Description
ArrayList	getChunks()	Gets all the chunks in this element.
Iterator	getElements()	Gets an iterator of Elements.
static boolean	isTag(String tag)	Checks if a given tag corresponds with this object.
String	name()	Returns the name of this Anchor.
boolean	process(ElementListener listener)	Processes the element by adding it (or the different parts) to an ElementListener.
String	reference()	Gets the reference of this Anchor.
void	setName(String name)	Sets the name of this Anchor.
void	setReference(String reference)	Sets the reference of this Anchor.
int	type()	Gets the type of the text element.
URL	url()	Gets the reference of this Anchor.

Methods inherited from class com.gitlab.pdftk_java.com.lowagie.text.Phrase

add, add, addAll, addSpecial, font, getInstance, getInstance, getInstance, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, isEmpty, leading, leadingDefined, setLeading, setMarkupAttribute, setMarkupAttributes

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.gitlab.pdftk_java.com.lowagie.text.Element

toString

Methods inherited from interface java.util.List

containsAll

Methods inherited from interface com.gitlab.pdftk_java.com.lowagie.text.MarkupAttributes

getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, setMarkupAttribute, setMarkupAttributes

Methods inherited from interface com.gitlab.pdftk_java.com.lowagie.text.TextElementArray

add

Field Detail

ANCHOR

public static final String ANCHOR

This is the anchor tag.

See Also:

Constant Field Values

name

protected String name

This is the name of the Anchor.

reference

protected 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(String string)

Constructs an Anchor with a certain String.

Parameters:

string - a String

Anchor

public Anchor(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,
              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,
              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(Properties attributes)

Returns an Anchor that has been constructed taking in account the value of some attributes.

Parameters:

attributes - Some attributes

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

Gets all the chunks in this element.

Specified by:

getChunks in interface Element

Overrides:

getChunks in class Phrase

Returns:

an ArrayList

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

getElements

public Iterator getElements()

Gets an iterator of Elements.

Returns:

an Iterator

setName

public void setName(String name)

Sets the name of this Anchor.

Parameters:

name - a new name

setReference

public void setReference(String reference)

Sets the reference of this Anchor.

Parameters:

reference - a new reference

name

public String name()

Returns the name of this Anchor.

Returns:

a name

reference

public String reference()

Gets the reference of this Anchor.

Returns:

a reference

url

public URL url()

Gets the reference of this Anchor.

Returns:

an URL

isTag

public static boolean isTag(String tag)

Checks if a given tag corresponds with this object.

Parameters:

tag - the given tag

Returns:

true if the tag corresponds