Class Phrase
java.lang.Object
java.util.AbstractCollection
java.util.AbstractList
java.util.ArrayList
com.gitlab.pdftk_java.com.lowagie.text.Phrase
- All Implemented Interfaces:
Element
,MarkupAttributes
,TextElementArray
,Serializable
,Cloneable
,Iterable
,Collection
,List
,RandomAccess
,SequencedCollection
A
Phrase
is a series of Chunk
s.
A Phrase
has a main Font
, but some chunks
within the phrase can have a Font
that differs from the
main Font
. All the Chunk
s in a Phrase
have the same leading
.
Example:
// When no parameters are passed, the default leading = 16 Phrase phrase0 = new Phrase(); Phrase phrase1 = new Phrase("this is a phrase"); // In this example the leading is passed as a parameter Phrase phrase2 = new Phrase(16, "this is a phrase with leading 16"); // When a Font is passed (explicitely or embedded in a chunk), the default leading = 1.5 * size of the font Phrase phrase3 = new Phrase("this is a phrase with a red, normal font Courier, size 12", FontFactory.getFont(FontFactory.COURIER, 12, Font.NORMAL, new Color(255, 0, 0))); Phrase phrase4 = new Phrase(new Chunk("this is a phrase")); Phrase phrase5 = new Phrase(18, new Chunk("this is a phrase", FontFactory.getFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Font
This is the font of this phrase.protected float
This is the leading of this phrase.protected Properties
Contains extra markupAttributesprivate static final long
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, ANCHOR, 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
ConstructorsModifierConstructorDescriptionPhrase()
Constructs aPhrase
without specifying a leading.private
Phrase
(boolean dummy) Constructs a Phrase that can be used in the static getInstance() method.Phrase
(float leading) Constructs aPhrase
with a certain leading.Constructs aPhrase
with a certainChunk
and a certain leading.Constructs aPhrase
with a certain leading and a certainString
.Constructs aPhrase
with a certain leading, a certainString
and a certainFont
.Constructs aPhrase
with a certainChunk
.Constructs aPhrase
with a certainString
.Constructs aPhrase
with a certainString
and a certainFont
.Phrase
(Properties attributes) Returns aPhrase
that has been constructed taking in account the value of some attributes. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aChunk
, anAnchor
or anotherPhrase
to thisPhrase
.boolean
Adds aChunk
,Anchor
or anotherPhrase
to thisPhrase
.boolean
addAll
(Collection collection) Adds a collection ofChunk
s to thisPhrase
.private boolean
Adds a Chunk.protected void
addSpecial
(Object object) Adds aObject
to theParagraph
.font()
Gets the font of the firstChunk
that appears in thisPhrase
.Gets all the chunks in this element.static final Phrase
getInstance
(int leading, String string) Gets a special kind of Phrase that changes some characters into corresponding symbols.static final Phrase
getInstance
(int leading, String string, Font font) Gets a special kind of Phrase that changes some characters into corresponding symbols.static final Phrase
getInstance
(String string) Gets a special kind of Phrase that changes some characters into corresponding symbols.getMarkupAttribute
(String name) Returns the value of the specified attribute.Returns aSet
ofString
attribute names for theMarkupAttributes
implementor.Return aProperties
-object containing all the markupAttributes.boolean
isEmpty()
Checks is thisPhrase
contains no or 1 emptyChunk
.static boolean
Checks if a given tag corresponds with this object.float
leading()
Gets the leading of this phrase.boolean
Checks you if the leading of this phrase is defined.boolean
process
(ElementListener listener) Processes the element by adding it (or the different parts) to anElementListener
.void
setLeading
(float leading) Sets the leading of this phrase.void
setMarkupAttribute
(String name, String value) Sets the specified attribute.void
setMarkupAttributes
(Properties markupAttributes) Sets the markupAttributes.int
type()
Gets the type of the text element.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 java.util.List
containsAll, reversed
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
leading
protected float leadingThis is the leading of this phrase. -
font
This is the font of this phrase. -
markupAttributes
Contains extra markupAttributes
-
-
Constructor Details
-
Phrase
private Phrase(boolean dummy) Constructs a Phrase that can be used in the static getInstance() method.- Parameters:
dummy
- a dummy parameter
-
Phrase
public Phrase()Constructs aPhrase
without specifying a leading. -
Phrase
public Phrase(float leading) Constructs aPhrase
with a certain leading.- Parameters:
leading
- the leading
-
Phrase
Constructs aPhrase
with a certainChunk
.- Parameters:
chunk
- aChunk
-
Phrase
Constructs aPhrase
with a certainChunk
and a certain leading.- Parameters:
leading
- the leadingchunk
- aChunk
-
Phrase
Constructs aPhrase
with a certainString
.- Parameters:
string
- aString
-
Phrase
Constructs aPhrase
with a certainString
and a certainFont
.- Parameters:
string
- aString
font
- aFont
-
Phrase
Constructs aPhrase
with a certain leading and a certainString
.- Parameters:
leading
- the leadingstring
- aString
-
Phrase
Constructs aPhrase
with a certain leading, a certainString
and a certainFont
.- Parameters:
leading
- the leadingstring
- aString
font
- aFont
-
Phrase
Returns aPhrase
that has been constructed taking in account the value of some attributes.- Parameters:
attributes
- Some attributes
-
-
Method Details
-
getInstance
Gets a special kind of Phrase that changes some characters into corresponding symbols.- Parameters:
string
-- Returns:
- a newly constructed Phrase
-
getInstance
Gets a special kind of Phrase that changes some characters into corresponding symbols.- Parameters:
leading
-string
-- Returns:
- a newly constructed Phrase
-
getInstance
Gets a special kind of Phrase that changes some characters into corresponding symbols.- Parameters:
leading
-string
-font
-- Returns:
- a newly constructed Phrase
-
process
Processes the element by adding it (or the different parts) to anElementListener
. -
type
public int type()Gets the type of the text element. -
getChunks
Gets all the chunks in this element. -
add
Adds aChunk
, anAnchor
or anotherPhrase
to thisPhrase
.- Specified by:
add
in interfaceList
- Overrides:
add
in classArrayList
- Parameters:
index
- index at which the specified element is to be insertedo
- an object of typeChunk
,Anchor
orPhrase
- Throws:
ClassCastException
- when you try to add something that isn't aChunk
,Anchor
orPhrase
-
add
Adds aChunk
,Anchor
or anotherPhrase
to thisPhrase
.- Specified by:
add
in interfaceCollection
- Specified by:
add
in interfaceList
- Specified by:
add
in interfaceTextElementArray
- Overrides:
add
in classArrayList
- Parameters:
o
- an object of typeChunk
,Anchor
orPhrase
- Returns:
- a boolean
- Throws:
ClassCastException
- when you try to add something that isn't aChunk
,Anchor
orPhrase
-
addChunk
Adds a Chunk.This method is a hack to solve a problem I had with phrases that were split between chunks in the wrong place.
- Parameters:
chunk
- a Chunk to add to the Phrase- Returns:
- true if adding the Chunk succeeded
-
addAll
Adds a collection ofChunk
s to thisPhrase
.- Specified by:
addAll
in interfaceCollection
- Specified by:
addAll
in interfaceList
- Overrides:
addAll
in classArrayList
- Parameters:
collection
- a collection ofChunk
s,Anchor
s andPhrase
s.- Returns:
true
if the action succeeded,false
if not.- Throws:
ClassCastException
- when you try to add something that isn't aChunk
,Anchor
orPhrase
-
addSpecial
Adds aObject
to theParagraph
.- Parameters:
object
- the object to add.
-
setLeading
public void setLeading(float leading) Sets the leading of this phrase.- Parameters:
leading
- the new leading
-
isEmpty
public boolean isEmpty()Checks is thisPhrase
contains no or 1 emptyChunk
. -
leadingDefined
public boolean leadingDefined()Checks you if the leading of this phrase is defined.- Returns:
- true if the leading is defined
-
leading
public float leading()Gets the leading of this phrase.- Returns:
- the linespacing
-
font
Gets the font of the firstChunk
that appears in thisPhrase
.- Returns:
- a
Font
-
isTag
Checks if a given tag corresponds with this object.- Parameters:
tag
- the given tag- Returns:
- true if the tag corresponds
-
setMarkupAttribute
Description copied from interface:MarkupAttributes
Sets the specified attribute.- Specified by:
setMarkupAttribute
in interfaceMarkupAttributes
- Parameters:
name
-String
attribute name.value
-String
attribute value.- See Also:
-
setMarkupAttributes
Description copied from interface:MarkupAttributes
Sets the markupAttributes.- Specified by:
setMarkupAttributes
in interfaceMarkupAttributes
- Parameters:
markupAttributes
- aProperties
-object containing markupattributes- See Also:
-
getMarkupAttribute
Description copied from interface:MarkupAttributes
Returns the value of the specified attribute.- Specified by:
getMarkupAttribute
in interfaceMarkupAttributes
- Parameters:
name
-String
attribute name.- Returns:
String
.- See Also:
-
getMarkupAttributeNames
Description copied from interface:MarkupAttributes
Returns aSet
ofString
attribute names for theMarkupAttributes
implementor.- Specified by:
getMarkupAttributeNames
in interfaceMarkupAttributes
- Returns:
Set
.- See Also:
-
getMarkupAttributes
Description copied from interface:MarkupAttributes
Return aProperties
-object containing all the markupAttributes.- Specified by:
getMarkupAttributes
in interfaceMarkupAttributes
- Returns:
Properties
- See Also:
-