Examples of SyntaxEditor

• org.jamesii.gui.syntaxeditor.SyntaxEditor
  Provides an editor that supports:
  

  • syntax highlighting with the following attributes
    • color
    • background color
    • font style
  • text emphasizers (e.g. to visualize problem regions)
    • underline a region using an arbitrary stroke
    • cross out a region using an arbitrary stroke
    • enclose a region by a rectangle (no multiple lines rectangle)
    • emphasizers can overlap (e.g. cross out a region and underline it at the same time)
  • line numbering (can be disabled)
  • icons for emphasizers next to line number (can be disabled)
  • annotations bar on the right, provides a fast overview on where the text has emphasizers related to the entire document and it also provides fast access to that region (can be disabled)

  It can be used with any kind of input text. The highlighting is done by providing a parser that implements the {@link ILexer} interface, that inreturn provides tokens for syntax highlighting as well as tokens for text emphasizing (called problem tokens because it was meant to be to emphasize problems but can be used for anything). For each token one can provide a custom styling, that includes custom background color, custom font style and font color as well as for the emphasizing, a stroke, a stroke color and the emphasizing type. This all is provided by an implementation of the {@link ILexerTokenStylizer} interface for both problem and syntax tokens.Additionally to the font style, colors and strokes the stylizers also provide icons and text for problem tokens that are used in annotations bar and the line numbering area. Tokens are represented using the {@link ILexerToken}interface.

  Example Usage:

   import org.jamesii.gui.syntaxeditor.SyntaxEditor; import org.jamesii.gui.syntaxeditor.highlighting.DefaultHighlighter; import org.jamesii.gui.syntaxeditor.highlighting.DefaultHighlighter.Style; import java.awt.BorderLayout; import javax.swing.JFrame; import javax.swing.SwingUtilities; public class SyntaxEditorTest { public static void main(String args[]) { SwingUtilities.invokeLater(new Runnable() { public void run() { JFrame window = new JFrame("SyntaxEditorTest"); window.setSize(640, 480); window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); window.getContentPane().setLayout(new BorderLayout()); DefaultHighlighter highlighter = new DefaultHighlighter( Style.JAVA); SyntaxEditor editor = new SyntaxEditor( highlighter.getLexer(), highlighter.getSyntaxStylizer()); window.getContentPane().add(editor, BorderLayout.CENTER); editor.setShowLineNumbers(true); editor.setShowIcons(true); editor.setShowAnnotations(true); editor .setText("import org.jamesii.gui.syntaxeditor.SyntaxEditor;\r\n" + "import org.jamesii.gui.syntaxeditor.highlighting.DefaultHighlighter;\r\n" + "import org.jamesii.gui.syntaxeditor.highlighting.DefaultHighlighter.Style;\r\n" + "\r\n" + "import java.awt.BorderLayout;\r\n" + "\r\n" + "import javax.swing.JFrame;\r\n" + "import javax.swing.SwingUtilities;\r\n" + "\r\n" + "public class SyntaxEditorTest {\r\n" + "\r\n" + "  public static void main(String args[]) {\r\n" + "    SwingUtilities.invokeLater(new Runnable() {\r\n" + "\r\n" + "      @Override\r\n" + "      public void run() {\r\n" + "        JFrame window = new JFrame(\"SyntaxEditorTest\");\r\n" + "        window.setSize(640, 480);\r\n" + "        window.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);\r\n" + "\r\n" + "        window.getContentPane().setLayout(new BorderLayout());\r\n" + "\r\n" + "        DefaultHighlighter highlighter = new DefaultHighlighter(\r\n" + "            Style.JAVA);\r\n" + "\r\n" + "        SyntaxEditor editor = new SyntaxEditor(\r\n" + "            highlighter.getLexer(), highlighter.getSyntaxStylizer());\r\n"  + "\r\n" + "        window.getContentPane().add(editor, BorderLayout.CENTER);\r\n" + "\r\n" + "        editor.setShowLineNumbers(true);\r\n" + "        editor.setShowIcons(true);\r\n" + "        editor.setShowAnnotations(true);\r\n" + "        editor\r\n" + "            .setText(\"\");\r\n" + "\r\n" + "        window.setVisible(true);\r\n" + "      }\r\n" + "    });\r\n" + "  }\r\n" + "\r\n" + "}\r\n"); window.setVisible(true); } }); } } 

  Important here are the following classes:

  • JavaLexer - which implements {@link ILexer}
  • JavaProblemTokenStylizer - which implements {@link ILexerTokenStylizer}
  • JavaSyntaxTokenStylizer - which implements {@link ILexerTokenStylizer}
  • JavaProblemToken.Type - is an enumeration like this: public enum JavaProblemTokenType {WARNING, ERROR}
  • JavaSyntaxToken.Type - is an enumeration like this: public enum JavaSyntaxTokenType {COMMENT, STRING, NUMBER, ...}

  They provide a concrete implementation of a parser for the java language to support highlighting for that kind of text. @author Stefan Rybacki @see ILexer @see ILexerTokenStylizer @see ILexerToken

Examples of org.jamesii.gui.syntaxeditor.SyntaxEditor