/*
* $Id: Paragraph.java 3668 2009-02-01 09:08:50Z blowagie $
*
* Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text;
/**
* A <CODE>Paragraph</CODE> is a series of <CODE>Chunk</CODE>s and/or <CODE>Phrases</CODE>.
* <P>
* A <CODE>Paragraph</CODE> has the same qualities of a <CODE>Phrase</CODE>, but also
* some additional layout-parameters:
* <UL>
* <LI>the indentation
* <LI>the alignment of the text
* </UL>
*
* Example:
* <BLOCKQUOTE><PRE>
* <STRONG>Paragraph p = new Paragraph("This is a paragraph",
* FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));</STRONG>
* </PRE></BLOCKQUOTE>
*
* @see Element
* @see Phrase
* @see ListItem
*/
public class
Paragraph extends
Phrase {
// constants
private static final long
serialVersionUID = 7852314969733375514L;
// membervariables
/** The alignment of the text. */
protected int
alignment =
Element.
ALIGN_UNDEFINED;
/** The text leading that is multiplied by the biggest font size in the line. */
protected float
multipliedLeading = 0;
/** The indentation of this paragraph on the left side. */
protected float
indentationLeft;
/** The indentation of this paragraph on the right side. */
protected float
indentationRight;
/** Holds value of property firstLineIndent. */
private float
firstLineIndent = 0;
/** The spacing before the paragraph. */
protected float
spacingBefore;
/** The spacing after the paragraph. */
protected float
spacingAfter;
/** Holds value of property extraParagraphSpace. */
private float
extraParagraphSpace = 0;
/** Does the paragraph has to be kept together on 1 page. */
protected boolean
keeptogether = false;
// constructors
/**
* Constructs a <CODE>Paragraph</CODE>.
*/
public
Paragraph() {
super();
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain leading.
*
* @param leading the leading
*/
public
Paragraph(float
leading) {
super(
leading);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>Chunk</CODE>.
*
* @param chunk a <CODE>Chunk</CODE>
*/
public
Paragraph(
Chunk chunk) {
super(
chunk);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>Chunk</CODE>
* and a certain leading.
*
* @param leading the leading
* @param chunk a <CODE>Chunk</CODE>
*/
public
Paragraph(float
leading,
Chunk chunk) {
super(
leading,
chunk);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>String</CODE>.
*
* @param string a <CODE>String</CODE>
*/
public
Paragraph(
String string) {
super(
string);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>String</CODE>
* and a certain <CODE>Font</CODE>.
*
* @param string a <CODE>String</CODE>
* @param font a <CODE>Font</CODE>
*/
public
Paragraph(
String string,
Font font) {
super(
string,
font);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>String</CODE>
* and a certain leading.
*
* @param leading the leading
* @param string a <CODE>String</CODE>
*/
public
Paragraph(float
leading,
String string) {
super(
leading,
string);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain leading, <CODE>String</CODE>
* and <CODE>Font</CODE>.
*
* @param leading the leading
* @param string a <CODE>String</CODE>
* @param font a <CODE>Font</CODE>
*/
public
Paragraph(float
leading,
String string,
Font font) {
super(
leading,
string,
font);
}
/**
* Constructs a <CODE>Paragraph</CODE> with a certain <CODE>Phrase</CODE>.
*
* @param phrase a <CODE>Phrase</CODE>
*/
public
Paragraph(
Phrase phrase) {
super(
phrase);
if (
phrase instanceof
Paragraph) {
Paragraph p = (
Paragraph)
phrase;
setAlignment(
p.
alignment);
setLeading(
phrase.
getLeading(),
p.
multipliedLeading);
setIndentationLeft(
p.
getIndentationLeft());
setIndentationRight(
p.
getIndentationRight());
setFirstLineIndent(
p.
getFirstLineIndent());
setSpacingAfter(
p.
spacingAfter());
setSpacingBefore(
p.
spacingBefore());
setExtraParagraphSpace(
p.
getExtraParagraphSpace());
}
}
// implementation of the Element-methods
/**
* Gets the type of the text element.
*
* @return a type
*/
public int
type() {
return
Element.
PARAGRAPH;
}
// methods
/**
* Adds an <CODE>Object</CODE> to the <CODE>Paragraph</CODE>.
*
* @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.
getIndentationLeft() +
indentationLeft);
list.
setIndentationRight(
indentationRight);
return super.add(
list);
}
else if (
o instanceof
Image) {
super.addSpecial(
o);
return true;
}
else if (
o instanceof
Paragraph) {
super.add(
o);
java.util.
List chunks =
getChunks();
if (!
chunks.
isEmpty()) {
Chunk tmp = ((
Chunk)
chunks.
get(
chunks.
size() - 1));
super.add(new
Chunk("\n",
tmp.
getFont()));
}
else {
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 <CODE>String</CODE>
*/
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;
}
/**
* @see com.lowagie.text.Phrase#setLeading(float)
*/
public void
setLeading(float
fixedLeading) {
this.
leading =
fixedLeading;
this.
multipliedLeading = 0;
}
/**
* Sets the variable leading. The resultant leading will be
* multipliedLeading*maxFontSize where maxFontSize is the
* size of the biggest font in the line.
* @param multipliedLeading the variable leading
*/
public void
setMultipliedLeading(float
multipliedLeading) {
this.
leading = 0;
this.
multipliedLeading =
multipliedLeading;
}
/**
* Sets the leading fixed and variable. The resultant leading will be
* fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the
* size of the biggest 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;
}
/**
* 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;
}
/**
* Setter for property firstLineIndent.
* @param firstLineIndent New value of property firstLineIndent.
*/
public void
setFirstLineIndent(float
firstLineIndent) {
this.
firstLineIndent =
firstLineIndent;
}
/**
* 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
getAlignment() {
return
alignment;
}
/**
* Gets the variable leading
* @return the leading
*/
public float
getMultipliedLeading() {
return
multipliedLeading;
}
/**
* Gets the total leading.
* This method is based on the assumption that the
* font of the Paragraph is the font of all the elements
* that make part of the paragraph. This isn't necessarily
* true.
* @return the total leading (fixed and multiplied)
*/
public float
getTotalLeading() {
float
m =
font == null ?
Font.
DEFAULTSIZE *
multipliedLeading :
font.
getCalculatedLeading(
multipliedLeading);
if (
m > 0 && !
hasLeading()) {
return
m;
}
return
getLeading() +
m;
}
/**
* Gets the indentation of this paragraph on the left side.
*
* @return the indentation
*/
public float
getIndentationLeft() {
return
indentationLeft;
}
/**
* Gets the indentation of this paragraph on the right side.
*
* @return the indentation
*/
public float
getIndentationRight() {
return
indentationRight;
}
/**
* Getter for property firstLineIndent.
* @return Value of property firstLineIndent.
*/
public float
getFirstLineIndent() {
return this.
firstLineIndent;
}
/**
* Gets the spacing before this paragraph.
* @return the spacing
* @since 2.1.5
*/
public float
getSpacingBefore() {
return
spacingBefore;
}
/**
* Gets the spacing after this paragraph.
* @return the spacing
* @since 2.1.5
*/
public float
getSpacingAfter() {
return
spacingAfter;
}
/**
* 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;
}
// scheduled for removal
/**
* Gets the spacing before this paragraph.
*
* @return the spacing
* @deprecated As of iText 2.1.5, replaced by {@link #getSpacingBefore()},
* scheduled for removal at 2.3.0
*/
public float
spacingBefore() {
return
getSpacingBefore();
}
/**
* Gets the spacing after this paragraph.
*
* @return the spacing
* @deprecated As of iText 2.1.5, replaced by {@link #getSpacingAfter()},
* scheduled for removal at 2.3.0
*/
public float
spacingAfter() {
return
spacingAfter;
}
}