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)));
* Phrase without specifying a leading.
*/
public Phrase() {
this(16);
}
/**
* Constructs a Phrase with a certain leading.
*
* @param leading the leading
*/
public Phrase(float leading) {
this.leading = leading;
}
/**
* Constructs a Phrase with a certain Chunk.
*
* @param chunk a Chunk
*/
public Phrase(Chunk chunk) {
super.add(chunk);
}
/**
* Constructs a Phrase with a certain Chunk
* and a certain leading.
*
* @param leading the leading
* @param chunk a Chunk
*/
public Phrase(float leading, Chunk chunk) {
this(leading);
super.add(chunk);
}
/**
* Constructs a Phrase with a certain String.
*
* @param string a String
*/
public Phrase(String string) {
this(Float.NaN, string, new Font());
}
/**
* Constructs a Phrase with a certain String and a certain Font.
*
* @param string a String
* @param font a Font
*/
public Phrase(String string, Font font) {
this(Float.NaN, string, font);
this.font = font;
}
/**
* Constructs a Phrase with a certain leading and a certain String.
*
* @param leading the leading
* @param string a String
*/
public Phrase(float leading, String string) {
this(leading, string, new Font());
}
/**
* Constructs a Phrase with a certain leading, a certain String
* and a certain Font.
*
* @param leading the leading
* @param string a String
* @param font a Font
*/
public Phrase(float leading, String string, Font font) {
this(leading);
this.font = font;
/* bugfix by August Detlefsen */
if (string != null && string.length() != 0) {
super.add(new Chunk(string, font));
}
}
/**
* Gets a special kind of Phrase that changes some characters into corresponding symbols.
* @param string
* @return a newly constructed Phrase
*/
public static final Phrase getInstance(String string) {
return getInstance(16, string, new Font());
}
/**
* Gets a special kind of Phrase that changes some characters into corresponding symbols.
* @param leading
* @param string
* @return a newly constructed Phrase
*/
public static final Phrase getInstance(int leading, String string) {
return getInstance(leading, string, new Font());
}
/**
* Gets a special kind of Phrase that changes some characters into corresponding symbols.
* @param leading
* @param string
* @param font
* @return a newly constructed Phrase
*/
public static final Phrase getInstance(int leading, String string, Font font) {
Phrase p = new Phrase(true);
p.setLeading(leading);
p.font = font;
if (font.family() != Font.SYMBOL && font.family() != Font.ZAPFDINGBATS && font.getBaseFont() == null) {
int index;
while((index = SpecialSymbol.index(string)) > -1) {
if (index > 0) {
String firstPart = string.substring(0, index);
/* bugfix [ #461272 ] CODE CHANGE REQUIRED IN Phrase.java
by Arekh Nambiar */
((ArrayList)p).add(new Chunk(firstPart, font));
string = string.substring(index);
}
Font symbol = new Font(Font.SYMBOL, font.size(), font.style(), font.color());
StringBuffer buf = new StringBuffer();
buf.append(SpecialSymbol.getCorrespondingSymbol(string.charAt(0)));
string = string.substring(1);
while (SpecialSymbol.index(string) == 0) {
buf.append(SpecialSymbol.getCorrespondingSymbol(string.charAt(0)));
string = string.substring(1);
}
((ArrayList)p).add(new Chunk(buf.toString(), symbol));
}
}
/* bugfix by August Detlefsen */
if (string != null && string.length() != 0) {
((ArrayList)p).add(new Chunk(string, font));
}
return p;
}
/**
* Returns a Phrase that has been constructed taking in account
* the value of some attributes.
*
* @param attributes Some attributes
*/
public Phrase(Properties attributes) {
this("", FontFactory.getFont(attributes));
clear();
String value;
if ((value = (String)attributes.remove(ElementTags.LEADING)) != null) {
setLeading(Float.valueOf(value + "f").floatValue());
}
else if ((value = (String)attributes.remove(MarkupTags.CSS_KEY_LINEHEIGHT)) != null) {
setLeading(MarkupParser.parseLength(value));
}
if ((value = (String)attributes.remove(ElementTags.ITEXT)) != null) {
Chunk chunk = new Chunk(value);
if ((value = (String)attributes.remove(ElementTags.GENERICTAG)) != null) {
chunk.setGenericTag(value);
}
add(chunk);
}
if (attributes.size() > 0) setMarkupAttributes(attributes);
}
// implementation of the Element-methods
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener an ElementListener
* @return true if the element was processed successfully
*/
public boolean process(ElementListener listener) {
try {
for (Iterator i = iterator(); i.hasNext(); ) {
listener.add((Element) i.next());
}
return true;
}
catch(DocumentException de) {
return false;
}
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.PHRASE;
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public ArrayList getChunks() {
ArrayList tmp = new ArrayList();
for (Iterator i = iterator(); i.hasNext(); ) {
tmp.addAll(((Element) i.next()).getChunks());
}
return tmp;
}
// overriding some of the ArrayList-methods
/**
* Adds a Chunk, an Anchor or another Phrase
* to this Phrase.
*
* @param index index at which the specified element is to be inserted
* @param 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
*/
public void add(int index, Object o) {
if (o == null) return;
try {
Element element = (Element) o;
if (element.type() == Element.CHUNK) {
Chunk chunk = (Chunk) element;
if (!font.isStandardFont()) {
chunk.setFont(font.difference(chunk.font()));
}
super.add(index, chunk);
}
else if (element.type() == Element.PHRASE ||
element.type() == Element.ANCHOR ||
element.type() == Element.ANNOTATION ||
element.type() == Element.TABLE || // line added by David Freels
element.type() == Element.GRAPHIC) {
super.add(index, element);
}
else {
throw new ClassCastException(String.valueOf(element.type()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException("Insertion of illegal Element: " + cce.getMessage());
}
}
/**
* Adds a Chunk, Anchor or another Phrase
* to this Phrase.
*
* @param o an object of type Chunk, Anchor or Phrase
* @return a boolean
* @throws ClassCastException when you try to add something that isn't a Chunk, Anchor or Phrase
*/
public boolean add(Object o) {
if (o == null) return false;
if (o instanceof String) {
return super.add(new Chunk((String) o, font));
}
try {
Element element = (Element) o;
switch(element.type()) {
case Element.CHUNK:
return addChunk((Chunk) o);
case Element.PHRASE:
case Element.PARAGRAPH:
Phrase phrase = (Phrase) o;
boolean success = true;
Element e;
for (Iterator i = phrase.iterator(); i.hasNext(); ) {
e = (Element) i.next();
if (e instanceof Chunk) {
success &= addChunk((Chunk)e);
}
else {
success &= this.add(e);
}
}
return success;
case Element.ANCHOR:
return super.add((Anchor) o);
case Element.ANNOTATION:
return super.add((Annotation) o);
case Element.TABLE: // case added by David Freels
return super.add((Table) o);
case Element.PTABLE: // case added by mr. Karen Vardanyan
// This will only work for PDF!!! Not for RTF/HTML
return super.add((com.lowagie.text.pdf.PdfPTable) o);
case Element.LIST:
return super.add((List) o);
case Element.GRAPHIC: // suggested by Steven Balthazor
return super.add((Graphic) o);
default:
throw new ClassCastException(String.valueOf(element.type()));
}
}
catch(ClassCastException cce) {
throw new ClassCastException("Insertion of illegal Element: " + cce.getMessage());
}
}
/**
* 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.
* @param chunk a Chunk to add to the Phrase
* @return true if adding the Chunk succeeded
*/
private synchronized boolean addChunk(Chunk chunk) {
if (!font.isStandardFont()) {
chunk.setFont(font.difference(chunk.font()));
}
if (size() > 0 && !chunk.hasAttributes()) {
try {
Chunk previous = (Chunk) get(size() - 1);
if (!previous.hasAttributes() && previous.font().compareTo(chunk.font()) == 0 && !"".equals(previous.content().trim()) && !"".equals(chunk.content().trim())) {
previous.append(chunk.content());
return true;
}
}
catch(ClassCastException cce) {
}
}
return super.add(chunk);
}
/**
* Adds a collection of Chunks
* to this Phrase.
*
* @param collection a collection of Chunks, Anchors and Phrases.
* @return true if the action succeeded, false if not.
* @throws ClassCastException when you try to add something that isn't a Chunk, Anchor or Phrase
*/
public boolean addAll(Collection collection) {
for (Iterator iterator = collection.iterator(); iterator.hasNext(); ) {
this.add(iterator.next());
}
return true;
}
/**
* Adds a Object to the Paragraph.
*
* @param object the object to add.
*/
protected void addSpecial(Object object) {
super.add(object);
}
// methods
/**
* Sets the leading of this phrase.
*
* @param leading the new leading
*/
public void setLeading(float leading) {
this.leading = leading;
}
// methods to retrieve information
/**
* Checks is this Phrase contains no or 1 empty Chunk.
*
* @return false if the Phrase
* contains more than one or more non-emptyChunks.
*/
public boolean isEmpty() {
switch(size()) {
case 0:
return true;
case 1:
Element element = (Element) get(0);
if (element.type() == Element.CHUNK && ((Chunk) element).isEmpty()) {
return true;
}
return false;
default:
return false;
}
}
/**
* Checks you if the leading of this phrase is defined.
*
* @return true if the leading is defined
*/
public boolean leadingDefined() {
if (Float.isNaN(leading)) {
return false;
}
return true;
}
/**
* Gets the leading of this phrase.
*
* @return the linespacing
*/
public float leading() {
if (Float.isNaN(leading)) {
return font.leading(1.5f);
}
return leading;
}
/**
* Gets the font of the first Chunk that appears in this Phrase.
*
* @return a Font
*/
public Font font() {
return font;
}
/**
* 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.
*/
public String content() {
StringBuffer buf = new StringBuffer();
for (Iterator i = getChunks().iterator(); i.hasNext(); ) {
buf.append(i.next().toString());
}
return buf.toString();
}
/**
* Checks if a given tag corresponds with this object.
*
* @param tag the given tag
* @return true if the tag corresponds
*/
public static boolean isTag(String tag) {
return ElementTags.PHRASE.equals(tag);
}
/**
* @see com.lowagie.text.MarkupAttributes#setMarkupAttribute(java.lang.String, java.lang.String)
*/
public void setMarkupAttribute(String name, String value) {
if (markupAttributes == null) markupAttributes = new Properties();
markupAttributes.put(name, value);
}
/**
* @see com.lowagie.text.MarkupAttributes#setMarkupAttributes(java.util.Properties)
*/
public void setMarkupAttributes(Properties markupAttributes) {
this.markupAttributes = markupAttributes;
}
/**
* @see com.lowagie.text.MarkupAttributes#getMarkupAttribute(java.lang.String)
*/
public String getMarkupAttribute(String name) {
return (markupAttributes == null) ? null : String.valueOf(markupAttributes.get(name));
}
/**
* @see com.lowagie.text.MarkupAttributes#getMarkupAttributeNames()
*/
public Set getMarkupAttributeNames() {
return Chunk.getKeySet(markupAttributes);
}
/**
* @see com.lowagie.text.MarkupAttributes#getMarkupAttributes()
*/
public Properties getMarkupAttributes() {
return markupAttributes;
}
}