Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.text.StyleConstants

java.lang.Object
    |
    +----java.awt.swing.text.StyleConstants

public class StyleConstants
extends Object

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.


Inner Class Summary
static   StyleConstants.CharacterConstants
This is a typesafe enumeration of the well-known attributes that contribute to a character style.
static   StyleConstants.ColorConstants
This is a typesafe enumeration of the well-known attributes that contribute to a color.
static   StyleConstants.FontConstants
This is a typesafe enumeration of the well-known attributes that contribute to a font.
static   StyleConstants.ParagraphConstants
This is a typesafe enumeration of the well-known attributes that contribute to a paragraph style.
 

Field Summary
static int  ALIGN_CENTER
A possible value for paragraph alignment.
static int  ALIGN_JUSTIFIED
A possible value for paragraph alignment.
static int  ALIGN_LEFT
A possible value for paragraph alignment.
static int  ALIGN_RIGHT
A possible value for paragraph alignment.
static Object  Alignment
Alignment for the paragraph.
static Object  Background
Name of the background color attribute.
static Object  Bold
Name of the bold attribute.
static Object  ComponentAttribute
Name of the component attribute.
static String  ComponentElementName
Name of elements used to represent components.
static Object  FirstLineIndent
The amount of space to indent the first line of the paragraph.
static Object  FontFamily
Name of the font family.
static Object  FontSize
Name of the font size.
static Object  Foreground
Name of the foreground color attribute.
static Object  IconAttribute
Name of the icon attribute.
static String  IconElementName
Name of elements used to represent icons.
static Object  Italic
Name of the italic attribute.
static Object  LeftIndent
The amount to indent the left side of the paragraph.
static Object  LineSpacing
The amount of space between lines of the paragraph.
static Object  NameAttribute
Attribute name used to name the collection of attributes.
static Object  ResolveAttribute
Attribute name used to identifiy the resolving parent set of attributes, if one is defined.
static Object  RightIndent
The amount to indent the right side of the paragraph.
static Object  SpaceAbove
The amount of space above the paragraph.
static Object  SpaceBelow
The amount of space below the paragraph.
static Object  TabSet
TabSet for the paragraph, type is a TabSet containing TabStops.
static Object  Underline
Name of the underline attribute.
 

Method Summary
static int  getAlignment(AttributeSet a)
Gets the alignment 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  isUnderline(AttributeSet a)
Checks whether the underline attribute is set.
static void  setAlignment(MutableAttributeSet a, int align)
Sets alignment.
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  setTabSet(MutableAttributeSet a, TabSet tabs)
Sets the TabSet.
static void  setUnderline(MutableAttributeSet a, boolean b)
Sets the underline attribute.
String  toString()
 
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ComponentElementName

public static final String ComponentElementName
Name of elements used to represent components.

IconElementName

public static final String IconElementName
Name of elements used to represent icons.

NameAttribute

public static final Object NameAttribute
Attribute name used to name the collection of attributes.

ResolveAttribute

public static final Object ResolveAttribute
Attribute name used to identifiy the resolving parent set of attributes, if one is defined.

FontFamily

public static final Object FontFamily
Name of the font family.

FontSize

public static final Object FontSize
Name of the font size.

Bold

public static final Object Bold
Name of the bold attribute.

Italic

public static final Object Italic
Name of the italic attribute.

Underline

public static final Object Underline
Name of the underline attribute.

Foreground

public static final Object Foreground
Name of the foreground color attribute.

Background

public static final Object Background
Name of the background color attribute.

ComponentAttribute

public static final Object ComponentAttribute
Name of the component attribute.

IconAttribute

public static final Object IconAttribute
Name of the icon attribute.

FirstLineIndent

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.

LeftIndent

public static final Object LeftIndent
The amount to indent the left side of the paragraph. Type is float and specifies the size in points.

RightIndent

public static final Object RightIndent
The amount to indent the right side of the paragraph. Type is float and specifies the size in points.

LineSpacing

public static final Object LineSpacing
The amount of space between lines of the paragraph. Type is float and specifies the size in points.

SpaceAbove

public static final Object SpaceAbove
The amount of space above the paragraph. Type is float and specifies the size in points.

SpaceBelow

public static final Object SpaceBelow
The amount of space below the paragraph. Type is float and specifies the size in points.

Alignment

public static final Object Alignment
Alignment for the paragraph. The type is Integer. Valid values are:

TabSet

public static final Object TabSet
TabSet for the paragraph, type is a TabSet containing TabStops.

ALIGN_LEFT

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

ALIGN_CENTER

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

ALIGN_RIGHT

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

ALIGN_JUSTIFIED

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.
Method Detail

