Paragraph is a series of Chunks and/or Phrases.
*
* A Paragraph has the same qualities of a Phrase, but also
* some additional layout-parameters:
*
* Paragraph p = new Paragraph("This is a paragraph",
* FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
* Paragraph.
*/
public Paragraph() {
super();
}
/**
* Constructs a Paragraph with a certain leading.
*
* @param leading the leading
*/
public Paragraph(float leading) {
super(leading);
}
/**
* Constructs a Paragraph with a certain Chunk.
*
* @param chunk a Chunk
*/
public Paragraph(Chunk chunk) {
super(chunk);
}
/**
* Constructs a Paragraph with a certain Chunk
* and a certain leading.
*
* @param leading the leading
* @param chunk a Chunk
*/
public Paragraph(float leading, Chunk chunk) {
super(leading, chunk);
}
/**
* Constructs a Paragraph with a certain String.
*
* @param string a String
*/
public Paragraph(String string) {
super(string);
}
/**
* Constructs a Paragraph with a certain String
* and a certain Font.
*
* @param string a String
* @param font a Font
*/
public Paragraph(String string, Font font) {
super(string, font);
}
/**
* Constructs a Paragraph with a certain String
* and a certain leading.
*
* @param leading the leading
* @param string a String
*/
public Paragraph(float leading, String string) {
super(leading, string);
}
/**
* Constructs a Paragraph with a certain leading, String
* and Font.
*
* @param leading the leading
* @param string a String
* @param font a Font
*/
public Paragraph(float leading, String string, Font font) {
super(leading, string, font);
}
/**
* Constructs a Paragraph with a certain Phrase.
*
* @param phrase a Phrase
*/
public Paragraph(Phrase phrase) {
super(phrase.leading, "", phrase.font());
super.add(phrase);
}
/**
* Returns a Paragraph that has been constructed taking in account
* the value of some attributes.
*
* @param attributes Some attributes
*/
public Paragraph(Properties attributes) {
this("", FontFactory.getFont(attributes));
String 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 ((value = (String)attributes.remove(ElementTags.ALIGN)) != null) {
setAlignment(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));
}
else {
setLeading(16);
}
if ((value = (String)attributes.remove(ElementTags.INDENTATIONLEFT)) != null) {
setIndentationLeft(Float.valueOf(value + "f").floatValue());
}
if ((value = (String)attributes.remove(ElementTags.INDENTATIONRIGHT)) != null) {
setIndentationRight(Float.valueOf(value + "f").floatValue());
}
if ((value = (String)attributes.remove(ElementTags.KEEPTOGETHER)) != null) {
keeptogether = new Boolean(value).booleanValue();
}
if (attributes.size() > 0) setMarkupAttributes(attributes);
}
// implementation of the Element-methods
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.PARAGRAPH;
}
// methods
/**
* Adds an Object to the Paragraph.
*
* @param o object the object to add.
* @return true is adding the object succeeded
*/
public boolean add(Object o) {
if (o instanceof List) {
List list = (List) o;
list.setIndentationLeft(list.indentationLeft() + indentationLeft);
list.setIndentationRight(indentationRight);
return super.add(list);
}
else if (o instanceof Image) {
super.addSpecial((Image) o);
return true;
}
else if (o instanceof Paragraph) {
super.add(o);
super.add(Chunk.NEWLINE);
return true;
}
return super.add(o);
}
// setting the membervariables
/**
* Sets the alignment of this paragraph.
*
* @param alignment the new alignment
*/
public void setAlignment(int alignment) {
this.alignment = alignment;
}
/**
* Sets the alignment of this paragraph.
*
* @param alignment the new alignment as a String
*/
public void setAlignment(String alignment) {
if (ElementTags.ALIGN_CENTER.equalsIgnoreCase(alignment)) {
this.alignment = Element.ALIGN_CENTER;
return;
}
if (ElementTags.ALIGN_RIGHT.equalsIgnoreCase(alignment)) {
this.alignment = Element.ALIGN_RIGHT;
return;
}
if (ElementTags.ALIGN_JUSTIFIED.equalsIgnoreCase(alignment)) {
this.alignment = Element.ALIGN_JUSTIFIED;
return;
}
if (ElementTags.ALIGN_JUSTIFIED_ALL.equalsIgnoreCase(alignment)) {
this.alignment = Element.ALIGN_JUSTIFIED_ALL;
return;
}
this.alignment = Element.ALIGN_LEFT;
}
/**
* Sets the indentation of this paragraph on the left side.
*
* @param indentation the new indentation
*/
public void setIndentationLeft(float indentation) {
this.indentationLeft = indentation;
}
/**
* Sets the indentation of this paragraph on the right side.
*
* @param indentation the new indentation
*/
public void setIndentationRight(float indentation) {
this.indentationRight = indentation;
}
/**
* Sets the spacing before this paragraph.
*
* @param spacing the new spacing
*/
public void setSpacingBefore(float spacing) {
this.spacingBefore = spacing;
}
/**
* Sets the spacing after this paragraph.
*
* @param spacing the new spacing
*/
public void setSpacingAfter(float spacing) {
this.spacingAfter = spacing;
}
/**
* Indicates that the paragraph has to be kept together on one page.
*
* @param keeptogether true of the paragraph may not be split over 2 pages
*/
public void setKeepTogether(boolean keeptogether) {
this.keeptogether = keeptogether;
}
/**
* Checks if this paragraph has to be kept together on one page.
*
* @return true if the paragraph may not be split over 2 pages.
*/
public boolean getKeepTogether() {
return keeptogether;
}
// methods to retrieve information
/**
* Gets the alignment of this paragraph.
*
* @return alignment
*/
public int alignment() {
return alignment;
}
/**
* Gets the indentation of this paragraph on the left side.
*
* @return the indentation
*/
public float indentationLeft() {
return indentationLeft;
}
/**
* Gets the indentation of this paragraph on the right side.
*
* @return the indentation
*/
public float indentationRight() {
return indentationRight;
}
/**
* Gets the spacing before this paragraph.
*
* @return the spacing
*/
public float spacingBefore() {
return spacingBefore;
}
/**
* Gets the spacing before this paragraph.
*
* @return the spacing
*/
public float spacingAfter() {
return spacingAfter;
}
/**
* 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.PARAGRAPH.equals(tag);
}
/**
* Sets the leading fixed and variable. The resultant leading will be
* fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the
* size of the bigest font in the line.
* @param fixedLeading the fixed leading
* @param multipliedLeading the variable leading
*/
public void setLeading(float fixedLeading, float multipliedLeading) {
this.leading = fixedLeading;
this.multipliedLeading = multipliedLeading;
}
/**
* @see com.lowagie.text.Phrase#setLeading(float)
*/
public void setLeading(float fixedLeading) {
this.leading = fixedLeading;
this.multipliedLeading = 0;
}
/**
* Gets the variable leading
* @return the leading
*/
public float getMultipliedLeading() {
return multipliedLeading;
}
/**
* Getter for property firstLineIndent.
* @return Value of property firstLineIndent.
*/
public float getFirstLineIndent() {
return this.firstLineIndent;
}
/**
* Setter for property firstLineIndent.
* @param firstLineIndent New value of property firstLineIndent.
*/
public void setFirstLineIndent(float firstLineIndent) {
this.firstLineIndent = firstLineIndent;
}
/**
* Getter for property extraParagraphSpace.
* @return Value of property extraParagraphSpace.
*/
public float getExtraParagraphSpace() {
return this.extraParagraphSpace;
}
/**
* Setter for property extraParagraphSpace.
* @param extraParagraphSpace New value of property extraParagraphSpace.
*/
public void setExtraParagraphSpace(float extraParagraphSpace) {
this.extraParagraphSpace = extraParagraphSpace;
}
}