Java Doc for TextAttribute.java in  » 6.0-JDK-Modules » j2me » java » awt » font » Java Source Code / Java DocumentationJava Source Code and Java Documentation

TextAttribute instances are used as attribute keys to identify attributes in java.text.AttributedCharacterIterator AttributedCharacterIterator , java.awt.Font Font , and other classes handling text attributes. Other constants defined in this class are used as attribute values.

For each text attribute, the documentation describes:

• the type of their values,
• the valid values if there are limitations
• relevant constants
• the default effect if the attribute is absent (or has a null value).
• a description of the effect.
• the fallback behavior if the exact attribute requested is not available.

Types of Values

• The values of attributes must always be immutable.
• Where a list of limitations is given, any value outside of that set is reserved for future use, and ignored at present.
• If the value is null or not of the proper type then it has the default effect. The effect of a particular value can be interpolated, especially in the case of multiple master fonts. This interpolation is done based on the nearest defined constants above and below the request:
  

  interpolation = (request - below)/(above - below);

Interpolation

• Fonts should interpolate values in certain circumstances. For example, when the WEIGHT value is 2.13. If the nearest surrounding values in the font are WEIGHT_BOLD = 2.0 and WEIGHT_HEAVY = 2.25 then font would then interpret the WEIGHT request as being 52% of the way between what it considers BOLD and what it considers HEAVY. If the nearest surrounding values are WEIGHT_SEMIBOLD = 1.25 and WEIGHT_ULTRABOLD = 2.75 then the WEIGHT request is interpreted as being 58.67% of the way between SEMIBOLD and ULTRABOLD.
• Where a font does not have enough capability to handle a given request, such as superscript, then it should simulate it to the best of its ability. To determine if simulation is being performed, the client should query the font to see what actual attributes were used.

