| java.lang.Object
 javax.microedition.lcdui.Font
| Font | | final public class Font (Code) | | 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.
since:
MIDP 1.0 |
| Field Summary | |
| final public static int | FACE_MONOSPACE
The "monospace" font face. | | final public static int | FACE_PROPORTIONAL
The "proportional" font face. | | final public static int | FACE_SYSTEM
The "system" font face. | | final public static int | FONT_INPUT_TEXT
Font specifier used by the implementation to draw text input by
a user. | | final public static int | FONT_STATIC_TEXT
Default font specifier used to draw Item and Screen contents. | | final public static int | SIZE_LARGE
The "large" system-dependent font size. | | final public static int | SIZE_MEDIUM
The "medium" system-dependent font size. | | final public static int | SIZE_SMALL
The "small" system-dependent font size. | | final public static int | STYLE_BOLD
The bold style constant. | | final public static int | STYLE_ITALIC
The italicized style constant. | | final public static int | STYLE_PLAIN
The plain style constant. | | final public static int | STYLE_UNDERLINED
The underlined style constant. |
| Method Summary | |
| native public int | charWidth(char ch)
Gets the advance width of the specified character in this Font. | | native public 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).
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. | | public int | getBaselinePosition()
Gets the distance in pixels from the top of the text to the text's
baseline. | | public static Font | getDefaultFont()
Gets the default font of the system. | | public int | getFace()
Gets the face of the font. | | public static Font | getFont(int fontSpecifier)
Gets the Font used by the high level user interface
for the fontSpecifier passed in. | | public static Font | getFont(int inp_face, int inp_style, int inp_size)
Obtains an object representing a font having the specified face, style,
and size. | | public int | getHeight()
Gets the standard height of a line of text in this font. | | public int | getSize()
Gets the size of the font. | | public int | getStyle()
Gets the style of the font. | | public boolean | isBold()
Returns true if the font is bold. | | public boolean | isItalic()
Returns true if the font is italic. | | public boolean | isPlain()
Returns true if the font is plain. | | public boolean | isUnderlined()
Returns true if the font is underlined. | | native public int | stringWidth(java.lang.String str)
Gets the total advance width for showing the specified
String
in this Font. | | native public int | substringWidth(String str, int offset, int len)
Gets the total advance width for showing the specified substring in this
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. |
| FACE_MONOSPACE | | final public static int FACE_MONOSPACE(Code) | | The "monospace" font face.
Value 32 is assigned to FACE_MONOSPACE.
|
| FACE_PROPORTIONAL | | final public static int FACE_PROPORTIONAL(Code) | | The "proportional" font face.
Value 64 is assigned to
FACE_PROPORTIONAL.
|
| FACE_SYSTEM | | final public static int FACE_SYSTEM(Code) | | The "system" font face.
Value 0 is assigned to FACE_SYSTEM.
|
| FONT_INPUT_TEXT | | final public static int FONT_INPUT_TEXT(Code) | | Font specifier used by the implementation to draw text input by
a user.
FONT_INPUT_TEXT has the value 1.
See Also: Font.getFont(int fontSpecifier) |
| FONT_STATIC_TEXT | | final public static int FONT_STATIC_TEXT(Code) | | Default font specifier used to draw Item and Screen contents.
FONT_STATIC_TEXT has the value 0.
See Also: Font.getFont(int fontSpecifier) |
| SIZE_LARGE | | final public static int SIZE_LARGE(Code) | | The "large" system-dependent font size.
Value 16 is assigned to SIZE_LARGE.
|
| SIZE_MEDIUM | | final public static int SIZE_MEDIUM(Code) | | The "medium" system-dependent font size.
Value 0 is assigned to STYLE_MEDIUM.
|
| SIZE_SMALL | | final public static int SIZE_SMALL(Code) | | The "small" system-dependent font size.
Value 8 is assigned to STYLE_SMALL.
|
| STYLE_BOLD | | final public static int STYLE_BOLD(Code) | | The bold style constant. This may be combined with the
other style constants for mixed styles.
Value 1 is assigned to STYLE_BOLD.
|
| STYLE_ITALIC | | final public static int STYLE_ITALIC(Code) | | The italicized style constant. This may be combined with
the other style constants for mixed styles.
Value 2 is assigned to STYLE_ITALIC.
|
| STYLE_PLAIN | | final public static int STYLE_PLAIN(Code) | | The plain style constant. This may be combined with the
other style constants for mixed styles.
Value 0 is assigned to STYLE_PLAIN.
|
| STYLE_UNDERLINED | | final public static int STYLE_UNDERLINED(Code) | | The underlined style constant. This may be combined with
the other style constants for mixed styles.
Value 4 is assigned to STYLE_UNDERLINED.
|
| charWidth | | native public int charWidth(char ch)(Code) | | Gets the advance width of the specified character in this Font.
The advance width is the horizontal distance that would be occupied if
ch were to be drawn using this Font,
including inter-character spacing following
ch necessary for proper positioning of subsequent text.
Parameters:
ch - the character to be measured the total advance width (a non-negative value) |
| charsWidth | | native public int charsWidth(char[] ch, int offset, int length)(Code) | | Returns the advance width of the characters in 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.
Parameters:
ch - the array of characters
Parameters:
offset - the index of the first character to measure
Parameters:
length - the number of characters to measure the width of the character range
throws:
ArrayIndexOutOfBoundsException - if offset andlength specify aninvalid range
throws:
NullPointerException - if ch is null |
| getBaselinePosition | | public int getBaselinePosition()(Code) | | Gets the distance in pixels from the top of the text to the text's
baseline.
the distance in pixels from the top of the text to the text'sbaseline |
| getDefaultFont | | public static Font getDefaultFont()(Code) | | Gets the default font of the system.
the default font |
| getFace | | public int getFace()(Code) | | Gets the face of the font.
one of FACE_SYSTEM,FACE_PROPORTIONAL, FACE_MONOSPACE |
| getFont | | public static Font getFont(int fontSpecifier)(Code) | | Gets the 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.
Parameters:
fontSpecifier - one of FONT_INPUT_TEXT, orFONT_STATIC_TEXT font that corresponds to the passed in font specifier
throws:
IllegalArgumentException - if fontSpecifier is not a valid fontSpecifier |
| getFont | | public static Font getFont(int inp_face, int inp_style, int inp_size)(Code) | | Obtains an object representing a font having the specified face, style,
and size. If a matching font does not exist, the system will
attempt to provide the closest match. This method always
returns
a valid font object, even if it is not a close match to the request.
Parameters:
inp_face - one of FACE_SYSTEM,FACE_MONOSPACE, or FACE_PROPORTIONAL
Parameters:
inp_style - STYLE_PLAIN, or a combination ofSTYLE_BOLD,STYLE_ITALIC, and STYLE_UNDERLINED
Parameters:
inp_size - one of SIZE_SMALL, SIZE_MEDIUM,or SIZE_LARGE instance the nearest font found
throws:
IllegalArgumentException - if face, style, or size are notlegal values |
| getHeight | | public int getHeight()(Code) | | Gets the standard height of a line of text in this font. This value
includes sufficient spacing to ensure that lines of text painted this
distance from anchor point to anchor point are spaced as intended by the
font designer and the device. This extra space (leading) occurs below
the text.
standard height of a line of text in this font (a non-negative value) |
| getSize | | public int getSize()(Code) | | Gets the size of the font.
one of SIZE_SMALL, SIZE_MEDIUM,SIZE_LARGE |
| getStyle | | public int getStyle()(Code) | | Gets the style of the font. The value is an OR'ed
combination of
STYLE_BOLD, STYLE_ITALIC, and
STYLE_UNDERLINED; or the value is
zero (STYLE_PLAIN).
style of the current font
See Also: Font.isPlain()
See Also: Font.isBold()
See Also: Font.isItalic() |
| isBold | | public boolean isBold()(Code) | | Returns true if the font is bold.
See Also: Font.getStyle() true if font is bold |
| isItalic | | public boolean isItalic()(Code) | | Returns true if the font is italic.
See Also: Font.getStyle() true if font is italic |
| isPlain | | public boolean isPlain()(Code) | | Returns true if the font is plain.
See Also: Font.getStyle() true if font is plain |
| isUnderlined | | public boolean isUnderlined()(Code) | | Returns true if the font is underlined.
See Also: Font.getStyle() true if font is underlined |
| stringWidth | | native public int stringWidth(java.lang.String str)(Code) | | Gets the total advance width for showing the specified
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.
Parameters:
str - the String to be measured the total advance width
throws:
NullPointerException - if str is null |
| substringWidth | | native public int substringWidth(String str, int offset, int len)(Code) | | Gets the total advance width for showing the specified substring in this
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().
Parameters:
str - the String to be measured
Parameters:
offset - zero-based index of first character in the substring
Parameters:
len - length of the substring the total advance width
throws:
StringIndexOutOfBoundsException - if offset andlength specify aninvalid range
throws:
NullPointerException - if str is null |
|
|