public class

StyleConstants

extends Object
java.lang.Object
   ↳ javax.swing.text.StyleConstants
Known Direct Subclasses

Class Overview

A collection of well known or common attribute keys and methods to apply to an AttributeSet or MutableAttributeSet to get/set the properties in a typesafe manner.

The paragraph attributes form the definition of a paragraph to be rendered. All sizes are specified in points (such as found in postscript), a device independent measure.

Diagram shows SpaceAbove, FirstLineIndent, LeftIndent, RightIndent, and SpaceBelow a paragraph.

Summary

Nested Classes
class StyleConstants.CharacterConstants This is a typesafe enumeration of the well-known attributes that contribute to a character style. 
class StyleConstants.ColorConstants This is a typesafe enumeration of the well-known attributes that contribute to a color. 
class StyleConstants.FontConstants This is a typesafe enumeration of the well-known attributes that contribute to a font. 
class StyleConstants.ParagraphConstants This is a typesafe enumeration of the well-known attributes that contribute to a paragraph style. 
Constants
int ALIGN_CENTER A possible value for paragraph alignment.
int ALIGN_JUSTIFIED A possible value for paragraph alignment.
int ALIGN_LEFT A possible value for paragraph alignment.
int ALIGN_RIGHT A possible value for paragraph alignment.
String ComponentElementName Name of elements used to represent components.
String IconElementName Name of elements used to represent icons.
Fields
public static final Object Alignment Alignment for the paragraph.
public static final Object Background Name of the background color attribute.
public static final Object BidiLevel Bidirectional level of a character as assigned by the Unicode bidi algorithm.
public static final Object Bold Name of the bold attribute.
public static final Object ComponentAttribute Name of the component attribute.
public static final Object ComposedTextAttribute Name of the input method composed text attribute.
public static final Object Family Name of the font family.
public static final Object FirstLineIndent The amount of space to indent the first line of the paragraph.
public static final Object FontFamily Name of the font family.
public static final Object FontSize Name of the font size.
public static final Object Foreground Name of the foreground color attribute.
public static final Object IconAttribute Name of the icon attribute.
public static final Object Italic Name of the italic attribute.
public static final Object LeftIndent The amount to indent the left side of the paragraph.
public static final Object LineSpacing The amount of space between lines of the paragraph.
public static final Object ModelAttribute Attribute used to identify the model for embedded objects that have a model view separation.
public static final Object NameAttribute Attribute name used to name the collection of attributes.
public static final Object Orientation Orientation for a paragraph.
public static final Object ResolveAttribute Attribute name used to identifiy the resolving parent set of attributes, if one is defined.
public static final Object RightIndent The amount to indent the right side of the paragraph.
public static final Object Size Name of the font size.
public static final Object SpaceAbove The amount of space above the paragraph.
public static final Object SpaceBelow The amount of space below the paragraph.
public static final Object StrikeThrough Name of the Strikethrough attribute.
public static final Object Subscript Name of the Subscript attribute.
public static final Object Superscript Name of the Superscript attribute.
public static final Object TabSet TabSet for the paragraph, type is a TabSet containing TabStops.
public static final Object Underline Name of the underline attribute.
Public Methods
static int getAlignment(AttributeSet a)
Gets the alignment setting.
static Color getBackground(AttributeSet a)
Gets the background color setting from the attribute list.
static int getBidiLevel(AttributeSet a)
Gets the BidiLevel setting.
static Component getComponent(AttributeSet a)
Gets the component setting from the attribute list.
static float getFirstLineIndent(AttributeSet a)
Gets the first line indent setting.
static String getFontFamily(AttributeSet a)
Gets the font family setting from the attribute list.
static int getFontSize(AttributeSet a)
Gets the font size setting from the attribute list.
static Color getForeground(AttributeSet a)
Gets the foreground color setting from the attribute list.
static Icon getIcon(AttributeSet a)
Gets the icon setting from the attribute list.
static float getLeftIndent(AttributeSet a)
Gets the left indent setting.
static float getLineSpacing(AttributeSet a)
Gets the line spacing setting.
static float getRightIndent(AttributeSet a)
Gets the right indent setting.
static float getSpaceAbove(AttributeSet a)
Gets the space above setting.
static float getSpaceBelow(AttributeSet a)
Gets the space below setting.
static TabSet getTabSet(AttributeSet a)
Gets the TabSet.
static boolean isBold(AttributeSet a)
Checks whether the bold attribute is set.
static boolean isItalic(AttributeSet a)
Checks whether the italic attribute is set.
static boolean isStrikeThrough(AttributeSet a)
Checks whether the strikethrough attribute is set.
static boolean isSubscript(AttributeSet a)
Checks whether the subscript attribute is set.
static boolean isSuperscript(AttributeSet a)
Checks whether the superscript attribute is set.
static boolean isUnderline(AttributeSet a)
Checks whether the underline attribute is set.
static void setAlignment(MutableAttributeSet a, int align)
Sets alignment.
static void setBackground(MutableAttributeSet a, Color fg)
Sets the background color.
static void setBidiLevel(MutableAttributeSet a, int o)
Sets the BidiLevel.
static void setBold(MutableAttributeSet a, boolean b)
Sets the bold attribute.
static void setComponent(MutableAttributeSet a, Component c)
Sets the component attribute.
static void setFirstLineIndent(MutableAttributeSet a, float i)
Sets the first line indent.
static void setFontFamily(MutableAttributeSet a, String fam)
Sets the font attribute.
static void setFontSize(MutableAttributeSet a, int s)
Sets the font size attribute.
static void setForeground(MutableAttributeSet a, Color fg)
Sets the foreground color.
static void setIcon(MutableAttributeSet a, Icon c)
Sets the icon attribute.
static void setItalic(MutableAttributeSet a, boolean b)
Sets the italic attribute.
static void setLeftIndent(MutableAttributeSet a, float i)
Sets left indent.
static void setLineSpacing(MutableAttributeSet a, float i)
Sets line spacing.
static void setRightIndent(MutableAttributeSet a, float i)
Sets right indent.
static void setSpaceAbove(MutableAttributeSet a, float i)
Sets space above.
static void setSpaceBelow(MutableAttributeSet a, float i)
Sets space below.
static void setStrikeThrough(MutableAttributeSet a, boolean b)
Sets the strikethrough attribute.
static void setSubscript(MutableAttributeSet a, boolean b)
Sets the subscript attribute.
static void setSuperscript(MutableAttributeSet a, boolean b)
Sets the superscript attribute.
static void setTabSet(MutableAttributeSet a, TabSet tabs)
Sets the TabSet.
static void setUnderline(MutableAttributeSet a, boolean b)
Sets the underline attribute.
String toString()
Returns the string representation.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int ALIGN_CENTER

