|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.fife.ui.rsyntaxtextarea.SyntaxScheme
public class SyntaxScheme
The set of colors and styles used by an RSyntaxTextArea
to
color tokens.
Field Summary | |
---|---|
Style[] |
styles
|
Constructor Summary | |
---|---|
SyntaxScheme(boolean useDefaults)
Creates a color scheme that either has all color values set to a default value or set to null . |
|
SyntaxScheme(Font baseFont)
Creates a default color scheme. |
Method Summary | |
---|---|
Object |
clone()
Returns a deep copy of this color scheme. |
boolean |
equals(Object otherScheme)
Tests whether this color scheme is the same as another color scheme. |
int |
hashCode()
This is implemented to be consistent with equals(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 from toCommaSeparatedString . |
void |
restoreDefaults(Font baseFont)
Restores all colors and fonts to their default values. |
void |
setStyle(int type,
Style style)
Sets a style to use when rendering a token type. |
String |
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<<16) | (g<<8) | (b)) ; if it is
null , it is added as "-,". |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public Style[] styles
Constructor Detail |
---|
public SyntaxScheme(boolean useDefaults)
null
.
useDefaults
- If true
, all color values will
be set to default colors; if false
, all colors
will be initially null
.public SyntaxScheme(Font baseFont)
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.Method Detail |
---|
public Object clone()
clone
in class Object
public boolean equals(Object otherScheme)
equals
in class Object
otherScheme
- The color scheme to compare to.
true
if this color scheme and
otherScheme
are the same scheme;
false
otherwise.public int hashCode()
equals(Object)
.
This is a requirement to keep FindBugs happy.
hashCode
in class Object
public static SyntaxScheme load(Font baseFont, InputStream in) throws IOException
baseFont
- The font to use as the "base" for the syntax scheme.
If this is null
, 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.
IOException
- If an IO error occurs.public static SyntaxScheme loadFromString(String string)
toCommaSeparatedString
. This method is useful for saving
and restoring color schemes.
string
- A string generated from toCommaSeparatedString()
.
public void restoreDefaults(Font baseFont)
baseFont
- The base font to use when creating this scheme. If
this is null
, then a default monospaced font is
used.public void setStyle(int type, Style style)
type
- The token type.style
- The style for the token type.public String toCommaSeparatedString()
((r<<16) | (g<<8) | (b))
; if it is
null
, it is added as "-,".
i
is the index of the syntax scheme.
-
).
uline
is whether or not the font should be
underlined, and is either t
or f
.
style
is the family,style,size
triplet described above.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |