Package org.fife.ui.rsyntaxtextarea

Class Theme

java.lang.Object

org.fife.ui.rsyntaxtextarea.Theme

public class Theme
extends Object

A theme is a set of fonts and colors to use to style RSyntaxTextArea and RTextScrollPane. Themes are defined in XML files that are validated against org/fife/ui/rsyntaxtextarea/themes/theme.dtd. This provides applications and other consumers with an easy way to style RSyntaxTextArea without having to use the API.

Sample themes are included in the source tree in the org.fife.ui.rsyntaxtextarea.themes package, and can be loaded via getClass().getResourceAsStream(...).

All fields are public to facilitate programmatic manipulation, but typically you won't need to reference any fields directly, rather using the load(), save(), and apply() methods for various tasks.

Note that to save a Theme via save(OutputStream), you must currently create a Theme from a text area wrapped in an RTextScrollPane, so that the color information for the gutter can be retrieved.

Version:

1.0

Author:

Robert Futrell

Field Summary

Fields

Modifier and Type	Field	Description
Color	activeLineRangeColor
Color	armedFoldBG
Font	baseFont
Color	bgColor
Color	caretColor
Color	currentLineHighlight
boolean	fadeCurrentLineHighlight
Color	foldBG
Color	foldIndicatorFG
Color	gutterBackgroundColor
Color	gutterBorderColor
Color	hyperlinkFG
boolean	iconRowHeaderInheritsGutterBG
Color	lineNumberColor
String	lineNumberFont
int	lineNumberFontSize
Color	marginLineColor
Color	markAllHighlightColor
boolean	markOccurrencesBorder
Color	markOccurrencesColor
boolean	matchedBracketAnimate
Color	matchedBracketBG
Color	matchedBracketFG
boolean	matchedBracketHighlightBoth
SyntaxScheme	scheme
Color[]	secondaryLanguages
Color	selectionBG
Color	selectionFG
boolean	selectionRoundedEdges
boolean	useSelctionFG

Constructor Summary

Constructors

Constructor	Description
Theme(RSyntaxTextArea textArea)	Creates a theme from an RSyntaxTextArea.

Method Summary

Modifier and Type	Method	Description
void	apply(RSyntaxTextArea textArea)	Applies this theme to a text area.
static Theme	load(InputStream in)	Loads a theme.
static Theme	load(InputStream in, Font baseFont)	Loads a theme.
void	save(OutputStream out)	Saves this theme to an output stream.

Methods inherited from class java.lang.Object

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

Field Detail

baseFont

public Font baseFont

bgColor

public Color bgColor

caretColor

public Color caretColor

useSelctionFG

public boolean useSelctionFG

selectionFG

public Color selectionFG

selectionBG

public Color selectionBG

selectionRoundedEdges

public boolean selectionRoundedEdges

currentLineHighlight

public Color currentLineHighlight

fadeCurrentLineHighlight

public boolean fadeCurrentLineHighlight

marginLineColor

public Color marginLineColor

markAllHighlightColor

public Color markAllHighlightColor

markOccurrencesColor

public Color markOccurrencesColor

markOccurrencesBorder

public boolean markOccurrencesBorder

matchedBracketFG

public Color matchedBracketFG

matchedBracketBG

public Color matchedBracketBG

matchedBracketHighlightBoth

public boolean matchedBracketHighlightBoth

matchedBracketAnimate

public boolean matchedBracketAnimate

hyperlinkFG

public Color hyperlinkFG

secondaryLanguages

public Color[] secondaryLanguages

scheme

public SyntaxScheme scheme

gutterBackgroundColor

public Color gutterBackgroundColor

gutterBorderColor

public Color gutterBorderColor

activeLineRangeColor

public Color activeLineRangeColor

iconRowHeaderInheritsGutterBG

public boolean iconRowHeaderInheritsGutterBG

lineNumberColor

public Color lineNumberColor

lineNumberFont

public String lineNumberFont

lineNumberFontSize

public int lineNumberFontSize

foldIndicatorFG

public Color foldIndicatorFG

foldBG

public Color foldBG

armedFoldBG

public Color armedFoldBG

Constructor Detail

Theme

public Theme(RSyntaxTextArea textArea)

Creates a theme from an RSyntaxTextArea. It should be contained in an RTextScrollPane to get all gutter color information.

Parameters:

textArea - The text area.

Method Detail

apply

public void apply(RSyntaxTextArea textArea)

Applies this theme to a text area.

Parameters:

textArea - The text area to apply this theme to.

load

public static Theme load(InputStream in)
                  throws IOException

Loads a theme.

Parameters:

in - The input stream to read from. This will be closed when this method returns.

Returns:

The theme.

Throws:

IOException - If an IO error occurs.

See Also:

save(OutputStream)

load

public static Theme load(InputStream in,
                         Font baseFont)
                  throws IOException

Loads a theme.

Parameters:

in - The input stream to read from. This will be closed when this method returns.

baseFont - The default font to use for any "base font" properties not specified in the theme XML. If this is null, a default monospaced font will be used.

Returns:

The theme.

Throws:

IOException - If an IO error occurs.

See Also:

save(OutputStream)

save

public void save(OutputStream out)
          throws IOException

Saves this theme to an output stream.

Parameters:

out - The output stream to write to.

Throws:

IOException - If an IO error occurs.

See Also:

load(InputStream)