1 /*
2  * Copyright (c) 2003, 2019, 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 
26 package sun.font;
27 
28 import java.awt.Font;
29 import java.awt.FontFormatException;
30 import java.io.File;
31 
32 /**
33  * Interface between Java Fonts (java.awt.Font) and the underlying
34  * font files/native font resources and the Java and native font scalers.
35  */
36 public interface FontManager {
37 
38     // These constants are used in findFont().
39     public static final int NO_FALLBACK = 0;
40     public static final int PHYSICAL_FALLBACK = 1;
41     public static final int LOGICAL_FALLBACK = 2;
42 
43     /**
44      * Register a new font. Please, note that {@code null} is not a valid
45      * argument, and it's caller's responsibility to ensure that, but to keep
46      * compatibility, if {@code null} is passed as an argument, {@code false}
47      * is returned, and no {@link NullPointerException}
48      * is thrown.
49      *
50      * As additional note, an implementation should ensure that this font
51      * cannot override existing installed fonts.
52      *
53      * @param font
54      * @return {@code true} is the font is successfully registered,
55      * {@code false} otherwise.
56      */
registerFont(Font font)57     public boolean registerFont(Font font);
58 
deRegisterBadFont(Font2D font2D)59     public void deRegisterBadFont(Font2D font2D);
60 
61     /**
62      * The client supplies a name and a style.
63      * The name could be a family name, or a full name.
64      * A font may exist with the specified style, or it may
65      * exist only in some other style. For non-native fonts the scaler
66      * may be able to emulate the required style.
67      */
findFont2D(String name, int style, int fallback)68     public Font2D findFont2D(String name, int style, int fallback);
69 
70     /**
71      * Creates a Font2D for the specified font file, that is expected
72      * to be in the specified font format (according to the constants
73      * in java.awt.Font). The parameter {@code isCopy} is set to true
74      * when the specified font file is actually a copy of the font data
75      * and needs to be deleted afterwards. This method is called
76      * for the Font.createFont() methods.
77      *
78      * @param fontFile the file holding the font data
79      * @param fontFormat the expected font format
80      * @param all whether to retrieve all fonts in the resource or
81      *        just the first one.
82      * @param isCopy {@code true} if the file is a copy and needs to be
83      *        deleted, {@code false} otherwise
84      *
85      * @return the created Font2D instance
86      */
createFont2D(File fontFile, int fontFormat, boolean all, boolean isCopy, CreatedFontTracker tracker)87     public Font2D[] createFont2D(File fontFile, int fontFormat, boolean all,
88                                  boolean isCopy, CreatedFontTracker tracker)
89         throws FontFormatException;
90 
91     /**
92      * Creates a derived composite font from the specified font (handle).
93      *
94      * @param family the font family of the derived font
95      * @param style the font style of the derived font
96      * @param handle the original font (handle)
97      *
98      * @return the handle for the derived font
99      */
getNewComposite(String family, int style, Font2DHandle handle)100     public Font2DHandle getNewComposite(String family, int style,
101                                         Font2DHandle handle);
102 
103     /**
104      * Indicates a preference for locale-specific fonts in the mapping of
105      * logical fonts to physical fonts. Calling this method indicates that font
106      * rendering should primarily use fonts specific to the primary writing
107      * system (the one indicated by the default encoding and the initial
108      * default locale). For example, if the primary writing system is
109      * Japanese, then characters should be rendered using a Japanese font
110      * if possible, and other fonts should only be used for characters for
111      * which the Japanese font doesn't have glyphs.
112      * <p>
113      * The actual change in font rendering behavior resulting from a call
114      * to this method is implementation dependent; it may have no effect at
115      * all, or the requested behavior may already match the default behavior.
116      * The behavior may differ between font rendering in lightweight
117      * and peered components.  Since calling this method requests a
118      * different font, clients should expect different metrics, and may need
119      * to recalculate window sizes and layout. Therefore this method should
120      * be called before user interface initialisation.
121      *
122      * @see #preferProportionalFonts()
123      * @since 1.5
124      */
preferLocaleFonts()125     public void preferLocaleFonts();
126 
127     /**
128      * preferLocaleFonts() and preferProportionalFonts() are called to inform
129      * that the application could be using an alternate set of composite
130      * fonts, and so the implementation should try to create a CompositeFonts
131      * with this directive in mind.
132      *
133      * @see #preferLocaleFonts()
134      */
preferProportionalFonts()135     public void preferProportionalFonts();
136 
137 }
138