com.lowagie.text

Class Phrase

public class Phrase extends ArrayList implements TextElementArray

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 Fontfont
This is the font of this phrase.
protected floatleading
This is the leading of this phrase.
static longserialVersionUID
Constructor Summary
Phrase()
Constructs a Phrase without specifying a leading.
Phrase(Phrase phrase)
Copy constructor for Phrase.
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(boolean dummy)
Constructs a Phrase that can be used in the static getInstance() method.
Phrase(Properties attributes)
Returns a Phrase that has been constructed taking in account the value of some attributes.
Method Summary
voidadd(int index, Object o)
Adds a Chunk, an Anchor or another Phrase to this Phrase.
booleanadd(Object o)
Adds a Chunk, Anchor or another Phrase to this Phrase.
booleanaddAll(Collection collection)
Adds a collection of Chunks to this Phrase.
protected booleanaddChunk(Chunk chunk)
Adds a Chunk.
protected voidaddSpecial(Object object)
Adds a Object to the Paragraph.
Stringcontent()
Returns the content as a String object.
Fontfont()
Gets the font of the first Chunk that appears in this Phrase.
ArrayListgetChunks()
Gets all the chunks in this element.
StringgetContent()
Returns the content as a String object.
FontgetFont()
Gets the font of the first Chunk that appears in this Phrase.
static PhrasegetInstance(String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
static PhrasegetInstance(int leading, String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
static PhrasegetInstance(int leading, String string, Font font)
Gets a special kind of Phrase that changes some characters into corresponding symbols.
floatgetLeading()
Gets the leading of this phrase.
booleanhasLeading()
Checks you if the leading of this phrase is defined.
booleanisEmpty()
Checks is this Phrase contains no or 1 empty Chunk.
floatleading()
Gets the leading of this phrase.
booleanleadingDefined()
Checks you if the leading of this phrase is defined.
booleanprocess(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener.
voidsetFont(Font font)
Sets the main font of this phrase.
voidsetLeading(float leading)
Sets the leading of this phrase.
inttype()
Gets the type of the text element.

Field Detail

font

protected Font font
This is the font of this phrase.

leading

protected float leading
This is the leading of this phrase.

serialVersionUID

private static final long serialVersionUID

Constructor Detail

Phrase

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

Phrase

public Phrase(Phrase phrase)
Copy constructor for Phrase.

Phrase

public Phrase(float leading)
Constructs a Phrase with a certain leading.

Parameters: leading the leading

Phrase

public Phrase(Chunk chunk)
Constructs a Phrase with a certain Chunk.

Parameters: chunk a Chunk

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

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

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

private Phrase(boolean dummy)
Constructs a Phrase that can be used in the static getInstance() method.

Parameters: dummy a dummy parameter

Phrase

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

Parameters: attributes Some attributes

Method Detail

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

Throws: ClassCastException when you try to add something that isn't a Chunk, Anchor or Phrase

add

public boolean add(Object o)
Adds a 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

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.

Throws: ClassCastException when you try to add something that isn't a Chunk, Anchor or Phrase

addChunk

protected 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()

Deprecated: Use getContent instead

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()

Deprecated: Use getFont instead

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.

Returns: an ArrayList

getContent

public String getContent()
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.

getFont

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

Returns: a Font

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

getLeading

public float getLeading()
Gets the leading of this phrase.

Returns: the linespacing

hasLeading

public boolean hasLeading()
Checks you if the leading of this phrase is defined.

Returns: true if the leading is defined

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.

leading

public float leading()

Deprecated: Use getLeading instead

Gets the leading of this phrase.

Returns: the linespacing

leadingDefined

public boolean leadingDefined()

Deprecated: Use hasLeading instead

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.

Parameters: listener an ElementListener

Returns: true if the element was processed successfully

setFont

public void setFont(Font font)
Sets the main font of this phrase.

Parameters: font the new font

setLeading

public void setLeading(float leading)
Sets the leading of this phrase.

Parameters: leading the new leading

type

public int type()
Gets the type of the text element.

Returns: a type