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
AnAnchor
can be a reference or a destination of a reference.An
Anchor
is a special kind ofPhrase
. 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 theAnchor
.protected java.lang.String
reference
This is the reference of theAnchor
.private static long
serialVersionUID
-
Fields inherited from class com.itextpdf.text.Phrase
font, hyphenation, leading, multipliedLeading, tabSettings
-
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 anAnchor
without specifying a leading.Anchor(float leading)
Constructs anAnchor
with a certain leading.Anchor(float leading, Chunk chunk)
Constructs anAnchor
with a certainChunk
and a certain leading.Anchor(float leading, java.lang.String string)
Constructs anAnchor
with a certain leading and a certainString
.Anchor(float leading, java.lang.String string, Font font)
Constructs anAnchor
with a certain leading, a certainString
and a certainFont
.Anchor(Chunk chunk)
Constructs anAnchor
with a certainChunk
.Anchor(Phrase phrase)
Constructs anAnchor
with a certainPhrase
.Anchor(java.lang.String string)
Constructs anAnchor
with a certainString
.Anchor(java.lang.String string, Font font)
Constructs anAnchor
with a certainString
and a certainFont
.
-
Method Summary
All Methods Instance Methods Concrete Methods 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 thisAnchor
.java.lang.String
getReference()
Gets the reference of thisAnchor
.java.net.URL
getUrl()
Gets the reference of thisAnchor
.boolean
process(ElementListener listener)
Processes the element by adding it (or the different parts) to anElementListener
.void
setName(java.lang.String name)
Sets the name of thisAnchor
.void
setReference(java.lang.String reference)
Sets the reference of thisAnchor
.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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
name
protected java.lang.String name
This is the name of theAnchor
.
-
reference
protected java.lang.String reference
This is the reference of theAnchor
.
-
-
Constructor Detail
-
Anchor
public Anchor()
Constructs anAnchor
without specifying a leading.
-
Anchor
public Anchor(float leading)
Constructs anAnchor
with a certain leading.- Parameters:
leading
- the leading
-
Anchor
public Anchor(Chunk chunk)
Constructs anAnchor
with a certainChunk
.- Parameters:
chunk
- aChunk
-
Anchor
public Anchor(java.lang.String string)
Constructs anAnchor
with a certainString
.- Parameters:
string
- aString
-
Anchor
public Anchor(java.lang.String string, Font font)
Constructs anAnchor
with a certainString
and a certainFont
.- Parameters:
string
- aString
font
- aFont
-
Anchor
public Anchor(float leading, Chunk chunk)
Constructs anAnchor
with a certainChunk
and a certain leading.- Parameters:
leading
- the leadingchunk
- aChunk
-
Anchor
public Anchor(float leading, java.lang.String string)
Constructs anAnchor
with a certain leading and a certainString
.- Parameters:
leading
- the leadingstring
- aString
-
Anchor
public Anchor(float leading, java.lang.String string, Font font)
Constructs anAnchor
with a certain leading, a certainString
and a certainFont
.- Parameters:
leading
- the leadingstring
- aString
font
- aFont
-
Anchor
public Anchor(Phrase phrase)
Constructs anAnchor
with a certainPhrase
.- Parameters:
phrase
- aPhrase
-
-
Method Detail
-
process
public boolean process(ElementListener listener)
Processes the element by adding it (or the different parts) to anElementListener
.
-
getChunks
public java.util.List<Chunk> getChunks()
Gets all the chunks in this element.
-
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 destinationlocalDestination
- 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.
-
setName
public void setName(java.lang.String name)
Sets the name of thisAnchor
.- Parameters:
name
- a new name
-
setReference
public void setReference(java.lang.String reference)
Sets the reference of thisAnchor
.- Parameters:
reference
- a new reference
-
getName
public java.lang.String getName()
Returns the name of thisAnchor
.- Returns:
- a name
-
getReference
public java.lang.String getReference()
Gets the reference of thisAnchor
.- Returns:
- a reference
-
getUrl
public java.net.URL getUrl()
Gets the reference of thisAnchor
.- Returns:
- an
URL
-
-