TextAttribute class defines attribute keys and
* attribute values used for text rendering.
*
* TextAttribute instances are used as attribute keys to
* identify attributes in
* {@link java.awt.Font Font},
* {@link java.awt.font.TextLayout TextLayout},
* {@link java.text.AttributedCharacterIterator AttributedCharacterIterator},
* and other classes handling text attributes. Other constants defined
* in this class can be used as attribute values.
*
* For each text attribute, the documentation provides: *
*
null is treated the same as the
* default value and results in the default behavior.
* TextAttribute.WEIGHT_BOLD and
* new Float(2.0)
* indicate the same WEIGHT.
* Number (used for
* WEIGHT, WIDTH, POSTURE,
* SIZE, JUSTIFICATION, and
* TRACKING) can vary along their natural range and are
* not restricted to the predefined constants.
* Number.floatValue() is used to get the actual value
* from the Number.
* WEIGHT, WIDTH, and
* POSTURE are interpolated by the system, which
* can select the 'nearest available' font or use other techniques to
* approximate the user's request.
*
*
*
*
*
*
*
* @see java.awt.Font
* @see java.awt.font.TextLayout
* @see java.text.AttributedCharacterIterator
*/
public final class TextAttribute extends Attribute {
// table of all instances in this class, used by readResolve
private static final Map instanceMap = new HashMap(29);
/**
* Constructs a
*
* Key
* Value Type
* Principal Constants
* Default Value
*
*
* {@link #FAMILY}
* String
* See Font {@link java.awt.Font#DIALOG DIALOG},
{@link java.awt.Font#DIALOG_INPUT DIALOG_INPUT},
*
{@link java.awt.Font#SERIF SERIF},
{@link java.awt.Font#SANS_SERIF SANS_SERIF}, and {@link java.awt.Font#MONOSPACED MONOSPACED}.
"Default" (use platform default)
*
*
* {@link #WEIGHT}
* Number
* WEIGHT_REGULAR, WEIGHT_BOLD
* WEIGHT_REGULAR
*
*
* {@link #WIDTH}
* Number
* WIDTH_CONDENSED, WIDTH_REGULAR,
*
WIDTH_EXTENDEDWIDTH_REGULAR
*
*
* {@link #POSTURE}
* Number
* POSTURE_REGULAR, POSTURE_OBLIQUE
* POSTURE_REGULAR
*
*
* {@link #SIZE}
* Number
* none
* 12.0
*
*
* {@link #TRANSFORM}
* {@link TransformAttribute}
* See TransformAttribute {@link TransformAttribute#IDENTITY IDENTITY}
* TransformAttribute.IDENTITY
*
*
* {@link #SUPERSCRIPT}
* Integer
* SUPERSCRIPT_SUPER, SUPERSCRIPT_SUB
* 0 (use the standard glyphs and metrics)
*
*
* {@link #FONT}
* {@link java.awt.Font}
* none
* null (do not override font resolution)
*
*
* {@link #CHAR_REPLACEMENT}
* {@link GraphicAttribute}
* none
* null (draw text using font glyphs)
*
*
* {@link #FOREGROUND}
* {@link java.awt.Paint}
* none
* null (use current graphics paint)
*
*
* {@link #BACKGROUND}
* {@link java.awt.Paint}
* none
* null (do not render background)
*
*
* {@link #UNDERLINE}
* Integer
* UNDERLINE_ON
* -1 (do not render underline)
*
*
* {@link #STRIKETHROUGH}
* Boolean
* STRIKETHROUGH_ON
* false (do not render strikethrough)
*
*
* {@link #RUN_DIRECTION}
* Boolean
* RUN_DIRECTION_LTR
*
RUN_DIRECTION_RTLnull (use {@link java.text.Bidi} standard default)
*
*
* {@link #BIDI_EMBEDDING}
* Integer
* none
* 0 (use base line direction)
*
*
* {@link #JUSTIFICATION}
* Number
* JUSTIFICATION_FULL
* JUSTIFICATION_FULL
*
*
* {@link #INPUT_METHOD_HIGHLIGHT}
* {@link java.awt.im.InputMethodHighlight},
*
{@link java.text.Annotation}(see class)
* null (do not apply input highlighting)
*
*
* {@link #INPUT_METHOD_UNDERLINE}
* Integer
* UNDERLINE_LOW_ONE_PIXEL,
*
UNDERLINE_LOW_TWO_PIXEL-1 (do not render underline)
*
*
* {@link #SWAP_COLORS}
* Boolean
* SWAP_COLORS_ON
* false (do not swap colors)
*
*
* {@link #NUMERIC_SHAPING}
* {@link java.awt.font.NumericShaper}
* none
* null (do not shape digits)
*
*
* {@link #KERNING}
* Integer
* KERNING_ON
* 0 (do not request kerning)
*
*
* {@link #LIGATURES}
* Integer
* LIGATURES_ON
* 0 (do not form optional ligatures)
*
*
* {@link #TRACKING}
* Number
* TRACKING_LOOSE, TRACKING_TIGHT
* 0 (do not add tracking)
* TextAttribute with the specified name.
* @param name the attribute name to assign to this
* TextAttribute
*/
protected TextAttribute(String name) {
super(name);
if (this.getClass() == TextAttribute.class) {
instanceMap.put(name, this);
}
}
/**
* Resolves instances being deserialized to the predefined constants.
*/
protected Object readResolve() throws InvalidObjectException {
if (this.getClass() != TextAttribute.class) {
throw new InvalidObjectException(
"subclass didn't correctly implement readResolve");
}
TextAttribute instance = (TextAttribute) instanceMap.get(getName());
if (instance != null) {
return instance;
} else {
throw new InvalidObjectException("unknown attribute name");
}
}
// Serialization compatibility with Java 2 platform v1.2.
// 1.2 will throw an InvalidObjectException if ever asked to
// deserialize INPUT_METHOD_UNDERLINE.
// This shouldn't happen in real life.
static final long serialVersionUID = 7744112784117861702L;
//
// For use with Font.
//
/**
* Attribute key for the font name. Values are instances of
* String. The default value is
* "Default", which causes the platform default font
* family to be used.
*
*
The Font class defines constants for the logical
* font names
* {@link java.awt.Font#DIALOG DIALOG},
* {@link java.awt.Font#DIALOG_INPUT DIALOG_INPUT},
* {@link java.awt.Font#SANS_SERIF SANS_SERIF},
* {@link java.awt.Font#SERIF SERIF}, and
* {@link java.awt.Font#MONOSPACED MONOSPACED}.
*
*
This defines the value passed as name to the
* Font constructor. Both logical and physical
* font names are allowed. If a font with the requested name
* is not found, the default font is used.
*
*
Note: This attribute is unfortunately misnamed, as * it specifies the face name and not just the family. Thus * values such as "Lucida Sans Bold" will select that face if it * exists. Note, though, that if the requested face does not * exist, the default will be used with regular weight. * The "Bold" in the name is part of the face name, not a separate * request that the font's weight be bold.
*/ public static final TextAttribute FAMILY = new TextAttribute("family"); /** * Attribute key for the weight of a font. Values are instances * ofNumber. The default value is
* WEIGHT_REGULAR.
*
* Several constant values are provided, see {@link
* #WEIGHT_EXTRA_LIGHT}, {@link #WEIGHT_LIGHT}, {@link
* #WEIGHT_DEMILIGHT}, {@link #WEIGHT_REGULAR}, {@link
* #WEIGHT_SEMIBOLD}, {@link #WEIGHT_MEDIUM}, {@link
* #WEIGHT_DEMIBOLD}, {@link #WEIGHT_BOLD}, {@link #WEIGHT_HEAVY},
* {@link #WEIGHT_EXTRABOLD}, and {@link #WEIGHT_ULTRABOLD}. The
* value WEIGHT_BOLD corresponds to the
* style value Font.BOLD as passed to the
* Font constructor.
*
*
The value is roughly the ratio of the stem width to that of * the regular weight. * *
The system can interpolate the provided value.
*/
public static final TextAttribute WEIGHT =
new TextAttribute("weight");
/**
* The lightest predefined weight.
* @see #WEIGHT
*/
public static final Float WEIGHT_EXTRA_LIGHT =
Float.valueOf(0.5f);
/**
* The standard light weight.
* @see #WEIGHT
*/
public static final Float WEIGHT_LIGHT =
Float.valueOf(0.75f);
/**
* An intermediate weight between WEIGHT_LIGHT and
* WEIGHT_STANDARD.
* @see #WEIGHT
*/
public static final Float WEIGHT_DEMILIGHT =
Float.valueOf(0.875f);
/**
* The standard weight. This is the default value for WEIGHT.
* @see #WEIGHT
*/
public static final Float WEIGHT_REGULAR =
Float.valueOf(1.0f);
/**
* A moderately heavier weight than WEIGHT_REGULAR.
* @see #WEIGHT
*/
public static final Float WEIGHT_SEMIBOLD =
Float.valueOf(1.25f);
/**
* An intermediate weight between WEIGHT_REGULAR and
* WEIGHT_BOLD.
* @see #WEIGHT
*/
public static final Float WEIGHT_MEDIUM =
Float.valueOf(1.5f);
/**
* A moderately lighter weight than WEIGHT_BOLD.
* @see #WEIGHT
*/
public static final Float WEIGHT_DEMIBOLD =
Float.valueOf(1.75f);
/**
* The standard bold weight.
* @see #WEIGHT
*/
public static final Float WEIGHT_BOLD =
Float.valueOf(2.0f);
/**
* A moderately heavier weight than WEIGHT_BOLD.
* @see #WEIGHT
*/
public static final Float WEIGHT_HEAVY =
Float.valueOf(2.25f);
/**
* An extra heavy weight.
* @see #WEIGHT
*/
public static final Float WEIGHT_EXTRABOLD =
Float.valueOf(2.5f);
/**
* The heaviest predefined weight.
* @see #WEIGHT
*/
public static final Float WEIGHT_ULTRABOLD =
Float.valueOf(2.75f);
/**
* Attribute key for the width of a font. Values are instances of
* Number. The default value is
* WIDTH_REGULAR.
*
*
Several constant values are provided, see {@link * #WIDTH_CONDENSED}, {@link #WIDTH_SEMI_CONDENSED}, {@link * #WIDTH_REGULAR}, {@link #WIDTH_SEMI_EXTENDED}, {@link * #WIDTH_EXTENDED}. * *
The value is roughly the ratio of the advance width to that * of the regular width. * *
The system can interpolate the provided value.
*/
public static final TextAttribute WIDTH =
new TextAttribute("width");
/**
* The most condensed predefined width.
* @see #WIDTH
*/
public static final Float WIDTH_CONDENSED =
Float.valueOf(0.75f);
/**
* A moderately condensed width.
* @see #WIDTH
*/
public static final Float WIDTH_SEMI_CONDENSED =
Float.valueOf(0.875f);
/**
* The standard width. This is the default value for
* WIDTH.
* @see #WIDTH
*/
public static final Float WIDTH_REGULAR =
Float.valueOf(1.0f);
/**
* A moderately extended width.
* @see #WIDTH
*/
public static final Float WIDTH_SEMI_EXTENDED =
Float.valueOf(1.25f);
/**
* The most extended predefined width.
* @see #WIDTH
*/
public static final Float WIDTH_EXTENDED =
Float.valueOf(1.5f);
/**
* Attribute key for the posture of a font. Values are instances
* of Number. The default value is
* POSTURE_REGULAR.
*
*
Two constant values are provided, {@link #POSTURE_REGULAR}
* and {@link #POSTURE_OBLIQUE}. The value
* POSTURE_OBLIQUE corresponds to the style value
* Font.ITALIC as passed to the Font
* constructor.
*
*
The value is roughly the slope of the stems of the font, * expressed as the run over the rise. Positive values lean right. * *
The system can interpolate the provided value. * *
This will affect the font's italic angle as returned by
* Font.getItalicAngle.
*
* @see java.awt.Font#getItalicAngle()
*/
public static final TextAttribute POSTURE =
new TextAttribute("posture");
/**
* The standard posture, upright. This is the default value for
* POSTURE.
* @see #POSTURE
*/
public static final Float POSTURE_REGULAR =
Float.valueOf(0.0f);
/**
* The standard italic posture.
* @see #POSTURE
*/
public static final Float POSTURE_OBLIQUE =
Float.valueOf(0.20f);
/**
* Attribute key for the font size. Values are instances of
* Number. The default value is 12pt.
*
*
This corresponds to the size parameter to the
* Font constructor.
*
*
Very large or small sizes will impact rendering performance, * and the rendering system might not render text at these sizes. * Negative sizes are illegal and result in the default size. * *
Note that the appearance and metrics of a 12pt font with a
* 2x transform might be different than that of a 24 point font
* with no transform.
*/
public static final TextAttribute SIZE =
new TextAttribute("size");
/**
* Attribute key for the transform of a font. Values are
* instances of TransformAttribute. The
* default value is TransformAttribute.IDENTITY.
*
*
The TransformAttribute class defines the
* constant {@link TransformAttribute#IDENTITY IDENTITY}.
*
*
This corresponds to the transform passed to
* Font.deriveFont(AffineTransform). Since that
* transform is mutable and TextAttribute values must
* not be, the TransformAttribute wrapper class is
* used.
*
*
The primary intent is to support scaling and skewing, though * other effects are possible.
* *Some transforms will cause the baseline to be rotated and/or * shifted. The text and the baseline are transformed together so * that the text follows the new baseline. For example, with text * on a horizontal baseline, the new baseline follows the * direction of the unit x vector passed through the * transform. Text metrics are measured against this new baseline. * So, for example, with other things being equal, text rendered * with a rotated TRANSFORM and an unrotated TRANSFORM will measure as * having the same ascent, descent, and advance.
* *In styled text, the baselines for each such run are aligned * one after the other to potentially create a non-linear baseline * for the entire run of text. For more information, see {@link * TextLayout#getLayoutPath}.
* * @see TransformAttribute * @see java.awt.geom.AffineTransform */ public static final TextAttribute TRANSFORM = new TextAttribute("transform"); /** * Attribute key for superscripting and subscripting. Values are * instances ofInteger. The default value is
* 0, which means that no superscript or subscript is used.
*
* Two constant values are provided, see {@link * #SUPERSCRIPT_SUPER} and {@link #SUPERSCRIPT_SUB}. These have * the values 1 and -1 respectively. Values of * greater magnitude define greater levels of superscript or * subscripting, for example, 2 corresponds to super-superscript, * 3 to super-super-superscript, and similarly for negative values * and subscript, up to a level of 7 (or -7). Values beyond this * range are reserved; behavior is platform-dependent. * *
SUPERSCRIPT can
* impact the ascent and descent of a font. The ascent
* and descent can never become negative, however.
*/
public static final TextAttribute SUPERSCRIPT =
new TextAttribute("superscript");
/**
* Standard superscript.
* @see #SUPERSCRIPT
*/
public static final Integer SUPERSCRIPT_SUPER =
Integer.valueOf(1);
/**
* Standard subscript.
* @see #SUPERSCRIPT
*/
public static final Integer SUPERSCRIPT_SUB =
Integer.valueOf(-1);
/**
* Attribute key used to provide the font to use to render text.
* Values are instances of {@link java.awt.Font}. The default
* value is null, indicating that normal resolution of a
* Font from attributes should be performed.
*
*
TextLayout and
* AttributedCharacterIterator work in terms of
* Maps of TextAttributes. Normally,
* all the attributes are examined and used to select and
* configure a Font instance. If a FONT
* attribute is present, though, its associated Font
* will be used. This provides a way for users to override the
* resolution of font attributes into a Font, or
* force use of a particular Font instance. This
* also allows users to specify subclasses of Font in
* cases where a Font can be subclassed.
*
*
FONT is used for special situations where
* clients already have a Font instance but still
* need to use Map-based APIs. Typically, there will
* be no other attributes in the Map except the
* FONT attribute. With Map-based APIs
* the common case is to specify all attributes individually, so
* FONT is not needed or desireable.
*
*
However, if both FONT and other attributes are
* present in the Map, the rendering system will
* merge the attributes defined in the Font with the
* additional attributes. This merging process classifies
* TextAttributes into two groups. One group, the
* 'primary' group, is considered fundamental to the selection and
* metric behavior of a font. These attributes are
* FAMILY, WEIGHT, WIDTH,
* POSTURE, SIZE,
* TRANSFORM, SUPERSCRIPT, and
* TRACKING. The other group, the 'secondary' group,
* consists of all other defined attributes, with the exception of
* FONT itself.
*
*
To generate the new Map, first the
* Font is obtained from the FONT
* attribute, and all of its attributes extracted into a
* new Map. Then only the secondary
* attributes from the original Map are added to
* those in the new Map. Thus the values of primary
* attributes come solely from the Font, and the
* values of secondary attributes originate with the
* Font but can be overridden by other values in the
* Map.
*
*
Note:Font's Map-based
* constructor and deriveFont methods do not process
* the FONT attribute, as these are used to create
* new Font objects. Instead, {@link
* java.awt.Font#getFont(Map) Font.getFont(Map)} should be used to
* handle the FONT attribute.
*
* @see java.awt.Font
*/
public static final TextAttribute FONT =
new TextAttribute("font");
/**
* Attribute key for a user-defined glyph to display in lieu
* of the font's standard glyph for a character. Values are
* intances of GraphicAttribute. The default value is null,
* indicating that the standard glyphs provided by the font
* should be used.
*
*
This attribute is used to reserve space for a graphic or
* other component embedded in a line of text. It is required for
* correct positioning of 'inline' components within a line when
* bidirectional reordering (see {@link java.text.Bidi}) is
* performed. Each character (Unicode code point) will be
* rendered using the provided GraphicAttribute. Typically, the
* characters to which this attribute is applied should be
* \uFFFC.
*
*
The GraphicAttribute determines the logical and visual
* bounds of the text; the actual Font values are ignored.
*
* @see GraphicAttribute
*/
public static final TextAttribute CHAR_REPLACEMENT =
new TextAttribute("char_replacement");
//
// Adornments added to text.
//
/**
* Attribute key for the paint used to render the text. Values are
* instances of Paint. The default value is
* null, indicating that the Paint set on the
* Graphics2D at the time of rendering is used.
*
*
Glyphs will be rendered using this
* Paint regardless of the Paint value
* set on the Graphics (but see {@link #SWAP_COLORS}).
*
* @see java.awt.Paint
* @see #SWAP_COLORS
*/
public static final TextAttribute FOREGROUND =
new TextAttribute("foreground");
/**
* Attribute key for the paint used to render the background of
* the text. Values are instances of Paint.
* The default value is null, indicating that the background
* should not be rendered.
*
*
The logical bounds of the text will be filled using this
* Paint, and then the text will be rendered on top
* of it (but see {@link #SWAP_COLORS}).
*
*
The visual bounds of the text is extended to include the
* logical bounds, if necessary. The outline is not affected.
*
* @see java.awt.Paint
* @see #SWAP_COLORS
*/
public static final TextAttribute BACKGROUND =
new TextAttribute("background");
/**
* Attribute key for underline. Values are instances of
* Integer. The default value is -1, which
* means no underline.
*
*
The constant value {@link #UNDERLINE_ON} is provided. * *
The underline affects both the visual bounds and the outline
* of the text.
*/
public static final TextAttribute UNDERLINE =
new TextAttribute("underline");
/**
* Standard underline.
*
* @see #UNDERLINE
*/
public static final Integer UNDERLINE_ON =
Integer.valueOf(0);
/**
* Attribute key for strikethrough. Values are instances of
* Boolean. The default value is
* false, which means no strikethrough.
*
*
The constant value {@link #STRIKETHROUGH_ON} is provided. * *
The strikethrough affects both the visual bounds and the
* outline of the text.
*/
public static final TextAttribute STRIKETHROUGH =
new TextAttribute("strikethrough");
/**
* A single strikethrough.
*
* @see #STRIKETHROUGH
*/
public static final Boolean STRIKETHROUGH_ON =
Boolean.TRUE;
//
// Attributes use to control layout of text on a line.
//
/**
* Attribute key for the run direction of the line. Values are
* instances of Boolean. The default value is
* null, which indicates that the standard Bidi algorithm for
* determining run direction should be used with the value {@link
* java.text.Bidi#DIRECTION_DEFAULT_LEFT_TO_RIGHT}.
*
*
The constants {@link #RUN_DIRECTION_RTL} and {@link * #RUN_DIRECTION_LTR} are provided. * *
This determines the value passed to the {@link * java.text.Bidi} constructor to select the primary direction of * the text in the paragraph. * *
Note: This attribute should have the same value for
* all the text in a paragraph, otherwise the behavior is
* undetermined.
*
* @see java.text.Bidi
*/
public static final TextAttribute RUN_DIRECTION =
new TextAttribute("run_direction");
/**
* Left-to-right run direction.
* @see #RUN_DIRECTION
*/
public static final Boolean RUN_DIRECTION_LTR =
Boolean.FALSE;
/**
* Right-to-left run direction.
* @see #RUN_DIRECTION
*/
public static final Boolean RUN_DIRECTION_RTL =
Boolean.TRUE;
/**
* Attribute key for the embedding level of the text. Values are
* instances of Integer. The default value is
* null, indicating that the the Bidirectional
* algorithm should run without explicit embeddings.
*
*
Positive values 1 through 61 are embedding levels, * negative values -1 through -61 are override levels. * The value 0 means that the base line direction is used. These * levels are passed in the embedding levels array to the {@link * java.text.Bidi} constructor. * *
Note: When this attribute is present anywhere in
* a paragraph, then any Unicode bidi control characters (RLO,
* LRO, RLE, LRE, and PDF) in the paragraph are
* disregarded, and runs of text where this attribute is not
* present are treated as though it were present and had the value
* 0.
*
* @see java.text.Bidi
*/
public static final TextAttribute BIDI_EMBEDDING =
new TextAttribute("bidi_embedding");
/**
* Attribute key for the justification of a paragraph. Values are
* instances of Number. The default value is
* 1, indicating that justification should use the full width
* provided. Values are pinned to the range [0..1].
*
*
The constants {@link #JUSTIFICATION_FULL} and {@link * #JUSTIFICATION_NONE} are provided. * *
Specifies the fraction of the extra space to use when
* justification is requested on a TextLayout. For
* example, if the line is 50 points wide and it is requested to
* justify to 70 points, a value of 0.75 will pad to use
* three-quarters of the remaining space, or 15 points, so that
* the resulting line will be 65 points in length.
*
*
Note: This should have the same value for all the
* text in a paragraph, otherwise the behavior is undetermined.
*
* @see TextLayout#getJustifiedLayout
*/
public static final TextAttribute JUSTIFICATION =
new TextAttribute("justification");
/**
* Justify the line to the full requested width. This is the
* default value for JUSTIFICATION.
* @see #JUSTIFICATION
*/
public static final Float JUSTIFICATION_FULL =
Float.valueOf(1.0f);
/**
* Do not allow the line to be justified.
* @see #JUSTIFICATION
*/
public static final Float JUSTIFICATION_NONE =
Float.valueOf(0.0f);
//
// For use by input method.
//
/**
* Attribute key for input method highlight styles.
*
*
Values are instances of {@link
* java.awt.im.InputMethodHighlight} or {@link
* java.text.Annotation}. The default value is null,
* which means that input method styles should not be applied
* before rendering.
*
*
If adjacent runs of text with the same
* InputMethodHighlight need to be rendered
* separately, the InputMethodHighlights should be
* wrapped in Annotation instances.
*
*
Input method highlights are used while text is being
* composed by an input method. Text editing components should
* retain them even if they generally only deal with unstyled
* text, and make them available to the drawing routines.
*
* @see java.awt.Font
* @see java.awt.im.InputMethodHighlight
* @see java.text.Annotation
*/
public static final TextAttribute INPUT_METHOD_HIGHLIGHT =
new TextAttribute("input method highlight");
/**
* Attribute key for input method underlines. Values
* are instances of Integer. The default
* value is -1, which means no underline.
*
*
Several constant values are provided, see {@link * #UNDERLINE_LOW_ONE_PIXEL}, {@link #UNDERLINE_LOW_TWO_PIXEL}, * {@link #UNDERLINE_LOW_DOTTED}, {@link #UNDERLINE_LOW_GRAY}, and * {@link #UNDERLINE_LOW_DASHED}. * *
This may be used in conjunction with {@link #UNDERLINE} if * desired. The primary purpose is for use by input methods. * Other use of these underlines for simple ornamentation might * confuse users. * *
The input method underline affects both the visual bounds and
* the outline of the text.
*
* @since 1.3
*/
public static final TextAttribute INPUT_METHOD_UNDERLINE =
new TextAttribute("input method underline");
/**
* Single pixel solid low underline.
* @see #INPUT_METHOD_UNDERLINE
* @since 1.3
*/
public static final Integer UNDERLINE_LOW_ONE_PIXEL =
Integer.valueOf(1);
/**
* Double pixel solid low underline.
* @see #INPUT_METHOD_UNDERLINE
* @since 1.3
*/
public static final Integer UNDERLINE_LOW_TWO_PIXEL =
Integer.valueOf(2);
/**
* Single pixel dotted low underline.
* @see #INPUT_METHOD_UNDERLINE
* @since 1.3
*/
public static final Integer UNDERLINE_LOW_DOTTED =
Integer.valueOf(3);
/**
* Double pixel gray low underline.
* @see #INPUT_METHOD_UNDERLINE
* @since 1.3
*/
public static final Integer UNDERLINE_LOW_GRAY =
Integer.valueOf(4);
/**
* Single pixel dashed low underline.
* @see #INPUT_METHOD_UNDERLINE
* @since 1.3
*/
public static final Integer UNDERLINE_LOW_DASHED =
Integer.valueOf(5);
/**
* Attribute key for swapping foreground and background
* Paints. Values are instances of
* Boolean. The default value is
* false, which means do not swap colors.
*
*
The constant value {@link #SWAP_COLORS_ON} is defined. * *
If the {@link #FOREGROUND} attribute is set, its
* Paint will be used as the background, otherwise
* the Paint currently on the Graphics
* will be used. If the {@link #BACKGROUND} attribute is set, its
* Paint will be used as the foreground, otherwise
* the system will find a contrasting color to the
* (resolved) background so that the text will be visible.
*
* @see #FOREGROUND
* @see #BACKGROUND
*/
public static final TextAttribute SWAP_COLORS =
new TextAttribute("swap_colors");
/**
* Swap foreground and background.
* @see #SWAP_COLORS
* @since 1.3
*/
public static final Boolean SWAP_COLORS_ON =
Boolean.TRUE;
/**
* Attribute key for converting ASCII decimal digits to other
* decimal ranges. Values are instances of {@link NumericShaper}.
* The default is null, which means do not perform
* numeric shaping.
*
*
When a numeric shaper is defined, the text is first * processed by the shaper before any other analysis of the text * is performed. * *
Note: This should have the same value for all the
* text in the paragraph, otherwise the behavior is undetermined.
*
* @see NumericShaper
* @since 1.4
*/
public static final TextAttribute NUMERIC_SHAPING =
new TextAttribute("numeric_shaping");
/**
* Attribute key to request kerning. Values are instances of
* Integer. The default value is
* 0, which does not request kerning.
*
*
The constant value {@link #KERNING_ON} is provided. * *
The default advances of single characters are not
* appropriate for some character sequences, for example "To" or
* "AWAY". Without kerning the adjacent characters appear to be
* separated by too much space. Kerning causes selected sequences
* of characters to be spaced differently for a more pleasing
* visual appearance.
*
* @since 1.6
*/
public static final TextAttribute KERNING =
new TextAttribute("kerning");
/**
* Request standard kerning.
* @see #KERNING
* @since 1.6
*/
public static final Integer KERNING_ON =
Integer.valueOf(1);
/**
* Attribute key for enabling optional ligatures. Values are
* instances of Integer. The default value is
* 0, which means do not use optional ligatures.
*
*
The constant value {@link #LIGATURES_ON} is defined. * *
Ligatures required by the writing system are always enabled.
*
* @since 1.6
*/
public static final TextAttribute LIGATURES =
new TextAttribute("ligatures");
/**
* Request standard optional ligatures.
* @see #LIGATURES
* @since 1.6
*/
public static final Integer LIGATURES_ON =
Integer.valueOf(1);
/**
* Attribute key to control tracking. Values are instances of
* Number. The default value is
* 0, which means no additional tracking.
*
*
The constant values {@link #TRACKING_TIGHT} and {@link * #TRACKING_LOOSE} are provided. * *
The tracking value is multiplied by the font point size and
* passed through the font transform to determine an additional
* amount to add to the advance of each glyph cluster. Positive
* tracking values will inhibit formation of optional ligatures.
* Tracking values are typically between -0.1 and
* 0.3; values outside this range are generally not
* desireable.
*
* @since 1.6
*/
public static final TextAttribute TRACKING =
new TextAttribute("tracking");
/**
* Perform tight tracking.
* @see #TRACKING
* @since 1.6
*/
public static final Float TRACKING_TIGHT =
Float.valueOf(-.04f);
/**
* Perform loose tracking.
* @see #TRACKING
* @since 1.6
*/
public static final Float TRACKING_LOOSE =
Float.valueOf(.04f);
}