com.lowagie.text
public class Phrase extends ArrayList implements TextElementArray
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)));
Field Summary | |
---|---|
protected Font | font This is the font of this phrase. |
protected float | leading This is the leading of this phrase. |
protected Properties | markupAttributes Contains extra markupAttributes |
static long | serialVersionUID |
Constructor Summary | |
---|---|
Phrase(boolean dummy)
Constructs a Phrase that can be used in the static getInstance() method. | |
Phrase()
Constructs a Phrase without specifying a leading. | |
Phrase(float leading)
Constructs a Phrase with a certain leading.
| |
Phrase(Chunk chunk)
Constructs a Phrase with a certain Chunk .
| |
Phrase(float leading, Chunk chunk)
Constructs a Phrase with a certain Chunk
and a certain leading.
| |
Phrase(String string)
Constructs a Phrase with a certain String .
| |
Phrase(String string, Font font)
Constructs a Phrase with a certain String and a certain Font .
| |
Phrase(float leading, String string)
Constructs a Phrase with a certain leading and a certain String .
| |
Phrase(float leading, String string, Font font)
Constructs a Phrase with a certain leading, a certain String
and a certain Font .
| |
Phrase(Properties attributes)
Returns a Phrase that has been constructed taking in account
the value of some attributes.
|
Method Summary | |
---|---|
void | add(int index, Object o)
Adds a Chunk , an Anchor or another Phrase
to this Phrase .
|
boolean | add(Object o)
Adds a Chunk , Anchor or another Phrase
to this Phrase .
|
boolean | addAll(Collection collection)
Adds a collection of Chunk s
to this Phrase .
|
boolean | addChunk(Chunk chunk)
Adds a Chunk.
|
protected void | addSpecial(Object object)
Adds a Object to the Paragraph .
|
String | content()
Returns the content as a String object.
|
Font | font()
Gets the font of the first Chunk that appears in this Phrase .
|
ArrayList | getChunks()
Gets all the chunks in this element.
|
static Phrase | getInstance(String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols. |
static Phrase | getInstance(int leading, String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols. |
static Phrase | getInstance(int leading, String string, Font font)
Gets a special kind of Phrase that changes some characters into corresponding symbols. |
boolean | isEmpty()
Checks is this Phrase contains no or 1 empty Chunk .
|
static boolean | isTag(String tag)
Checks if a given tag corresponds with this object.
|
float | leading()
Gets the leading of this phrase.
|
boolean | leadingDefined()
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 an
ElementListener .
|
void | setLeading(float leading)
Sets the leading of this phrase.
|
int | type()
Gets the type of the text element.
|
Parameters: dummy a dummy parameter
Phrase
without specifying a leading.Phrase
with a certain leading.
Parameters: leading the leading
Phrase
with a certain Chunk
.
Parameters: chunk a Chunk
Phrase
with a certain Chunk
and a certain leading.
Parameters: leading the leading chunk a Chunk
Phrase
with a certain String
.
Parameters: string a String
Phrase
with a certain String
and a certain Font
.
Parameters: string a String
font a Font
Phrase
with a certain leading and a certain String
.
Parameters: leading the leading string a String
Phrase
with a certain leading, a certain String
and a certain Font
.
Parameters: leading the leading string a String
font a Font
Phrase
that has been constructed taking in account
the value of some attributes.
Parameters: attributes Some attributes
Chunk
, an Anchor
or another Phrase
to this Phrase
.
Parameters: index index at which the specified element is to be inserted o an object of type Chunk
, Anchor
or Phrase
Throws: ClassCastException when you try to add something that isn't a Chunk
, Anchor
or Phrase
Chunk
, Anchor
or another Phrase
to this Phrase
.
Parameters: o an object of type Chunk
, Anchor
or Phrase
Returns: a boolean
Throws: ClassCastException when you try to add something that isn't a Chunk
, Anchor
or Phrase
Chunk
s
to this Phrase
.
Parameters: collection a collection of Chunk
s, Anchor
s and Phrase
s.
Returns: true
if the action succeeded, false
if not.
Throws: ClassCastException when you try to add something that isn't a Chunk
, Anchor
or Phrase
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
Object
to the Paragraph
.
Parameters: object the object to add.
Chunk
that appears in this Phrase
.
Returns: a Font
Returns: an ArrayList
Parameters: string
Returns: a newly constructed Phrase
Parameters: leading string
Returns: a newly constructed Phrase
Parameters: leading string font
Returns: a newly constructed Phrase
Phrase
contains no or 1 empty Chunk
.
Returns: false
if the Phrase
contains more than one or more non-emptyChunk
s.
Parameters: tag the given tag
Returns: true if the tag corresponds
Returns: the linespacing
Returns: true if the leading is defined
ElementListener
.
Parameters: listener an ElementListener
Returns: true
if the element was processed successfully
Parameters: leading the new leading
Returns: a type