net.rim.device.api.ui
Class DrawTextParam

java.lang.Object
  |
  +--net.rim.device.api.ui.DrawTextParam

public final class DrawTextParam
extends Object

Parameters used to control the drawing and measurement of text.

Since:
JDE 4.2.1

Field Summary
static int ALREADY_REVERSED
          Value for iReverse: draw text without reversing.
static int BIDI_REORDER
          Value for iReverse: perform bidirectional reordering on the text before drawing.
static int NO_REVERSE
          Value for iReverse: draw text without reversing.
static int NO_TRUNCATE_WITH_ELLIPSIS
          Do not perform truncation with ellipsis.
static int REVERSE
          Value for iReverse: reverse the text before drawing.
static int TRUNCATE_WITH_ELLIPSIS_AT_END
          If the text would exceed MaxAdvance, truncate it at the end and insert an ellipsis.
static int TRUNCATE_WITH_ELLIPSIS_AT_START
          If the text would exceed MaxAdvance, truncate it at the start and insert an ellipsis.
static int TRUNCATE_WITH_NO_ELLIPSIS_AT_START
          If the text would exceed MaxAdvance, truncate it at the start but do not insert an ellipsis.
 
Method Summary
 int getEndOffset()
          Get the end offset of the text to draw, within the supplied text
 int getStartOffset()
          Get the start offset of the text to draw, within the supplied text
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALREADY_REVERSED

public static final int ALREADY_REVERSED
Value for iReverse: draw text without reversing. This value is now obsolete and has the same effect as NO_REVERSE.
Since:
JDE 4.2.1

BIDI_REORDER

public static final int BIDI_REORDER
Value for iReverse: perform bidirectional reordering on the text before drawing. This is the default setting. Code that has already done bidirectional reordering should use NO_REVERSE for left-to-right runs and REVERSE for right-to-left runs.
Since:
JDE 4.2.1

NO_REVERSE

public static final int NO_REVERSE
Value for iReverse: draw text without reversing.
Since:
JDE 4.2.1

NO_TRUNCATE_WITH_ELLIPSIS

public static final int NO_TRUNCATE_WITH_ELLIPSIS
Do not perform truncation with ellipsis. Truncation will occurs if iMaxAdvance or iMaxCharacters would be exceeded, but no ellipsis is used.
Since:
JDE 4.2.1

REVERSE

public static final int REVERSE
Value for iReverse: reverse the text before drawing.
Since:
JDE 4.2.1

TRUNCATE_WITH_ELLIPSIS_AT_END

public static final int TRUNCATE_WITH_ELLIPSIS_AT_END
If the text would exceed MaxAdvance, truncate it at the end and insert an ellipsis.
Since:
JDE 4.2.1

TRUNCATE_WITH_ELLIPSIS_AT_START

public static final int TRUNCATE_WITH_ELLIPSIS_AT_START
If the text would exceed MaxAdvance, truncate it at the start and insert an ellipsis.
Since:
JDE 4.2.1

TRUNCATE_WITH_NO_ELLIPSIS_AT_START

public static final int TRUNCATE_WITH_NO_ELLIPSIS_AT_START
If the text would exceed MaxAdvance, truncate it at the start but do not insert an ellipsis. This is a convenience feature that is equivalent to using ETruncateWithEllipsisAtStart with the ellipsis character set to U+FFFF.
Since:
JDE 4.2.1
Method Detail

getEndOffset

public int getEndOffset()
Get the end offset of the text to draw, within the supplied text
Returns:
The end offset of the text to draw, within the supplied text
Since:
JDE 4.2.1

getStartOffset

public int getStartOffset()
Get the start offset of the text to draw, within the supplied text
Returns:
The start offset of the text to draw, within the supplied text
Since:
JDE 4.2.1



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.