https://github.com/bobbylight/RSyntaxTextArea

A syntax highlighting, code folding text editor for Java Swing applications.
https://github.com/bobbylight/RSyntaxTextArea

code-editor java-swing-applications syntax-highlighting

Last synced: 3 months ago
JSON representation

A syntax highlighting, code folding text editor for Java Swing applications.

• Host: GitHub
• URL: https://github.com/bobbylight/RSyntaxTextArea
• Owner: bobbylight
• License: bsd-3-clause
• Created: 2013-08-08T03:40:21.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T23:19:32.000Z (7 months ago)
• Last Synced: 2024-04-13T08:05:14.249Z (7 months ago)
• Topics: code-editor, java-swing-applications, syntax-highlighting
• Language: Java
• Size: 13.9 MB
• Stars: 1,052
• Watchers: 59
• Forks: 250
• Open Issues: 125
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# RSyntaxTextArea

![Java Build](https://github.com/bobbylight/RSyntaxTextArea/actions/workflows/gradle.yml/badge.svg)

![Java Build](https://github.com/bobbylight/RSyntaxTextArea/actions/workflows/codeql-analysis.yml/badge.svg)

[![codecov](https://codecov.io/gh/bobbylight/RSyntaxTextArea/branch/master/graph/badge.svg?token=Hktq3vfINy)](https://codecov.io/gh/bobbylight/RSyntaxTextArea)

RSyntaxTextArea is a customizable, syntax highlighting text component for Java Swing applications.  Out of

the box, it supports syntax highlighting for 50+ programming languages, code folding, search and replace,

and has add-on libraries for code completion and spell checking.  Syntax highlighting for additional languages

[can be added](https://github.com/bobbylight/RSyntaxTextArea/wiki) via tools such as [JFlex](http://jflex.de).

RSyntaxTextArea is available under a [BSD 3-Clause license](https://github.com/bobbylight/RSyntaxTextArea/blob/master/RSyntaxTextArea/src/main/resources/META-INF/LICENSE).

For more information, visit [http://bobbylight.github.io/RSyntaxTextArea/](http://bobbylight.github.io/RSyntaxTextArea/).

Available in the [Maven Central repository](http://search.maven.org/#search%7Cga%7C1%7Crsyntaxtextarea%20jar) (`com.fifesoft:rsyntaxtextarea:XXX`).

SNAPSHOT builds of the in-development, unreleased version are hosted on [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/fifesoft/rsyntaxtextarea/).

Please see [the wiki](https://github.com/bobbylight/RSyntaxTextArea/wiki)

for an overview of features and a deep-dive into the code!

# Building

RSyntaxTextArea uses [Gradle](http://gradle.org/) to build.  To compile, run

all unit tests, and create the jar, run:

    ./gradlew build --warning-mode all

RSTA 3.0 and newer requires Java 8 to compile and run.  If you need

Java 6 compatibility, you'll need to use a 2.6.x version.

# Demos

There are several simple demo applications in the

`RSyntaxTextAreaDemo` submodule.  To run the "main" one, which

shows off syntax highlighting and code folding for several

languages as well as several common configuration options,

run:

```bash

./gradlew RSyntaxTextAreaDemo:run

```

# Example Usage

RSyntaxTextArea is simply a subclass of JTextComponent, so it can be dropped into any Swing application with ease.

```java

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));

    }

}

```

# Sister Projects

RSyntaxTextArea provides syntax highlighting, code folding, and many other features out-of-the-box, but when building a code editor you often want to go further.  Below is a list of small add-on libraries that add more complex functionality:

* [AutoComplete](https://github.com/bobbylight/AutoComplete) - Adds code completion to RSyntaxTextArea (or any other JTextComponent).

* [RSTALanguageSupport](https://github.com/bobbylight/RSTALanguageSupport) - Code completion for RSTA for the following languages: Java, JavaScript, HTML, PHP, JSP, Perl, C, Unix Shell.  Built on both RSTA and AutoComplete.

* [SpellChecker](https://github.com/bobbylight/SpellChecker) - Adds squiggle-underline spell checking to RSyntaxTextArea.

* [RSTAUI](https://github.com/bobbylight/RSTAUI) - Common dialogs needed by text editing applications: Find, Replace, Go to Line, File Properties.

# Getting Help

* Add an issue on GitHub

* Peruse [the wiki](https://github.com/bobbylight/RSyntaxTextArea/wiki)

* Check the project's [home page](http://bobbylight.github.io/RSyntaxTextArea/)