1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*
* $Id: PdfPageLabels.java,v 1.46 2005/05/04 14:32:31 blowagie Exp $
* $Name: $
*
* Copyright 2001, 2002 Paulo Soares
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import java.util.Comparator;
import java.util.TreeMap;
import java.util.Iterator;
/** Page labels are used to identify each
* page visually on the screen or in print.
* @author Paulo Soares (psoares@consiste.pt)
*/
public class PdfPageLabels implements Comparator {
/** Logical pages will have the form 1,2,3,...
*/
public static int DECIMAL_ARABIC_NUMERALS = 0;
/** Logical pages will have the form I,II,III,IV,...
*/
public static int UPPERCASE_ROMAN_NUMERALS = 1;
/** Logical pages will have the form i,ii,iii,iv,...
*/
public static int LOWERCASE_ROMAN_NUMERALS = 2;
/** Logical pages will have the form of uppercase letters
* (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)
*/
public static int UPPERCASE_LETTERS = 3;
/** Logical pages will have the form of uppercase letters
* (a to z for the first 26 pages, aa to zz for the next 26, and so on)
*/
public static int LOWERCASE_LETTERS = 4;
/** No logical page numbers are generated but fixed text may
* still exist
*/
public static int EMPTY = 5;
/** Dictionary values to set the logical page styles
*/
static PdfName numberingStyle[] = new PdfName[]{PdfName.D, PdfName.R,
new PdfName("r"), PdfName.A, new PdfName("a")};
/** The sequence of logical pages. Will contain at least a value for page 1
*/
TreeMap map;
/** Creates a new PdfPageLabel with a default logical page 1
*/
public PdfPageLabels() {
map = new TreeMap(this);
addPageLabel(1, DECIMAL_ARABIC_NUMERALS, null, 1);
}
/** Compares two <CODE>Integer</CODE>.
* @param obj the first <CODE>Integer</CODE>
* @param obj1 the second <CODE>Integer</CODE>
* @return a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second
*/
public int compare(Object obj, Object obj1) {
int v1 = ((Integer)obj).intValue();
int v2 = ((Integer)obj1).intValue();
if (v1 < v2)
return -1;
if (v1 == v2)
return 0;
return 1;
}
/** Not used
* @param obj not used
* @return always <CODE>true</CODE>
*/
public boolean equals(Object obj) {
return true;
}
/** Adds or replaces a page label.
* @param page the real page to start the numbering. First page is 1
* @param numberStyle the numbering style such as LOWERCASE_ROMAN_NUMERALS
* @param text the text to prefix the number. Can be <CODE>null</CODE> or empty
* @param firstPage the first logical page number
*/
public void addPageLabel(int page, int numberStyle, String text, int firstPage) {
if (page < 1 || firstPage < 1)
throw new IllegalArgumentException("In a page label the page numbers must be greater or equal to 1.");
PdfName pdfName = null;
if (numberStyle >= 0 && numberStyle < numberingStyle.length)
pdfName = numberingStyle[numberStyle];
Integer iPage = new Integer(page);
Object obj = new Object[]{iPage, pdfName, text, new Integer(firstPage)};
map.put(iPage, obj);
}
/** Adds or replaces a page label. The first logical page has the default
* of 1.
* @param page the real page to start the numbering. First page is 1
* @param numberStyle the numbering style such as LOWERCASE_ROMAN_NUMERALS
* @param text the text to prefix the number. Can be <CODE>null</CODE> or empty
*/
public void addPageLabel(int page, int numberStyle, String text) {
addPageLabel(page, numberStyle, text, 1);
}
/** Adds or replaces a page label. There is no text prefix and the first
* logical page has the default of 1.
* @param page the real page to start the numbering. First page is 1
* @param numberStyle the numbering style such as LOWERCASE_ROMAN_NUMERALS
*/
public void addPageLabel(int page, int numberStyle) {
addPageLabel(page, numberStyle, null, 1);
}
/** Removes a page label. The first page label can not be removed, only changed.
* @param page the real page to remove
*/
public void removePageLabel(int page) {
if (page <= 1)
return;
map.remove(new Integer(page));
}
/** Gets the page label dictionary to insert into the document.
* @return the page label dictionary
*/
PdfDictionary getDictionary() {
PdfDictionary dic = new PdfDictionary();
PdfArray array = new PdfArray();
for (Iterator it = map.values().iterator(); it.hasNext();) {
Object obj[] = (Object[])it.next();
PdfDictionary subDic = new PdfDictionary();
PdfName pName = (PdfName)obj[1];
if (pName != null)
subDic.put(PdfName.S, pName);
String text = (String)obj[2];
if (text != null)
subDic.put(PdfName.P, new PdfString(text, PdfObject.TEXT_UNICODE));
int st = ((Integer)obj[3]).intValue();
if (st != 1)
subDic.put(PdfName.ST, new PdfNumber(st));
array.add(new PdfNumber(((Integer)obj[0]).intValue() - 1));
array.add(subDic);
}
dic.put(PdfName.NUMS, array);
return dic;
}
}
|