A possible value for paragraph alignment. This specifies that the text is aligned to the center and extra whitespace should be placed equally on the left and right.

Constant Value: 1 (0x00000001)

public static final int ALIGN_JUSTIFIED

A possible value for paragraph alignment. This specifies that extra whitespace should be spread out through the rows of the paragraph with the text lined up with the left and right indent except on the last line which should be aligned to the left.

Constant Value: 3 (0x00000003)

public static final int ALIGN_LEFT

A possible value for paragraph alignment. This specifies that the text is aligned to the left indent and extra whitespace should be placed on the right.

Constant Value: 0 (0x00000000)

public static final int ALIGN_RIGHT

A possible value for paragraph alignment. This specifies that the text is aligned to the right indent and extra whitespace should be placed on the left.

Constant Value: 2 (0x00000002)

public static final String ComponentElementName

Name of elements used to represent components.

Constant Value: "component"

public static final String IconElementName

Name of elements used to represent icons.

Constant Value: "icon"

Fields

public static final Object Alignment

Alignment for the paragraph. The type is Integer. Valid values are:

  • ALIGN_LEFT
  • ALIGN_RIGHT
  • ALIGN_CENTER
  • ALIGN_JUSTIFED

public static final Object Background

Name of the background color attribute.

public static final Object BidiLevel

Bidirectional level of a character as assigned by the Unicode bidi algorithm.

public static final Object Bold

Name of the bold attribute.

public static final Object ComponentAttribute

Name of the component attribute.

public static final Object ComposedTextAttribute

Name of the input method composed text attribute. The value of this attribute is an instance of AttributedString which represents the composed text.

public static final Object Family

Name of the font family.

public static final Object FirstLineIndent

The amount of space to indent the first line of the paragraph. This value may be negative to offset in the reverse direction. The type is Float and specifies the size of the space in points.

public static final Object FontFamily

Name of the font family.

public static final Object FontSize

Name of the font size.

public static final Object Foreground

Name of the foreground color attribute.

public static final Object IconAttribute

Name of the icon attribute.

public static final Object Italic

Name of the italic attribute.

public static final Object LeftIndent

The amount to indent the left side of the paragraph. Type is float and specifies the size in points.

public static final Object LineSpacing

The amount of space between lines of the paragraph. Type is float and specifies the size as a factor of the line height

public static final Object ModelAttribute

Attribute used to identify the model for embedded objects that have a model view separation.

public static final Object NameAttribute

Attribute name used to name the collection of attributes.

public static final Object Orientation

Orientation for a paragraph.

public static final Object ResolveAttribute

Attribute name used to identifiy the resolving parent set of attributes, if one is defined.

public static final Object RightIndent

The amount to indent the right side of the paragraph. Type is float and specifies the size in points.

public static final Object Size

Name of the font size.

public static final Object SpaceAbove

The amount of space above the paragraph. Type is float and specifies the size in points.

public static final Object SpaceBelow

The amount of space below the paragraph. Type is float and specifies the size in points.

public static final Object StrikeThrough

Name of the Strikethrough attribute.

public static final Object Subscript

Name of the Subscript attribute.

public static final Object Superscript

Name of the Superscript attribute.

public static final Object TabSet

TabSet for the paragraph, type is a TabSet containing TabStops.

public static final Object Underline

Name of the underline attribute.

Public Methods

