RSyntaxTextArea Documentation

repository·master·Indexed 22 days ago

https://github.com/bobbylight/rsyntaxtextarea

A customizable, syntax-highlighting text component for Java Swing applications. It supports over 50 programming languages and features code folding, search/replace, and a ParserManager for handling delayed parsing and visual error feedback. The library is available via Maven (com.fifesoft:rsyntaxtextarea) and offers add-on libraries for autocomplete, spell checking, and UI dialogs.

Tokens: 2K
Snippets: 3
Records: 16
Agent score: 78%

What's inside RSyntaxTextArea

Explore RSyntaxTextArea demo applications
master
The RSyntaxTextAreaDemo repository contains several sample applications to help you understand the capabilities of RSyntaxTextArea:
- RSyntaxTextAreaDemoApp: Demonstrates syntax highlighting, code folding, and the ability to toggle between built-in editor themes and other basic configuration options.
- FindAndReplaceDemo: Provides a basic implementation of search and replace functionality within the editor.
- SyntaxSchemeDemo: Demonstrates how to customize the editor's appearance by modifying fonts and colors.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextAreaDemo/README.md
Explore RSyntaxTextArea add-on libraries
master
For advanced editor features, you can use these specialized add-on libraries:
- AutoComplete: Adds code completion to RSyntaxTextArea or any JTextComponent.
- RSTALanguageSupport: Provides code completion specifically for Java, JavaScript, HTML, PHP, JSP, Perl, C, and Unix Shell.
- SpellChecker: Adds squiggle-underline spell checking.
- RSTAUI: Provides common text editor dialogs like Find, Replace, Go to Line, and File Properties.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/README.md
Install RSyntaxTextArea via Maven
master
RSyntaxTextArea is available in the Maven Central repository. You can include it in your project using the following coordinates:
com.fifesoft:rsyntaxtextarea:XXX (replace XXX with the desired version).
SNAPSHOT builds for unreleased versions are available on Sonatype.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/README.md
Use RSTAUI for built-in Find and Replace dialogs
master
If you require ready-to-use Find and Replace dialogs that integrate seamlessly with RSyntaxTextArea, use the RSTAUI sister project instead of implementing the basic logic shown in FindAndReplaceDemo.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextAreaDemo/README.md
Build RSyntaxTextArea from source
master
RSyntaxTextArea uses Gradle for its build process. To compile the project, run all unit tests, and generate the JAR file, use the following command from the root directory:
```
./gradlew build --warning-mode all
```
https://github.com/bobbylight/rsyntaxtextarea/blob/master/README.md
Manage syntax parsers with ParserManager
master
The ParserManager class is responsible for managing one or more Parser objects for an RSyntaxTextArea. It handles the lifecycle of parsing, including scheduling parsing tasks after a delay following document modifications to avoid excessive CPU usage. It also manages the visual representation of parsing results, such as error underlines (squiggles) and tooltips.
Key behaviors:
- Delayed Parsing: By default, parsing is triggered after a delay (defaulting to 1250ms) following the last document edit.
- Visual Feedback: It automatically adds highlights to the editor for ParserNotice objects returned by parsers.
- Tooltips: It enables tooltips to display error descriptions or other information when a user hovers over a highlighted error area.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextArea/src/main/java/org/fife/ui/rsyntaxtextarea/ParserManager.java
Use StyledTextTransferable for clipboard and DnD operations
master
StyledTextTransferable is a class used during copy/paste and Drag-and-Drop (DnD) operations to represent styled text. It extends the functionality of java.awt.datatransfer.StringSelection by allowing the transferred data to be retrieved in multiple formats: HTML, RTF, or plain text.
When implementing custom clipboard or DnD logic, you can use this object to ensure that styled text is available to other applications in formats they can understand. It supports the following DataFlavor types:
- DataFlavor.fragmentHtmlFlavor (HTML format)
- new DataFlavor("text/rtf", "RTF") (RTF format, returned as a ByteArrayInputStream)
- DataFlavor.stringFlavor (Plain text format)
Note: This class is package-private within org.fife.ui.rsyntaxtextarea and is intended to be used by the library's internal components for handling text transfers.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextArea/src/main/java/org/fife/ui/rsyntaxtextarea/StyledTextTransferable.java
Run RSyntaxTextArea demos
master
To see the syntax highlighting, code folding, and configuration options in action, you can run the main demo application located in the RSyntaxTextAreaDemo submodule using Gradle:
```
./gradlew RSyntaxTextAreaDemo:run
```
https://github.com/bobbylight/rsyntaxtextarea/blob/master/README.md

Use RSyntaxTextArea in a Swing application

master

RSyntaxTextArea is a subclass of JTextComponent, making it easy to integrate into any Java Swing application. To use it, instantiate RSyntaxTextArea, set its syntax style using SyntaxConstants, and wrap it in an RTextScrollPane to provide scrollbars.

Key steps:

Instantiate RSyntaxTextArea(rows, columns).
Call setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_...) to enable specific language highlighting.
Call setCodeFoldingEnabled(true) if code folding is desired.
Wrap the component in an RTextScrollPane for proper scrolling behavior.

import javax.swing.*;
import java.awt.BorderLayout;

import org.fife.ui.rtextarea.*;
import org.fife.ui.rsyntaxtextarea.*;

public class TextEditorDemo extends JFrame {

    public TextEditorDemo() {

        JPanel cp = new JPanel(new BorderLayout());

        RSyntaxTextArea textArea = new RSyntaxTextArea(20, 60);
        textArea.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_JAVA);
        textArea.setCodeFoldingEnabled(true);
        RTextScrollPane sp = new RTextScrollPane(textArea);
        cp.add(sp);

        setContentPane(cp);
        setTitle("Text Editor Demo");
        setDefaultCloseOperation(EXIT_ON_CLOSE);
        pack();
        setLocationRelativeTo(null);

    }

    public static void main(String[] args) {
        // Start all Swing applications on the EDT.
        SwingUtilities.invokeLater(() -> new TextEditorDemo().setVisible(true));
    }

}

Check Java version compatibility for RSyntaxTextArea
master
RSyntaxTextArea version requirements vary by release. Ensure your runtime environment (JRE) and build environment (JDK) meet the following requirements:
RSTA Version Required to build (JDK) Required to run (JRE)
4.x 25 11
3.x 17 8
2.6.x 6 6
https://github.com/bobbylight/rsyntaxtextarea/blob/master/README.md
Configure the parsing delay in ParserManager
master
You can control the amount of time the system waits after the last keystroke before triggering a re-parse using setDelay(int millis). This is useful for balancing responsiveness with performance. The value must be greater than 0.
Use getDelay() to retrieve the current delay in milliseconds.
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextArea/src/main/java/org/fife/ui/rsyntaxtextarea/ParserManager.java
Clear all parsers and highlights
master
To remove all registered parsers and clear all associated visual highlights (like error squiggles) from the text area, use clearParsers().
https://github.com/bobbylight/rsyntaxtextarea/blob/master/RSyntaxTextArea/src/main/java/org/fife/ui/rsyntaxtextarea/ParserManager.java

RSTA Version	Required to build (JDK)	Required to run (JRE)
4.x	25	11
3.x	17	8
2.6.x	6	6