Skip to content

Most visited

Recently visited

navigation

NumericShaper

public final class NumericShaper
extends Object implements Serializable

java.lang.Object
   ↳ java.awt.font.NumericShaper


The NumericShaper class is used to convert Latin-1 (European) digits to other Unicode decimal digits. Users of this class will primarily be people who wish to present data using national digit shapes, but find it more convenient to represent the data internally using Latin-1 (European) digits. This does not interpret the deprecated numeric shape selector character (U+206E).

Instances of NumericShaper are typically applied as attributes to text with the NUMERIC_SHAPING attribute of the TextAttribute class. For example, this code snippet causes a TextLayout to shape European digits to Arabic in an Arabic context:

 Map map = new HashMap();
 map.put(TextAttribute.NUMERIC_SHAPING,
     NumericShaper.getContextualShaper(NumericShaper.ARABIC));
 FontRenderContext frc = ...;
 TextLayout layout = new TextLayout(text, map, frc);
 layout.draw(g2d, x, y);
 

It is also possible to perform numeric shaping explicitly using instances of NumericShaper, as this code snippet demonstrates:
 char[] text = ...;
 // shape all EUROPEAN digits (except zero) to ARABIC digits
 NumericShaper shaper = NumericShaper.getShaper(NumericShaper.ARABIC);
 shaper.shape(text, start, count);

 // shape European digits to ARABIC digits if preceding text is Arabic, or
 // shape European digits to TAMIL digits if preceding text is Tamil, or
 // leave European digits alone if there is no preceding text, or
 // preceding text is neither Arabic nor Tamil
 NumericShaper shaper =
     NumericShaper.getContextualShaper(NumericShaper.ARABIC |
                                         NumericShaper.TAMIL,
                                       NumericShaper.EUROPEAN);
 shaper.shape(text, start, count);
 

Bit mask- and enum-based Unicode ranges

This class supports two different programming interfaces to represent Unicode ranges for script-specific digits: bit mask-based ones, such as NumericShaper.ARABIC, and enum-based ones, such as ARABIC. Multiple ranges can be specified by ORing bit mask-based constants, such as:

 NumericShaper.ARABIC | NumericShaper.TAMIL
 
or creating a Set with the NumericShaper.Range constants, such as:
 EnumSet.of(NumericShaper.Scirpt.ARABIC, NumericShaper.Range.TAMIL)
 
The enum-based ranges are a super set of the bit mask-based ones.

If the two interfaces are mixed (including serialization), Unicode range values are mapped to their counterparts where such mapping is possible, such as NumericShaper.Range.ARABIC from/to NumericShaper.ARABIC. If any unmappable range values are specified, such as NumericShaper.Range.BALINESE, those ranges are ignored.

Decimal Digits Precedence

A Unicode range may have more than one set of decimal digits. If multiple decimal digits sets are specified for the same Unicode range, one of the sets will take precedence as follows.

Unicode Range NumericShaper Constants Precedence
Arabic NumericShaper.ARABIC
NumericShaper.EASTERN_ARABIC
NumericShaper.EASTERN_ARABIC
ARABIC
EASTERN_ARABIC
EASTERN_ARABIC
Tai Tham TAI_THAM_HORA
TAI_THAM_THAM
TAI_THAM_THAM

Summary

Nested classes

enum NumericShaper.Range

A NumericShaper.Range represents a Unicode range of a script having its own decimal digits. 

Constants

int ALL_RANGES

Identifies all ranges, for full contextual shaping.

int ARABIC

Identifies the ARABIC range and decimal base.

int BENGALI

Identifies the BENGALI range and decimal base.

int DEVANAGARI

Identifies the DEVANAGARI range and decimal base.

int EASTERN_ARABIC

Identifies the ARABIC range and ARABIC_EXTENDED decimal base.

int ETHIOPIC

Identifies the ETHIOPIC range and decimal base.

int EUROPEAN

Identifies the Latin-1 (European) and extended range, and Latin-1 (European) decimal base.

int GUJARATI

Identifies the GUJARATI range and decimal base.

int GURMUKHI

Identifies the GURMUKHI range and decimal base.

