SyntaxScheme

java.lang.Object
- com.fr.design.gui.syntax.ui.rsyntaxtextarea.SyntaxScheme

所有已实现的接口:

TokenTypes, java.lang.Cloneable
```
public class SyntaxScheme
extends java.lang.Object
implements java.lang.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 Themes instead.

版本:

1.0

作者:

Robert Futrell

另请参阅:
Theme

字段概要
- 从接口继承的字段 com.fr.design.gui.syntax.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

构造器概要

构造器
构造器和说明
`SyntaxScheme(boolean useDefaults)` Creates a color scheme that either has all color values set to a default value or set to `null`.
`SyntaxScheme(java.awt.Font baseFont)` Creates a default color scheme.
`SyntaxScheme(java.awt.Font baseFont, boolean fontStyles)` Creates a default color scheme.

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`clone()` Returns a deep copy of this color scheme.
`boolean`	`equals(java.lang.Object otherScheme)` Tests whether this color scheme is the same as another color scheme.
`Style`	`getStyle(int index)` Returns the specified style.
`int`	`getStyleCount()` Returns the number of styles.
`Style[]`	`getStyles()` Used by third party implementors e.g.
`int`	`hashCode()` This is implemented to be consistent with `equals(Object)`.
`static SyntaxScheme`	`load(java.awt.Font baseFont, java.io.InputStream in)` Loads a syntax scheme from an input stream.
`static SyntaxScheme`	`loadFromString(java.lang.String string)` Loads a syntax highlighting color scheme from a string created from `toCommaSeparatedString`.
`static SyntaxScheme`	`loadFromString(java.lang.String string, int tokenTypeCount)` Loads a syntax highlighting color scheme from a string created from `toCommaSeparatedString`.
`void`	`restoreDefaults(java.awt.Font baseFont)` Restores all colors and fonts to their default values.
`void`	`restoreDefaults(java.awt.Font baseFont, boolean fontStyles)` 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.
`void`	`setStyles(Style[] styles)` Used by third party implementors e.g.
`java.lang.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 "-,".

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SyntaxScheme
```
public SyntaxScheme(boolean useDefaults)
```
    Creates a color scheme that either has all color values set to a default value or set to null.
    
    参数:
    useDefaults - If true, all color values will be set to default colors; if false, all colors will be initially null.
  - SyntaxScheme
```
public SyntaxScheme(java.awt.Font baseFont)
```
    Creates a default color scheme.
    
    参数:
    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
```
public SyntaxScheme(java.awt.Font baseFont,
            boolean fontStyles)
```
    Creates a default color scheme.
    
    参数:
    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).
- 方法详细资料
  - clone
```
public java.lang.Object clone()
```
    Returns a deep copy of this color scheme.
    
    覆盖:
    
    clone 在类中 java.lang.Object
    
    返回:
    The copy.
  - equals
```
public boolean equals(java.lang.Object otherScheme)
```
    Tests whether this color scheme is the same as another color scheme.
    
    覆盖:
    
    equals 在类中 java.lang.Object
    
    参数:
    otherScheme - The color scheme to compare to.
    
    返回:
    true if this color scheme and otherScheme are the same scheme; false otherwise.
  - getStyle
```
public Style getStyle(int index)
```
    Returns the specified style.
    
    参数:
    index - The index of the style.
    
    返回:
    The style.
    另请参阅:
    setStyle(int, Style), getStyleCount()
  - getStyleCount
```
public int getStyleCount()
```
    Returns the number of styles.
    
    返回:
    The number of styles.
    另请参阅:
    getStyle(int)
  - getStyles
```
public Style[] 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.
    
    返回:
    The style array.
    另请参阅:
    setStyles(Style[])
  - hashCode
```
public int hashCode()
```
    This is implemented to be consistent with equals(Object). This is a requirement to keep FindBugs happy.
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    The hash code for this object.
  - load
```
public static SyntaxScheme load(java.awt.Font baseFont,
                java.io.InputStream in)
                         throws java.io.IOException
```
    Loads a syntax scheme from an input stream.
    Consider using the Theme class for saving and loading RSTA styles rather than using this API.
    
    参数:
    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.
    
    返回:
    The syntax scheme.
    
    抛出:
    
    java.io.IOException - If an IO error occurs.
  - loadFromString
```
public static SyntaxScheme loadFromString(java.lang.String string)
```
    Loads a syntax highlighting color scheme from a string created from toCommaSeparatedString. 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.
    
    参数:
    string - A string generated from toCommaSeparatedString().
    
    返回:
    A color scheme.
    另请参阅:
    toCommaSeparatedString()
  - loadFromString
```
public static SyntaxScheme loadFromString(java.lang.String string,
                          int tokenTypeCount)
```
    Loads a syntax highlighting color scheme from a string created from toCommaSeparatedString. 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.
    
    参数:
    string - A string generated from toCommaSeparatedString().
    tokenTypeCount - The number of token types saved in this string. This should be the number of token types saved by your custom SyntaxScheme subclass, or TokenTypes.DEFAULT_NUM_TOKEN_TYPES if you used the standard implementation (which most people will).
    
    返回:
    A color scheme.
    另请参阅:
    loadFromString(String), toCommaSeparatedString()
  - restoreDefaults
```
public void restoreDefaults(java.awt.Font baseFont)
```
    Restores all colors and fonts to their default values.
    
    参数:
    baseFont - The base font to use when creating this scheme. If this is null, then a default monospaced font is used.
  - restoreDefaults
```
public void restoreDefaults(java.awt.Font baseFont,
                   boolean fontStyles)
```
    Restores all colors and fonts to their default values.
    
    参数:
    baseFont - The base font to use when creating this scheme. If this is null, 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
```
public void setStyle(int type,
            Style style)
```
    Sets a style to use when rendering a token type.
    
    参数:
    type - The token type.
    style - The style for the token type.
    另请参阅:
    getStyle(int)
  - setStyles
```
public void setStyles(Style[] styles)
```
    Used by third party implementors e.g. SquirreL SQL. Most applications do not need to call this method; individual styles can be set via setStyle(int, Style).
    
    参数:
    styles - The new array of styles to use. Note that this should have length of at least TokenTypes.DEFAULT_NUM_TOKEN_TYPES.
    另请参阅:
    setStyle(int, Style), getStyles()
  - toCommaSeparatedString
```
public java.lang.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 "-,".
    - 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 or not the font should be underlined, and is either t or f.
      style is the family,style,size triplet described above.
    返回:
    A string representing the rgb values of the colors.
    另请参阅:
    loadFromString(String)

类 SyntaxScheme

字段概要

从接口继承的字段 com.fr.design.gui.syntax.ui.rsyntaxtextarea.TokenTypes

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SyntaxScheme

SyntaxScheme

SyntaxScheme

方法详细资料

clone

equals

getStyle

getStyleCount

getStyles

hashCode

load

loadFromString

loadFromString

restoreDefaults

restoreDefaults

setStyle

setStyles

toCommaSeparatedString