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