1 /*
2  * Copyright 2005 by Michael Niedermair.
3  *
4  * The contents of this file are subject to the Mozilla Public License Version 1.1
5  * (the "License"); you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the License.
11  *
12  * The Original Code is 'iText, a free JAVA-PDF library'.
13  *
14  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
15  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
16  * All Rights Reserved.
17  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
18  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
19  *
20  * Contributor(s): all the names of the contributors are added in the source code
21  * where applicable.
22  *
23  * Alternatively, the contents of this file may be used under the terms of the
24  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
25  * provisions of LGPL are applicable instead of those above.  If you wish to
26  * allow use of your version of this file only under the terms of the LGPL
27  * License and not to allow others to use your version of this file under
28  * the MPL, indicate your decision by deleting the provisions above and
29  * replace them with the notice and other provisions required by the LGPL.
30  * If you do not delete the provisions above, a recipient may use your version
31  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
32  *
33  * This library is free software; you can redistribute it and/or modify it
34  * under the terms of the MPL as stated above or under the terms of the GNU
35  * Library General Public License as published by the Free Software Foundation;
36  * either version 2 of the License, or any later version.
37  *
38  * This library is distributed in the hope that it will be useful, but WITHOUT
39  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
40  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
41  * details.
42  *
43  * If you didn't download this code from the following link, you should check if
44  * you aren't using an obsolete version:
45  * http://www.lowagie.com/iText/
46  */
47
48 package com.lowagie.text;
49
50 /**
51  * Chapter with auto numbering.
52  *
53  * @author Michael Niedermair
54  */
55 public class ChapterAutoNumber extends Chapter {
56
57     // constant
58     private static final long serialVersionUID = -9217457637987854167L;
59
60     /**
61      * Is the chapter number already set?
62      * @since    2.1.4
63      */
64     protected boolean numberSet = false;
65     
66     /**
67      * Create a new object.
68      *
69      * @param para     the Chapter title (as a <CODE>Paragraph</CODE>)
70      */
71     public ChapterAutoNumber(final Paragraph para) {
72         super(para, 0);
73     }
74
75     /**
76      * Create a new object.
77      * 
78      * @param title        the Chapter title (as a <CODE>String</CODE>)
79      */
80     public ChapterAutoNumber(final String title) {
81         super(title, 0);
82     }
83
84     /**
85      * Create a new section for this chapter and ad it.
86      *
87      * @param title  the Section title (as a <CODE>String</CODE>)
88      * @return Returns the new section.
89      */
90     public Section addSection(final String title) {
91         if (isAddedCompletely()) {
92             throw new IllegalStateException("This LargeElement has already been added to the Document.");
93         }
94         return addSection(title, 2);
95     }
96
97     /**
98      * Create a new section for this chapter and add it.
99      *
100      * @param title  the Section title (as a <CODE>Paragraph</CODE>)
101      * @return Returns the new section.
102      */
103     public Section addSection(final Paragraph title) {
104         if (isAddedCompletely()) {
105             throw new IllegalStateException("This LargeElement has already been added to the Document.");
106         }
107         return addSection(title, 2);
108     }
109     
110     /**
111      * Changes the Chapter number.
112      * @param    number    the new chapter number
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 }
125