FontManager.java revision 2362
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * This code is free software; you can redistribute it and/or modify it
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * under the terms of the GNU General Public License version 2 only, as
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * published by the Free Software Foundation. Oracle designates this
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * particular file as subject to the "Classpath" exception as provided
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * by Oracle in the LICENSE file that accompanied this code.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * This code is distributed in the hope that it will be useful, but WITHOUT
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * version 2 for more details (a copy is included in the LICENSE file that
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * accompanied this code).
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * You should have received a copy of the GNU General Public License version
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * 2 along with this work; if not, write to the Free Software Foundation,
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * or visit www.oracle.com if you need additional information or have any
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * questions.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Interface between Java Fonts (java.awt.Font) and the underlying
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * font files/native font resources and the Java and native font scalers.
18c2aff776a775d34a4c9893a4c72e0434d68e36artempublic interface FontManager {
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine // These constants are used in findFont().
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public static final int PHYSICAL_FALLBACK = 1;
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public static final int LOGICAL_FALLBACK = 2;
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * Register a new font. Please, note that {@code null} is not a valid
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * argument, and it's caller's responsibility to ensure that, but to keep
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * compatibility, if {@code null} is passed as an argument, {@code false}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * is returned, and no {@link NullPointerException}
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * is thrown.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * As additional note, an implementation should ensure that this font
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * cannot override existing installed fonts.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @return {@code true} is the font is successfully registered,
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * {@code false} otherwise.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public void deRegisterBadFont(Font2D font2D);
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * The client supplies a name and a style.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * The name could be a family name, or a full name.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * A font may exist with the specified style, or it may
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * exist only in some other style. For non-native fonts the scaler
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * may be able to emulate the required style.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public Font2D findFont2D(String name, int style, int fallback);
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * Creates a Font2D for the specified font file, that is expected
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * to be in the specified font format (according to the constants
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * in java.awt.Font). The parameter {@code isCopy} is set to true
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * when the specified font file is actually a copy of the font data
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * and needs to be deleted afterwards. This method is called
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * for the Font.createFont() methods.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param fontFile the file holding the font data
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param fontFormat the expected font format
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param isCopy {@code true} if the file is a copy and needs to be
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * deleted, {@code false} otherwise
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @return the created Font2D instance
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public Font2D createFont2D(File fontFile, int fontFormat,
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine boolean isCopy, CreatedFontTracker tracker)
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * If usingPerAppContextComposites is true, we are in "applet"
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * (eg browser) enviroment and at least one context has selected
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * an alternate composite font behaviour.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public boolean usingPerAppContextComposites();
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * Creates a derived composite font from the specified font (handle).
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param family the font family of the derived font
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param style the font style of the derived font
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @param handle the original font (handle)
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @return the handle for the derived font
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine public Font2DHandle getNewComposite(String family, int style,
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * Indicates a preference for locale-specific fonts in the mapping of
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * logical fonts to physical fonts. Calling this method indicates that font
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * rendering should primarily use fonts specific to the primary writing
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * system (the one indicated by the default encoding and the initial
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * default locale). For example, if the primary writing system is
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * Japanese, then characters should be rendered using a Japanese font
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * if possible, and other fonts should only be used for characters for
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * which the Japanese font doesn't have glyphs.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * The actual change in font rendering behavior resulting from a call
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * to this method is implementation dependent; it may have no effect at
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * all, or the requested behavior may already match the default behavior.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * The behavior may differ between font rendering in lightweight
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * and peered components. Since calling this method requests a
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * different font, clients should expect different metrics, and may need
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * to recalculate window sizes and layout. Therefore this method should
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * be called before user interface initialisation.
97ddcdce0091922bf2049977a3d42ba4fc0857a6Artem Kachitchkine * @see #preferProportionalFonts()
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * preferLocaleFonts() and preferProportionalFonts() are called to inform
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * that the application could be using an alternate set of composite
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * fonts, and so the implementation should try to create a CompositeFonts
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * with this directive in mind.
18c2aff776a775d34a4c9893a4c72e0434d68e36artem * @see #preferLocaleFonts()