From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001 From: tknall Date: Fri, 1 Dec 2006 12:20:24 +0000 Subject: Initial import of release 2.2. git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c --- .../java/com/lowagie/text/pdf/PdfPageLabels.java | 191 +++++++++++++++++++++ 1 file changed, 191 insertions(+) create mode 100644 src/main/java/com/lowagie/text/pdf/PdfPageLabels.java (limited to 'src/main/java/com/lowagie/text/pdf/PdfPageLabels.java') diff --git a/src/main/java/com/lowagie/text/pdf/PdfPageLabels.java b/src/main/java/com/lowagie/text/pdf/PdfPageLabels.java new file mode 100644 index 0000000..2c3bf28 --- /dev/null +++ b/src/main/java/com/lowagie/text/pdf/PdfPageLabels.java @@ -0,0 +1,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 Integer. + * @param obj the first Integer + * @param obj1 the second Integer + * @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 true + */ + 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 null 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 null 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; + } +} -- cgit v1.2.3