com.itextpdf.text.ChapterAutoNumber.java Source code

Introduction

Here is the source code for com.itextpdf.text.ChapterAutoNumber.java

Source

/*
 *
 * This file is part of the iText (R) project.
Copyright (c) 1998-2019 iText Group NV
 * 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
 * ITEXT GROUP. ITEXT GROUP 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: sales@itextpdf.com
 */
package com.itextpdf.text;

import com.itextpdf.text.error_messages.MessageLocalization;

/**
 * Chapter with auto numbering.
 *
 * @author Michael Niedermair
 */
public class ChapterAutoNumber extends Chapter {

    // constant
    private static final long serialVersionUID = -9217457637987854167L;

    /**
     * Is the chapter number already set?
     * @since   2.1.4
     */
    protected boolean numberSet = false;

    /**
     * Create a new object.
     *
     * @param para     the Chapter title (as a <CODE>Paragraph</CODE>)
     */
    public ChapterAutoNumber(final Paragraph para) {
        super(para, 0);
    }

    /**
     * Create a new object.
     *
     * @param title       the Chapter title (as a <CODE>String</CODE>)
     */
    public ChapterAutoNumber(final String title) {
        super(title, 0);
    }

    /**
     * Create a new section for this chapter and ad it.
     *
     * @param title  the Section title (as a <CODE>String</CODE>)
     * @return Returns the new section.
     */
    @Override
    public Section addSection(final String title) {
        if (isAddedCompletely()) {
            throw new IllegalStateException(MessageLocalization
                    .getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
        }
        return addSection(title, 2);
    }

    /**
     * Create a new section for this chapter and add it.
     *
     * @param title  the Section title (as a <CODE>Paragraph</CODE>)
     * @return Returns the new section.
     */
    @Override
    public Section addSection(final Paragraph title) {
        if (isAddedCompletely()) {
            throw new IllegalStateException(MessageLocalization
                    .getComposedMessage("this.largeelement.has.already.been.added.to.the.document"));
        }
        return addSection(title, 2);
    }

    /**
     * Changes the Chapter number.
     * @param   number   the new chapter number
     * @return possibly increased number if the chapternumber was already set.
     * @since 2.1.4
     */
    public int setAutomaticNumber(int number) {
        if (!numberSet) {
            number++;
            super.setChapterNumber(number);
            numberSet = true;
        }
        return number;
    }

}