001/*
002 * $Id: ZapfDingbatsList.java 4885 2011-05-29 13:49:53Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text;
045
046/**
047 *
048 * A special-version of <CODE>LIST</CODE> which use zapfdingbats-letters.
049 *
050 * @see com.itextpdf.text.List
051 * @author Michael Niedermair and Bruno Lowagie
052 */
053
054public class ZapfDingbatsList extends List {
055
056        /**
057         * char-number in zapfdingbats
058         */
059        protected int zn;
060
061        /**
062         * Creates a ZapfDingbatsList
063         *
064         * @param zn a char-number
065         */
066        public ZapfDingbatsList(int zn) {
067                super(true);
068                this.zn = zn;
069                float fontsize = symbol.getFont().getSize();
070                symbol.setFont(FontFactory.getFont(FontFactory.ZAPFDINGBATS, fontsize, Font.NORMAL));
071                postSymbol = " ";
072        }
073
074        /**
075         * Creates a ZapfDingbatsList
076         *
077         * @param zn a char-number
078         * @param symbolIndent  indent
079         */
080        public ZapfDingbatsList(int zn, int symbolIndent) {
081                super(true, symbolIndent);
082                this.zn = zn;
083                float fontsize = symbol.getFont().getSize();
084                symbol.setFont(FontFactory.getFont(FontFactory.ZAPFDINGBATS, fontsize, Font.NORMAL));
085                postSymbol = " ";
086        }
087
088        /**
089         * set the char-number
090         * @param zn a char-number
091         */
092        public void setCharNumber(int zn) {
093                this.zn = zn;
094        }
095
096        /**
097         * get the char-number
098         *
099         * @return      char-number
100         */
101        public int getCharNumber() {
102                return zn;
103        }
104
105        /**
106         * Adds an <CODE>Element</CODE> to the <CODE>List</CODE>.
107         *
108         * @param       o       the object to add.
109         * @return true if adding the object succeeded
110         */
111        @Override
112        public boolean add(Element o) {
113                if (o instanceof ListItem) {
114                        ListItem item = (ListItem) o;
115                        Chunk chunk = new Chunk(preSymbol, symbol.getFont());
116            chunk.setAttributes(symbol.getAttributes());
117                        chunk.append(String.valueOf((char)zn));
118                        chunk.append(postSymbol);
119                        item.setListSymbol(chunk);
120                        item.setIndentationLeft(symbolIndent, autoindent);
121                        item.setIndentationRight(0);
122                        list.add(item);
123                } else if (o instanceof List) {
124                        List nested = (List) o;
125                        nested.setIndentationLeft(nested.getIndentationLeft() + symbolIndent);
126                        first--;
127                        return list.add(nested);
128                }
129                return false;
130        }
131}