com.fr.design.gui.syntax.ui.rsyntaxtextarea

类 Theme

java.lang.Object

com.fr.design.gui.syntax.ui.rsyntaxtextarea.Theme

public class Theme
extends java.lang.Object

A theme is a set of fonts and colors to use to style RSyntaxTextArea. Themes are defined in XML files that are validated against themes.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 under the /themes folder, but are not a part of the built RSyntaxTextArea jar. Hosting applications are free to ship and use these themes as-is, modify them, or create their own.

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.

版本:

1.0

作者:

Robert Futrell

构造器概要

构造器

构造器和说明
Theme(RSyntaxTextArea textArea) Creates a theme from an RSyntaxTextArea.

方法概要

方法

限定符和类型	方法和说明
void	apply(RSyntaxTextArea textArea) Applies this theme to a text area.
static Theme	load(java.io.InputStream in) Loads a theme.
static Theme	load(java.io.InputStream in, java.awt.Font baseFont) Loads a theme.
void	save(java.io.OutputStream out) Saves this theme to an output stream.

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

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

构造器详细资料

Theme

public Theme(RSyntaxTextArea textArea)

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

参数:

textArea - The text area.

方法详细资料

apply

public void apply(RSyntaxTextArea textArea)

Applies this theme to a text area.

参数:

textArea - The text area to apply this theme to.

load

public static Theme load(java.io.InputStream in)
                  throws java.io.IOException

Loads a theme.

参数:

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

返回:

The theme.

抛出:

java.io.IOException - If an IO error occurs.

另请参阅:

save(OutputStream)

load

public static Theme load(java.io.InputStream in,
         java.awt.Font baseFont)
                  throws java.io.IOException

Loads a theme.

参数:

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.

返回:

The theme.

抛出:

java.io.IOException - If an IO error occurs.

另请参阅:

save(OutputStream)

save

public void save(java.io.OutputStream out)
          throws java.io.IOException

Saves this theme to an output stream.

参数:

out - The output stream to write to.

抛出:

java.io.IOException - If an IO error occurs.

另请参阅:

load(InputStream)