KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > list > RtfListTable


1 /*
2  * $Id: RtfListTable.java 2776 2007-05-23 20:01:40Z hallm $
3  * $Name$
4  *
5  * Copyright 2001, 2002, 2003, 2004 by Mark Hall
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text.rtf.list;
52
53 import java.io.ByteArrayOutputStream JavaDoc;
54 import java.io.IOException JavaDoc;
55 import java.io.OutputStream JavaDoc;
56 import java.util.ArrayList JavaDoc;
57
58 import com.lowagie.text.rtf.RtfElement;
59 import com.lowagie.text.rtf.RtfExtendedElement;
60 import com.lowagie.text.rtf.document.RtfDocument;
61
62
63 /**
64  * The RtfListTable manages all RtfLists in one RtfDocument. It also generates
65  * the list and list override tables in the document header.
66  *
67  * @version $Id: RtfListTable.java 2776 2007-05-23 20:01:40Z hallm $
68  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
69  * @author Thomas Bickel (tmb99@inode.at)
70  */
71 public class RtfListTable extends RtfElement implements RtfExtendedElement {
72
73     /**
74      * Constant for the list number
75      */
76     protected static final byte[] LIST_NUMBER = "\\ls".getBytes();
77     /**
78      * Constant for the list table
79      */
80     private static final byte[] LIST_TABLE = "\\*\\listtable".getBytes();
81     /**
82      * Constant for the list
83      */
84     private static final byte[] LIST = "\\list".getBytes();
85     /**
86      * Constant for the list template id
87      */
88     private static final byte[] LIST_TEMPLATE_ID = "\\listtemplateid".getBytes();
89     /**
90      * Constant for the hybrid list
91      */
92     private static final byte[] LIST_HYBRID = "\\hybrid".getBytes();
93     /**
94      * Constant for the list id
95      */
96     private static final byte[] LIST_ID = "\\listid".getBytes();
97     /**
98      * Constant for the list override table
99      */
100     private static final byte[] LIST_OVERRIDE_TABLE = "\\*\\listoverridetable".getBytes();
101     /**
102      * Constant for the list override
103      */
104     private static final byte[] LIST_OVERRIDE = "\\listoverride".getBytes();
105     /**
106      * Constant for the list override count
107      */
108     private static final byte[] LIST_OVERRIDE_COUNT = "\\listoverridecount".getBytes();
109     
110     /**
111      * The RtfLists managed by this RtfListTable
112      */
113     private ArrayList JavaDoc lists;
114     
115     /**
116      * Constructs a RtfListTable for a RtfDocument
117      *
118      * @param doc The RtfDocument this RtfListTable belongs to
119      */
120     public RtfListTable(RtfDocument doc) {
121         super(doc);
122         
123         this.lists = new ArrayList JavaDoc();
124     }
125
126     /**
127      * unused
128      * @deprecated replaced by {@link #writeContent(OutputStream)}
129      */
130     public byte[] write()
131     {
132         return(new byte[0]);
133     }
134     /**
135      * unused
136      */
137     public void writeContent(final OutputStream JavaDoc out) throws IOException JavaDoc
138     {
139     }
140     
141     /**
142      * Writes the list and list override tables.
143      *
144      * @return A byte array with the list and list override tables.
145      * @deprecated replaced by {@link #writeDefinition(OutputStream)}
146      */
147     public byte[] writeDefinition() {
148         ByteArrayOutputStream JavaDoc result = new ByteArrayOutputStream JavaDoc();
149         try {
150             writeDefinition(result);
151         } catch(IOException JavaDoc ioe) {
152             ioe.printStackTrace();
153         }
154         return result.toByteArray();
155     }
156     
157     /**
158      * Writes the list and list override tables.
159      */
160     public void writeDefinition(final OutputStream JavaDoc result) throws IOException JavaDoc
161     {
162         final int[] listIds = new int[lists.size()];
163         result.write(OPEN_GROUP);
164         result.write(LIST_TABLE);
165         result.write("\n".getBytes());
166         for(int i = 0; i < lists.size(); i++) {
167             result.write(OPEN_GROUP);
168             result.write(LIST);
169             result.write(LIST_TEMPLATE_ID);
170             result.write(intToByteArray(document.getRandomInt()));
171             result.write(LIST_HYBRID);
172             result.write("\n".getBytes());
173             final RtfList rList = (RtfList) lists.get(i);
174             //.result.write(rList.writeDefinition());
175 rList.writeDefinition(result);
176             result.write(LIST_ID);
177             listIds[i] = document.getRandomInt();
178             result.write(intToByteArray(listIds[i]));
179             result.write(CLOSE_GROUP);
180             result.write("\n".getBytes());
181         }
182         result.write(CLOSE_GROUP);
183         result.write("\n".getBytes());
184         result.write(OPEN_GROUP);
185         result.write(LIST_OVERRIDE_TABLE);
186         result.write("\n".getBytes());
187         for(int i = 0; i < lists.size(); i++) {
188             result.write(OPEN_GROUP);
189             result.write(LIST_OVERRIDE);
190             result.write(LIST_ID);
191             result.write(intToByteArray(listIds[i]));
192             result.write(LIST_OVERRIDE_COUNT);
193             result.write(intToByteArray(0));
194             result.write(LIST_NUMBER);
195             result.write(intToByteArray(((RtfList) lists.get(i)).getListNumber()));
196             result.write(CLOSE_GROUP);
197             result.write("\n".getBytes());
198         }
199         result.write(CLOSE_GROUP);
200         result.write("\n".getBytes());
201     }
202
203     /**
204      * Gets the id of the specified RtfList. If the RtfList is not yet in the
205      * list of RtfLists, then it is added.
206      *
207      * @param list The RtfList for which to get the id.
208      * @return The id of the RtfList.
209      */
210     public int getListNumber(RtfList list) {
211         if(lists.contains(list)) {
212             return lists.indexOf(list);
213         } else {
214             lists.add(list);
215             return lists.size();
216         }
217     }
218     
219     /**
220      * Remove a RtfList from the list of RtfLists
221      *
222      * @param list The RtfList to remove.
223      */
224     public void freeListNumber(RtfList list) {
225         int i = lists.indexOf(list);
226         if(i >= 0) {
227             lists.remove(i);
228         }
229     }
230 }
231
Popular Tags