Font

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.lwuit
Class Font

java.lang.Object
  com.sun.lwuit.Font

public class Font
extends java.lang.Object
extends java.lang.Object

A simple abstraction of platform fonts and library fonts that enables the library to use more elaborate fonts unsupported by a specific device. This abstraction also supports bitmap fonts using an Ant task (more details about the unifier are explained in the javadoc overview document).

A bitmap font can be created manually but that is tedious, normally you would use the Ant task as illustrated bellow to produce a resource file containing the supported bitmap font. For further detail read the overview document and Resources.

<target name="pre-init">
     <taskdef classpath="ImageUnifier.jar" classname="com.sun.jwt.resource.Builder" name="build" />
     <build dest="src/font.res">
        <font src="images/arial.ttf" bold="true" italic="true" size="11" />
        <font logicalName="Dialog" />
    </build>
</target>

The following attributes can be expressed for a font ant task:

name - name for the font to load from the resource file (optional: defaults to logical name or file name).
charset - defaults to the English alphabet, numbers and common signs. Should contain a list of all characters that should be supported by a font. E.g. if a font would always be used for uppercase letters then it would save space to define the charset as: "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
src - font file in the case of using a file, defaults to TrueType font
size - floating point size of the font
bold - defaults to false indicates if the font should be bold
italic - defaults to false indicates if the font should be italic
trueType - defaults to true, relevant only when src is used. If set to false type 1 fonts are assumed.
antiAliasing - defaults to true otherwise fonts will be aliased
logicalName - logical name of the font as specified by java.awt.Font in Java SE: Dialog, DialogInput, Monospaced, Serif, or SansSerif

Field Summary
`static int`	`FACE_MONOSPACE` Constant allowing us to author portable system fonts
`static int`	`FACE_PROPORTIONAL` Constant allowing us to author portable system fonts
`static int`	`FACE_SYSTEM` Constant allowing us to author portable system fonts
`static int`	`SIZE_LARGE` Constant allowing us to author portable system fonts
`static int`	`SIZE_MEDIUM` Constant allowing us to author portable system fonts
`static int`	`SIZE_SMALL` Constant allowing us to author portable system fonts
`static int`	`STYLE_BOLD` Constant allowing us to author portable system fonts
`static int`	`STYLE_ITALIC` Constant allowing us to author portable system fonts
`static int`	`STYLE_PLAIN` Constant allowing us to author portable system fonts
`static int`	`STYLE_UNDERLINED` Constant allowing us to author portable system fonts

Method Summary
`void`	`addContrast(byte value)` Increase the contrast of the bitmap font for rendering on top of a surface whose color is darker.
`int`	`charsWidth(char[] ch, int offset, int length)` Return the width of the given characters in this font instance
`int`	`charWidth(char ch)` Return the width of the specific character when rendered alone
`static void`	`clearBitmapCache()` Bitmap fonts are cached this method allows us to flush the cache thus allows us to reload a font
`static Font`	`create(java.lang.String lookup)` Creates a new font instance based on the platform specific string name of the font.
`static Font`	`createBitmapFont(Image bitmap, int[] cutOffsets, int[] charWidth, java.lang.String charsets)` Creates a bitmap font with the given arguments
`static Font`	`createBitmapFont(java.lang.String name, Image bitmap, int[] cutOffsets, int[] charWidth, java.lang.String charsets)` Creates a bitmap font with the given arguments and places said font in the cache
`static Font`	`createSystemFont(int face, int style, int size)` Creates a system native font in a similar way to common MIDP fonts
`static Font`	`createTrueTypeFont(java.io.InputStream stream)` Creates a true type font from the given stream if the underlying platform supports truetype font loading.
`boolean`	`equals(java.lang.Object o)`
`static Font`	`getBitmapFont(java.lang.String fontName)` Returns a previously loaded bitmap font from cache
`java.lang.String`	`getCharset()` Returns a string containing all the characters supported by this font.
`static Font`	`getDefaultFont()` Return the global default font instance
`int`	`getFace()` Return Optional operation returning the font face for system fonts
`int`	`getHeight()` Return the total height of the font
`java.lang.Object`	`getNativeFont()` Returns the internal implementation specific font object
`int`	`getSize()` Return Optional operation returning the font size for system fonts
`int`	`getStyle()` Return Optional operation returning the font style for system fonts
`static boolean`	`isBitmapFontEnabled()` Indicates whether bitmap fonts should be enabled when loading or the fallback system font should be used instead.
`static boolean`	`isCreationByStringSupported()` Returns true if the underlying platform allows creating a font based on a user submitted string.
`static boolean`	`isTrueTypeFileSupported()` Returns true if the underlying platform supports loading truetype fonts from a file stream.
`static void`	`setBitmapFontEnabled(boolean enabled)` Indicates whether bitmap fonts should be enabled by default when loading or the fallback system font should be used instead.
`static void`	`setDefaultFont(Font f)` Sets the global default font instance
`int`	`stringWidth(java.lang.String str)` Return the width of the given string in this font instance
`int`	`substringWidth(java.lang.String str, int offset, int len)` Return the width of the given string subset in this font instance

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail