com.aryjr.nheengatu.pdf.RomanList.java Source code

Java tutorial

Introduction

Here is the source code for com.aryjr.nheengatu.pdf.RomanList.java

Source

/*******************************************************************************
 * Copyright (c) 2006 - 2011 SJRJ.
 * 
 *     This file is part of SIGA.
 * 
 *     SIGA is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     SIGA 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 General Public License for more details.
 * 
 *     You should have received a copy of the GNU General Public License
 *     along with SIGA.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package com.aryjr.nheengatu.pdf;

import java.util.Iterator;

import com.aryjr.nheengatu.util.TagsManager;
import com.lowagie.text.Chunk;
import com.lowagie.text.List;
import com.lowagie.text.ListItem;

/*
 * Copyright 2003 by Michael Niedermair.
 *
 * 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/
 */

/**
 * 
 * A special-version of <CODE>LIST</CODE> which use roman-letters.
 * 
 * @see com.lowagie.text.List
 * @version 2003-06-22
 * @author Michael Niedermair
 */

public class RomanList extends List {

    /**
     * UpperCase or LowerCase
     */
    protected String listStyleType;

    /**
     * Initialization
     * 
     * @param symbolIndent   indent
     */
    public RomanList(int symbolIndent) {
        super(true, symbolIndent);
    }

    /**
     * Initialization 
     * @param   romanlower      roman-char in lowercase   
     * @param    symbolIndent   indent
     */
    public RomanList(String listStyleType, int symbolIndent) {
        super(true, symbolIndent);
        this.listStyleType = listStyleType;
    }

    /**
     * Adds an <CODE>Object</CODE> to the <CODE>List</CODE>.
     *
     * @param   o   the object to add.
     * @return true if adding the object succeeded
     */
    public boolean add(Object o) {
        if (o instanceof ListItem) {
            ListItem item = (ListItem) o;
            final TagsManager tm = TagsManager.getInstance();
            Chunk chunk;
            if (listStyleType != null && listStyleType.equals("lower-roman"))
                chunk = new Chunk(toRomanLowerCase(first + list.size()), tm.getFont());
            else if (listStyleType != null && listStyleType.equals("upper-roman"))
                chunk = new Chunk(toRomanUppercase(first + list.size()), tm.getFont());
            else if (listStyleType != null && listStyleType.equals("lower-alpha"))
                chunk = new Chunk(nextLetter(), tm.getFont());
            else if (listStyleType != null && listStyleType.equals("upper-alpha"))
                chunk = new Chunk(nextLetter(), tm.getFont());
            else
                chunk = new Chunk(String.valueOf(first + list.size()), tm.getFont());
            chunk.append(" - ");
            item.setListSymbol(chunk);
            item.setIndentationLeft(symbolIndent);
            item.setIndentationRight(0);
            list.add(item);
        } else if (o instanceof List) {
            List nested = (List) o;
            nested.setIndentationLeft(nested.getIndentationLeft() + symbolIndent);
            first--;
            return list.add(nested);
        } else if (o instanceof String) {
            return this.add(new ListItem((String) o));
        }
        return false;
    }

    /**
     * Retrieves the next letter in the sequence
     *
     * @return  String contains the next character (A-Z or a-z)
     */
    private String nextLetter() {
        /*Markenson: O cdigo abaixo foi desabilitado quando o
         * nheengatu deixou de utilizar o itext-1.4.jar. Como este mtodo tem 
        * forte dependncia com o itext v 1.4, mas no est sendo utilizado,
        * o mesmo foi desativado. Alm disso, foram feitos vrios testes e 
        * para qualquer valor retornado, no afeta o resultado em romano.
         */
        /*           int num_in_list = listItemsInList(); //list.size();
                   int max_ival = (lastCh + 0);
                   int ival = (firstCh + num_in_list);
            
                   while ( ival > max_ival ) {
           ival -= 26;
                   }
                   char[] new_char = new char[1];
                   new_char[0] = (char) ival;
                   String ret = new String( new_char );
                   return ret;
        */
        return "";
    }

    /**
    * Counts the number of ListItems in the list ommiting nested lists
    *
    * @return  Integer number of ListItems in the list
    */
    private int listItemsInList() {
        int result = 0;
        for (Iterator i = list.iterator(); i.hasNext();) {
            if (!(i.next() instanceof List))
                result++;
        }
        return result;
    }

    // ****************************************************************************************

