1. /*

  2.  * @(#)TextAttribute.java	1.29 01/11/29

  3.  *

  4.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. /*

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

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

  11.  *

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

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

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

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

  16.  * by multiple US and International patents.

  17.  *

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

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

  20.  *

  21.  */

  22. 

  23. package java.awt.font;

  24. 

  25. import java.io.InvalidObjectException;

  26. import java.text.AttributedCharacterIterator.Attribute;

  27. import java.util.Map;

  28. import java.util.HashMap;

  29. 

  30. /**

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

  32.  * attribute values used for text rendering. 

  33.  * <p>

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

  35.  * identify attributes in 

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

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

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

  39.  * as attribute values.

  40.  * <p>

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

  42.  * <UL>

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

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

  45.  *   <LI>relevant constants

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

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

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

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

  50.  *	available.

  51.  * </UL>

  52.  * <p>

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

  54.  * <UL>

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

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

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

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

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

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

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

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

  63.  *      <BLOCKQUOTE><TT>

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

  65.  *	</BLOCKQUOTE></TT>

  66.  * </UL>

  67.  * <p>

  68.  * <H4>Interpolation</H4>

  69.  * <UL>

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

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

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

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

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

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

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

  77.  *   and ULTRABOLD.

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

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

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

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

  82.  * </UL>

  83.  * 

  84.  * @see java.text.AttributedCharacterIterator

  85.  * @see java.awt.Font 

  86.  */

  87. public final class TextAttribute extends Attribute {

  88. 

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

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

  91. 

  92.     /**

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

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

  95.      * <code>TextAttribute</code>

  96.      */

  97.     protected TextAttribute(String name) {

  98.         super(name);

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

  100.             instanceMap.put(name, this);

  101.         }

  102.     }

  103. 

  104.     /**

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

  106.      */

  107.     protected Object readResolve() throws InvalidObjectException {

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

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

  110.         }

  111.         

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

  113.         if (instance != null) {

  114.             return instance;

  115.         } else {

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

  117.         };

  118.     }

  119. 

  120.     // 

  121.     // For use with Font.

  122.     //

  123. 

  124.     /**

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

  126.      *

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

  128.      * <TR>

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

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

  131.      * <TR>

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

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

  134.      * <TR>

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

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

  137.      * <TR>

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

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

  140.      * <TR>

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

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

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

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

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

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

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

  148.      * </TABLE>

  149.      */

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

  151. 

  152.     /**

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

  154.      *

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

  156.      * <TR>

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

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

  159.      * <TR>

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

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

  162.      * <TR>

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

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

  165.      * WEIGHT_EXTRA_LIGHT = 0.5,<BR>

  166.      * WEIGHT_LIGHT = 0.75,<BR>

  167.      * WEIGHT_DEMILIGHT = 0.875,<BR>

  168.      * WEIGHT_REGULAR = 1.0,<BR>

  169.      * WEIGHT_SEMIBOLD = 1.25,<BR>

  170.      * WEIGHT_MEDIUM = 1.5,<BR>

  171.      * WEIGHT_DEMIBOLD = 1.75,<BR>

  172.      * WEIGHT_BOLD = 2.0,<BR>

  173.      * WEIGHT_HEAVY = 2.25,<BR>

  174.      * WEIGHT_EXTRABOLD = 2.5,<BR>

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

  176.      * <TR>

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

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

  179.      * <TR>

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

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

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

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

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

  185.      * <TR>

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

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

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

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

  190.      * </TABLE>

  191.      * <BR>

  192.      */

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

  194. 

  195.     /**

  196.      * The lightest predefined weight.

  197.      * @see #WEIGHT

  198.      */

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

  200. 

  201.     /**

  202.      * The standard light weight.

  203.      * @see #WEIGHT

  204.      */

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

  206. 

  207.     /**

  208.      * An intermediate weight between LIGHT and STANDARD.

  209.      * @see #WEIGHT

  210.      */

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

  212. 

  213.     /**

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

  215.      * @see #WEIGHT

  216.      */

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

  218. 

  219.     /**

  220.      * A moderately heavier weight than REGULAR.

  221.      * @see #WEIGHT

  222.      */

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

  224. 

  225.     /**

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

  227.      * @see #WEIGHT

  228.      */

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

  230. 

  231.     /**

  232.      * A moderately lighter weight than BOLD.

  233.      * @see #WEIGHT

  234.      */

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

  236. 

  237.     /**

  238.      * The standard bold weight.

  239.      * @see #WEIGHT

  240.      */

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

  242. 

  243.     /**

  244.      * A moderately heavier weight than BOLD.

  245.      * @see #WEIGHT

  246.      */

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

  248. 

  249.     /**

  250.      * An extra heavy weight.

  251.      * @see #WEIGHT

  252.      */

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

  254. 

  255.     /**

  256.      * The heaviest predefined weight.

  257.      * @see #WEIGHT

  258.      */

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

  260. 

  261.     /**

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

  263.      *

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

  265.      * <TR>

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

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

  268.      * <TR>

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

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

  271.      * <TR>

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

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

  274.      * WIDTH_SEMI_CONDENSED = 0.875,<BR>

  275.      * WIDTH_REGULAR = 1.0,<BR>

  276.      * WIDTH_SEMI_EXTENDED = 1.25,<BR>

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

  278.      * <TR>

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

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

  281.      * <TR>

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

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

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

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

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

  287.      * <TR>

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

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

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

  291.      * </TABLE>

  292.      */

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

  294. 

  295.     /**

  296.      * The most condensed predefined width.

  297.      * @see #WIDTH

  298.      */

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

  300. 

  301.     /**

  302.      * A moderately condensed width.

  303.      * @see #WIDTH

  304.      */

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

  306. 

  307.     /**

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

  309.      * @see #WIDTH

  310.      */

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

  312. 

  313.     /**

  314.      * A moderately extended width.

  315.      * @see #WIDTH

  316.      */

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

  318. 

  319.     /**

  320.      * The most extended predefined width.

  321.      * @see #WIDTH

  322.      */

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

  324. 

  325.     /**

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

  327.      *

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

  329.      * <TR>

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

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

  332.      * <TR>

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

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

  335.      * <TR>

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

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

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

  339.      * <TR>

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

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

  342.      * <TR>

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

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

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

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

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

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

  349.      * might change.<BR>

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

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

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

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

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

  355.      * <TR>

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

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

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

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

  360.      * </TABLE>

  361.      *

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

  363.      */

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

  365. 

  366.     /**

  367.      * The standard posture, upright.

  368.      * @see #POSTURE

  369.      */

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

  371. 

  372.     /**

  373.      * The standard italic posture.

  374.      * @see #POSTURE

  375.      */

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

  377. 

  378.     /**

  379.      * Attribute key for the font size.

  380.      *

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

  382.      * <TR>

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

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

  385.      * <TR>

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

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

  388.      * <TR>

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

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

  391.      * <TR>

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

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

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

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

  396.      * <TR>

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

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

  399.      * </TABLE>

  400.      */

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

  402. 

  403.     /**

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

  405.      *

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

  407.      * <TR>

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

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

  410.      * <TR>

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

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

  413.      * <TR>

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

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

  416.      * <TR>

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

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

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

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

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

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

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

  424.      * movement of 6 points.

  425.      * <p>

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

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

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

  429.      * <p>

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

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

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

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

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

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

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

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

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

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

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

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

  442.      * </TABLE>

  443.      */

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

  445. 

  446.     /**

  447.      * Attribute key for super and subscripting.

  448.      *

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

  450.      * <TR>

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

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

  453.      * <TR>

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

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

  456.      * <TR>

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

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

  459.      * SUPERSCRIPT_SUPER = 1,<BR>

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

  461.      * <TR>

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

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

  464.      * <TR>

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

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

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

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

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

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

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

  472.      * <TR>

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

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

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

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

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

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

  479.      * </TABLE>

  480.      */

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

  482. 

  483.     /**

  484.      * Standard superscript.

  485.      * @see #SUPERSCRIPT

  486.      */

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

  488. 

  489.     /**

  490.      * Standard subscript.

  491.      * @see #SUPERSCRIPT

  492.      */

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

  494. 

  495.     /**

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

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

  498.      * <TR>

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

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

  501.      * <TR>

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

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

  504.      * <TR>

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

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

  507.      * <TR>

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

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

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

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

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

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

  514.      * </TABLE>

  515.      */

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

  517. 

  518.     /**

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

  520.      * of a character.

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

  522.      * <TR>

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

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

  525.      * <TR>

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

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

  528.      * <TR>

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

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

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

  532.      * or other embedded component. Required for

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

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

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

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

  537.      * </TABLE>

  538.      */

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

  540. 

  541.     //

  542.     // Adornments added to text.

  543.     //

  544. 

  545.     /**

  546.      * Attribute key for the foreground paint

  547.      *  adornment.

  548.      *

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

  550.      * <TR>

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

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

  553.      * <TR>

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

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

  556.      * <TR>

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

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

  559.      * <TR>

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

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

  562.      * </TABLE>

  563.      */

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

  565. 

  566.     /**

  567.      * Attribute key for the background Paint adornment.

  568.      *

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

  570.      * <TR>

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

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

  573.      * <TR>

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

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

  576.      * <TR>

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

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

  579.      * <TR>

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

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

  582.      * </TABLE>

  583.      */

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

  585. 

  586.     /**

  587.      * Attribute key for underline adornments.

  588.      *

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

  590.      * <TR>

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

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

  593.      * <TR>

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

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

  596.      * <TR>

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

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

  599.      * <TR>

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

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

  602.      * <TR>

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

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

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

  606.      * <TR>

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

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

  609.      * </TABLE>

  610.      */

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

  612. 

  613.     /**

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

  615.      * the decenders for other text.

  616.      *

  617.      * @see #UNDERLINE

  618.      */

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

  620. 

  621.     /**

  622.      * Attribute key for the strikethrough adornment.

  623.      *

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

  625.      * <TR>

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

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

  628.      * <TR>

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

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

  631.      * <TR>

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

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

  634.      * <TR>

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

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

  637.      * <TR>

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

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

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

  641.      * </TABLE>

  642.      */

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

  644. 

  645.     /**

  646.      * A single strikethrough.

  647.      *

  648.      * @see #STRIKETHROUGH

  649.      */

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

  651. 

  652.     //

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

  654.     //

  655. 

  656.     /**

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

  658.      *

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

  660.      * <TR>

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

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

  663.      * <TR>

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

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

  666.      * <TR>

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

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

  669.      * </TD></TR>

  670.      * <TR>

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

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

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

  674.      * <TR>

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

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

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

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

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

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

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

  682.      * </TABLE>

  683.      */

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

  685. 

  686.     /**

  687.      * Left-to-right run direction.

  688.      * @see #RUN_DIRECTION

  689.      */

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

  691. 

  692.     /**

  693.      * Right-to-left run direction.

  694.      * @see #RUN_DIRECTION

  695.      */

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

  697. 

  698.     /**

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

  700.      *

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

  702.      * <TR>

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

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

  705.      * <TR>

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

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

  708.      * <TR>

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

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

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

  712.      * </TD></TR>

  713.      * <TR>

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

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

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

  717.      * <TR>

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

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

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

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

  722.      * analysis of that paragraph. 

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

  724.      * </TD></TR>

  725.      * </TABLE>

  726.      */

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

  728. 

  729.     /**

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

  731.      *

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

  733.      * <TR>

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

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

  736.      * <TR>

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

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

  739.      * <TR>

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

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

  742.      * <TR>

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

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

  745.      * <TR>

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

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

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

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

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

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

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

  753.      * </TABLE>

  754.      */

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

  756. 

  757.     /**

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

  759.      * @see #JUSTIFICATION

  760.      */

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

  762. 

  763.     /**

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

  765.      * @see #JUSTIFICATION

  766.      */

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

  768. 

  769.     //

  770.     // For use by input method.

  771.     //

  772. 

  773.     /**

  774.      * Attribute key for input method highlight styles.

  775.      * <p>Values are instances of 

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

  777.      * These instances should be wrapped in 

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

  779.      * if segments need to be highlighted separately.

  780.      * <p>

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

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

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

  784.      * available to the drawing routines.

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

  786.      */

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

  788. 

  789.     /**

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

  791.      *

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

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

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

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

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

  797.      * an 'inverted' appearance.

  798.      */

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

  800. 

  801.     /** Swap foreground and background. */

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

  803. }

  804. 

  805. 

  806. 

  807. 

  808. 

  809. 

  810. 

  811.