org.netbeans.api.editor.settings

Class FontColorSettings

java.lang.Object

org.netbeans.api.editor.settings.FontColorSettings

public abstract class FontColorSettings
extends Object

The map of coloring names and their parameters.

The term coloring refers to a set attributes that can be used for rendering text in an editor window. These attributes may be but are not limited to a font, foreground and background color, etc.

The coloring names are defined by modules. Each coloring is represented by AttributeSet, which contains keys and values for all the attributes that should be used for rendering text that was colorified by the coloring. The keys that can be used to obtain particular attributes are defined in the StyleConstants and EditorStyleConstants classes.

Supported keys for FontColorSettings are:

1. StyleConstants.FontFamily
2. StyleConstants.FontSize
3. StyleConstants.Bold
4. StyleConstants.Italic
5. StyleConstants.Foreground
6. StyleConstants.Background
7. StyleConstants.Underline
8. StyleConstants.StrikeThrough
9. and all attributes defined in EditorStyleConstants

Instances of this class should be retrieved from MimeLookup.

This class must NOT be extended by any API clients.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_FONT_COLORS Deprecated. This should have never been made public. Nobody can listen on this property.

Constructor Summary

Constructors

Constructor and Description
FontColorSettings() Construction prohibited for API clients.

Method Summary

Modifier and Type	Method and Description
abstract AttributeSet	getFontColors(String settingName) Gets the font and colors.
abstract AttributeSet	getTokenFontColors(String tokenName) Gets the token font and colors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_FONT_COLORS

@Deprecated
public static final String PROP_FONT_COLORS

Deprecated. This should have never been made public. Nobody can listen on this property.

See Also:

Constant Field Values

Constructor Detail

FontColorSettings

public FontColorSettings()

Construction prohibited for API clients.

Method Detail

getFontColors

public abstract AttributeSet getFontColors(String settingName)

Gets the font and colors.

Parameters:

settingName - font and colors setting name

Returns:

AttributeSet describing the font and colors.

getTokenFontColors

public abstract AttributeSet getTokenFontColors(String tokenName)

Gets the token font and colors.

Parameters:

tokenName - token name

Returns:

AttributeSet describing the font and colors