1 /* 2 * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package sun.font; 26 27 import java.awt.Font; 28 import java.awt.FontFormatException; 29 import java.io.File; 30 import java.util.Locale; 31 import java.util.TreeMap; 32 33 import javax.swing.plaf.FontUIResource; 34 35 import javax.tools.annotation.GenerateNativeHeader; 36 37 /** 38 * Interface between Java Fonts (java.awt.Font) and the underlying 39 * font files/native font resources and the Java and native font scalers. 40 */ 41 /* No native methods here, but the constants are needed in the supporting JNI code */ 42 @GenerateNativeHeader 43 public interface FontManager { 44 45 // These constants are used in findFont(). 46 public static final int NO_FALLBACK = 0; 47 public static final int PHYSICAL_FALLBACK = 1; 48 public static final int LOGICAL_FALLBACK = 2; 49 50 /** 51 * Register a new font. Please, note that {@code null} is not a valid 52 * argument, and it's caller's responsibility to ensure that, but to keep 53 * compatibility, if {@code null} is passed as an argument, {@code false} 54 * is returned, and no {@link NullPointerException} 55 * is thrown. 56 * 57 * As additional note, an implementation should ensure that this font 58 * cannot override existing installed fonts. 59 * 60 * @param font 61 * @return {@code true} is the font is successfully registered, 62 * {@code false} otherwise. 63 */ 64 public boolean registerFont(Font font); 65 66 public void deRegisterBadFont(Font2D font2D); 67 68 /** 69 * The client supplies a name and a style. 70 * The name could be a family name, or a full name. 71 * A font may exist with the specified style, or it may 72 * exist only in some other style. For non-native fonts the scaler 73 * may be able to emulate the required style. 74 */ 75 public Font2D findFont2D(String name, int style, int fallback); 76 77 /** 78 * Creates a Font2D for the specified font file, that is expected 79 * to be in the specified font format (according to the constants 80 * in java.awt.Font). The parameter {@code isCopy} is set to true 81 * when the specified font file is actually a copy of the font data 82 * and needs to be deleted afterwards. This method is called 83 * for the Font.createFont() methods. 84 * 85 * @param fontFile the file holding the font data 86 * @param fontFormat the expected font format 87 * @param isCopy {@code true} if the file is a copy and needs to be 88 * deleted, {@code false} otherwise 89 * 90 * @return the created Font2D instance 91 */ 92 public Font2D createFont2D(File fontFile, int fontFormat, 93 boolean isCopy, CreatedFontTracker tracker) 94 throws FontFormatException; 95 96 /** 97 * If usingPerAppContextComposites is true, we are in "applet" 98 * (eg browser) enviroment and at least one context has selected 99 * an alternate composite font behaviour. 100 */ 101 public boolean usingPerAppContextComposites(); 102 103 /** 104 * Creates a derived composite font from the specified font (handle). 105 * 106 * @param family the font family of the derived font 107 * @param style the font style of the derived font 108 * @param handle the original font (handle) 109 * 110 * @return the handle for the derived font 111 */ 112 public Font2DHandle getNewComposite(String family, int style, 113 Font2DHandle handle); 114 115 /** 116 * Indicates a preference for locale-specific fonts in the mapping of 117 * logical fonts to physical fonts. Calling this method indicates that font 118 * rendering should primarily use fonts specific to the primary writing 119 * system (the one indicated by the default encoding and the initial 120 * default locale). For example, if the primary writing system is 121 * Japanese, then characters should be rendered using a Japanese font 122 * if possible, and other fonts should only be used for characters for 123 * which the Japanese font doesn't have glyphs. 124 * <p> 125 * The actual change in font rendering behavior resulting from a call 126 * to this method is implementation dependent; it may have no effect at 127 * all, or the requested behavior may already match the default behavior. 128 * The behavior may differ between font rendering in lightweight 129 * and peered components. Since calling this method requests a 130 * different font, clients should expect different metrics, and may need 131 * to recalculate window sizes and layout. Therefore this method should 132 * be called before user interface initialisation. 133 * 134 * @see #preferProportionalFonts() 135 * @since 1.5 136 */ 137 public void preferLocaleFonts(); 138 139 /** 140 * preferLocaleFonts() and preferProportionalFonts() are called to inform 141 * that the application could be using an alternate set of composite 142 * fonts, and so the implementation should try to create a CompositeFonts 143 * with this directive in mind. 144 * 145 * @see #preferLocaleFonts() 146 */ 147 public void preferProportionalFonts(); 148 149 }