---
category: swing
folder: SimpleSyntaxHighlight
title: JTextPaneでキーワードのSyntaxHighlight
tags: [JTextPane, StyledDocument, Element, Highlight]
author: aterai
pubdate: 2009-09-21T02:07:00+09:00
description: JTextPaneでキーワードのSyntax Highlightを行います。
image: https://lh5.googleusercontent.com/_9Z4BYR88imo/TQTTAw3RBeI/AAAAAAAAAjs/LtUs6l9UpZo/s800/SimpleSyntaxHighlight.png
---
* 概要 [#summary]
`JTextPane`でキーワードの`Syntax Highlight`を行います。このサンプルは、[https://community.oracle.com/thread/2105230 Fast styled JTextPane editor | Oracle Community]などのサンプルコードからキーワードのハイライト部分を参考にして作成しています。

#download(https://lh5.googleusercontent.com/_9Z4BYR88imo/TQTTAw3RBeI/AAAAAAAAAjs/LtUs6l9UpZo/s800/SimpleSyntaxHighlight.png)

* サンプルコード [#sourcecode]
#code(link){{
//This code is taken from: SyntaxDocument.java, MultiSyntaxDocument.java
// This code is taken from: SyntaxDocument.java, MultiSyntaxDocument.java
// Fast styled JTextPane editor | Oracle Community
// @author camickr
// @author David Underhill
// https://community.oracle.com/thread/2105230
// modified by aterai aterai@outlook.com
class SimpleSyntaxDocument extends DefaultStyledDocument {
  //HashMap<String, AttributeSet> keywords = new HashMap<>();
  private final Style normal;
  private static final String OPERANDS = ".,";
  public SimpleSyntaxDocument() {
    super();
    Style def = StyleContext.getDefaultStyleContext().getStyle(
        StyleContext.DEFAULT_STYLE);
    normal = addStyle("normal", def);
    StyleConstants.setForeground(normal, Color.BLACK);
    StyleConstants.setForeground(addStyle("red",   normal), Color.RED);
    StyleConstants.setForeground(addStyle("green", normal), Color.GREEN);
    StyleConstants.setForeground(addStyle("blue",  normal), Color.BLUE);
  }
  @Override public void insertString(int offset, String str, AttributeSet a)
        throws BadLocationException {
    super.insertString(offset, str, a);
    processChangedLines(offset, str.length());
  }
  @Override public void remove(int offset, int length)
        throws BadLocationException {
    super.remove(offset, length);
    processChangedLines(offset, 0);
  }
  private void processChangedLines(int offset, int length)
        throws BadLocationException {
    Element root = getDefaultRootElement();
    int startLine = root.getElementIndex(offset);
    int endLine = root.getElementIndex(offset + length);
    for (int line = startLine; line <= endLine; line++) {
      applyHighlighting(line);
    }
  }
  private void applyHighlighting(int line) throws BadLocationException {
    Element root = getDefaultRootElement();
    int startOffset   = root.getElement(line).getStartOffset();
    int endOffset     = root.getElement(line).getEndOffset() - 1;
    int lineLength    = endOffset - startOffset;
    int contentLength = getLength();
    if (endOffset >= contentLength) {
      endOffset = contentLength - 1;
    }
    setCharacterAttributes(startOffset, lineLength, normal, true);
    checkForTokens(startOffset, endOffset);
  }
  private void checkForTokens(int startOffset, int endOffset)
        throws BadLocationException {
    int index = startOffset;
    while (index <= endOffset) {
      while (isDelimiter(getText(index, 1))) {
        if (index < endOffset) {
          index++;
        } else {
          return;
        }
      }
      index = getOtherToken(index, endOffset);
    }
  }
  private int getOtherToken(int startOffset, int endOffset)
        throws BadLocationException {
    int endOfToken = startOffset + 1;
    while (endOfToken <= endOffset) {
      if (isDelimiter(getText(endOfToken, 1))) {
        break;
      }
      endOfToken++;
    }
    String token = getText(startOffset, endOfToken - startOffset);
    Style s = getStyle(token);
    if (s != null) {
      setCharacterAttributes(startOffset, endOfToken - startOffset, s, false);
    }
    return endOfToken + 1;
  }
  protected boolean isDelimiter(String character) {
    return Character.isWhitespace(
        character.charAt(0)) || OPERANDS.indexOf(character) != -1;
  }
}
}}

* 解説 [#explanation]
上記のサンプルでは、`red`, `green`, `blue`といったキーワードを入力すると、その色で文字列をハイライトするようになっています。区切り文字は、空白、`.`(ドット)、`,`(カンマ)の`3`つです。

`Java`のシンタックスハイライトを行うサンプルコード(参考リンクの`SyntaxDocument.java`など)からキーワードのハイライト部分を抜き出して作成しています。

* 参考リンク [#reference]
- [https://community.oracle.com/thread/2105230 Fast styled JTextPane editor | Oracle Community]
-- %%オリジナルの作者、ライセンス、参照元のページが何処かなどが不明…%%
-- [http://www.programcreek.com/java-api-examples/index.php?example_code_path=weka-weka.gui.scripting-SyntaxDocument.java Java Code Example for]によると、元は[https://community.oracle.com/thread/2105230 Fast styled JTextPane editor | Oracle Community]の投稿で、作者は camickr さん、David Underhill さん。そう言われるとなんとなくそんな記憶があるような…、あのフォーラムはもういろいろ変更されすぎていてどうにも…
- [http://web.archive.org/web/20120802021725/http://java.sun.com/products/jfc/tsc/articles/text/editor_kit/index.html Customizing a Text Editor]
- [http://ostermiller.org/syntax/editor.html Text Editor Tutorial]

* コメント [#comment]
#comment
#comment