public static int getAlignment (AttributeSet a)

Gets the alignment setting.

Parameters
a the attribute set
Returns
  • the value StyleConstants.ALIGN_LEFT if not set

public static Color getBackground (AttributeSet a)

Gets the background color setting from the attribute list.

Parameters
a the attribute set
Returns
  • the color, Color.black as the default

public static int getBidiLevel (AttributeSet a)

Gets the BidiLevel setting.

Parameters
a the attribute set
Returns
  • the value

public static Component getComponent (AttributeSet a)

Gets the component setting from the attribute list.

Parameters
a the attribute set
Returns
  • the component, null if none

public static float getFirstLineIndent (AttributeSet a)

Gets the first line indent setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static String getFontFamily (AttributeSet a)

Gets the font family setting from the attribute list.

Parameters
a the attribute set
Returns
  • the font family, "Monospaced" as the default

public static int getFontSize (AttributeSet a)

Gets the font size setting from the attribute list.

Parameters
a the attribute set
Returns
  • the font size, 12 as the default

public static Color getForeground (AttributeSet a)

Gets the foreground color setting from the attribute list.

Parameters
a the attribute set
Returns
  • the color, Color.black as the default

public static Icon getIcon (AttributeSet a)

Gets the icon setting from the attribute list.

Parameters
a the attribute set
Returns
  • the icon, null if none

public static float getLeftIndent (AttributeSet a)

Gets the left indent setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static float getLineSpacing (AttributeSet a)

Gets the line spacing setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static float getRightIndent (AttributeSet a)

Gets the right indent setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static float getSpaceAbove (AttributeSet a)

Gets the space above setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static float getSpaceBelow (AttributeSet a)

Gets the space below setting.

Parameters
a the attribute set
Returns
  • the value, 0 if not set

public static TabSet getTabSet (AttributeSet a)

Gets the TabSet.

Parameters
a the attribute set
Returns
  • the TabSet

public static boolean isBold (AttributeSet a)

Checks whether the bold attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static boolean isItalic (AttributeSet a)

Checks whether the italic attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static boolean isStrikeThrough (AttributeSet a)

Checks whether the strikethrough attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static boolean isSubscript (AttributeSet a)

Checks whether the subscript attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static boolean isSuperscript (AttributeSet a)

Checks whether the superscript attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static boolean isUnderline (AttributeSet a)

Checks whether the underline attribute is set.

Parameters
a the attribute set
Returns
  • true if set else false

public static void setAlignment (MutableAttributeSet a, int align)

Sets alignment.

Parameters
a the attribute set
align the alignment value

public static void setBackground (MutableAttributeSet a, Color fg)

Sets the background color.

Parameters
a the attribute set
fg the color

public static void setBidiLevel (MutableAttributeSet a, int o)

Sets the BidiLevel.

Parameters
a the attribute set
o the bidi level value

public static void setBold (MutableAttributeSet a, boolean b)

Sets the bold attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public static void setComponent (MutableAttributeSet a, Component c)

Sets the component attribute.

Parameters
a the attribute set
c the component

public static void setFirstLineIndent (MutableAttributeSet a, float i)

Sets the first line indent.

Parameters
a the attribute set
i the value

public static void setFontFamily (MutableAttributeSet a, String fam)

Sets the font attribute.

Parameters
a the attribute set
fam the font

public static void setFontSize (MutableAttributeSet a, int s)

Sets the font size attribute.

Parameters
a the attribute set
s the font size

public static void setForeground (MutableAttributeSet a, Color fg)

Sets the foreground color.

Parameters
a the attribute set
fg the color

public static void setIcon (MutableAttributeSet a, Icon c)

Sets the icon attribute.

Parameters
a the attribute set
c the icon

public static void setItalic (MutableAttributeSet a, boolean b)

Sets the italic attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public static void setLeftIndent (MutableAttributeSet a, float i)

Sets left indent.

Parameters
a the attribute set
i the value

public static void setLineSpacing (MutableAttributeSet a, float i)

Sets line spacing.

Parameters
a the attribute set
i the value

public static void setRightIndent (MutableAttributeSet a, float i)

Sets right indent.

Parameters
a the attribute set
i the value

public static void setSpaceAbove (MutableAttributeSet a, float i)

Sets space above.

Parameters
a the attribute set
i the value

public static void setSpaceBelow (MutableAttributeSet a, float i)

Sets space below.

Parameters
a the attribute set
i the value

public static void setStrikeThrough (MutableAttributeSet a, boolean b)

Sets the strikethrough attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public static void setSubscript (MutableAttributeSet a, boolean b)

Sets the subscript attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public static void setSuperscript (MutableAttributeSet a, boolean b)

Sets the superscript attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public static void setTabSet (MutableAttributeSet a, TabSet tabs)

Sets the TabSet.

Parameters
a the attribute set.
tabs the TabSet

public static void setUnderline (MutableAttributeSet a, boolean b)

Sets the underline attribute.

Parameters
a the attribute set
b specifies true/false for setting the attribute

public String toString ()

Returns the string representation.

Returns
  • the string