    /*
     * Wandelt eine Integer-Zahl in rmische Schreibweise um
     *
     * Regeln: http://de.wikipedia.org/wiki/R%F6mische_Ziffern
     *  
     * 1. Die Ziffern werden addiert, wobei sie von gro nach klein sortiert sind:
     *
     *  XVII = 10+5+1+1=17 
     *
     * 2. Eine kleinere Ziffer, die links von einer greren steht, wird abgezogen:
     * 
     *  IV = 5-1=4 
     *  CM = 1000-100=900 
     *
     * 3. Maximal drei gleiche Ziffern stehen nebeneinander (Ausnahme: IIII auf Zifferblaettern von Uhren):
     * 
     *  XL = 40 (und nicht XXXX) 
     *  IX = 9 (und nicht VIIII) 
     *  Diese "Subtraktionsschreibweise" ist erst im Mittelalter allgemein gebruchlich geworden. 
     *  Vorher wurde oft "IIII" fr "4" geshrieben. 
     *
     * 4. Bei mehreren mglichen Schreibweisen wird in der Regel der krzesten der Vorzug gegeben:
     *
     *  IC = 99 (auch LXLIX) 
     *  IL = 49 (auch XLIX oder sogar XLVIV) 
     *  Andererseits gibt es die Vorschrift, nach der ein Symbol, das einen Wert von 10n darstellt, 
     *  nicht einem Symbol, das einen Wert von 10(n+1) darstellt, direkt voranstehen darf. 
     *  Nach dieser Regel wre die Schreibweise "XCIX" fr "99" der Schreibweise "IC" vorzuziehen. 
     *
     * 5. Die rmischen Zahlen V, L und D knnen nicht greren Zahlen voran gestellt werden:
     *
     *  XCV = 95 (nicht VC) 
     * 
     *  Zahlen ber 3000 werden dargestellt durch Einkastung der Tausender: |IX|LIV=9054
     * 
     *
     * Zahlen grer als 3.000.000 werden durch Doppelstrich etc. dargestellt.
     */

    /**
     * Array with Roman digits.
     */
    private static final RomanDigit[] roman = { new RomanDigit('m', 1000, false), new RomanDigit('d', 500, false),
            new RomanDigit('c', 100, true), new RomanDigit('l', 50, false), new RomanDigit('x', 10, true),
            new RomanDigit('v', 5, false), new RomanDigit('i', 1, true) };

    /** 
     * changes an int into a lower case roman number.
     * @param number the original number
     * @return the roman number (lower case)
     */
    public static String toRoman(int number) {
        return toRomanLowerCase(number);
    }

    /** 
     * Changes an int into an upper case roman number.
     * @param number the original number
     * @return the roman number (upper case)
     */
    public static String toRomanUppercase(int number) {
        return toRomanLowerCase(number).toUpperCase();
    }

    /** 
     * Changes an int into a lower case roman number.
     * @param number the original number
     * @return the roman number (lower case)
     */
    public static String toRomanLowerCase(int number) {

        // Buffer
        StringBuffer buf = new StringBuffer();

        // kleiner 0 ? Vorzeichen festlegen
        if (number < 0) {
            buf.append('-');
            number = -number;
        }

        // grer 3000
        if (number > 3000) {
            // rekursiver Aufruf (ohne tausender-Bereich)
            buf.append('|');
            buf.append(toRomanLowerCase(number / 1000));
            buf.append('|');
            // tausender-Bereich 
            number = number - (number / 1000) * 1000;
        }

        // Schleife
        int pos = 0;
        while (true) {
            // roman-array durchlaufen
            RomanDigit dig = roman[pos];

            // solange Zahl grer roman-Wert
            while (number >= dig.value) {
                // Zeichen hinzufgen
                buf.append(dig.digit);
                // Wert des Zeichens abziehen
                number -= dig.value;
            }

            // Abbruch
            if (number <= 0) {
                break;
            }
            // pre=false suchen (ab Stelle pos)
            int j = pos;
            while (!roman[++j].pre)
                ;

            // neuer Wert grer
            if (number + roman[j].value >= dig.value) {
                // hinzufgen
                buf.append(roman[j].digit).append(dig.digit);
                // Wert vom Rest abziehen
                number -= dig.value - roman[j].value;
            }
            pos++;
        }
        return buf.toString();
    }

    /**
     * Helper class for Roman Digits
     */
    private static class RomanDigit {

        /** part of a roman number */
        public char digit;

        /** value of the roman digit */
        public int value;

        /** can the digit be used as a prefix */
        public boolean pre;

        /**
         * Constructs a roman digit
         * @param digit the roman digit
         * @param value the value
         * @param pre can it be used as a prefix
         */
        RomanDigit(char digit, int value, boolean pre) {
            this.digit = digit;
            this.value = value;
            this.pre = pre;
        }
    }

}