Typeface.java revision bbed0d68c815446400193bdc8b16fbf73e1ee664
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.graphics; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.res.AssetManager; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 21a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guyimport java.io.File; 22a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The Typeface class specifies the typeface and intrinsic style of a font. 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is used in the paint, along with optionally Paint settings like 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * textSize, textSkewX, textScaleX to specify 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * how text appears when drawn (and measured). 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Typeface { 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The default NORMAL typeface object */ 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Typeface DEFAULT; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The default BOLD typeface object. Note: this may be not actually be 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * bold, depending on what fonts are installed. Call getStyle() to know 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for sure. 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Typeface DEFAULT_BOLD; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The NORMAL style of the default sans serif typeface. */ 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Typeface SANS_SERIF; 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The NORMAL style of the default serif typeface. */ 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Typeface SERIF; 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The NORMAL style of the default monospace typeface. */ 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Typeface MONOSPACE; 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static Typeface[] sDefaults; 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* package */ int native_instance; 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Style 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int NORMAL = 0; 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int BOLD = 1; 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int ITALIC = 2; 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int BOLD_ITALIC = 3; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Returns the typeface's intrinsic style attributes */ 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getStyle() { 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return nativeGetStyle(native_instance); 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Returns true if getStyle() has the BOLD bit set. */ 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean isBold() { 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return (getStyle() & BOLD) != 0; 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Returns true if getStyle() has the ITALIC bit set. */ 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public final boolean isItalic() { 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return (getStyle() & ITALIC) != 0; 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a typeface object given a family name, and option style information. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If null is passed for the name, then the "default" font will be chosen. 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The resulting typeface object can be queried (getStyle()) to discover what 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its "real" style characteristics are. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param familyName May be null. The name of the font family. 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param style The style (normal, bold, italic) of the typeface. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The best matching typeface. 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static Typeface create(String familyName, int style) { 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new Typeface(nativeCreate(familyName, style)); 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a typeface object that best matches the specified existing 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * typeface and the specified Style. Use this call if you want to pick a new 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * style from the same family of an existing typeface object. If family is 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * null, this selects from the default font's family. 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param family May be null. The name of the existing type face. 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param style The style (normal, bold, italic) of the typeface. 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The best matching typeface. 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static Typeface create(Typeface family, int style) { 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int ni = 0; 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (family != null) { 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ni = family.native_instance; 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new Typeface(nativeCreateFromTypeface(ni, style)); 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns one of the default typeface objects, based on the specified style 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the default typeface that corresponds to the style 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static Typeface defaultFromStyle(int style) { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sDefaults[style]; 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a new typeface from the specified font data. 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param mgr The application's asset manager 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param path The file name of the font data in the assets directory 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The new typeface. 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static Typeface createFromAsset(AssetManager mgr, String path) { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new Typeface(nativeCreateFromAsset(mgr, path)); 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 123a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy 124a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy /** 125a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * Create a new typeface from the specified font file. 126a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * 127a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * @param path The path to the font data. 128a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * @return The new typeface. 129a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy */ 130a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy public static Typeface createFromFile(File path) { 131a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy return new Typeface(nativeCreateFromFile(path.getAbsolutePath())); 132a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy } 133a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy 134a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy /** 135a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * Create a new typeface from the specified font file. 136a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * 137a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * @param path The full path to the font data. 138a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy * @return The new typeface. 139a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy */ 140a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy public static Typeface createFromFile(String path) { 141a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy return new Typeface(nativeCreateFromFile(path)); 142a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy } 143a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // don't allow clients to call this directly 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Typeface(int ni) { 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project native_instance = ni; 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static { 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT = create((String)null, 0); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT_BOLD = create((String)null, Typeface.BOLD); 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SANS_SERIF = create("sans-serif", 0); 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SERIF = create("serif", 0); 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MONOSPACE = create("monospace", 0); 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sDefaults = new Typeface[] { 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT, 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT_BOLD, 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project create((String)null, Typeface.ITALIC), 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project create((String)null, Typeface.BOLD_ITALIC), 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void finalize() throws Throwable { 165a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy super.finalize(); 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project nativeUnref(native_instance); 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native int nativeCreate(String familyName, int style); 170a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy private static native int nativeCreateFromTypeface(int native_instance, int style); 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native void nativeUnref(int native_instance); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static native int nativeGetStyle(int native_instance); 173a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy private static native int nativeCreateFromAsset(AssetManager mgr, String path); 174a87a132ebf1c2dd733cf52feff6e44525257c961Romain Guy private static native int nativeCreateFromFile(String path); 175dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed 176dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed /** 177dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * Set the global gamma coefficients for black and white text. This call is 178dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * usually a no-op in shipping products, and only exists for testing during 179dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * development. 180dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * 181dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * @param blackGamma gamma coefficient for black text 182dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed * @param whiteGamma gamma coefficient for white text 183bbed0d68c815446400193bdc8b16fbf73e1ee664Mike Reed * 184bbed0d68c815446400193bdc8b16fbf73e1ee664Mike Reed * @hide - this is just for calibrating devices, not for normal apps 185dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed */ 186dbade9d6a075b1d5b8ebe10ee8961a5de296c93bMike Reed public static native void setGammaForText(float blackGamma, float whiteGamma); 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 188