toString

public String toString()
Overrides:
toString in class Object

getComponent

public static Component getComponent(AttributeSet a)
Gets the component setting from the attribute list.
Parameters:
a - the attribute set
Returns:
the component

setComponent

public static void setComponent(MutableAttributeSet a,
                                Component c)
Sets the component attribute.
Parameters:
a - the attribute set
c - the component

getIcon

public static Icon getIcon(AttributeSet a)
Gets the icon setting from the attribute list.
Parameters:
a - the attribute set
Returns:
the icon

setIcon

public static void setIcon(MutableAttributeSet a,
                           Icon c)
Sets the icon attribute.
Parameters:
a - the attribute set
c - the icon

getFontFamily

public static String getFontFamily(AttributeSet a)
Gets the font family setting from the attribute list.
Parameters:
a - the attribute set
Returns:
the font family

setFontFamily

public static void setFontFamily(MutableAttributeSet a,
                                 String fam)
Sets the font attribute.
Parameters:
a - the attribute set
fam - the font

getFontSize

public static int getFontSize(AttributeSet a)
Gets the font size setting from the attribute list.
Parameters:
a - the attribute set
Returns:
the font size

setFontSize

public static void setFontSize(MutableAttributeSet a,
                               int s)
Sets the font size attribute.
Parameters:
a - the attribute set
s - the font size

isBold

public static boolean isBold(AttributeSet a)
Checks whether the bold attribute is set.
Parameters:
a - the attribute set
Returns:
true if set else false

setBold

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

isItalic

public static boolean isItalic(AttributeSet a)
Checks whether the italic attribute is set.
Parameters:
a - the attribute set
Returns:
true if set else false

setItalic

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

isUnderline

public static boolean isUnderline(AttributeSet a)
Checks whether the underline attribute is set.
Parameters:
a - the attribute set
Returns:
true if set else false

setUnderline

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

getForeground

public static Color getForeground(AttributeSet a)
Gets the foreground color setting from the attribute list.
Parameters:
a - the attribute set
Returns:
the color

setForeground

public static void setForeground(MutableAttributeSet a,
                                 Color fg)
Sets the foreground color.
Parameters:
a - the attribute set
fg - the color

getFirstLineIndent

public static float getFirstLineIndent(AttributeSet a)
Gets the first line indent setting.
Parameters:
a - the attribute set

setFirstLineIndent

public static void setFirstLineIndent(MutableAttributeSet a,
                                      float i)
Sets the first line indent.
Parameters:
a - the attribute set
i - the value

getRightIndent

public static float getRightIndent(AttributeSet a)
Gets the right indent setting.
Parameters:
a - the attribute set

setRightIndent

public static void setRightIndent(MutableAttributeSet a,
                                  float i)
Sets right indent.
Parameters:
a - the attribute set
i - the value

getLeftIndent

public static float getLeftIndent(AttributeSet a)
Gets the left indent setting.
Parameters:
a - the attribute set

setLeftIndent

public static void setLeftIndent(MutableAttributeSet a,
                                 float i)
Sets left indent.
Parameters:
a - the attribute set
i - the value

getLineSpacing

public static float getLineSpacing(AttributeSet a)
Gets the line spacing setting.
Parameters:
a - the attribute set

setLineSpacing

public static void setLineSpacing(MutableAttributeSet a,
                                  float i)
Sets line spacing.
Parameters:
a - the attribute set
i - the value

getSpaceAbove

public static float getSpaceAbove(AttributeSet a)
Gets the space above setting.
Parameters:
a - the attribute set

setSpaceAbove

public static void setSpaceAbove(MutableAttributeSet a,
                                 float i)
Sets space above.
Parameters:
a - the attribute set
i - the value

getSpaceBelow

public static float getSpaceBelow(AttributeSet a)
Gets the space below setting.
Parameters:
a - the attribute set

setSpaceBelow

public static void setSpaceBelow(MutableAttributeSet a,
                                 float i)
Sets space below.
Parameters:
a - the attribute set
i - the value

getAlignment

public static int getAlignment(AttributeSet a)
Gets the alignment setting.
Parameters:
a - the attribute set

setAlignment

public static void setAlignment(MutableAttributeSet a,
                                int align)
Sets alignment.
Parameters:
a - the attribute set
align - the alignment value

getTabSet

public static TabSet getTabSet(AttributeSet a)
Gets the TabSet.
Parameters:
a - the attribute set

setTabSet

public static void setTabSet(MutableAttributeSet a,
                             TabSet tabs)
Sets the TabSet.
Parameters:
a - the attribute set.
tabs - the TabSet

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.