Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.lowagie.text

Class Phrase

Implemented Interfaces:
Element, MarkupAttributes, TextElementArray
Known Direct Subclasses:
Anchor, Paragraph
public class Phrase
extends ArrayList
implements TextElementArray, MarkupAttributes
A Phrase is a series of Chunks.

A Phrase has a main Font, but some chunks within the phrase can have a Font that differs from the main Font. All the Chunks 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:
Element, Chunk, Paragraph, Anchor

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
private static long
serialVersionUID

Fields inherited from interface 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, CCITTG3_1D, CCITTG3_2D, CCITTG4, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, 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

Phrase()
Constructs a Phrase without specifying a leading.
Phrase(Properties attributes)
Returns a Phrase that has been constructed taking in account the value of some attributes.
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(boolean dummy)
Constructs a Phrase that can be used in the static getInstance() method.
Phrase(Chunk chunk)
Constructs a Phrase with a certain Chunk.
Phrase(float leading)
Constructs a Phrase with a certain leading.
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(float leading, Chunk chunk)
Constructs a Phrase with a certain Chunk and a certain leading.

Method Summary

boolean
add(Object o)
Adds a Chunk, Anchor or another Phrase to this Phrase.
void
add(int index, Object o)
Adds a Chunk, an Anchor or another Phrase to this Phrase.
boolean
addAll(Collection collection)
Adds a collection of Chunks to this Phrase.
private 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.
String
getMarkupAttribute(String name)
Set
getMarkupAttributeNames()
Properties
getMarkupAttributes()
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.
void
setMarkupAttribute(String name, String value)
void
setMarkupAttributes(Properties markupAttributes)
int
type()
Gets the type of the text element.

Field Details

font

protected Font font
This is the font of this phrase.

leading

protected float leading
This is the leading of this phrase.

markupAttributes

protected Properties markupAttributes
Contains extra markupAttributes

serialVersionUID

private static final long serialVersionUID
Field Value:
2643594602455068231L

Constructor Details

Phrase

public Phrase()
Constructs a Phrase without specifying a leading.

Phrase

public Phrase(Properties attributes)
Returns a Phrase that has been constructed taking in account the value of some attributes.
Parameters:
attributes - Some attributes

Phrase

public Phrase(String string)
Constructs a Phrase with a certain String.
Parameters:
string - a String

Phrase

public Phrase(String string,
              Font font)
Constructs a Phrase with a certain String and a certain Font.
Parameters:
string - a String
font - a Font

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(Chunk chunk)
Constructs a Phrase with a certain Chunk.
Parameters:
chunk - a Chunk

Phrase

public Phrase(float leading)
Constructs a Phrase with a certain leading.
Parameters:
leading - the leading

Phrase

public Phrase(float leading,
              String string)
Constructs a Phrase with a certain leading and a certain String.
Parameters:
leading - the leading
string - a String

Phrase

public Phrase(float leading,
              String string,
              Font font)
Constructs a Phrase with a certain leading, a certain String and a certain Font.
Parameters:
leading - the leading
string - a String
font - a Font

Phrase

public Phrase(float leading,
              Chunk chunk)
Constructs a Phrase with a certain Chunk and a certain leading.
Parameters:
leading - the leading
chunk - a Chunk

Method Details

add

public boolean add(Object o)
Adds a Chunk, Anchor or another Phrase to this Phrase.
Specified by:
add in interface TextElementArray
Parameters:
o - an object of type Chunk, Anchor or Phrase
Returns:
a boolean

add

public void add(int index,
                Object o)
Adds a 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

addAll

public boolean addAll(Collection collection)
Adds a collection of Chunks to this Phrase.
Parameters:
collection - a collection of Chunks, Anchors and Phrases.
Returns:
true if the action succeeded, false if not.

addChunk

private boolean addChunk(Chunk chunk)
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

addSpecial

protected void addSpecial(Object object)
Adds a Object to the Paragraph.
Parameters:
object - the object to add.

content

public String content()
Returns the content as a String object. This method differs from toString because toString will return an ArrayList with the toString value of the Chunks in this Phrase.

font

public Font font()
Gets the font of the first Chunk that appears in this Phrase.
Returns:
a Font

getChunks

public ArrayList getChunks()
Gets all the chunks in this element.
Specified by:
getChunks in interface Element
Returns:
an ArrayList

getInstance

public static final Phrase getInstance(String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
Parameters:
string -
Returns:
a newly constructed Phrase

getInstance

public static final Phrase getInstance(int leading,
                                       String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
Parameters:
leading -
string -
Returns:
a newly constructed Phrase

getInstance

public static final Phrase getInstance(int leading,
                                       String string,
                                       Font font)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
Parameters:
leading -
string -
font -
Returns:
a newly constructed Phrase

getMarkupAttribute

public String getMarkupAttribute(String name)
Specified by:
getMarkupAttribute in interface MarkupAttributes
See Also:
com.lowagie.text.MarkupAttributes.getMarkupAttribute(java.lang.String)

getMarkupAttributeNames

public Set getMarkupAttributeNames()
Specified by:
getMarkupAttributeNames in interface MarkupAttributes
See Also:
MarkupAttributes.getMarkupAttributeNames()

getMarkupAttributes

public Properties getMarkupAttributes()
Specified by:
getMarkupAttributes in interface MarkupAttributes
See Also:
MarkupAttributes.getMarkupAttributes()

isEmpty

public boolean isEmpty()
Checks is this Phrase contains no or 1 empty Chunk.
Returns:
false if the Phrase contains more than one or more non-emptyChunks.

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

leading

public float leading()
Gets the leading of this phrase.
Returns:
the linespacing

leadingDefined

public boolean leadingDefined()
Checks you if the leading of this phrase is defined.
Returns:
true if the leading is defined

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
Parameters:
listener - an ElementListener
Returns:
true if the element was processed successfully

setLeading

public void setLeading(float leading)
Sets the leading of this phrase.
Parameters:
leading - the new leading

setMarkupAttribute

public void setMarkupAttribute(String name,
                               String value)
Specified by:
setMarkupAttribute in interface MarkupAttributes
See Also:
com.lowagie.text.MarkupAttributes.setMarkupAttribute(java.lang.String, java.lang.String)

setMarkupAttributes

public void setMarkupAttributes(Properties markupAttributes)
Specified by:
setMarkupAttributes in interface MarkupAttributes
See Also:
com.lowagie.text.MarkupAttributes.setMarkupAttributes(java.util.Properties)

type

public int type()
Gets the type of the text element.
Specified by:
type in interface Element
Returns:
a type

Overview Package Tree Index Deprecated About