Module com.github.librepdf.openpdf

Package org.openpdf.text

Class Footnote

java.lang.Object

java.util.AbstractCollection<Element>

java.util.AbstractList<Element>

java.util.ArrayList<Element>

org.openpdf.text.Phrase

org.openpdf.text.Footnote

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Element>, Collection<Element>, List<Element>, RandomAccess, SequencedCollection<Element>, Element, TextElementArray

public class Footnote
extends Phrase

A Footnote is a little note that can be added at the bottom of a page.

See Also:

• Element
• Anchor
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT	This is a possible attribute.
static final String	DESTINATION	This is a possible attribute.
static final String	FONT	This is a possible attribute.
protected HashMap	footnoteAttributes	This is the title of the Annotation.
protected int	footnoteType	This is the type of footnote.
static final String	NAMED	This is a possible attribute.
static final String	PAGE	This is a possible attribute.
static final int	TEXT	This is a possible footnote type.

Fields inherited from class org.openpdf.text.Phrase

font, hyphenation, leading

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.openpdf.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, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK

Constructor Summary

Constructors

Constructor	Description
Footnote()
Footnote(String text)
Footnote(String text, Font font)
Footnote(Chunk chunk)

Method Summary

Modifier and Type	Method	Description
int	footnoteType()	Returns the type of this Annotation.
int	type()	Gets the type of the text element.

Methods inherited from class org.openpdf.text.Phrase

add, add, add, addAll, addChunk, addSpecial, getChunks, getContent, getFont, getHyphenation, getInstance, getInstance, getInstance, getLeading, hasLeading, isContent, isEmpty, isNestable, process, setFont, setHyphenation, setLeading

Methods inherited from class java.util.ArrayList

addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, 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 org.openpdf.text.Element

toString

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

TEXT

public static final int TEXT

This is a possible footnote type.

See Also:

• Constant Field Values

CONTENT

public static final String CONTENT

This is a possible attribute.

See Also:

• Constant Field Values

FONT

public static final String FONT

This is a possible attribute.

See Also:

• Constant Field Values

DESTINATION

public static final String DESTINATION

This is a possible attribute.

See Also:

• Constant Field Values

PAGE

public static final String PAGE

This is a possible attribute.

See Also:

• Constant Field Values

NAMED

public static final String NAMED

This is a possible attribute.

See Also:

• Constant Field Values

footnoteType

protected int footnoteType

This is the type of footnote.

footnoteAttributes

protected HashMap footnoteAttributes

This is the title of the Annotation.

Constructor Details

Footnote

public Footnote()

Footnote

public Footnote(Chunk chunk)

Footnote

public Footnote(String text,
 Font font)

Footnote

public Footnote(String text)

Method Details

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

footnoteType

public int footnoteType()

Returns the type of this Annotation.

Returns:

a type