int KANNADA

Identifies the KANNADA range and decimal base.

int KHMER

Identifies the KHMER range and decimal base.

int LAO

Identifies the LAO range and decimal base.

int MALAYALAM

Identifies the MALAYALAM range and decimal base.

int MONGOLIAN

Identifies the MONGOLIAN range and decimal base.

int MYANMAR

Identifies the MYANMAR range and decimal base.

int ORIYA

Identifies the ORIYA range and decimal base.

int TAMIL

Identifies the TAMIL range and decimal base.

int TELUGU

Identifies the TELUGU range and decimal base.

int THAI

Identifies the THAI range and decimal base.

int TIBETAN

Identifies the TIBETAN range and decimal base.

Public methods

boolean equals(Object o)

Returns true if the specified object is an instance of NumericShaper and shapes identically to this one, regardless of the range representations, the bit mask or the enum.

static NumericShaper getContextualShaper(Set<NumericShaper.Range> ranges)

Returns a contextual shaper for the provided Unicode range(s).

static NumericShaper getContextualShaper(int ranges, int defaultContext)

Returns a contextual shaper for the provided unicode range(s).

static NumericShaper getContextualShaper(Set<NumericShaper.Range> ranges, NumericShaper.Range defaultContext)

Returns a contextual shaper for the provided Unicode range(s).

static NumericShaper getContextualShaper(int ranges)

Returns a contextual shaper for the provided unicode range(s).

Set<NumericShaper.Range> getRangeSet()

Returns a Set representing all the Unicode ranges in this NumericShaper that will be shaped.

int getRanges()

Returns an int that ORs together the values for all the ranges that will be shaped.

static NumericShaper getShaper(int singleRange)

Returns a shaper for the provided unicode range.

static NumericShaper getShaper(NumericShaper.Range singleRange)

Returns a shaper for the provided Unicode range.

int hashCode()

Returns a hash code for this shaper.

boolean isContextual()

Returns a boolean indicating whether or not this shaper shapes contextually.

void shape(char[] text, int start, int count)

Converts the digits in the text that occur between start and start + count.

void shape(char[] text, int start, int count, NumericShaper.Range context)

Converts the digits in the text that occur between start and start + count, using the provided context.

void shape(char[] text, int start, int count, int context)

Converts the digits in the text that occur between start and start + count, using the provided context.

String toString()

Returns a String that describes this shaper.

Inherited methods

From class java.lang.Object

Constants

ALL_RANGES

Added in API level 1
int ALL_RANGES

Identifies all ranges, for full contextual shaping.

This constant specifies all of the bit mask-based ranges. Use EmunSet.allOf(NumericShaper.Range.class) to specify all of the enum-based ranges.

Constant Value: 524287 (0x0007ffff)

ARABIC

Added in API level 1
int ARABIC

Identifies the ARABIC range and decimal base.

Constant Value: 2 (0x00000002)

BENGALI

Added in API level 1
int BENGALI

Identifies the BENGALI range and decimal base.

Constant Value: 16 (0x00000010)

DEVANAGARI

Added in API level 1
int DEVANAGARI

Identifies the DEVANAGARI range and decimal base.

Constant Value: 8 (0x00000008)

EASTERN_ARABIC

Added in API level 1
int EASTERN_ARABIC

Identifies the ARABIC range and ARABIC_EXTENDED decimal base.

Constant Value: 4 (0x00000004)

ETHIOPIC

Added in API level 1
int ETHIOPIC

Identifies the ETHIOPIC range and decimal base.

Constant Value: 65536 (0x00010000)

EUROPEAN

Added in API level 1
int EUROPEAN

Identifies the Latin-1 (European) and extended range, and Latin-1 (European) decimal base.

Constant Value: 1 (0x00000001)

GUJARATI

Added in API level 1
int GUJARATI

Identifies the GUJARATI range and decimal base.

Constant Value: 64 (0x00000040)

GURMUKHI

Added in API level 1
int GURMUKHI

Identifies the GURMUKHI range and decimal base.

Constant Value: 32 (0x00000020)

KANNADA

