1. /*

  2.  * @(#)TextAttribute.java	1.35 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. /*

  12.  * (C) Copyright Taligent, Inc. 1996 - 1997, All Rights Reserved

  13.  * (C) Copyright IBM Corp. 1996 - 1998, All Rights Reserved

  14.  *

  15.  * The original version of this source code and documentation is

  16.  * copyrighted and owned by Taligent, Inc., a wholly-owned subsidiary

  17.  * of IBM. These materials are provided under terms of a License

  18.  * Agreement between Taligent and Sun. This technology is protected

  19.  * by multiple US and International patents.

  20.  *

  21.  * This notice and attribution to Taligent may not be removed.

  22.  * Taligent is a registered trademark of Taligent, Inc.

  23.  *

  24.  */

  25. 

  26. package java.awt.font;

  27. 

  28. import java.io.InvalidObjectException;

  29. import java.text.AttributedCharacterIterator.Attribute;

  30. import java.util.Map;

  31. import java.util.HashMap;

  32. 

  33. /**

  34.  * The <code>TextAttribute</code> class defines attribute keys and

  35.  * attribute values used for text rendering. 

  36.  * <p>

  37.  * <code>TextAttribute</code> instances are used as attribute keys to

  38.  * identify attributes in 

  39.  * {@link java.text.AttributedCharacterIterator AttributedCharacterIterator}, 

  40.  * {@link java.awt.Font Font}, and other classes handling text 

  41.  * attributes. Other constants defined in this class are used 

  42.  * as attribute values.

  43.  * <p>

  44.  * For each text attribute, the documentation describes:

  45.  * <UL>

  46.  *   <LI>the type of their values,

  47.  *   <LI>the valid values if there are limitations

  48.  *   <LI>relevant constants

  49.  *   <LI>the default effect if the attribute is absent (or has a

  50.  *	<code>null</code> value).

  51.  *   <LI>a description of the effect.

  52.  *   <LI>the fallback behavior if the exact attribute requested is not 

  53.  *	available.

  54.  * </UL>

  55.  * <p>

  56.  * <H4>Types of Values</H4>

  57.  * <UL>

  58.  *   <LI>The values of attributes must always be immutable.

  59.  *   <LI>Where a list of limitations is given, any value outside of that

  60.  *   set is reserved for future use, and ignored at present.

  61.  *   <LI>If the value is <code>null</code> or not of the proper type

  62.  *	then it has the default effect. The effect of a particular value

  63.  *	can be interpolated, especially in the case of multiple master

  64.  *	fonts. This interpolation is done based on the nearest defined

  65.  * 	constants above and below the request:<BR>

  66.  *      <BLOCKQUOTE><TT>

  67.  *	interpolation = (request - below)/(above - below);

  68.  *	</BLOCKQUOTE></TT>

  69.  * </UL>

  70.  * <p>

  71.  * <H4>Interpolation</H4>

  72.  * <UL>

  73.  *   <LI>Fonts should interpolate values in certain circumstances. For example,

  74.  *   when the WEIGHT value is 2.13. If the nearest surrounding values

  75.  *   in the font are WEIGHT_BOLD = 2.0 and WEIGHT_HEAVY = 2.25 then font would

  76.  *   then interpret the WEIGHT request as being 52% of the way between what

  77.  *   it considers BOLD and what it considers HEAVY. If the nearest surrounding

  78.  *   values are WEIGHT_SEMIBOLD = 1.25 and WEIGHT_ULTRABOLD = 2.75 then the

  79.  *   WEIGHT request is interpreted as being 58.67% of the way between SEMIBOLD

  80.  *   and ULTRABOLD.

  81.  *   <LI>Where a font does not have enough capability to handle a given 

  82.  *   request, such as superscript, then it should simulate it to the best of 

  83.  *   its ability.  To determine if simulation is being performed, the client

  84.  *   should query the font to see what actual attributes were used.

  85.  * </UL>

  86.  * 

  87.  * @see java.text.AttributedCharacterIterator

  88.  * @see java.awt.Font 

  89.  */

  90. public final class TextAttribute extends Attribute {

  91. 

  92.     // table of all instances in this class, used by readResolve

  93.     private static final Map instanceMap = new HashMap(29);

  94. 

  95.     /**

  96.      * Constructs a <code>TextAttribute</code> with the specified name.

  97.      * @param name the attribute name to assign to this 

  98.      * <code>TextAttribute</code>

  99.      */

  100.     protected TextAttribute(String name) {

  101.         super(name);

  102.         if (this.getClass() == TextAttribute.class) {

  103.             instanceMap.put(name, this);

  104.         }

  105.     }

  106. 

  107.     /**

  108.      * Resolves instances being deserialized to the predefined constants.

  109.      */

  110.     protected Object readResolve() throws InvalidObjectException {

  111.         if (this.getClass() != TextAttribute.class) {

  112.             throw new InvalidObjectException("subclass didn't correctly implement readResolve");

  113.         }

  114.         

  115.         TextAttribute instance = (TextAttribute) instanceMap.get(getName());

  116.         if (instance != null) {

  117.             return instance;

  118.         } else {

  119.             throw new InvalidObjectException("unknown attribute name");

  120.         }

  121.     }

  122.     

  123.     // Serialization compatibility with Java 2 platform v1.2.

  124.     // 1.2 will throw an InvalidObjectException if ever asked to deserialize INPUT_METHOD_UNDERLINE.

  125.     // This shouldn't happen in real life.

  126.     static final long serialVersionUID = 7744112784117861702L;

  127. 

  128.     // 

  129.     // For use with Font.

  130.     //

  131. 

  132.     /**

  133.      * Attribute key for the unlocalized font family name.

  134.      *

  135.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  136.      * <TR>

  137.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  138.      * <TD VALIGN="TOP">FAMILY</TD></TR>

  139.      * <TR>

  140.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  141.      * <TD VALIGN="TOP">String</TD></TR>

  142.      * <TR>

  143.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  144.      * <TD VALIGN="TOP">"Serif", "SansSerif"</TD></TR>

  145.      * <TR>

  146.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  147.      * <TD VALIGN="TOP">Host default;</TD></TR>

  148.      * <TR>

  149.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  150.      * <TD VALIGN="TOP">The name of the font family. If the family name is not 

  151.      * found, the default font is used. The name should not be the full

  152.      * font name or specify other attributes (such as the name

  153.      * "Helvetica Bold"). Such names might result in the default

  154.      * font if the name does not match a known

  155.      * family name.</TD></TR>

  156.      * </TABLE>

  157.      */

  158.     public static final TextAttribute FAMILY = new TextAttribute("family");

  159. 

  160.     /**

  161.      * Attribute key for the weight of a font.

  162.      *

  163.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  164.      * <TR>

  165.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  166.      * <TD VALIGN="TOP">WEIGHT</TD></TR>

  167.      * <TR>

  168.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  169.      * <TD VALIGN="TOP">Float</TD></TR>

  170.      * <TR>

  171.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  172.      * <TD VALIGN="TOP">WEIGHT_ULTRA_LIGHT = 0.25,<BR>

  173.      * WEIGHT_EXTRA_LIGHT = 0.5,<BR>

  174.      * WEIGHT_LIGHT = 0.75,<BR>

  175.      * WEIGHT_DEMILIGHT = 0.875,<BR>

  176.      * WEIGHT_REGULAR = 1.0,<BR>

  177.      * WEIGHT_SEMIBOLD = 1.25,<BR>

  178.      * WEIGHT_MEDIUM = 1.5,<BR>

  179.      * WEIGHT_DEMIBOLD = 1.75,<BR>

  180.      * WEIGHT_BOLD = 2.0,<BR>

  181.      * WEIGHT_HEAVY = 2.25,<BR>

  182.      * WEIGHT_EXTRABOLD = 2.5,<BR>

  183.      * WEIGHT_ULTRABOLD = 2.75</TD></TR>

  184.      * <TR>

  185.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  186.      * <TD VALIGN="TOP">WEIGHT_REGULAR</TD></TR>

  187.      * <TR>

  188.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  189.      * <TD VALIGN="TOP">The value is roughly the ratio of the stem width to 

  190.      * that of the regular weight. If the font has a different value for

  191.      * specific constants, then the value is interpolated as described in

  192.      * the class description.</TD></TR>

  193.      * <TR>

  194.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  195.      * <TD VALIGN="TOP">Currently none. However, in the future, shape 

  196.      * manipulations might be<BR> available to simulate weight variations

  197.      * for fonts that don't have them.</TD></TR>

  198.      * </TABLE>

  199.      * <BR>

  200.      */

  201.     public static final TextAttribute WEIGHT = new TextAttribute("weight");

  202. 

  203.     /**

  204.      * The lightest predefined weight.

  205.      * @see #WEIGHT

  206.      */

  207.     public static final Float WEIGHT_EXTRA_LIGHT = new Float(0.5f);

  208. 

  209.     /**

  210.      * The standard light weight.

  211.      * @see #WEIGHT

  212.      */

  213.     public static final Float WEIGHT_LIGHT = new Float(0.75f);

  214. 

  215.     /**

  216.      * An intermediate weight between LIGHT and STANDARD.

  217.      * @see #WEIGHT

  218.      */

  219.     public static final Float WEIGHT_DEMILIGHT = new Float(0.875f);

  220. 

  221.     /**

  222.      * The standard weight. This weight is used if WEIGHT is unspecified.

  223.      * @see #WEIGHT

  224.      */

  225.     public static final Float WEIGHT_REGULAR = new Float(1.0f);

  226. 

  227.     /**

  228.      * A moderately heavier weight than REGULAR.

  229.      * @see #WEIGHT

  230.      */

  231.     public static final Float WEIGHT_SEMIBOLD = new Float(1.25f);

  232. 

  233.     /**

  234.      * An intermediate weight between the REGULAR and BOLD weights.

  235.      * @see #WEIGHT

  236.      */

  237.     public static final Float WEIGHT_MEDIUM = new Float(1.5f);

  238. 

  239.     /**

  240.      * A moderately lighter weight than BOLD.

  241.      * @see #WEIGHT

  242.      */

  243.     public static final Float WEIGHT_DEMIBOLD = new Float(1.75f);

  244. 

  245.     /**

  246.      * The standard bold weight.

  247.      * @see #WEIGHT

  248.      */

  249.     public static final Float WEIGHT_BOLD = new Float(2.0f);

  250. 

  251.     /**

  252.      * A moderately heavier weight than BOLD.

  253.      * @see #WEIGHT

  254.      */

  255.     public static final Float WEIGHT_HEAVY = new Float(2.25f);

  256. 

  257.     /**

  258.      * An extra heavy weight.

  259.      * @see #WEIGHT

  260.      */

  261.     public static final Float WEIGHT_EXTRABOLD = new Float(2.5f);

  262. 

  263.     /**

  264.      * The heaviest predefined weight.

  265.      * @see #WEIGHT

  266.      */

  267.     public static final Float WEIGHT_ULTRABOLD = new Float(2.75f);

  268. 

  269.     /**

  270.      * Attribute key for the width of a font.

  271.      *

  272.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  273.      * <TR>

  274.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  275.      * <TD VALIGN="TOP">WIDTH</TD></TR>

  276.      * <TR>

  277.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  278.      * <TD VALIGN="TOP">Float</TD></TR>

  279.      * <TR>

  280.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  281.      * <TD VALIGN="TOP">WIDTH_CONDENSED = 0.75,<BR>

  282.      * WIDTH_SEMI_CONDENSED = 0.875,<BR>

  283.      * WIDTH_REGULAR = 1.0,<BR>

  284.      * WIDTH_SEMI_EXTENDED = 1.25,<BR>

  285.      * WIDTH_EXTENDED = 1.5</TD></TR>

  286.      * <TR>

  287.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  288.      * <TD VALIGN="TOP">WIDTH_REGULAR</TD></TR>

  289.      * <TR>

  290.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  291.      * <TD VALIGN="TOP">The value is roughly the ratio of the advance width 

  292.      * to that of the regular width. If the font has a different value for

  293.      * specific constants, then the value is interpolated as described in

  294.      * the class description.</TD></TR>

  295.      * <TR>

  296.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  297.      * <TD VALIGN="TOP">If a Narrow font is available and matches, use that. 

  298.      * Otherwise scale with a transform based on the value.</TD></TR>

  299.      * </TABLE>

  300.      */

  301.     public static final TextAttribute WIDTH = new TextAttribute("width");

  302. 

  303.     /**

  304.      * The most condensed predefined width.

  305.      * @see #WIDTH

  306.      */

  307.     public static final Float WIDTH_CONDENSED = new Float(0.75f);

  308. 

  309.     /**

  310.      * A moderately condensed width.

  311.      * @see #WIDTH

  312.      */

  313.     public static final Float WIDTH_SEMI_CONDENSED = new Float(0.875f);

  314. 

  315.     /**

  316.      * The standard width. This width is used if WIDTH is unspecified.

  317.      * @see #WIDTH

  318.      */

  319.     public static final Float WIDTH_REGULAR = new Float(1.0f);

  320. 

  321.     /**

  322.      * A moderately extended width.

  323.      * @see #WIDTH

  324.      */

  325.     public static final Float WIDTH_SEMI_EXTENDED = new Float(1.25f);

  326. 

  327.     /**

  328.      * The most extended predefined width.

  329.      * @see #WIDTH

  330.      */

  331.     public static final Float WIDTH_EXTENDED = new Float(1.5f);

  332. 

  333.     /**

  334.      * Attribute key for the posture of a font.

  335.      *

  336.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  337.      * <TR>

  338.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  339.      * <TD VALIGN="TOP">POSTURE</TD></TR>

  340.      * <TR>

  341.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  342.      * <TD VALIGN="TOP">Float</TD></TR>

  343.      * <TR>

  344.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  345.      * <TD VALIGN="TOP">POSTURE_REGULAR = 0, <BR>

  346.      * POSTURE_OBLIQUE = 0.20</TD></TR>

  347.      * <TR>

  348.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  349.      * <TD VALIGN="TOP">POSTURE_REGULAR</TD></TR>

  350.      * <TR>

  351.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  352.      * <TD VALIGN="TOP">The value is interpreted generally as a skew slope, 

  353.      * positive leans to the right. If the font has a different value for

  354.      * specific constants, then the value is interpolated as described in

  355.      * the class description. With fonts that have italic faces, not only

  356.      * the skew of the character changes, but also the letter shapes

  357.      * might change.<BR>

  358.      * <B>Notes: </B><BR>

  359.      * To set the value by angle, use:<BR>

  360.      * <TT>value = new Float(Math.tan(Math.PI*degrees/180.0)</TT><BR>

  361.      * To determine the angle from the value, use:<BR>

  362.      * <TT>angle = Math.atan(value.floatValue())*180/Math.PI</TT></TD></TR>

  363.      * <TR>

  364.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  365.      * <TD VALIGN="TOP">If an Oblique font is available and matches, use that. 

  366.      * Otherwise skew with a transform using the posture value interpreted as 

  367.      * run/rise.</TD></TR>

  368.      * </TABLE>

  369.      *

  370.      * @see java.awt.Font#getItalicAngle()

  371.      */

  372.     public static final TextAttribute POSTURE = new TextAttribute("posture");

  373. 

  374.     /**

  375.      * The standard posture, upright.

  376.      * @see #POSTURE

  377.      */

  378.     public static final Float POSTURE_REGULAR = new Float(0.0f);

  379. 

  380.     /**

  381.      * The standard italic posture.

  382.      * @see #POSTURE

  383.      */

  384.     public static final Float POSTURE_OBLIQUE = new Float(0.20f);

  385. 

  386.     /**

  387.      * Attribute key for the font size.

  388.      *

  389.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  390.      * <TR>

  391.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  392.      * <TD VALIGN="TOP">SIZE</TD></TR>

  393.      * <TR>

  394.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  395.      * <TD VALIGN="TOP">Float</TD></TR>

  396.      * <TR>

  397.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  398.      * <TD VALIGN="TOP">from System Properties</TD></TR>

  399.      * <TR>

  400.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  401.      * <TD VALIGN="TOP">Represents point size. Note that the appearance and 

  402.      * metrics of a 12pt font with a 2X transform might be different than

  403.      * that of a 24 point font with no transform.</TD></TR>

  404.      * <TR>

  405.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  406.      * <TD VALIGN="TOP">Scale to provided size.</TD></TR>

  407.      * </TABLE>

  408.      */

  409.     public static final TextAttribute SIZE = new TextAttribute("size");

  410. 

  411.     /**

  412.      * Attribute key for the transform of a font.

  413.      *

  414.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  415.      * <TR>

  416.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  417.      * <TD VALIGN="TOP">TRANSFORM</TD></TR>

  418.      * <TR>

  419.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  420.      * <TD VALIGN="TOP">TransformAttribute</TD></TR>

  421.      * <TR>

  422.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  423.      * <TD VALIGN="TOP">Identity transform</TD></TR>

  424.      * <TR>

  425.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  426.      * <TD VALIGN="TOP"><P>Used to transform glyphs rendered by this font. The 

  427.      * primary intent is to support scaling, skewing, and translation. In

  428.      * general, large rotations do not produce very useful results. The

  429.      * transform modifies both the glyph and the advance. The translations

  430.      * in the transform are interpreted as a ratio of the point size. That

  431.      * is, with a point size of 12, a translation of 0.5 results in a

  432.      * movement of 6 points.

  433.      * <p>

  434.      * The advance point of the transformed glyph is the transform of the 

  435.      * advance point projected onto the baseline. If the advance ends up

  436.      * to the left (top) of the glyph origin, the two points are swapped.

  437.      * <p>

  438.      * <P><EM>Example one</EM>: The point 

  439.      * size is 20, the original advance is 10.0, and the transform is a 60 

  440.      * degree counterclockwise rotation plus an offset up and to the right 

  441.      * of 0.1, -0.1. The translation results in an offset of <2.0, -2.0>.

  442.      * The original advance point is <10.0, 0.0>; after the rotation it 

  443.      * is <6.0, -8.0>; when adding the offset this becomes 

  444.      * <8.0,-10.0>, when projecting on the (horizontal) baseline this

  445.      * becomes the new advance point: <8.0, 0.0>. The advance width is

  446.      * the distance from the origin to the advance point: 8.0. The rotated

  447.      * glyph is rendered two points up and to the right of its origin and

  448.      * rotated.  This does not affect the baseline for subsequent

  449.      * glyphs.</P></TD></TR>

  450.      * </TABLE>

  451.      */

  452.     public static final TextAttribute TRANSFORM = new TextAttribute("transform");

  453. 

  454.     /**

  455.      * Attribute key for super and subscripting.

  456.      *

  457.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  458.      * <TR>

  459.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  460.      * <TD VALIGN="TOP">SUPERSCRIPT</TD></TR>

  461.      * <TR>

  462.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  463.      * <TD VALIGN="TOP">Integer</TD></TR>

  464.      * <TR>

  465.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  466.      * <TD VALIGN="TOP">SUPERSCRIPT_NONE = 0,<BR>

  467.      * SUPERSCRIPT_SUPER = 1,<BR>

  468.      * SUPERSCRIPT_SUB = -1</TD></TR>

  469.      * <TR>

  470.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  471.      * <TD VALIGN="TOP">SUPERSCRIPT_NONE</TD></TR>

  472.      * <TR>

  473.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  474.      * <TD VALIGN="TOP">Requests that the font display the characters with 

  475.      * glyphs at a particular superscript level: 0 = none, 1 =

  476.      * superscript, 2 = superscript of superscript,...-1

  477.      * = subscript, -2 = subscript of subscript,... Requests that the font 

  478.      * display text using default superscript (or subscript) glyphs and/or

  479.      * scaling.</TD></TR>

  480.      * <TR>

  481.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  482.      * <TD VALIGN="TOP">Use transform with translation of +/-1/2 and scale 

  483.      * of 2/3, progressively for each level. That is, for the transform at

  484.      * level N (with N != 0):<BR>

  485.      * <TT>offset = sign(N)*1/2*(2/3)^(abs(N)-1)<BR>

  486.      * scale = (2/3)^abs(N)</TT></TD></TR>

  487.      * </TABLE>

  488.      */

  489.     public static final TextAttribute SUPERSCRIPT = new TextAttribute("superscript");

  490. 

  491.     /**

  492.      * Standard superscript.

  493.      * @see #SUPERSCRIPT

  494.      */

  495.     public static final Integer SUPERSCRIPT_SUPER = new Integer(1);

  496. 

  497.     /**

  498.      * Standard subscript.

  499.      * @see #SUPERSCRIPT

  500.      */

  501.     public static final Integer SUPERSCRIPT_SUB = new Integer(-1);

  502. 

  503.     /**

  504.      * Attribute key for the font to use to render text.

  505.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  506.      * <TR>

  507.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  508.      * <TD VALIGN="TOP">FONT</TD></TR>

  509.      * <TR>

  510.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  511.      * <TD VALIGN="TOP">Font</TD></TR>

  512.      * <TR>

  513.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  514.      * <TD VALIGN="TOP">None, perform default resolution</TD></TR>

  515.      * <TR>

  516.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  517.      * <TD VALIGN="TOP">A way for users to override the resolution of font 

  518.      * attributes into a <code>Font</code>, or force use of a particular

  519.      * <code>Font</code> instance.

  520.      * This also allows users to specify subclasses of <code>Font</code> in 

  521.      * cases where a <code>Font</code> can be subclassed.</TD></TR>

  522.      * </TABLE>

  523.      */

  524.     public static final TextAttribute FONT = new TextAttribute("font");

  525. 

  526.     /**

  527.      * Attribute key for a user_defined glyph to display in the text in lieu 

  528.      * of a character.

  529.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  530.      * <TR>

  531.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  532.      * <TD VALIGN="TOP">CHAR_REPLACEMENT</TD></TR>

  533.      * <TR>

  534.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  535.      * <TD VALIGN="TOP">GraphicAttribute</TD></TR>

  536.      * <TR>

  537.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  538.      * <TD VALIGN="TOP">Allows the user to specify an empty position plus 

  539.      * metric information. This method is used to reserve space for a graphic

  540.      * or other embedded component. Required for

  541.      * correct BIDI position of 'inline' components within a line. An optional

  542.      * convenience method allows drawing for simple cases. Follows the 

  543.      * Microsoft model: the character that this is applied to should be 

  544.      * \uFFFC.</TD></TR>

  545.      * </TABLE>

  546.      */

  547.     public static final TextAttribute CHAR_REPLACEMENT = new TextAttribute("char_replacement");

  548. 

  549.     //

  550.     // Adornments added to text.

  551.     //

  552. 

  553.     /**

  554.      * Attribute key for the foreground paint

  555.      *  adornment.

  556.      *

  557.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  558.      * <TR>

  559.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  560.      * <TD VALIGN="TOP">FOREGROUND</TD></TR>

  561.      * <TR>

  562.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  563.      * <TD VALIGN="TOP">Paint</TD></TR>

  564.      * <TR>

  565.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  566.      * <TD VALIGN="TOP">Color.black</TD></TR>

  567.      * <TR>

  568.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  569.      * <TD VALIGN="TOP">Specify the foreground Paint (or Color) of the text.</TD></TR>

  570.      * </TABLE>

  571.      */

  572.     public static final TextAttribute FOREGROUND = new TextAttribute("foreground");

  573. 

  574.     /**

  575.      * Attribute key for the background Paint adornment.

  576.      *

  577.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  578.      * <TR>

  579.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  580.      * <TD VALIGN="TOP">BACKGROUND</TD></TR>

  581.      * <TR>

  582.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  583.      * <TD VALIGN="TOP">Paint</TD></TR>

  584.      * <TR>

  585.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  586.      * <TD VALIGN="TOP">null</TD></TR>

  587.      * <TR>

  588.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  589.      * <TD VALIGN="TOP">Specify the background Paint (or Color) of the text.</TD></TR>

  590.      * </TABLE>

  591.      */

  592.     public static final TextAttribute BACKGROUND = new TextAttribute("background");

  593. 

  594.     /**

  595.      * Attribute key for underline adornments.

  596.      *

  597.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  598.      * <TR>

  599.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  600.      * <TD VALIGN="TOP">UNDERLINE</TD></TR>

  601.      * <TR>

  602.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  603.      * <TD VALIGN="TOP">Integer</TD></TR>

  604.      * <TR>

  605.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  606.      * <TD VALIGN="TOP">UNDERLINE_ON = 0</TD></TR>

  607.      * <TR>

  608.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  609.      * <TD VALIGN="TOP">none</TD></TR>

  610.      * <TR>

  611.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  612.      * <TD VALIGN="TOP">An embellishment added to the glyphs rendered by a 

  613.      * font.</TD></TR>

  614.      * <TR>

  615.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Fallback</TH>

  616.      * <TD VALIGN="TOP"></TD></TR>

  617.      * </TABLE>

  618.      */

  619.     public static final TextAttribute UNDERLINE = new TextAttribute("underline");

  620. 

  621.     /**

  622.      * Standard underline at the roman baseline for roman text, and below

  623.      * the decenders for other text.

  624.      *

  625.      * @see #UNDERLINE

  626.      */

  627.     public static final Integer UNDERLINE_ON = new Integer((byte)0);

  628. 

  629.     /**

  630.      * Attribute key for the strikethrough adornment.

  631.      *

  632.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  633.      * <TR>

  634.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  635.      * <TD VALIGN="TOP">STRIKETHROUGH</TD></TR>

  636.      * <TR>

  637.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  638.      * <TD VALIGN="TOP">Boolean</TD></TR>

  639.      * <TR>

  640.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  641.      * <TD VALIGN="TOP">true = on, false = off</TD></TR>

  642.      * <TR>

  643.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  644.      * <TD VALIGN="TOP">off</TD></TR>

  645.      * <TR>

  646.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  647.      * <TD VALIGN="TOP">An embellishment added to the glyphs rendered by a 

  648.      * font.</TD></TR>

  649.      * </TABLE>

  650.      */

  651.     public static final TextAttribute STRIKETHROUGH = new TextAttribute("strikethrough");

  652. 

  653.     /**

  654.      * A single strikethrough.

  655.      *

  656.      * @see #STRIKETHROUGH

  657.      */

  658.     public static final Boolean STRIKETHROUGH_ON = new Boolean(true);

  659. 

  660.     //

  661.     // Attributes use to control layout of text on a line.

  662.     //

  663. 

  664.     /**

  665.      * Attribute key for the run direction of the line.

  666.      *

  667.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  668.      * <TR>

  669.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  670.      * <TD VALIGN="TOP">RUN_DIRECTION</TD></TR>

  671.      * <TR>

  672.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  673.      * <TD VALIGN="TOP">Boolean</TD></TR>

  674.      * <TR>

  675.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  676.      * <TD VALIGN="TOP">RUN_DIRECTION_LTR = true, RUN_DIRECTION_RTL = false

  677.      * </TD></TR>

  678.      * <TR>

  679.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  680.      * <TD VALIGN="TOP">Use the default Unicode base direction from the BIDI 

  681.      * algorithm.</TD></TR>

  682.      * <TR>

  683.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  684.      * <TD VALIGN="TOP"><P>Specifies which base run direction to use when 

  685.      * positioning mixed directional runs within a paragraph. If this value is

  686.      * RUN_DIRECTION_DEFAULT, <code>TextLayout</code> uses the default Unicode

  687.      * base direction from the BIDI algorithm.</P>

  688.      * <P><I>This attribute should have the same value over the whole 

  689.      * paragraph.</I></TD></TR>

  690.      * </TABLE>

  691.      */

  692.     public static final TextAttribute RUN_DIRECTION = new TextAttribute("run_direction");

  693. 

  694.     /**

  695.      * Left-to-right run direction.

  696.      * @see #RUN_DIRECTION

  697.      */

  698.     public static final Boolean RUN_DIRECTION_LTR = new Boolean(false);

  699. 

  700.     /**

  701.      * Right-to-left run direction.

  702.      * @see #RUN_DIRECTION

  703.      */

  704.     public static final Boolean RUN_DIRECTION_RTL = new Boolean(true);

  705. 

  706.     /**

  707.      * Attribute key for the embedding level for nested bidirectional runs.

  708.      *

  709.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  710.      * <TR>

  711.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  712.      * <TD VALIGN="TOP">BIDI_EMBEDDING</TD></TR>

  713.      * <TR>

  714.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  715.      * <TD VALIGN="TOP">Integer</TD></TR>

  716.      * <TR>

  717.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Limits</TH>

  718.      * <TD VALIGN="TOP">Positive values 1 through 15 are <I>embedding</I>

  719.      * levels, negative values<BR> through -15 are <I>override</I> levels

  720.      * </TD></TR>

  721.      * <TR>

  722.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  723.      * <TD VALIGN="TOP">Use standard BIDI to compute levels from formatting

  724.      * characters in the text.</TD></TR>

  725.      * <TR>

  726.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  727.      * <TD VALIGN="TOP">Specifies the bidi embedding level of the character.

  728.      * When this attribute is present anywhere in a paragraph, then the 

  729.      * Unicode characters RLO, LRO, RLE, LRE, PDF are disregarded in the BIDI 

  730.      * analysis of that paragraph. 

  731.      * See the Unicode Standard v. 2.0, section 3-11.

  732.      * </TD></TR>

  733.      * </TABLE>

  734.      */

  735.     public static final TextAttribute BIDI_EMBEDDING = new TextAttribute("bidi_embedding");

  736. 

  737.     /**

  738.      * Attribute key for the justification of a paragraph.

  739.      *

  740.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  741.      * <TR>

  742.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  743.      * <TD VALIGN="TOP">JUSTIFICATION</TD></TR>

  744.      * <TR>

  745.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  746.      * <TD VALIGN="TOP">Float</TD></TR>

  747.      * <TR>

  748.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Limits</TH>

  749.      * <TD VALIGN="TOP">0.0 through1.0</TD></TR>

  750.      * <TR>

  751.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  752.      * <TD VALIGN="TOP">1.0</TD></TR>

  753.      * <TR>

  754.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Description</TH>

  755.      * <TD VALIGN="TOP"><P>Specifies which fraction of the extra space to use 

  756.      * when justification is requested. For example, if the line is 50 points

  757.      * wide and the margins are 70 points apart, a value of 0.5 means that the

  758.      * line is padded to reach a width of 60 points.</P>

  759.      * <P><I>This attribute should have the same value over the whole

  760.      * paragraph.</I></TD></TR>

  761.      * </TABLE>

  762.      */

  763.     public static final TextAttribute JUSTIFICATION = new TextAttribute("justification");

  764. 

  765.     /**

  766.      * Justify the line to the full requested width.

  767.      * @see #JUSTIFICATION

  768.      */

  769.     public static final Float JUSTIFICATION_FULL = new Float(1.0f);

  770. 

  771.     /**

  772.      * Do not allow the line to be justified.

  773.      * @see #JUSTIFICATION

  774.      */

  775.     public static final Float JUSTIFICATION_NONE = new Float(0.0f);

  776. 

  777.     //

  778.     // For use by input method.

  779.     //

  780. 

  781.     /**

  782.      * Attribute key for input method highlight styles.

  783.      * <p>Values are instances of 

  784.      * {@link java.awt.im.InputMethodHighlight InputMethodHighlight}.

  785.      * These instances should be wrapped in 

  786.      * {@link java.text.Annotation Annotation} instances

  787.      * if segments need to be highlighted separately.

  788.      * <p>

  789.      * Input method highlights are used while text is being composed

  790.      * using an input method. Text editing components should retain them

  791.      * even if they generally only deal with unstyled text, and make them

  792.      * available to the drawing routines.

  793.      * @see java.awt.im.InputMethodHighlight

  794.      */

  795.     public static final TextAttribute INPUT_METHOD_HIGHLIGHT = new TextAttribute("input method highlight");

  796. 

  797.     /**

  798.      * Attribute key for input method underline adornments.

  799.      *

  800.      * <P><TABLE BORDER="0" CELLSPACING="0" CELLPADDING="1">

  801.      * <TR>

  802.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Key</TH>

  803.      * <TD VALIGN="TOP">INPUT_METHOD_UNDERLINE</TD></TR>

  804.      * <TR>

  805.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Value</TH>

  806.      * <TD VALIGN="TOP">Integer</TD></TR>

  807.      * <TR>

  808.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Constants</TH>

  809.      * <TD VALIGN="TOP">UNDERLINE_LOW_ONE_PIXEL, UNDERLINE_LOW_TWO_PIXEL,

  810.      *     UNDERLINE_LOW_DOTTED, UNDERLINE_LOW_GRAY, UNDERLINE_LOW_DASHED</TD></TR>

  811.      * <TR>

  812.      * <TH VALIGN="TOP" ALIGN="RIGHT"><P ALIGN=RIGHT>Default</TH>

  813.      * <TD VALIGN="TOP">no underline</TD></TR>

  814.      * </TABLE>

  815.      * @since 1.3

  816.      */

  817.     public static final TextAttribute INPUT_METHOD_UNDERLINE

  818.                  = new TextAttribute("input method underline");

  819. 

  820.     /**

  821.      * Single pixel solid low underline.

  822.      * @see #INPUT_METHOD_UNDERLINE

  823.      * @since 1.3

  824.      */

  825.     public static final Integer UNDERLINE_LOW_ONE_PIXEL = new Integer(1);

  826. 

  827.     /**

  828.      * Double pixel solid low underline.

  829.      * @see #INPUT_METHOD_UNDERLINE

  830.      * @since 1.3

  831.      */

  832.     public static final Integer UNDERLINE_LOW_TWO_PIXEL = new Integer(2);

  833. 

  834.     /**

  835.      * Single pixel dotted low underline.

  836.      * @see #INPUT_METHOD_UNDERLINE

  837.      * @since 1.3

  838.      */

  839.     public static final Integer UNDERLINE_LOW_DOTTED = new Integer(3);

  840. 

  841.     /**

  842.      * Double pixel gray low underline.

  843.      * @see #INPUT_METHOD_UNDERLINE

  844.      * @since 1.3

  845.      */

  846.     public static final Integer UNDERLINE_LOW_GRAY = new Integer(4);

  847. 

  848.     /**

  849.      * Single pixel dashed low underline.

  850.      * @see #INPUT_METHOD_UNDERLINE

  851.      * @since 1.3

  852.      */

  853.     public static final Integer UNDERLINE_LOW_DASHED = new Integer(5);

  854. 

  855.     /**

  856.      * Attribute key for swapping foreground and background Paints (or Colors).

  857.      *

  858.      * <p>Values are instances of <code>Boolean</code>.

  859.      * The default is not to swap the foreground and background.

  860.      * If the foreground and background attributes are both defined,

  861.      * this causes them to be swapped when rendering text.  If either is

  862.      * defaulted, the exact effect is undefined--generally it will produce

  863.      * an 'inverted' appearance.

  864.      */

  865.     public static final TextAttribute SWAP_COLORS = new TextAttribute("swap_colors");

  866. 

  867.     /** Swap foreground and background. */

  868.     public static final Boolean SWAP_COLORS_ON = new Boolean(true);

  869. }

  870. 

  871. 

  872. 

  873. 

  874. 

  875. 

  876. 

  877.