001/*
002 * $Id: ChapterAutoNumber.java 4847 2011-05-05 19:46:13Z redlab_b $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text;
045
046import com.itextpdf.text.error_messages.MessageLocalization;
047/**
048 * Chapter with auto numbering.
049 *
050 * @author Michael Niedermair
051 */
052public class ChapterAutoNumber extends Chapter {
053
054    // constant
055    private static final long serialVersionUID = -9217457637987854167L;
056
057    /**
058     * Is the chapter number already set?
059     * @since   2.1.4
060     */
061    protected boolean numberSet = false;
062
063    /**
064     * Create a new object.
065     *
066     * @param para     the Chapter title (as a <CODE>Paragraph</CODE>)
067     */
068    public ChapterAutoNumber(final Paragraph para) {
069        super(para, 0);
070    }
071
072    /**
073     * Create a new object.
074     *
075     * @param title         the Chapter title (as a <CODE>String</CODE>)
076     */
077    public ChapterAutoNumber(final String title) {
078        super(title, 0);
079    }
080
081    /**
082     * Create a new section for this chapter and ad it.
083     *
084     * @param title  the Section title (as a <CODE>String</CODE>)
085     * @return Returns the new section.
086     */
087    @Override
088        public Section addSection(final String title) {
089        if (isAddedCompletely()) {
090                throw new IllegalStateException(MessageLocalization.getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
091        }
092        return addSection(title, 2);
093    }
094
095    /**
096     * Create a new section for this chapter and add it.
097     *
098     * @param title  the Section title (as a <CODE>Paragraph</CODE>)
099     * @return Returns the new section.
100     */
101    @Override
102        public Section addSection(final Paragraph title) {
103        if (isAddedCompletely()) {
104                throw new IllegalStateException(MessageLocalization.getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
105        }
106        return addSection(title, 2);
107    }
108
109    /**
110     * Changes the Chapter number.
111     * @param   number  the new chapter number
112     * @return possibly increased number if the chapternumber was already set.
113     * @since 2.1.4
114     */
115    public int setAutomaticNumber(int number) {
116        if (!numberSet) {
117                number++;
118                super.setChapterNumber(number);
119                numberSet = true;
120        }
121                return number;
122    }
123
124}