KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > style > RtfColorList


1 /*
2  * $Id: RtfColorList.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.style;
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 RtfColorList stores all colours that appear in the document. Black
65  * and White are always added
66  *
67  * @version $Id: RtfColorList.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 RtfColorList extends RtfElement implements RtfExtendedElement {
72
73     /**
74      * Constant for the beginning of the colour table
75      */

76     private static final byte[] COLOR_TABLE = "\\colortbl".getBytes();
77     
78     /**
79      * ArrayList containing all colours of this RtfColorList
80      */

81     ArrayList JavaDoc colorList = new ArrayList JavaDoc();
82     
83     /**
84      * Constructs a new RtfColorList for the RtfDocument. Will add the default
85      * black and white colours.
86      *
87      * @param doc The RtfDocument this RtfColorList belongs to
88      */

89     public RtfColorList(RtfDocument doc) {
90         super(doc);
91         colorList.add(new RtfColor(doc, 0, 0, 0, 0));
92         colorList.add(new RtfColor(doc, 255, 255, 255, 1));
93     }
94     
95     /**
96      * Returns the index of the given RtfColor in the colour list. If the RtfColor
97      * is not in the list of colours, then it is added.
98      *
99      * @param color The RtfColor for which to get the index
100      * @return The index of the RtfColor
101      */

102     public int getColorNumber(RtfColor color) {
103         int colorIndex = -1;
104         for(int i = 0; i < colorList.size(); i++) {
105             if(colorList.get(i).equals(color)) {
106                 colorIndex = i;
107             }
108         }
109         if(colorIndex == -1) {
110             colorIndex = colorList.size();
111             colorList.add(color);
112         }
113         return colorIndex;
114     }
115     
116     /**
117      * unused
118      * @deprecated replaced by {@link #writeContent(OutputStream)}
119      */

120     public byte[] write()
121     {
122         return(new byte[0]);
123     }
124     /**
125      * unused
126      */

127     public void writeContent(final OutputStream JavaDoc out) throws IOException JavaDoc
128     {
129     }
130     
131     /**
132      * Write the definition part of the colour list. Calls the writeDefinition
133      * methods of the RtfColors in the colour list.
134      *
135      * @return A byte array with the definition colour list
136      * @deprecated replaced by {@link #writeDefinition(OutputStream)}
137      */

138     public byte[] writeDefinition() {
139         ByteArrayOutputStream JavaDoc result = new ByteArrayOutputStream JavaDoc();
140         try {
141             writeDefinition(result);
142         } catch(IOException JavaDoc ioe) {
143             ioe.printStackTrace();
144         }
145         return result.toByteArray();
146     }
147
148     /**
149      * Write the definition part of the colour list. Calls the writeDefinition
150      * methods of the RtfColors in the colour list.
151      */

152     public void writeDefinition(final OutputStream JavaDoc result) throws IOException JavaDoc
153     {
154         result.write(OPEN_GROUP);
155         result.write(COLOR_TABLE);
156         for(int i = 0; i < colorList.size(); i++) {
157             RtfColor color = (RtfColor) colorList.get(i);
158             //.result.write(color.writeDefinition());
159
color.writeDefinition(result);
160         }
161         result.write(CLOSE_GROUP);
162         result.write((byte)'\n');
163     }
164     
165
166 }
167
Popular Tags