Added in API level 1
int KANNADA

Identifies the KANNADA range and decimal base.

Constant Value: 1024 (0x00000400)

KHMER

Added in API level 1
int KHMER

Identifies the KHMER range and decimal base.

Constant Value: 131072 (0x00020000)

LAO

Added in API level 1
int LAO

Identifies the LAO range and decimal base.

Constant Value: 8192 (0x00002000)

MALAYALAM

Added in API level 1
int MALAYALAM

Identifies the MALAYALAM range and decimal base.

Constant Value: 2048 (0x00000800)

MONGOLIAN

Added in API level 1
int MONGOLIAN

Identifies the MONGOLIAN range and decimal base.

Constant Value: 262144 (0x00040000)

MYANMAR

Added in API level 1
int MYANMAR

Identifies the MYANMAR range and decimal base.

Constant Value: 32768 (0x00008000)

ORIYA

Added in API level 1
int ORIYA

Identifies the ORIYA range and decimal base.

Constant Value: 128 (0x00000080)

TAMIL

Added in API level 1
int TAMIL

Identifies the TAMIL range and decimal base.

Constant Value: 256 (0x00000100)

TELUGU

Added in API level 1
int TELUGU

Identifies the TELUGU range and decimal base.

Constant Value: 512 (0x00000200)

THAI

Added in API level 1
int THAI

Identifies the THAI range and decimal base.

Constant Value: 4096 (0x00001000)

TIBETAN

Added in API level 1
int TIBETAN

Identifies the TIBETAN range and decimal base.

Constant Value: 16384 (0x00004000)

Public methods

equals

Added in API level 1
boolean equals (Object o)

Returns true if the specified object is an instance of NumericShaper and shapes identically to this one, regardless of the range representations, the bit mask or the enum. For example, the following code produces "true".

 NumericShaper ns1 = NumericShaper.getShaper(NumericShaper.ARABIC);
 NumericShaper ns2 = NumericShaper.getShaper(NumericShaper.Range.ARABIC);
 System.out.println(ns1.equals(ns2));
 

Parameters
o Object: the specified object to compare to this NumericShaper
Returns
boolean true if o is an instance of NumericShaper and shapes in the same way; false otherwise.

See also:

getContextualShaper

Added in API level 24
NumericShaper getContextualShaper (Set<NumericShaper.Range> ranges)

Returns a contextual shaper for the provided Unicode range(s). The Latin-1 (EUROPEAN) digits are converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges.

The shaper assumes EUROPEAN as the starting context, that is, if EUROPEAN digits are encountered before any strong directional text in the string, the context is presumed to be EUROPEAN, and so the digits will not shape.

Parameters
ranges Set: the specified Unicode ranges
Returns
NumericShaper a contextual shaper for the specified ranges
Throws
NullPointerException if ranges is null.

getContextualShaper

Added in API level 1
NumericShaper getContextualShaper (int ranges, 
                int defaultContext)

Returns a contextual shaper for the provided unicode range(s). Latin-1 (EUROPEAN) digits will be converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. Multiple ranges are represented by or-ing the values together, for example, NumericShaper.ARABIC | NumericShaper.THAI. The shaper uses defaultContext as the starting context.

Parameters
ranges int: the specified Unicode ranges
defaultContext int: the starting context, such as NumericShaper.EUROPEAN
Returns
NumericShaper a shaper for the specified Unicode ranges.
Throws
IllegalArgumentException if the specified defaultContext is not a single valid range.

getContextualShaper

Added in API level 24
NumericShaper getContextualShaper (Set<NumericShaper.Range> ranges, 
                NumericShaper.Range defaultContext)

Returns a contextual shaper for the provided Unicode range(s). The Latin-1 (EUROPEAN) digits will be converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. The shaper uses defaultContext as the starting context.

Parameters
ranges Set: the specified Unicode ranges
defaultContext NumericShaper.Range: the starting context, such as NumericShaper.Range.EUROPEAN
Returns
NumericShaper a contextual shaper for the specified Unicode ranges.
Throws
NullPointerException if ranges or defaultContext is null

getContextualShaper

