|
|||||||||
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 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)));
Element
,
Chunk
,
Paragraph
,
Anchor
,
Serialized FormField 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 |
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, 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. |
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(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 . |
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 . |
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(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. |
String |
getMarkupAttribute(String name)
Returns the value of the specified attribute. |
Set |
getMarkupAttributeNames()
Returns a Set of String attribute names for the
MarkupAttributes implementor. |
Properties |
getMarkupAttributes()
Return a Properties -object containing all the markupAttributes. |
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)
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, clear, clone, contains, ensureCapacity, get, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode |
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 com.lowagie.text.Element |
---|
toString |
Methods inherited from interface java.util.List |
---|
containsAll, equals, hashCode |
Field Detail |
---|
protected float leading
protected Font font
protected Properties markupAttributes
Constructor Detail |
---|
private Phrase(boolean dummy)
dummy
- a dummy parameterpublic Phrase()
Phrase
without specifying a leading.
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 Chunk
public 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 String
font
- 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 String
font
- a Font
public Phrase(Properties attributes)
Phrase
that has been constructed taking in account
the value of some attributes.
attributes
- Some attributesMethod Detail |
---|
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 boolean process(ElementListener listener)
ElementListener
.
process
in interface Element
listener
- an ElementListener
true
if the element was processed successfullypublic int type()
type
in interface Element
public ArrayList getChunks()
getChunks
in interface Element
ArrayList
public void add(int index, Object o)
Chunk
, an Anchor
or another Phrase
to this Phrase
.
add
in interface List
add
in class ArrayList
index
- 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 Phrase
public boolean add(Object o)
Chunk
, Anchor
or another Phrase
to this Phrase
.
add
in interface TextElementArray
add
in interface Collection
add
in interface List
add
in class ArrayList
o
- an object of type Chunk
, Anchor
or Phrase
ClassCastException
- when you try to add something that isn't a Chunk
, Anchor
or Phrase
private 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
public boolean addAll(Collection collection)
Chunk
s
to this Phrase
.
addAll
in interface Collection
addAll
in interface List
addAll
in class ArrayList
collection
- a collection of Chunk
s, Anchor
s and Phrase
s.
true
if the action succeeded, false
if not.
ClassCastException
- when you try to add something that isn't a Chunk
, Anchor
or Phrase
protected void addSpecial(Object object)
Object
to the Paragraph
.
object
- the object to add.public void setLeading(float leading)
leading
- the new leadingpublic boolean isEmpty()
Phrase
contains no or 1 empty Chunk
.
isEmpty
in interface Collection
isEmpty
in interface List
isEmpty
in class ArrayList
false
if the Phrase
contains more than one or more non-emptyChunk
s.public boolean leadingDefined()
public float leading()
public Font font()
Chunk
that appears in this Phrase
.
Font
public String content()
public static boolean isTag(String tag)
tag
- the given tag
public void setMarkupAttribute(String name, String value)
MarkupAttributes
setMarkupAttribute
in interface MarkupAttributes
name
- String
attribute name.value
- String
attribute value.MarkupAttributes.setMarkupAttribute(java.lang.String, java.lang.String)
public void setMarkupAttributes(Properties markupAttributes)
MarkupAttributes
setMarkupAttributes
in interface MarkupAttributes
markupAttributes
- a Properties
-object containing markupattributesMarkupAttributes.setMarkupAttributes(java.util.Properties)
public String getMarkupAttribute(String name)
MarkupAttributes
getMarkupAttribute
in interface MarkupAttributes
name
- String
attribute name.
String
.MarkupAttributes.getMarkupAttribute(java.lang.String)
public Set getMarkupAttributeNames()
MarkupAttributes
Set
of String
attribute names for the
MarkupAttributes
implementor.
getMarkupAttributeNames
in interface MarkupAttributes
Set
.MarkupAttributes.getMarkupAttributeNames()
public Properties getMarkupAttributes()
MarkupAttributes
Properties
-object containing all the markupAttributes.
getMarkupAttributes
in interface MarkupAttributes
Properties
MarkupAttributes.getMarkupAttributes()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |