Java tutorial
/* * * This file is part of the iText (R) project. Copyright (c) 1998-2019 iText Group NV * Authors: Bruno Lowagie, Paulo Soares, et al. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License version 3 * as published by the Free Software Foundation with the addition of the * following permission added to Section 15 as permitted in Section 7(a): * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT * OF THIRD PARTY RIGHTS * * This program 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 Affero General Public License for more details. * You should have received a copy of the GNU Affero General Public License * along with this program; if not, see http://www.gnu.org/licenses or write to * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA, 02110-1301 USA, or download the license from the following URL: * http://itextpdf.com/terms-of-use/ * * The interactive user interfaces in modified source and object code versions * of this program must display Appropriate Legal Notices, as required under * Section 5 of the GNU Affero General Public License. * * In accordance with Section 7(b) of the GNU Affero General Public License, * a covered work must retain the producer line in every PDF that is created * or manipulated using iText. * * You can be released from the requirements of the license by purchasing * a commercial license. Buying such a license is mandatory as soon as you * develop commercial activities involving the iText software without * disclosing the source code of your own applications. * These activities include: offering paid services to customers as an ASP, * serving PDFs on the fly in a web application, shipping iText with a closed * source product. * * For more information, please contact iText Software Corp. at this * address: sales@itextpdf.com */ package com.itextpdf.text; import java.util.Set; import com.itextpdf.text.error_messages.MessageLocalization; import com.itextpdf.text.pdf.BaseFont; /** * If you are using True Type fonts, you can declare the paths of the different ttf- and ttc-files * to this static class first and then create fonts in your code using one of the static getFont-method * without having to enter a path as parameter. * * @author Bruno Lowagie */ public final class FontFactory { /** This is a possible value of a base 14 type 1 font */ public static final String COURIER = BaseFont.COURIER; /** This is a possible value of a base 14 type 1 font */ public static final String COURIER_BOLD = BaseFont.COURIER_BOLD; /** This is a possible value of a base 14 type 1 font */ public static final String COURIER_OBLIQUE = BaseFont.COURIER_OBLIQUE; /** This is a possible value of a base 14 type 1 font */ public static final String COURIER_BOLDOBLIQUE = BaseFont.COURIER_BOLDOBLIQUE; /** This is a possible value of a base 14 type 1 font */ public static final String HELVETICA = BaseFont.HELVETICA; /** This is a possible value of a base 14 type 1 font */ public static final String HELVETICA_BOLD = BaseFont.HELVETICA_BOLD; /** This is a possible value of a base 14 type 1 font */ public static final String HELVETICA_OBLIQUE = BaseFont.HELVETICA_OBLIQUE; /** This is a possible value of a base 14 type 1 font */ public static final String HELVETICA_BOLDOBLIQUE = BaseFont.HELVETICA_BOLDOBLIQUE; /** This is a possible value of a base 14 type 1 font */ public static final String SYMBOL = BaseFont.SYMBOL; /** This is a possible value of a base 14 type 1 font */ public static final String TIMES = "Times"; /** This is a possible value of a base 14 type 1 font */ public static final String TIMES_ROMAN = BaseFont.TIMES_ROMAN; /** This is a possible value of a base 14 type 1 font */ public static final String TIMES_BOLD = BaseFont.TIMES_BOLD; /** This is a possible value of a base 14 type 1 font */ public static final String TIMES_ITALIC = BaseFont.TIMES_ITALIC; /** This is a possible value of a base 14 type 1 font */ public static final String TIMES_BOLDITALIC = BaseFont.TIMES_BOLDITALIC; /** This is a possible value of a base 14 type 1 font */ public static final String ZAPFDINGBATS = BaseFont.ZAPFDINGBATS; private static FontFactoryImp fontImp = new FontFactoryImp(); /** This is the default encoding to use. */ public static String defaultEncoding = BaseFont.WINANSI; /** This is the default value of the <VAR>embedded</VAR> variable. */ public static boolean defaultEmbedding = BaseFont.NOT_EMBEDDED; /** Creates new FontFactory */ private FontFactory() { } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param embedded true if the font is to be embedded in the PDF * @param size the size of this font * @param style the style of this font * @param color the <CODE>BaseColor</CODE> of this font. * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final boolean embedded, final float size, final int style, final BaseColor color) { return fontImp.getFont(fontname, encoding, embedded, size, style, color); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param embedded true if the font is to be embedded in the PDF * @param size the size of this font * @param style the style of this font * @param color the <CODE>BaseColor</CODE> of this font. * @param cached true if the font comes from the cache or is added to * the cache if new, false if the font is always created new * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final boolean embedded, final float size, final int style, final BaseColor color, final boolean cached) { return fontImp.getFont(fontname, encoding, embedded, size, style, color, cached); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param embedded true if the font is to be embedded in the PDF * @param size the size of this font * @param style the style of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final boolean embedded, final float size, final int style) { return getFont(fontname, encoding, embedded, size, style, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param embedded true if the font is to be embedded in the PDF * @param size the size of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final boolean embedded, final float size) { return getFont(fontname, encoding, embedded, size, Font.UNDEFINED, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param embedded true if the font is to be embedded in the PDF * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final boolean embedded) { return getFont(fontname, encoding, embedded, Font.UNDEFINED, Font.UNDEFINED, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param size the size of this font * @param style the style of this font * @param color the <CODE>BaseColor</CODE> of this font. * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final float size, final int style, final BaseColor color) { return getFont(fontname, encoding, defaultEmbedding, size, style, color); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param size the size of this font * @param style the style of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final float size, final int style) { return getFont(fontname, encoding, defaultEmbedding, size, style, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @param size the size of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding, final float size) { return getFont(fontname, encoding, defaultEmbedding, size, Font.UNDEFINED, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param encoding the encoding of the font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final String encoding) { return getFont(fontname, encoding, defaultEmbedding, Font.UNDEFINED, Font.UNDEFINED, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param size the size of this font * @param style the style of this font * @param color the <CODE>BaseColor</CODE> of this font. * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final float size, final int style, final BaseColor color) { return getFont(fontname, defaultEncoding, defaultEmbedding, size, style, color); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param size the size of this font * @param color the <CODE>BaseColor</CODE> of this font. * @return the Font constructed based on the parameters * @since 2.1.0 */ public static Font getFont(final String fontname, final float size, final BaseColor color) { return getFont(fontname, defaultEncoding, defaultEmbedding, size, Font.UNDEFINED, color); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param size the size of this font * @param style the style of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final float size, final int style) { return getFont(fontname, defaultEncoding, defaultEmbedding, size, style, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @param size the size of this font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname, final float size) { return getFont(fontname, defaultEncoding, defaultEmbedding, size, Font.UNDEFINED, null); } /** * Constructs a <CODE>Font</CODE>-object. * * @param fontname the name of the font * @return the Font constructed based on the parameters */ public static Font getFont(final String fontname) { return getFont(fontname, defaultEncoding, defaultEmbedding, Font.UNDEFINED, Font.UNDEFINED, null); } /** * Register a font by giving explicitly the font family and name. * @param familyName the font family * @param fullName the font name * @param path the font path */ public static void registerFamily(final String familyName, final String fullName, final String path) { fontImp.registerFamily(familyName, fullName, path); } /** * Register a ttf- or a ttc-file. * * @param path the path to a ttf- or ttc-file */ public static void register(final String path) { register(path, null); } /** * Register a font file and use an alias for the font contained in it. * * @param path the path to a font file * @param alias the alias you want to use for the font */ public static void register(final String path, final String alias) { fontImp.register(path, alias); } /** Register all the fonts in a directory. * @param dir the directory * @return the number of fonts registered */ public static int registerDirectory(final String dir) { return fontImp.registerDirectory(dir); } /** * Register all the fonts in a directory and possibly its subdirectories. * @param dir the directory * @param scanSubdirectories recursively scan subdirectories if <code>true</true> * @return the number of fonts registered * @since 2.1.2 */ public static int registerDirectory(final String dir, final boolean scanSubdirectories) { return fontImp.registerDirectory(dir, scanSubdirectories); } /** Register fonts in some probable directories. It usually works in Windows, * Linux and Solaris. * @return the number of fonts registered */ public static int registerDirectories() { return fontImp.registerDirectories(); } /** * Gets a set of registered fontnames. * @return a set of registered fonts */ public static Set<String> getRegisteredFonts() { return fontImp.getRegisteredFonts(); } /** * Gets a set of registered fontnames. * @return a set of registered font families */ public static Set<String> getRegisteredFamilies() { return fontImp.getRegisteredFamilies(); } /** * Gets a set of registered fontnames. * @param fontname of a font that may or may not be registered * @return true if a given font is registered */ public static boolean contains(final String fontname) { return fontImp.isRegistered(fontname); } /** * Checks if a certain font is registered. * * @param fontname the name of the font that has to be checked. * @return true if the font is found */ public static boolean isRegistered(final String fontname) { return fontImp.isRegistered(fontname); } /** * Gets the font factory implementation. * @return the font factory implementation */ public static FontFactoryImp getFontImp() { return fontImp; } /** * Sets the font factory implementation. * @param fontImp the font factory implementation */ public static void setFontImp(final FontFactoryImp fontImp) { if (fontImp == null) throw new NullPointerException(MessageLocalization.getComposedMessage("fontfactoryimp.cannot.be.null")); FontFactory.fontImp = fontImp; } }