KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > text > RtfTab


1 /*
2  * $Id: RtfTab.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  * Co-Developer of the code is Mark Hall. Portions created by the Co-Developer are
23  * Copyright (C) 2006 by Mark Hall. All Rights Reserved
24  *
25  * Contributor(s): all the names of the contributors are added in the source code
26  * where applicable.
27  *
28  * Alternatively, the contents of this file may be used under the terms of the
29  * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
30  * provisions of LGPL are applicable instead of those above. If you wish to
31  * allow use of your version of this file only under the terms of the LGPL
32  * License and not to allow others to use your version of this file under
33  * the MPL, indicate your decision by deleting the provisions above and
34  * replace them with the notice and other provisions required by the LGPL.
35  * If you do not delete the provisions above, a recipient may use your version
36  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
37  *
38  * This library is free software; you can redistribute it and/or modify it
39  * under the terms of the MPL as stated above or under the terms of the GNU
40  * Library General Public License as published by the Free Software Foundation;
41  * either version 2 of the License, or any later version.
42  *
43  * This library is distributed in the hope that it will be useful, but WITHOUT
44  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
45  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
46  * details.
47  *
48  * If you didn't download this code from the following link, you should check if
49  * you aren't using an obsolete version:
50  * http://www.lowagie.com/iText/
51  */
52
53 package com.lowagie.text.rtf.text;
54
55 import java.io.ByteArrayOutputStream JavaDoc;
56 import java.io.IOException JavaDoc;
57 import java.io.OutputStream JavaDoc;
58
59 import com.lowagie.text.rtf.RtfAddableElement;
60
61 /**
62  * The RtfTab encapsulates a tab position and tab type in a paragraph.
63  * To add tabs to a paragraph construct new RtfTab objects with the desired
64  * tab position and alignment and then add them to the paragraph. In the actual
65  * text the tabs are then defined as standard \t characters.<br /><br />
66  *
67  * <code>RtfTab tab = new RtfTab(300, RtfTab.TAB_LEFT_ALIGN);<br />
68  * Paragraph para = new Paragraph();<br />
69  * para.add(tab);<br />
70  * para.add("This paragraph has a\ttab defined.");</code>
71  *
72  * @version $Id: RtfTab.java 2776 2007-05-23 20:01:40Z hallm $
73  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
74  * @author Thomas Bickel (tmb99@inode.at)
75  */
76 public class RtfTab extends RtfAddableElement {
77
78     /**
79      * A tab where the text is left aligned.
80      */
81     public static final int TAB_LEFT_ALIGN = 0;
82     /**
83      * A tab where the text is centre aligned.
84      */
85     public static final int TAB_CENTER_ALIGN = 1;
86     /**
87      * A tab where the text is right aligned.
88      */
89     public static final int TAB_RIGHT_ALIGN = 2;
90     /**
91      * A tab where the text is aligned on the decimal character. Which
92      * character that is depends on the language settings of the viewer.
93      */
94     public static final int TAB_DECIMAL_ALIGN = 3;
95     
96     /**
97      * The tab position in twips.
98      */
99     private int position = 0;
100     /**
101      * The tab alignment.
102      */
103     private int type = TAB_LEFT_ALIGN;
104     
105     /**
106      * Constructs a new RtfTab with the given position and type. The position
107      * is in standard iText points. The type is one of the tab alignment
108      * constants defined in the RtfTab.
109      *
110      * @param position The position of the tab in points.
111      * @param type The tab type constant.
112      */
113     public RtfTab(float position, int type) {
114         this.position = (int) Math.round(position * TWIPS_FACTOR);
115         switch(type) {
116         case TAB_LEFT_ALIGN: this.type = TAB_LEFT_ALIGN; break;
117         case TAB_CENTER_ALIGN: this.type = TAB_CENTER_ALIGN; break;
118         case TAB_RIGHT_ALIGN: this.type = TAB_RIGHT_ALIGN; break;
119         case TAB_DECIMAL_ALIGN: this.type = TAB_DECIMAL_ALIGN; break;
120         default: this.type = TAB_LEFT_ALIGN; break;
121         }
122     }
123     
124     /**
125      * Writes the tab settings.
126      * @deprecated replaced by {@link #writeContent(OutputStream)}
127      */
128     public byte[] write() {
129         ByteArrayOutputStream JavaDoc result = new ByteArrayOutputStream JavaDoc();
130         try {
131             writeContent(result);
132         } catch(IOException JavaDoc ioe) {
133             ioe.printStackTrace();
134         }
135         return result.toByteArray();
136     }
137     
138     /**
139      * Writes the tab settings.
140      */
141     public void writeContent(final OutputStream JavaDoc result) throws IOException JavaDoc
142     {
143         switch(this.type) {
144             case TAB_CENTER_ALIGN: result.write("\\tqc".getBytes()); break;
145             case TAB_RIGHT_ALIGN: result.write("\\tqr".getBytes()); break;
146             case TAB_DECIMAL_ALIGN: result.write("\\tqdec".getBytes()); break;
147         }
148         result.write("\\tx".getBytes());
149         result.write(intToByteArray(this.position));
150     }
151     
152 }
153
Popular Tags