Key	FAMILY
Value	String
Constants	"Serif", "SansSerif"
Default	Host default;
Description	The name of the font family.
final public static  TextAttribute	FONT      Attribute key for the font to use to render text.
final public static  TextAttribute	FOREGROUND      Attribute key for the foreground paint adornment.
final public static  TextAttribute	INPUT_METHOD_HIGHLIGHT      Attribute key for input method highlight styles. Values are instances of java.awt.im.InputMethodHighlight InputMethodHighlight . These instances should be wrapped in java.text.Annotation Annotation instances if segments need to be highlighted separately. Input method highlights are used while text is being composed using an input method.
final public static  TextAttribute	POSTURE      Attribute key for the posture of a font. Key POSTURE Value Float Constants POSTURE_REGULAR = 0, POSTURE_OBLIQUE = 0.20 Default POSTURE_REGULAR Description The value is interpreted generally as a skew slope, positive leans to the right. final public static  Float POSTURE_OBLIQUE      The standard italic posture. final public static  Float POSTURE_REGULAR      The standard posture, upright. final public static  TextAttribute SIZE      Attribute key for the font size. Key SIZE Value Float Default from System Properties Description Represents point size. final public static  TextAttribute STRIKETHROUGH      Attribute key for the strikethrough adornment. final public static  Boolean STRIKETHROUGH_ON      A single strikethrough. final public static  TextAttribute UNDERLINE      Attribute key for underline adornments. final public static  Integer UNDERLINE_ON      Standard underline at the roman baseline for roman text, and below the decenders for other text. final public static  TextAttribute WEIGHT      Attribute key for the weight of a font. Key WEIGHT Value Float Constants WEIGHT_EXTRA_LIGHT = 0.5, WEIGHT_LIGHT = 0.75, WEIGHT_DEMILIGHT = 0.875, WEIGHT_REGULAR = 1.0, WEIGHT_SEMIBOLD = 1.25, WEIGHT_MEDIUM = 1.5, WEIGHT_DEMIBOLD = 1.75, WEIGHT_BOLD = 2.0, WEIGHT_HEAVY = 2.25, WEIGHT_EXTRABOLD = 2.5, WEIGHT_ULTRABOLD = 2.75 Default WEIGHT_REGULAR Description The value is roughly the ratio of the stem width to that of the regular weight. final public static  Float WEIGHT_BOLD      The standard bold weight. final public static  Float WEIGHT_DEMIBOLD      A moderately lighter weight than BOLD. final public static  Float WEIGHT_DEMILIGHT      An intermediate weight between LIGHT and STANDARD. final public static  Float WEIGHT_EXTRABOLD      An extra heavy weight. final public static  Float WEIGHT_EXTRA_LIGHT      The lightest predefined weight. final public static  Float WEIGHT_HEAVY      A moderately heavier weight than BOLD. final public static  Float WEIGHT_LIGHT      The standard light weight. final public static  Float WEIGHT_MEDIUM      An intermediate weight between the REGULAR and BOLD weights. final public static  Float WEIGHT_REGULAR      The standard weight. final public static  Float WEIGHT_SEMIBOLD      A moderately heavier weight than REGULAR. final public static  Float WEIGHT_ULTRABOLD      The heaviest predefined weight. final static  long serialVersionUID      Method Summary protected  Object readResolve()      Resolves instances being deserialized to the predefined constants. Field Detail FAMILY final public static TextAttribute FAMILY(Code) Attribute key for the unlocalized font family name. Key FAMILY Value String Constants "Serif", "SansSerif" Default Host default; Description The name of the font family. If the family name is not found, the default font is used. The name should not be the full font name or specify other attributes (such as the name "Helvetica Bold"). Such names might result in the default font if the name does not match a known family name. FONT final public static TextAttribute FONT(Code) Attribute key for the font to use to render text. Key FONT Value Font Default None, perform default resolution Description 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. FOREGROUND final public static TextAttribute FOREGROUND(Code) Attribute key for the foreground paint adornment. Key FOREGROUND Value Paint Default Color.black Description Specify the foreground Paint (or Color) of the text. INPUT_METHOD_HIGHLIGHT final public static TextAttribute INPUT_METHOD_HIGHLIGHT(Code) Attribute key for input method highlight styles. Values are instances of java.awt.im.InputMethodHighlight InputMethodHighlight . These instances should be wrapped in java.text.Annotation Annotation instances if segments need to be highlighted separately. Input method highlights are used while text is being composed using 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 Also:   java.awt.im.InputMethodHighlight POSTURE final public static TextAttribute POSTURE(Code) Attribute key for the posture of a font. Key POSTURE Value Float Constants POSTURE_REGULAR = 0, POSTURE_OBLIQUE = 0.20 Default POSTURE_REGULAR Description The value is interpreted generally as a skew slope, positive leans to the right. If the font has a different value for specific constants, then the value is interpolated as described in the class description. With fonts that have italic faces, not only the skew of the character changes, but also the letter shapes might change. Notes: To set the value by angle, use: value = new Float(Math.tan(Math.PI*degrees/180.0) To determine the angle from the value, use: angle = Math.atan(value.floatValue())*180/Math.PI Fallback If an Oblique font is available and matches, use that. Otherwise skew with a transform using the posture value interpreted as run/rise. See Also:   java.awt.Font.getItalicAngle POSTURE_OBLIQUE final public static Float POSTURE_OBLIQUE(Code) The standard italic posture. See Also:   TextAttribute.POSTURE POSTURE_REGULAR final public static Float POSTURE_REGULAR(Code) The standard posture, upright. See Also:   TextAttribute.POSTURE SIZE final public static TextAttribute SIZE(Code) Attribute key for the font size. Key SIZE Value Float Default from System Properties Description Represents point 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. Fallback Scale to provided size. STRIKETHROUGH final public static TextAttribute STRIKETHROUGH(Code) Attribute key for the strikethrough adornment. Key STRIKETHROUGH Value Boolean Constants true = on, false = off Default off Description An embellishment added to the glyphs rendered by a font. STRIKETHROUGH_ON final public static Boolean STRIKETHROUGH_ON(Code) A single strikethrough. See Also:   TextAttribute.STRIKETHROUGH UNDERLINE final public static TextAttribute UNDERLINE(Code) Attribute key for underline adornments. Key UNDERLINE Value Integer Constants UNDERLINE_ON = 0 Default none Description An embellishment added to the glyphs rendered by a font. Fallback UNDERLINE_ON final public static Integer UNDERLINE_ON(Code) Standard underline at the roman baseline for roman text, and below the decenders for other text. See Also:   TextAttribute.UNDERLINE WEIGHT final public static TextAttribute WEIGHT(Code) Attribute key for the weight of a font. Key WEIGHT Value Float Constants WEIGHT_EXTRA_LIGHT = 0.5, WEIGHT_LIGHT = 0.75, WEIGHT_DEMILIGHT = 0.875, WEIGHT_REGULAR = 1.0, WEIGHT_SEMIBOLD = 1.25, WEIGHT_MEDIUM = 1.5, WEIGHT_DEMIBOLD = 1.75, WEIGHT_BOLD = 2.0, WEIGHT_HEAVY = 2.25, WEIGHT_EXTRABOLD = 2.5, WEIGHT_ULTRABOLD = 2.75 Default WEIGHT_REGULAR Description The value is roughly the ratio of the stem width to that of the regular weight. If the font has a different value for specific constants, then the value is interpolated as described in the class description. Fallback Currently none. However, in the future, shape manipulations might be available to simulate weight variations for fonts that don't have them. WEIGHT_BOLD final public static Float WEIGHT_BOLD(Code) The standard bold weight. See Also:   TextAttribute.WEIGHT WEIGHT_DEMIBOLD final public static Float WEIGHT_DEMIBOLD(Code) A moderately lighter weight than BOLD. See Also:   TextAttribute.WEIGHT WEIGHT_DEMILIGHT final public static Float WEIGHT_DEMILIGHT(Code) An intermediate weight between LIGHT and STANDARD. See Also:   TextAttribute.WEIGHT WEIGHT_EXTRABOLD final public static Float WEIGHT_EXTRABOLD(Code) An extra heavy weight. See Also:   TextAttribute.WEIGHT WEIGHT_EXTRA_LIGHT final public static Float WEIGHT_EXTRA_LIGHT(Code) The lightest predefined weight. See Also:   TextAttribute.WEIGHT WEIGHT_HEAVY final public static Float WEIGHT_HEAVY(Code) A moderately heavier weight than BOLD. See Also:   TextAttribute.WEIGHT WEIGHT_LIGHT final public static Float WEIGHT_LIGHT(Code) The standard light weight. See Also:   TextAttribute.WEIGHT WEIGHT_MEDIUM final public static Float WEIGHT_MEDIUM(Code) An intermediate weight between the REGULAR and BOLD weights. See Also:   TextAttribute.WEIGHT WEIGHT_REGULAR final public static Float WEIGHT_REGULAR(Code) The standard weight. This weight is used if WEIGHT is unspecified. See Also:   TextAttribute.WEIGHT WEIGHT_SEMIBOLD final public static Float WEIGHT_SEMIBOLD(Code) A moderately heavier weight than REGULAR. See Also:   TextAttribute.WEIGHT WEIGHT_ULTRABOLD final public static Float WEIGHT_ULTRABOLD(Code) The heaviest predefined weight. See Also:   TextAttribute.WEIGHT serialVersionUID final static long serialVersionUID(Code) Method Detail readResolve protected Object readResolve() throws InvalidObjectException(Code) Resolves instances being deserialized to the predefined constants.