|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList
com.lowagie.text.Phrase
public class Phrase
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)));
Element,
Chunk,
Paragraph,
Anchor,
Serialized Form| Field Summary | |
|---|---|
protected Font |
font
This is the font of this phrase. |
protected float |
leading
This is the leading of this phrase. |
private static long |
serialVersionUID
|
| Fields inherited from class java.util.AbstractList |
|---|
modCount |
| 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, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE |
| Constructor Summary | |
|---|---|
|
Phrase()
Constructs a Phrase without specifying a leading. |
private |
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,
Chunk chunk)
Constructs a Phrase with a certain Chunk
and 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(Phrase phrase)
Copy constructor for Phrase. |
|
Phrase(Properties attributes)
Deprecated. As of iText 2.0.3, replaced by ElementFactory.getPhrase(Properties),
scheduled for removal at 2.1.0 |
|
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. |
| 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 Chunks
to this Phrase. |
protected boolean |
addChunk(Chunk chunk)
Adds a Chunk. |
protected void |
addSpecial(Object object)
Adds a Object to the Paragraph. |
String |
content()
Deprecated. As of iText 2.0.3, replaced by getContent(),
scheduled for removal at 2.1.0 |
Font |
font()
Deprecated. As of iText 2.0.3, replaced by getFont(),
scheduled for removal at 2.1.0 |
ArrayList |
getChunks()
Gets all the chunks in this element. |
String |
getContent()
Returns the content as a String object. |
Font |
getFont()
Gets the font of the first Chunk that appears in this Phrase. |
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. |
static Phrase |
getInstance(String string)
Gets a special kind of Phrase that changes some characters into corresponding symbols. |
float |
getLeading()
Gets the leading of this phrase. |
boolean |
hasLeading()
Checks you if the leading of this phrase is defined. |
boolean |
isContent()
Checks if this element is a content object. |
boolean |
isEmpty()
Checks is this Phrase contains no or 1 empty Chunk. |
boolean |
isNestable()
Checks if this element is nestable. |
float |
leading()
Deprecated. As of iText 2.0.3, replaced by getLeading(),
scheduled for removal at 2.1.0 |
boolean |
leadingDefined()
Deprecated. As of iText 2.0.3, replaced by hasLeading(),
scheduled for removal at 2.1.0 |
boolean |
process(ElementListener listener)
Processes the element by adding it (or the different parts) to an ElementListener. |
void |
setFont(Font font)
Sets the main font of this phrase. |
void |
setLeading(float leading)
Sets the leading of this phrase. |
int |
type()
Gets the type of the text element. |
| Methods inherited from class java.util.ArrayList |
|---|
addAll, clear, clone, contains, ensureCapacity, get, indexOf, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize |
| Methods inherited from class java.util.AbstractList |
|---|
equals, hashCode, iterator, listIterator, listIterator, subList |
| Methods inherited from class java.util.AbstractCollection |
|---|
containsAll, removeAll, retainAll, toString |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.lowagie.text.Element |
|---|
toString |
| Methods inherited from interface java.util.List |
|---|
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList |
| Field Detail |
|---|
private static final long serialVersionUID
protected float leading
protected Font font
| Constructor Detail |
|---|
public Phrase()
Phrase without specifying a leading.
public Phrase(Phrase phrase)
Phrase.
public Phrase(float leading)
Phrase with a certain leading.
leading - the leadingpublic Phrase(Chunk chunk)
Phrase with a certain Chunk.
chunk - a Chunk
public Phrase(float leading,
Chunk chunk)
Phrase with a certain Chunk
and a certain leading.
leading - the leadingchunk - a Chunkpublic Phrase(String string)
Phrase with a certain String.
string - a String
public Phrase(String string,
Font font)
Phrase with a certain String and a certain Font.
string - a Stringfont - a Font
public Phrase(float leading,
String string)
Phrase with a certain leading and a certain String.
leading - the leadingstring - a String
public Phrase(float leading,
String string,
Font font)
Phrase with a certain leading, a certain String
and a certain Font.
leading - the leadingstring - a Stringfont - a Fontprivate Phrase(boolean dummy)
dummy - a dummy parameterpublic Phrase(Properties attributes)
ElementFactory.getPhrase(Properties),
scheduled for removal at 2.1.0
Phrase that has been constructed taking in account
the value of some attributes.
attributes - Some attributes| Method Detail |
|---|
public boolean process(ElementListener listener)
ElementListener.
process in interface Elementlistener - an ElementListener
true if the element was processed successfullypublic int type()
type in interface Elementpublic ArrayList getChunks()
getChunks in interface ElementArrayListpublic boolean isContent()
Element
isContent in interface ElementElement.isContent()public boolean isNestable()
Element
isNestable in interface ElementElement.isNestable()
public void add(int index,
Object o)
Chunk, an Anchor or another Phrase
to this Phrase.
add in interface Listadd in class ArrayListindex - index at which the specified element is to be insertedo - an object of type Chunk, Anchor or Phrase
ClassCastException - when you try to add something that isn't a Chunk, Anchor or Phrasepublic boolean add(Object o)
Chunk, Anchor or another Phrase
to this Phrase.
add in interface TextElementArrayadd in interface Collectionadd in interface Listadd in class ArrayListo - an object of type Chunk, Anchor or Phrase
ClassCastException - when you try to add something that isn't a Chunk, Anchor or Phrasepublic boolean addAll(Collection collection)
Chunks
to this Phrase.
addAll in interface CollectionaddAll in interface ListaddAll in class ArrayListcollection - a collection of Chunks, Anchors and Phrases.
true if the action succeeded, false if not.
ClassCastException - when you try to add something that isn't a Chunk, Anchor or Phraseprotected boolean addChunk(Chunk chunk)
This method is a hack to solve a problem I had with phrases that were split between chunks in the wrong place.
chunk - a Chunk to add to the Phrase
protected void addSpecial(Object object)
Object to the Paragraph.
object - the object to add.public void setLeading(float leading)
leading - the new leadingpublic void setFont(Font font)
font - the new fontpublic float getLeading()
public boolean hasLeading()
public Font getFont()
Chunk that appears in this Phrase.
Fontpublic String getContent()
public boolean isEmpty()
Phrase contains no or 1 empty Chunk.
isEmpty in interface CollectionisEmpty in interface ListisEmpty in class ArrayListfalse if the Phrase
contains more than one or more non-emptyChunks.public static final Phrase getInstance(String string)
string -
public static final Phrase getInstance(int leading,
String string)
leading - string -
public static final Phrase getInstance(int leading,
String string,
Font font)
leading - string - font -
public Font font()
getFont(),
scheduled for removal at 2.1.0
Chunk that appears in this Phrase.
Fontpublic float leading()
getLeading(),
scheduled for removal at 2.1.0
public boolean leadingDefined()
hasLeading(),
scheduled for removal at 2.1.0
public String content()
getContent(),
scheduled for removal at 2.1.0
|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||