Package org.fife.ui.rsyntaxtextarea
Class SyntaxScheme
java.lang.Object
org.fife.ui.rsyntaxtextarea.SyntaxScheme
- All Implemented Interfaces:
Cloneable
,TokenTypes
The set of colors and styles used by an
RSyntaxTextArea
to
color tokens.
You can use this class to programmatically set the fonts and colors used in
an RSyntaxTextArea, but for more powerful, externalized control, consider
using Theme
s instead.
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Loads aSyntaxScheme
from an XML file. -
Field Summary
FieldsFields inherited from interface org.fife.ui.rsyntaxtextarea.TokenTypes
ANNOTATION, COMMENT_DOCUMENTATION, COMMENT_EOL, COMMENT_KEYWORD, COMMENT_MARKUP, COMMENT_MULTILINE, DATA_TYPE, DEFAULT_NUM_TOKEN_TYPES, ERROR_CHAR, ERROR_IDENTIFIER, ERROR_NUMBER_FORMAT, ERROR_STRING_DOUBLE, FUNCTION, IDENTIFIER, LITERAL_BACKQUOTE, LITERAL_BOOLEAN, LITERAL_CHAR, LITERAL_NUMBER_DECIMAL_INT, LITERAL_NUMBER_FLOAT, LITERAL_NUMBER_HEXADECIMAL, LITERAL_STRING_DOUBLE_QUOTE, MARKUP_CDATA, MARKUP_CDATA_DELIMITER, MARKUP_COMMENT, MARKUP_DTD, MARKUP_ENTITY_REFERENCE, MARKUP_PROCESSING_INSTRUCTION, MARKUP_TAG_ATTRIBUTE, MARKUP_TAG_ATTRIBUTE_VALUE, MARKUP_TAG_DELIMITER, MARKUP_TAG_NAME, NULL, OPERATOR, PREPROCESSOR, REGEX, RESERVED_WORD, RESERVED_WORD_2, SEPARATOR, VARIABLE, WHITESPACE
-
Constructor Summary
ConstructorsConstructorDescriptionSyntaxScheme
(boolean useDefaults) Creates a color scheme that either has all color values set to a default value or set tonull
.SyntaxScheme
(Font baseFont) Creates a default color scheme.SyntaxScheme
(Font baseFont, boolean fontStyles) Creates a default color scheme. -
Method Summary
Modifier and TypeMethodDescription(package private) void
changeBaseFont
(Font old, Font font) Changes the "base font" for this syntax scheme.clone()
Returns a deep copy of this color scheme.boolean
Tests whether this color scheme is the same as another color scheme.private static String
Returns a hex string representing an RGB color, of the form"$rrggbb"
.getStyle
(int index) Returns the specified style.int
Returns the number of styles.Style[]
Used by third party implementors e.g.int
hashCode()
This is implemented to be consistent withequals(Object)
.static SyntaxScheme
load
(Font baseFont, InputStream in) Loads a syntax scheme from an input stream.static SyntaxScheme
loadFromString
(String string) Loads a syntax highlighting color scheme from a string created fromtoCommaSeparatedString
.static SyntaxScheme
loadFromString
(String string, int tokenTypeCount) Loads a syntax highlighting color scheme from a string created fromtoCommaSeparatedString
.(package private) void
void
restoreDefaults
(Font baseFont) Restores all colors and fonts to their default values.void
restoreDefaults
(Font baseFont, boolean fontStyles) Restores all colors and fonts to their default values.void
Sets a style to use when rendering a token type.void
Used by third party implementors e.g.private static Color
Returns the color represented by a string.Returns this syntax highlighting scheme as a comma-separated list of values as follows: If a color is non-null, it is added as a 24-bit integer of the form((r<*lt;16) | (g<*lt;8) | (b))
; if it isnull
, it is added as "-,".
-
Field Details
-
styles
-
VERSION
- See Also:
-
-
Constructor Details
-
SyntaxScheme
public SyntaxScheme(boolean useDefaults) Creates a color scheme that either has all color values set to a default value or set tonull
.- Parameters:
useDefaults
- Iftrue
, all color values will be set to default colors; iffalse
, all colors will be initiallynull
.
-
SyntaxScheme
Creates a default color scheme.- Parameters:
baseFont
- The base font to use. Keywords will be a bold version of this font, and comments will be an italicized version of this font.
-
SyntaxScheme
Creates a default color scheme.- Parameters:
baseFont
- The base font to use. Keywords will be a bold version of this font, and comments will be an italicized version of this font.fontStyles
- Whether bold and italic should be used in the scheme (vs. all tokens using a plain font).
-
-
Method Details
-
changeBaseFont
Changes the "base font" for this syntax scheme. This is called byRSyntaxTextArea
when its font changes viasetFont()
. This looks for tokens that use a derivative of the text area's old font (but bolded and/or italicized) and makes them use the new font with those styles instead. This is desirable because most programmers prefer a single font to be used in their text editor, but might want bold (say for keywords) or italics.- Parameters:
old
- The old font of the text area.font
- The new font of the text area.
-
clone
Returns a deep copy of this color scheme. -
equals
Tests whether this color scheme is the same as another color scheme. -
getHexString
Returns a hex string representing an RGB color, of the form"$rrggbb"
.- Parameters:
c
- The color.- Returns:
- The string representation of the color.
-
getStyle
Returns the specified style.- Parameters:
index
- The index of the style.- Returns:
- The style.
- See Also:
-
getStyleCount
public int getStyleCount()Returns the number of styles.- Returns:
- The number of styles.
- See Also:
-
getStyles
Used by third party implementors e.g. SquirreL SQL. Most applications do not need to call this method.Note that the returned array is not a copy of the style data; editing the array will modify the styles used by any
RSyntaxTextArea
using this scheme.- Returns:
- The style array.
- See Also:
-
hashCode
public int hashCode()This is implemented to be consistent withequals(Object)
. This is a requirement to keep FindBugs happy. -
load
Loads a syntax scheme from an input stream.Consider using the
Theme
class for saving and loading RSTA styles rather than using this API.- Parameters:
baseFont
- The font to use as the "base" for the syntax scheme. If this isnull
, a default monospaced font is used.in
- The stream to load from. It is up to the caller to close this stream when they are done.- Returns:
- The syntax scheme.
- Throws:
IOException
- If an IO error occurs.
-
loadFromString
Loads a syntax highlighting color scheme from a string created fromtoCommaSeparatedString
. This method is useful for saving and restoring color schemes.Consider using the
Theme
class for saving and loading RSTA styles rather than using this API.- Parameters:
string
- A string generated fromtoCommaSeparatedString()
.- Returns:
- A color scheme.
- See Also:
-
loadFromString
Loads a syntax highlighting color scheme from a string created fromtoCommaSeparatedString
. This method is useful for saving and restoring color schemes.Consider using the
Theme
class for saving and loading RSTA styles rather than using this API.- Parameters:
string
- A string generated fromtoCommaSeparatedString()
.tokenTypeCount
- The number of token types saved in this string. This should be the number of token types saved by your custom SyntaxScheme subclass, orTokenTypes.DEFAULT_NUM_TOKEN_TYPES
if you used the standard implementation (which most people will).- Returns:
- A color scheme.
- See Also:
-
refreshFontMetrics
-
restoreDefaults
Restores all colors and fonts to their default values.- Parameters:
baseFont
- The base font to use when creating this scheme. If this isnull
, then a default monospaced font is used.
-
restoreDefaults
Restores all colors and fonts to their default values.- Parameters:
baseFont
- The base font to use when creating this scheme. If this isnull
, then a default monospaced font is used.fontStyles
- Whether bold and italic should be used in the scheme (vs. all tokens using a plain font).
-
setStyle
Sets a style to use when rendering a token type.- Parameters:
type
- The token type.style
- The style for the token type.- See Also:
-
setStyles
Used by third party implementors e.g. SquirreL SQL. Most applications do not need to call this method; individual styles can be set viasetStyle(int, Style)
.- Parameters:
styles
- The new array of styles to use. Note that this should have length of at leastTokenTypes.DEFAULT_NUM_TOKEN_TYPES
.- See Also:
-
stringToColor
Returns the color represented by a string. If the first char in the string is '$
', it is assumed to be in hex, otherwise it is assumed to be decimal. So, for example, both of these:"$00ff00" "65280"
will returnnew Color(0, 255, 0)
.- Parameters:
s
- The string to evaluate.- Returns:
- The color.
-
toCommaSeparatedString
Returns this syntax highlighting scheme as a comma-separated list of values as follows:- If a color is non-null, it is added as a 24-bit integer
of the form
((r<*lt;16) | (g<*lt;8) | (b))
; if it isnull
, it is added as "-,". - The font and style (bold/italic) is added as an integer like so: "family, style, size".
- The entire syntax highlighting scheme is thus one long string of
color schemes of the format "i,[fg],[bg],uline,[style],
where:
i
is the index of the syntax scheme.- fg and bg are the foreground and background
colors for the scheme, and may be null (represented by
-
). uline
is whether the font should be underlined, and is eithert
orf
.style
is thefamily,style,size
triplet described above.
- Returns:
- A string representing the rgb values of the colors.
- See Also:
- If a color is non-null, it is added as a 24-bit integer
of the form
-