Home » openjdk-7 » java » awt » font » [javadoc | source]
java.awt.font
public final class: NumericShaper [javadoc | source]
java.lang.Object
   java.awt.font.NumericShaper

All Implemented Interfaces:
    java$io$Serializable

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 NumericShaper.Range#ARABIC . Multiple ranges can be specified by ORing bit mask-based constants, such as:

NumericShaper.ARABIC | NumericShaper.TAMIL
or creating a {@code 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 {@code NumericShaper.Range.ARABIC} from/to {@code NumericShaper.ARABIC}. If any unmappable range values are specified, such as {@code 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
NumericShaper.Range#ARABIC
NumericShaper.Range#EASTERN_ARABIC
NumericShaper.Range#EASTERN_ARABIC
Tai Tham NumericShaper.Range#TAI_THAM_HORA
NumericShaper.Range#TAI_THAM_THAM
NumericShaper.Range#TAI_THAM_THAM

Nested Class Summary:
public static enum class  NumericShaper.Range  A {@code NumericShaper.Range} represents a Unicode range of a script having its own decimal digits. For example, the {@link NumericShaper.Range#THAI} range has the Thai digits, THAI DIGIT ZERO (U+0E50) to THAI DIGIT NINE (U+0E59).

The Range enum replaces the traditional bit mask-based values (e.g., {@link NumericShaper#ARABIC}), and supports more Unicode ranges than the bit mask-based ones. For example, the following code using the bit mask:

NumericShaper.getContextualShaper(NumericShaper.ARABIC |
                                    NumericShaper.TAMIL,
                                  NumericShaper.EUROPEAN);
can be written using this enum as:
NumericShaper.getContextualShaper(EnumSet.of(
                                    NumericShaper.Range.ARABIC,
                                    NumericShaper.Range.TAMIL),
                                  NumericShaper.Range.EUROPEAN);
 
Field Summary
public static final  int EUROPEAN    Identifies the Latin-1 (European) and extended range, and Latin-1 (European) decimal base. 
public static final  int ARABIC    Identifies the ARABIC range and decimal base. 
public static final  int EASTERN_ARABIC    Identifies the ARABIC range and ARABIC_EXTENDED decimal base. 
public static final  int DEVANAGARI    Identifies the DEVANAGARI range and decimal base. 
public static final  int BENGALI    Identifies the BENGALI range and decimal base. 
public static final  int GURMUKHI    Identifies the GURMUKHI range and decimal base. 
public static final  int GUJARATI    Identifies the GUJARATI range and decimal base. 
public static final  int ORIYA    Identifies the ORIYA range and decimal base. 
public static final  int TAMIL    Identifies the TAMIL range and decimal base. 
public static final  int TELUGU    Identifies the TELUGU range and decimal base. 
public static final  int KANNADA    Identifies the KANNADA range and decimal base. 
public static final  int MALAYALAM    Identifies the MALAYALAM range and decimal base. 
public static final  int THAI    Identifies the THAI range and decimal base. 
public static final  int LAO    Identifies the LAO range and decimal base. 
public static final  int TIBETAN    Identifies the TIBETAN range and decimal base. 
public static final  int MYANMAR    Identifies the MYANMAR range and decimal base. 
public static final  int ETHIOPIC    Identifies the ETHIOPIC range and decimal base. 
public static final  int KHMER    Identifies the KHMER range and decimal base. 
public static final  int MONGOLIAN    Identifies the MONGOLIAN range and decimal base. 
public static final  int ALL_RANGES    Identifies all ranges, for full contextual shaping.

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

Method from java.awt.font.NumericShaper Summary:
equals,   getContextualShaper,   getContextualShaper,   getContextualShaper,   getContextualShaper,   getRangeSet,   getRanges,   getShaper,   getShaper,   hashCode,   isContextual,   shape,   shape,   shape,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.font.NumericShaper Detail:
 public boolean equals(Object o) 
    Returns {@code 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 {@code "true"}.
    NumericShaper ns1 = NumericShaper.getShaper(NumericShaper.ARABIC);
    NumericShaper ns2 = NumericShaper.getShaper(NumericShaper.Range.ARABIC);
    System.out.println(ns1.equals(ns2));
    
 public static 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.
 public static NumericShaper getContextualShaper(Set<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.

 public static 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.
 public static NumericShaper getContextualShaper(Set<Range> ranges,
    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 {@code defaultContext} as the starting context.
 public Set<Range> getRangeSet() 
    Returns a {@code Set} representing all the Unicode ranges in this {@code NumericShaper} that will be shaped.
 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) { ...

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

 public static 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.
 public static NumericShaper getShaper(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.
 public int hashCode() 
    Returns a hash code for this shaper.
 public boolean isContextual() 
    Returns a boolean indicating whether or not this shaper shapes contextually.
 public  void shape(char[] text,
    int start,
    int count) 
    Converts the digits in the text that occur between start and start + count.
 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. Context is ignored if the shaper is not a contextual shaper.
 public  void shape(char[] text,
    int start,
    int count,
    Range context) 
    Converts the digits in the text that occur between {@code start} and {@code start + count}, using the provided {@code context}. {@code Context} is ignored if the shaper is not a contextual shaper.
 public String toString() 
    Returns a String that describes this shaper. This method is used for debugging purposes only.