/*
* $Id: Chapter.java 4861 2011-05-11 11:57:30Z redlab_b $
*
* This file is part of the iText (R) project.
* Copyright (c) 1998-2011 1T3XT BVBA
* Authors: Bruno Lowagie, Paulo Soares, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
* 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program 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 Affero General Public License for more details.
* You should have received a copy of the GNU Affero General Public License
* along with this program; if not, see http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License,
* a covered work must retain the producer line in every PDF that is created
* or manipulated using iText.
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the iText software without
* disclosing the source code of your own applications.
* These activities include: offering paid services to customers as an ASP,
* serving PDFs on the fly in a web application, shipping iText with a closed
* source product.
*
* For more information, please contact iText Software Corp. at this
* address: [email protected]
*/
package com.itextpdf.text;
import java.util.ArrayList;
/**
* A <CODE>Chapter</CODE> is a special <CODE>Section</CODE>.
* <P>
* A chapter number has to be created using a <CODE>Paragraph</CODE> as title
* and an <CODE>int</CODE> as chapter number. The chapter number is shown by
* default. If you don't want to see the chapter number, you have to set the
* numberdepth to <VAR>0</VAR>.
* <P>
* Example:
* <BLOCKQUOTE><PRE>
* Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
* <STRONG>Chapter chapter2 = new Chapter(title2, 2);</STRONG>
* <STRONG>chapter2.setNumberDepth(0);</STRONG>
* Paragraph someText = new Paragraph("This is some text");
* <STRONG>chapter2.add(someText);</STRONG>
* Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.getFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
* Section section1 = <STRONG>chapter2.addSection(title21);</STRONG>
* Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
* section1.add(someSectionText);
* </PRE></BLOCKQUOTE>
*/
public class Chapter extends Section {
// constant
private static final long serialVersionUID = 1791000695779357361L;
/**
* Constructs a new <CODE>Chapter</CODE>.
* @param number the Chapter number
*/
public Chapter(int number) {
super(null, 1);
numbers = new ArrayList<Integer>();
numbers.add(Integer.valueOf(number));
triggerNewPage = true;
}
/**
* Constructs a new <CODE>Chapter</CODE>.
*
* @param title the Chapter title (as a <CODE>Paragraph</CODE>)
* @param number the Chapter number
*/
public Chapter(Paragraph title, int number) {
super(title, 1);
numbers = new ArrayList<Integer>();
numbers.add(Integer.valueOf(number));
triggerNewPage = true;
}
/**
* Constructs a new <CODE>Chapter</CODE>.
*
* @param title the Chapter title (as a <CODE>String</CODE>)
* @param number the Chapter number
*/
public Chapter(String title, int number) {
this(new Paragraph(title), number);
}
// implementation of the Element-methods
/**
* Gets the type of the text element.
*
* @return a type
*/
@Override
public int type() {
return Element.CHAPTER;
}
/**
* @see com.itextpdf.text.Element#isNestable()
* @since iText 2.0.8
*/
@Override
public boolean isNestable() {
return false;
}
}
|