|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.microedition.lcdui.Font
The Font
class represents fonts and font
metrics. Fonts
cannot be
created by applications. Instead, applications query for fonts
based on
font attributes and the system will attempt to provide a font that
matches
the requested attributes as closely as possible.
A Font's
attributes are style, size, and face. Values for
attributes must be specified in terms of symbolic constants. Values for
the style attribute may be combined using the bit-wise
OR
operator,
whereas values for the other attributes may not be combined. For example,
the value
STYLE_BOLD | STYLE_ITALIC
may be used to specify a bold-italic font; however
SIZE_LARGE | SIZE_SMALL
is illegal.
The values of these constants are arranged so that zero is valid for each attribute and can be used to specify a reasonable default font for the system. For clarity of programming, the following symbolic constants are provided and are defined to have values of zero:
STYLE_PLAIN
SIZE_MEDIUM
FACE_SYSTEM
Values for other attributes are arranged to have disjoint bit patterns
in order to raise errors if they are inadvertently misused (for example,
using FACE_PROPORTIONAL
where a style is
required). However, the values
for the different attributes are not intended to be combined with each
other.
Field Summary | |
static int |
FACE_MONOSPACE
The "monospace" font face. |
static int |
FACE_PROPORTIONAL
The "proportional" font face. |
static int |
FACE_SYSTEM
The "system" font face. |
static int |
FONT_INPUT_TEXT
Font specifier used by the implementation to draw text input by a user. |
static int |
FONT_STATIC_TEXT
Default font specifier used to draw Item and Screen contents. |
static int |
SIZE_LARGE
The "large" system-dependent font size. |
static int |
SIZE_MEDIUM
The "medium" system-dependent font size. |
static int |
SIZE_SMALL
The "small" system-dependent font size. |
static int |
STYLE_BOLD
The bold style constant. |
static int |
STYLE_ITALIC
The italicized style constant. |
static int |
STYLE_PLAIN
The plain style constant. |
static int |
STYLE_UNDERLINED
The underlined style constant. |
Method Summary | |
int |
charsWidth(char[] ch,
int offset,
int length)
Returns the advance width of the characters in ch ,
starting at the specified offset and for the specified number of
characters (length). |
int |
charWidth(char ch)
Gets the advance width of the specified character in this Font. |
int |
getBaselinePosition()
Gets the distance in pixels from the top of the text to the text's baseline. |
static Font |
getDefaultFont()
Gets the default font of the system. |
int |
getFace()
Gets the face of the font. |
static Font |
getFont(int fontSpecifier)
Gets the Font used by the high level user interface
for the fontSpecifier passed in. |
static Font |
getFont(int face,
int style,
int size)
Obtains an object representing a font having the specified face, style, and size. |
int |
getHeight()
Gets the standard height of a line of text in this font. |
int |
getSize()
Gets the size of the font. |
int |
getStyle()
Gets the style of the font. |
boolean |
isBold()
Returns true if the font is bold. |
boolean |
isItalic()
Returns true if the font is italic. |
boolean |
isPlain()
Returns true if the font is plain. |
boolean |
isUnderlined()
Returns true if the font is underlined. |
int |
stringWidth(String str)
Gets the total advance width for showing the specified String
in this Font . |
int |
substringWidth(String str,
int offset,
int len)
Gets the total advance width for showing the specified substring in this Font . |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int STYLE_PLAIN
Value 0
is assigned to STYLE_PLAIN
.
public static final int STYLE_BOLD
Value 1
is assigned to STYLE_BOLD
.
public static final int STYLE_ITALIC
Value 2
is assigned to STYLE_ITALIC
.
public static final int STYLE_UNDERLINED
Value 4
is assigned to STYLE_UNDERLINED
.
public static final int SIZE_SMALL
Value 8
is assigned to STYLE_SMALL
.
public static final int SIZE_MEDIUM
Value 0
is assigned to STYLE_MEDIUM
.
public static final int SIZE_LARGE
Value 16
is assigned to SIZE_LARGE
.
public static final int FACE_SYSTEM
Value 0
is assigned to FACE_SYSTEM
.
public static final int FACE_MONOSPACE
Value 32
is assigned to FACE_MONOSPACE
.
public static final int FACE_PROPORTIONAL
Value 64
is assigned to
FACE_PROPORTIONAL
.
public static final int FONT_STATIC_TEXT
FONT_STATIC_TEXT
has the value 0
.getFont(int fontSpecifier)
public static final int FONT_INPUT_TEXT
FONT_INPUT_TEXT
has the value 1
.getFont(int fontSpecifier)
Method Detail |
public static Font getFont(int fontSpecifier)
Font
used by the high level user interface
for the fontSpecifier
passed in. It should be used
by subclasses of
CustomItem
and Canvas
to match user
interface on the device.fontSpecifier
- one of FONT_INPUT_TEXT
, or
FONT_STATIC_TEXT
IllegalArgumentException
- if fontSpecifier
is not
a valid fontSpecifierpublic static Font getDefaultFont()
public static Font getFont(int face, int style, int size)
face
- one of FACE_SYSTEM
,
FACE_MONOSPACE
, or FACE_PROPORTIONAL
style
- STYLE_PLAIN
, or a combination of
STYLE_BOLD
,
STYLE_ITALIC
, and STYLE_UNDERLINED
size
- one of SIZE_SMALL
, SIZE_MEDIUM
,
or SIZE_LARGE
IllegalArgumentException
- if face
,
style
, or size
are not
legal valuespublic int getStyle()
OR'ed
combination of
STYLE_BOLD
, STYLE_ITALIC
, and
STYLE_UNDERLINED
; or the value is
zero (STYLE_PLAIN
).isPlain()
,
isBold()
,
isItalic()
public int getSize()
SIZE_SMALL
, SIZE_MEDIUM
,
SIZE_LARGE
public int getFace()
FACE_SYSTEM
,
FACE_PROPORTIONAL
, FACE_MONOSPACE
public boolean isPlain()
true
if the font is plain.true
if font is plaingetStyle()
public boolean isBold()
true
if the font is bold.true
if font is boldgetStyle()
public boolean isItalic()
true
if the font is italic.true
if font is italicgetStyle()
public boolean isUnderlined()
true
if the font is underlined.true
if font is underlinedgetStyle()
public int getHeight()
public int getBaselinePosition()
public int charWidth(char ch)
ch
were to be drawn using this Font
,
including inter-character spacing following
ch
necessary for proper positioning of subsequent text.ch
- the character to be measuredpublic int charsWidth(char[] ch, int offset, int length)
ch
,
starting at the specified offset and for the specified number of
characters (length).
The advance width is the horizontal distance that would be occupied if
the characters were to be drawn using this Font
,
including inter-character spacing following
the characters necessary for proper positioning of subsequent text.
The offset
and length
parameters must
specify a valid range of characters
within the character array ch
. The offset
parameter must be within the
range [0..(ch.length)]
, inclusive.
The length
parameter must be a non-negative
integer such that (offset + length) <= ch.length
.
ch
- the array of charactersoffset
- the index of the first character to measurelength
- the number of characters to measureArrayIndexOutOfBoundsException
- if offset
and
length
specify an
invalid rangeNullPointerException
- if ch
is null
public int stringWidth(String str)
String
in this Font
.
The advance width is the horizontal distance that would be occupied if
str
were to be drawn using this Font
,
including inter-character spacing following
str
necessary for proper positioning of subsequent text.str
- the String
to be measuredNullPointerException
- if str
is null
public int substringWidth(String str, int offset, int len)
Font
.
The advance width is the horizontal distance that would be occupied if
the substring were to be drawn using this Font
,
including inter-character spacing following
the substring necessary for proper positioning of subsequent text.
The offset
and len
parameters must
specify a valid range of characters
within str
. The offset
parameter must
be within the
range [0..(str.length())]
, inclusive.
The len
parameter must be a non-negative
integer such that (offset + len) <= str.length()
.
str
- the String
to be measuredoffset
- zero-based index of first character in the substringlen
- length of the substringStringIndexOutOfBoundsException
- if offset
and
length
specify an
invalid rangeNullPointerException
- if str
is null
|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |