NumericShaper JDK 1.6)

Description

publicfinal class NumericShaper

The NumericShaper class is used to convert Latin-1 (European) digits to other Unicode decimal digits.

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);

See also:

Methods

Hide/Show inherited methods

public boolean equals (Object o)

Returns true if the specified object is an instance of NumericShaper and shapes identically to this one.

Returns true if the specified object is an instance of
NumericShaper and shapes identically to this one.
Returns: true if o is an instance of NumericShaper and shapes in the same way; false otherwise.
Parameters:
- o - the specified object to compare to this NumericShaper
See Also: Object.equals(java.lang.Object),

publicstatic NumericShaper getContextualShaper (int ranges)

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

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.
Returns: a shaper for the specified ranges
Parameters:
- ranges - the specified Unicode ranges

publicstatic NumericShaper getContextualShaper (int ranges, int defaultContext)

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

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.
Returns: a shaper for the specified Unicode ranges.
Parameters:
- ranges - the specified Unicode ranges
- defaultContext - the starting context, such as NumericShaper.EUROPEAN
Throws:
- IllegalArgumentException - if the specified defaultContext is not a single valid range.

public 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) { ...

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

publicstatic NumericShaper getShaper (int singleRange)

Returns a shaper for the provided unicode range.

public int hashCode ()

Returns a hash code for this shaper.

public boolean isContextual ()

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

Returns a boolean indicating whether or not
this shaper shapes contextually.
Returns: true if this shaper is contextual; false otherwise.

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

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

Converts the digits in the text that occur between start and
start + count.
Parameters:
- text - an array of characters to convert
- start - the index into text to start converting
- count - the number of characters in text to convert
Throws:
- IndexOutOfBoundsException - if start or start + count is out of bounds
- NullPointerException - if text is null

public 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.

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 - an array of characters
- start - the index into text to start converting
- count - the number of characters in text to convert
- context - 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.

public String toString ()

Returns a String that describes this shaper.

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

Fields

Hide/Show inherited fields

publicfinalstatic int ALL_RANGES = "524287"

Identifies all ranges, for full contextual shaping.

publicfinalstatic int ARABIC = "2"

Identifies the ARABIC range and decimal base.

publicfinalstatic int BENGALI = "16"

Identifies the BENGALI range and decimal base.

publicfinalstatic int DEVANAGARI = "8"

Identifies the DEVANAGARI range and decimal base.

publicfinalstatic int EASTERN_ARABIC = "4"

Identifies the ARABIC range and ARABIC_EXTENDED decimal base.

publicfinalstatic int ETHIOPIC = "65536"

Identifies the ETHIOPIC range and decimal base.

publicfinalstatic int EUROPEAN = "1"

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

publicfinalstatic int GUJARATI = "64"

Identifies the GUJARATI range and decimal base.

publicfinalstatic int GURMUKHI = "32"

Identifies the GURMUKHI range and decimal base.

publicfinalstatic int KANNADA = "1024"

Identifies the KANNADA range and decimal base.

publicfinalstatic int KHMER = "131072"

Identifies the KHMER range and decimal base.

publicfinalstatic int LAO = "8192"

Identifies the LAO range and decimal base.

publicfinalstatic int MALAYALAM = "2048"

Identifies the MALAYALAM range and decimal base.

publicfinalstatic int MONGOLIAN = "262144"

Identifies the MONGOLIAN range and decimal base.

publicfinalstatic int MYANMAR = "32768"

Identifies the MYANMAR range and decimal base.

publicfinalstatic int ORIYA = "128"

Identifies the ORIYA range and decimal base.

publicfinalstatic int TAMIL = "256"

Identifies the TAMIL range and decimal base.

publicfinalstatic int TELUGU = "512"

Identifies the TELUGU range and decimal base.

publicfinalstatic int THAI = "4096"

Identifies the THAI range and decimal base.

publicfinalstatic int TIBETAN = "16384"

Identifies the TIBETAN range and decimal base.