Awesome

OmniEditor

Ready-made ScalaFX IDE for custom languages

Introduction

OmniEditor is a ScalaFX library providing a ready-made, user-friendly IDE for custom programming languages as well as an independent code editor with syntax highlighting.

First of all, it supports the basic interactive activities provided by a document workspace:

New
Open
Save
Save as
Undo
Redo
Cut
Copy
Paste
Settings
Help
About

In addition to this, OmniEditor enables the execution of interpreters/compilers on the code written in the text editor, allowing the user to cancel the process via the Stop button in the user interface (for example, in case of infinite loops).

Finally, for Java/JavaFX development (without Scala), the 2.x series is still available on Hephaestus, its Gradle/Maven repository.

Core classes

OmniEditor

The OmniEditor class provides a customizable IDE application packaged as a Scala class.

To run it, just add a few lines to the start method of your JavaFX/ScalaFX application subclass:

val omniEditor = new OmniEditor(appStrategy)
omniEditor.start(primaryStage)

where appStrategy is an instance of a class implementing the AppStrategy interface defined by the library, and primaryStage is the parameter of the start method in your JavaFX/ScalaFX application.

For further information, please refer to the Scaladoc documentation.

StyledCodeEditor

Stemming from the "JavaKeywords" example provided by RichTextFX, this class is the core of OmniEditor and creates a code editor easily customizable via CSS.

In particular:

you can define a chain of regex patterns, each describing which CSS class should be applied to its matching text
a shortcut method is defined to apply a CSS class to a set of tokens (especially keywords)
it supports indented new lines, to keep each new line aligned with the previous one whenever the user presses ENTER
it supports dynamic tabs - the insertion of a given number of space characters in lieu of \t whenever the user presses TAB.

Please, refer to its Scaladoc for more details.

Requirements

OmniEditor requires:

Java 8 Update 91 or later compatible
Scala 2.11.8 or later compatible

Download

For further information about downloading or referencing OmniEditor via Gradle or Maven, please visit its page on Hephaestus, its Gradle/Maven repository.

OmniEditor in action

The very first open source application employing OmniEditor is Chronos IDE, for the Chronos programming language.

Special thanks

OmniEditor is based on RichTextFX, and was created starting from its brilliant "JavaKeywords" demo
OmniEditor also employs Helios-fx, an open source ScalaFX library of shared utilities
The UI icons are taken from the elegant Kids Icons set, by Everaldo Coelho.

RichTextFX - License information

Copyright (c) 2013-2014, Tomas Mikula All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.