Added in API level 1
NumericShaper getContextualShaper (int ranges)

Returns a contextual shaper for the provided unicode range(s). Latin-1 (EUROPEAN) digits are converted to the decimal digits corresponding to the range of the preceding text, if the range is one of the provided ranges. Multiple ranges are represented by or-ing the values together, such as, NumericShaper.ARABIC | NumericShaper.THAI. The shaper assumes EUROPEAN as the starting context, that is, if EUROPEAN digits are encountered before any strong directional text in the string, the context is presumed to be EUROPEAN, and so the digits will not shape.

Parameters
ranges int: the specified Unicode ranges
Returns
NumericShaper a shaper for the specified ranges

getRangeSet

Added in API level 24
Set<NumericShaper.Range> getRangeSet ()

Returns a Set representing all the Unicode ranges in this NumericShaper that will be shaped.

Returns
Set<NumericShaper.Range> all the Unicode ranges to be shaped.

getRanges

Added in API level 1
int getRanges ()

Returns an int that ORs together the values for all the ranges that will be shaped.

For example, to check if a shaper shapes to Arabic, you would use the following:

if ((shaper.getRanges() & shaper.ARABIC) != 0) { ...

Note that this method supports only the bit mask-based ranges. Call getRangeSet() for the enum-based ranges.

Returns
int the values for all the ranges to be shaped.

getShaper

Added in API level 1
NumericShaper getShaper (int singleRange)

Returns a shaper for the provided unicode range. All Latin-1 (EUROPEAN) digits are converted to the corresponding decimal unicode digits.

Parameters
singleRange int: the specified Unicode range
Returns
NumericShaper a non-contextual numeric shaper
Throws
IllegalArgumentException if the range is not a single range

getShaper

Added in API level 24
NumericShaper getShaper (NumericShaper.Range singleRange)

Returns a shaper for the provided Unicode range. All Latin-1 (EUROPEAN) digits are converted to the corresponding decimal digits of the specified Unicode range.

Parameters
singleRange NumericShaper.Range: the Unicode range given by a NumericShaper.Range constant.
Returns
NumericShaper a non-contextual NumericShaper.
Throws
NullPointerException if singleRange is null

hashCode

Added in API level 1
int hashCode ()

Returns a hash code for this shaper.

Returns
int this shaper's hash code.

See also:

isContextual

Added in API level 1
boolean isContextual ()

Returns a boolean indicating whether or not this shaper shapes contextually.

Returns
boolean true if this shaper is contextual; false otherwise.

shape

Added in API level 1
void shape (char[] text, 
                int start, 
                int count)

Converts the digits in the text that occur between start and start + count.

Parameters
text char: an array of characters to convert
start int: the index into text to start converting
count int: the number of characters in text to convert
Throws
IndexOutOfBoundsException if start or start + count is out of bounds
NullPointerException if text is null

shape

Added in API level 24
void shape (char[] text, 
                int start, 
                int count, 
                NumericShaper.Range context)

Converts the digits in the text that occur between start and start + count, using the provided context. Context is ignored if the shaper is not a contextual shaper.

Parameters
text char: a char array
start int: the index into text to start converting
count int: the number of chars in text to convert
context NumericShaper.Range: the context to which to convert the characters, such as NumericShaper.Range.EUROPEAN
Throws
IndexOutOfBoundsException if start or start + count is out of bounds
NullPointerException if text or context is null

shape

Added in API level 1
void shape (char[] text, 
                int start, 
                int count, 
                int context)

Converts the digits in the text that occur between start and start + count, using the provided context. Context is ignored if the shaper is not a contextual shaper.

Parameters
text char: an array of characters
start int: the index into text to start converting
count int: the number of characters in text to convert
context int: the context to which to convert the characters, such as NumericShaper.EUROPEAN
Throws
IndexOutOfBoundsException if start or start + count is out of bounds
NullPointerException if text is null
IllegalArgumentException if this is a contextual shaper and the specified context is not a single valid range.

toString

Added in API level 1
String toString ()

Returns a String that describes this shaper. This method is used for debugging purposes only.

Returns
String a String describing this shaper.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.