KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > RomanList


1 /*
2  * Copyright 2003 by Michael Niedermair and 2007 Bruno Lowagie.
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 package com.lowagie.text;
48
49 import com.lowagie.text.factories.RomanNumberFactory;
50
51 /**
52  *
53  * A special-version of <CODE>LIST</CODE> which use roman-letters.
54  *
55  * @see com.lowagie.text.List
56  */
57
58 public class RomanList extends List {
59
60 // constructors
61
62     /**
63      * Initialization
64      */
65     public RomanList() {
66         super(true);
67     }
68
69     /**
70      * Initialization
71      *
72      * @param symbolIndent indent
73      */
74     public RomanList(int symbolIndent) {
75         super(true, symbolIndent);
76     }
77
78     /**
79      * Initialization
80      * @param lowercase roman-char in lowercase
81      * @param symbolIndent indent
82      */
83     public RomanList(boolean lowercase, int symbolIndent) {
84         super(true, symbolIndent);
85         this.lowercase = lowercase;
86     }
87
88 // overridden method
89
90     /**
91      * Adds an <CODE>Object</CODE> to the <CODE>List</CODE>.
92      *
93      * @param o the object to add.
94      * @return true if adding the object succeeded
95      */
96     public boolean add(Object JavaDoc o) {
97         if (o instanceof ListItem) {
98             ListItem item = (ListItem) o;
99             Chunk chunk;
100             chunk = new Chunk(RomanNumberFactory.getString(first + list.size(), lowercase), symbol.getFont());
101             chunk.append(". ");
102             item.setListSymbol(chunk);
103             item.setIndentationLeft(symbolIndent, autoindent);
104             item.setIndentationRight(0);
105             list.add(item);
106         } else if (o instanceof List) {
107             List nested = (List) o;
108             nested.setIndentationLeft(nested.getIndentationLeft() + symbolIndent);
109             first--;
110             return list.add(nested);
111         } else if (o instanceof String JavaDoc) {
112             return this.add(new ListItem((String JavaDoc) o));
113         }
114         return false;
115     }
116     
117 // deprecated methods
118
119     /**
120      * @deprecated use RomanNumberFactory.getString(int)
121      */
122     public static String JavaDoc toRoman(int number) {
123         return RomanNumberFactory.getString(number);
124     }
125     /**
126      * @deprecated use RomanNumberFactory.getString(int, boolean)
127      */
128     public static String JavaDoc toRomanLowerCase(int number) {
129         return RomanNumberFactory.getString(number, true);
130     }
131     /**
132      * @deprecated use RomanNumberFactory.getString(int, boolean)
133      */
134     public static String JavaDoc toRomanUpperCase(int number) {
135         return RomanNumberFactory.getString(number, false);
136     }
137
138     /**
139      * set the roman-letters to lowercase otherwise to uppercase
140      *
141      * @param romanlower
142      * @deprecated use setLowercase(boolean)
143      */
144     public void setRomanLower(boolean romanlower) {
145         setLowercase(romanlower);
146     }
147
148     /**
149      * Checks if the list is roman-letter with lowercase
150      *
151      * @return <CODE>true</CODE> if the roman-letter is lowercase, <CODE>false</CODE> otherwise.
152      * @deprecated use isLowercase()
153      */
154     public boolean isRomanLower() {
155         return isLowercase();
156     }
157 }
158
Popular Tags