net.rim.device.api.ui.DrawTextParam.AdvancedDrawTextParam
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public static class DrawTextParam.AdvancedDrawTextParam
Advanced text drawing parameters. A DrawTextParam can optionally have a reference to an object of this type.
| Field Summary | ||
|---|---|---|
static int |
ALPHABETIC_BASELINE
Value for iBaseline: this identifies the baseline used by most alphabetic
and syllabic scripts. |
|
static int |
BOTTOM_BASELINE
Value for iBaseline: a baseline that is (descent + leading below)
lower than the alphabetic baseline. |
|
static int |
CENTRAL_BASELINE
Value for iBaseline: identifies a computed baseline that is at the
center of the EM box. |
|
static int |
DEFAULT_BASELINE
Value for iBaseline: the default baseline allows the baseline to be
specified by DrawTextParam.iAlignment, which supports fewer baselines
but is backward-compatible. |
|
static int |
HANGING_BASELINE
Value for iBaseline: this identifies the baseline used by certain Indic
scripts. |
|
static int |
HIGH_CENTRAL_BASELINE
Value for iBaseline: a baseline half way between TOP_BASELINE
and ALPHABETIC_BASELINE. |
|
static int |
IDEOGRAPHIC_BASELINE
Value for iBaseline: this identifies the baseline used by ideographic
scripts. |
|
static int |
MATHEMATICAL_BASELINE
Value for iBaseline: the baseline used for mathematical symbols. |
|
static int |
MIDDLE_BASELINE
Value for iBaseline: this identifies a baseline that is offset from the
alphabetic baseline in the shift-direction by half the value of the x-height
font characteristic. |
|
static int |
TEXT_AFTER_EDGE_BASELINE
Value for iBaseline: this identifies the after-edge of the EM box. |
|
static int |
TEXT_BEFORE_EDGE_BASELINE
Value for iBaseline: this identifies the before-edge of the EM box. |
|
static int |
TEXT_CASE_CAPITALIZE
Value for iTextCaseTransform: capitalizes the text. |
|
static int |
TEXT_CASE_LOWER
Value for iTextCaseTransform: changes the text to lower case. |
|
static int |
TEXT_CASE_NONE
Value for iTextCaseTransform: does not change the case of the text. |
|
static int |
TEXT_CASE_TITLE
Value for iTextCaseTransform: changes the text to Title Case. |
|
static int |
TEXT_CASE_UPPER
Value for iTextCaseTransform: changes the text to UPPER CASE. |
|
static int |
TOP_BASELINE
Value for iBaseline: a baseline that is (ascent + leading above) higher than the
alphabetic baseline. |
|
static int |
WORD_SPACE_ADD
Value for iWordSpacing: the supplied word space size is added to the
natural word space size. |
|
static int |
WORD_SPACE_MULTIPLY
Value for iWordSpacing: the supplied word space size is multiplied by
the natural word space size. |
|
static int |
WORD_SPACE_NATURAL
Value for iWordSpacing: uses the natural word spacing. |
|
static int |
WORD_SPACE_OVERRIDE
Value for iWordSpacing: the supplied word space size is used instead of
the natural word space size. |
|
boolean |
iAllowStartOverlap
If true |
|
int |
iBaseLine
The baseline controls how the text is aligned on the path on which it is drawn. |
|
boolean |
iCopyFit
If true, copy-fits the text - that is, stretches it or shrinks it
to fit a certain rectangle, relative to the point at which the text is drawn. |
|
int |
iCopyFitRectBottom
The bottom edge of the copy-fit rectangle. |
|
int |
iCopyFitRectLeft
The left edge of the copy-fit rectangle. |
|
int |
iCopyFitRectRight
The right edge of the copy-fit rectangle. |
|
int |
iCopyFitRectTop
The top edge of the copy-fit rectangle. |
|
boolean |
iKern
If true |
|
int |
iStartOffset
Where to start along the path. |
|
int |
iSupplementaryRotation
The amount in degrees by which to rotate each character around the drawing position after any transformations needed to position it on the path. |
|
int |
iTextCaseTransform
If iTextCaseTransform is not TEXT_CASE_NONE, changes the case of the
text while drawing or measuring it. |
|
int |
iUnderlineColor
The 32-bit color for drawing underlines, overlines and strikethroughs. |
|
int |
iUnderlineOffset
The distance below the baseline, in pixels, of underlines. |
|
int |
iUnderlineWeight
The weight in pixels of underlines, overlines and strikethroughs. |
|
boolean |
iUseUnderlineOffset
If true, iUnderlineOffset is used. |
|
int |
iWordSpaceMode
If iWordSpaceMode is non-zero, overrides word spacing by using the value of iWordSpacing in various ways (see the WORD_SPACE_* constants). |
|
int |
iWordSpacing
If iWordSpaceMode is non-zero this value in pixels overrides the natural width of a word space (U+0020). |
|
| Constructor Summary | ||
|---|---|---|
DrawTextParam.AdvancedDrawTextParam()
Constructs an AdvancedDrawTextParam object with default parameters. |
||
| Method Summary | ||
|---|---|---|
void |
reset()
Sets all parameters to their default values. |
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int DEFAULT_BASELINE
iBaseline: the default baseline allows the baseline to be
specified by DrawTextParam.iAlignment, which supports fewer baselines
but is backward-compatible.
public static final int ALPHABETIC_BASELINE
iBaseline: this identifies the baseline used by most alphabetic
and syllabic scripts. These include, but are not limited to, many Western,
Southern Indic, Southeast Asian (non-ideographic) scripts.
public static final int IDEOGRAPHIC_BASELINE
iBaseline: this identifies the baseline used by ideographic
scripts.
For historical reasons, this baseline is at the bottom of the ideographic EM box and not in the centre of the ideographic EM box. See the "central" baseline. The ideographic scripts include Chinese, Japanese, Korean, and Vietnamese Chu Nom.
public static final int HANGING_BASELINE
iBaseline: this identifies the baseline used by certain Indic
scripts. These scripts include Devanagari, Gurmukhi and Bengali.
public static final int MATHEMATICAL_BASELINE
iBaseline: the baseline used for mathematical symbols.
public static final int CENTRAL_BASELINE
iBaseline: identifies a computed baseline that is at the
center of the EM box.
This baseline lies halfway between the text-before-edge and text-after-edge baselines. For ideographic fonts, this baseline is often used to align the glyphs; it is an alternative to the ideographic baseline.
public static final int MIDDLE_BASELINE
iBaseline: this identifies a baseline that is offset from the
alphabetic baseline in the shift-direction by half the value of the x-height
font characteristic.
The position of this baseline may be obtained from the font data or, for fonts that have a font characteristic for x-height, it may be computed using half the x-height. Lacking either of these pieces of information, the position of this baseline may be approximated by the central baseline.
public static final int TEXT_BEFORE_EDGE_BASELINE
iBaseline: this identifies the before-edge of the EM box.
The position of this baseline may be specified in the baseline table or it may be calculated. The position of this baseline is normally around or at the top of the ascenders, but it may not encompass all accents that can appear above a glyph. For these fonts the value of the ascent font characteristic is used. For ideographic fonts, the position of this baseline is normally 1 EM in the shiftdirection from the ideographic baseline. However, some ideographic fonts have a reduced width in the inline-progression-direction to allow tighter setting. When such a font, designed only for vertical writing-modes, is used in a horizontal writing-mode, the text-before-edge baseline may be less than 1 EM from the text-after-edge.
public static final int TEXT_AFTER_EDGE_BASELINE
iBaseline: this identifies the after-edge of the EM box.
The position of this baseline may be specified in the baselinetable or it may be calculated. For fonts with descenders, the position of this baseline is normally around or at the bottom of the descenders. For these fonts the value of the descent font characteristic is used. For ideographic fonts, the position of this baseline is normally at the ideographic baseline.
public static final int TOP_BASELINE
iBaseline: a baseline that is (ascent + leading above) higher than the
alphabetic baseline.
It is higher than TEXT_BEFORE_EDGE_BASELINE by the leading above.
public static final int HIGH_CENTRAL_BASELINE
iBaseline: a baseline half way between TOP_BASELINE
and ALPHABETIC_BASELINE.
public static final int BOTTOM_BASELINE
iBaseline: a baseline that is (descent + leading below)
lower than the alphabetic baseline.
It is lower than TEXT_AFTER_EDGE_BASELINE by the leading below.
public static final int WORD_SPACE_NATURAL
iWordSpacing: uses the natural word spacing.
public static final int WORD_SPACE_OVERRIDE
iWordSpacing: the supplied word space size is used instead of
the natural word space size.
public static final int WORD_SPACE_ADD
iWordSpacing: the supplied word space size is added to the
natural word space size.
public static final int WORD_SPACE_MULTIPLY
iWordSpacing: the supplied word space size is multiplied by
the natural word space size.
public static final int TEXT_CASE_NONE
iTextCaseTransform: does not change the case of the text.
public static final int TEXT_CASE_LOWER
iTextCaseTransform: changes the text to lower case.
public static final int TEXT_CASE_TITLE
iTextCaseTransform: changes the text to Title Case.
public static final int TEXT_CASE_UPPER
iTextCaseTransform: changes the text to UPPER CASE.
public static final int TEXT_CASE_CAPITALIZE
iTextCaseTransform: capitalizes the text. Converts the first
character of each word to upper or title case; does not change other characters.
public int iStartOffset
If there is no path this value is used as an offset along an implicit path, which is an infinitely long line in the direction of the baseline. Defined as a 16.16 fixed-point number.
For example, if the curved path is 100 units long, and you want to draw a label
on it that is 37 units long and you want the label to be in the middle of the
path, calculate the start position along the path as
(100 - 37) / 2 = 31.5, then set iStartOffset to that value.
public int iBaseLine
public int iSupplementaryRotation
public int iWordSpacing
This parameter is scaled by the transform applied to the font used to draw the
text, unless iWordSpaceMode is WORD_SPACE_MULTIPLY.
public int iWordSpaceMode
iWordSpacing in various ways (see the WORD_SPACE_* constants).
public boolean iKern
true, kerning is done normally, otherwise kerning is suppressed.
The default value is true.
- Since:
- BlackBerry API 6.0.0
public boolean iAllowStartOverlap
true, allows the first glyph group to kern left of the origin.
If false, this is prevented from happening by inserting a
compensating kern.
If a piece of connected text is drawn as more than one run, iAllowStartOverlap
should be set to true for all runs except the first.
The default value is false.
- Since:
- BlackBerry API 6.0.0
public int iTextCaseTransform
TEXT_CASE_NONE, changes the case of the
text while drawing or measuring it. The text supplied to the drawing or
measuring function is not itself changed.
Character counts returned in the text metrics, like the number of characters drawn, reflect the original text, not the transformed text.
public boolean iCopyFit
true, copy-fits the text - that is, stretches it or shrinks it
to fit a certain rectangle, relative to the point at which the text is drawn.
The rectangle is given by the parameters iCopyFitRectLeft, iCopyFitTop, etc., which define the copy-fit rectangle: the desired rectangle before any rotation resulting from the font instance transformation. If the copy-fit rectangle is empty the bounds of the unrotated text are used, allowing rotated text to be forced to the same size as unrotated text. If the copy-fit rectangle has non-zero height but zero width, the width of the unrotated text is used but the text is fitted to the height of the copy-fit rectangle, and vice versa.
The default value is false.
public int iCopyFitRectLeft
This parameter is scaled by the transform applied to the font used to draw the text.
public int iCopyFitRectTop
This parameter is scaled by the transform applied to the font used to draw the text.
public int iCopyFitRectRight
This parameter is scaled by the transform applied to the font used to draw the text.
public int iCopyFitRectBottom
This parameter is scaled by the transform applied to the font used to draw the text.
public int iUnderlineColor
The default value is transparent white, which causes underlines, etc., to be drawn in the same color as the text, as does any fully transparent color.
public int iUnderlineWeight
The default value is 0, which causes underlines, etc., to be drawn using the default width specified by the font. Defined as a 16.16 fixed-point number.
This parameter is scaled by the transform applied to the font used to draw the text.
public boolean iUseUnderlineOffset
true, iUnderlineOffset is used. If false,
iUnderlineOffset is ignored.
public int iUnderlineOffset
This value is used if iUseUnderlineOffset is true. If
iUseUnderlineOffset is false underlines are drawn at the default
offset specified by the font.
This parameter is scaled by the transform applied to the font used to draw the text.
| Constructor Detail |
|---|
public DrawTextParam.AdvancedDrawTextParam()
| Method Detail |
|---|
public void reset()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal