Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/* $Id$ $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: https://github.com/LibrePDF/OpenPDF */
package com.lowagie.text.pdf;
import com.lowagie.text.error_messages.MessageLocalization;
import com.lowagie.text.ExceptionConverter;
import com.lowagie.text.factories.RomanAlphabetFactory;
import com.lowagie.text.factories.RomanNumberFactory;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/**
* Page labels are used to identify each page visually on the screen or in print.
*
* @author Paulo Soares ([email protected])
*/
public class PdfPageLabels {
/**
* Logical pages will have the form 1,2,3,...
*/
public static final int DECIMAL_ARABIC_NUMERALS = 0;
/**
* Logical pages will have the form I,II,III,IV,...
*/
public static final int UPPERCASE_ROMAN_NUMERALS = 1;
/**
* Logical pages will have the form i,ii,iii,iv,...
*/
public static final 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 final 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 final int LOWERCASE_LETTERS = 4;
/**
* No logical page numbers are generated but fixed text may still exist
*/
public static final 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
*/
private HashMap map;
/**
* Creates a new PdfPageLabel with a default logical page 1
*/
public PdfPageLabels() {
map = new HashMap<>();
addPageLabel(1, PdfPageLabels.DECIMAL_ARABIC_NUMERALS, null, 1);
}
/**
* 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(
MessageLocalization.getComposedMessage("in.a.page.label.the.page.numbers.must.be.greater.or.equal.to.1"));
}
PdfDictionary dic = new PdfDictionary();
if (numberStyle >= 0 && numberStyle < PdfPageLabels.numberingStyle.length) {
dic.put(PdfName.S, PdfPageLabels.numberingStyle[numberStyle]);
}
if (text != null) {
dic.put(PdfName.P, new PdfString(text, PdfObject.TEXT_UNICODE));
}
if (firstPage != 1) {
dic.put(PdfName.ST, new PdfNumber(firstPage));
}
map.put(page - 1, dic);
}
/**
* 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);
}
/**
* Adds or replaces a page label.
* @param format the PdfPageLabelFormat to add
*/
public void addPageLabel(PdfPageLabelFormat format) {
addPageLabel(format.physicalPage, format.numberStyle, format.prefix, format.logicalPage);
}
/**
* 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(page - 1);
}
/**
* Gets the page label dictionary to insert into the document.
*
* @return the page label dictionary
*/
PdfDictionary getDictionary(PdfWriter writer) {
try {
return PdfNumberTree.writeTree(map, writer);
} catch (IOException e) {
throw new ExceptionConverter(e);
}
}
/**
* Retrieves the page labels from a PDF as an array of String objects.
*
* @param reader
* a PdfReader object that has the page labels you want to retrieve
* @return a String array or null if no page labels are present
*/
public static String[] getPageLabels(PdfReader reader) {
int n = reader.getNumberOfPages();
PdfDictionary dict = reader.getCatalog();
PdfDictionary labels = (PdfDictionary) PdfReader.getPdfObjectRelease(dict.get(PdfName.PAGELABELS));
if (labels == null) {
return null;
}
String[] labelstrings = new String[n];
Map numberTree = PdfNumberTree.readTree(labels);
int pagecount = 1;
Integer current;
char type = 'D';
String prefix = "";
for (int i = 0; i < n; i++ ) {
current = i;
if (numberTree.containsKey(current)) {
PdfDictionary d = (PdfDictionary) PdfReader.getPdfObjectRelease(numberTree.get(current));
if (d.contains(PdfName.ST)) {
pagecount = ((PdfNumber) d.get(PdfName.ST)).intValue();
} else {
pagecount = 1;
}
if (d.contains(PdfName.P)) {
prefix = ((PdfString) d.get(PdfName.P)).toUnicodeString();
} else {
prefix = "";
}
if (d.contains(PdfName.S)) {
type = d.get(PdfName.S).toString().charAt(1);
}
}
switch (type) {
default:
labelstrings[i] = prefix + pagecount;
break;
case 'R':
labelstrings[i] = prefix + RomanNumberFactory.getUpperCaseString(pagecount);
break;
case 'r':
labelstrings[i] = prefix + RomanNumberFactory.getLowerCaseString(pagecount);
break;
case 'A':
labelstrings[i] = prefix + RomanAlphabetFactory.getUpperCaseString(pagecount);
break;
case 'a':
labelstrings[i] = prefix + RomanAlphabetFactory.getLowerCaseString(pagecount);
break;
}
pagecount++ ;
}
return labelstrings;
}
/**
* Retrieves the page labels from a PDF as an array of {@link PdfPageLabelFormat} objects.
*
* @param reader
* a PdfReader object that has the page labels you want to retrieve
* @return a PdfPageLabelEntry array, containing an entry for each format change or
* null if no page labels are present
*/
public static PdfPageLabelFormat[] getPageLabelFormats(PdfReader reader) {
PdfDictionary dict = reader.getCatalog();
PdfDictionary labels = (PdfDictionary) PdfReader.getPdfObjectRelease(dict.get(PdfName.PAGELABELS));
if (labels == null) {
return null;
}
Map numberTree = PdfNumberTree.readTree(labels);
Integer[] numbers = new Integer[numberTree.size()];
numbers = numberTree.keySet().toArray(numbers);
Arrays.sort(numbers);
PdfPageLabelFormat[] formats = new PdfPageLabelFormat[numberTree.size()];
String prefix;
int numberStyle;
int pagecount;
for (int k = 0; k < numbers.length; ++k) {
Integer key = numbers[k];
PdfDictionary d = (PdfDictionary) PdfReader.getPdfObjectRelease(numberTree.get(key));
if (d.contains(PdfName.ST)) {
pagecount = ((PdfNumber) d.get(PdfName.ST)).intValue();
} else {
pagecount = 1;
}
if (d.contains(PdfName.P)) {
prefix = ((PdfString) d.get(PdfName.P)).toUnicodeString();
} else {
prefix = "";
}
if (d.contains(PdfName.S)) {
char type = d.get(PdfName.S).toString().charAt(1);
switch (type) {
case 'R':
numberStyle = PdfPageLabels.UPPERCASE_ROMAN_NUMERALS;
break;
case 'r':
numberStyle = PdfPageLabels.LOWERCASE_ROMAN_NUMERALS;
break;
case 'A':
numberStyle = PdfPageLabels.UPPERCASE_LETTERS;
break;
case 'a':
numberStyle = PdfPageLabels.LOWERCASE_LETTERS;
break;
default:
numberStyle = PdfPageLabels.DECIMAL_ARABIC_NUMERALS;
break;
}
} else {
numberStyle = PdfPageLabels.EMPTY;
}
formats[k] = new PdfPageLabelFormat(key + 1, numberStyle, prefix, pagecount);
}
return formats;
}
public static class PdfPageLabelFormat {
public int physicalPage;
public int numberStyle;
public String prefix;
public int logicalPage;
/**
* Creates a page label format.
*
* @param physicalPage
* the real page to start the numbering. First page is 1
* @param numberStyle
* the numbering style such as LOWERCASE_ROMAN_NUMERALS
* @param prefix
* the text to prefix the number. Can be null or empty
* @param logicalPage
* the first logical page number
*/
public PdfPageLabelFormat( int physicalPage,
int numberStyle,
String prefix,
int logicalPage) {
this.physicalPage = physicalPage;
this.numberStyle = numberStyle;
this.prefix = prefix;
this.logicalPage = logicalPage;
}
@Override
public String toString() {
return "PdfPageLabelFormat{" +
"physicalPage=" + physicalPage +
", numberStyle=" + numberStyle +
", prefix='" + prefix + '\'' +
", logicalPage=" + logicalPage +
'}';
}
}
}
