JavaTM 2 Platform
Std. Ed. v1.3

javax.swing.text
インタフェース Highlighter

既知の実装クラスの一覧:
LayeredHighlighter

public interface Highlighter

バックグラウンドを色付き領域でマークアップできるようにするオブジェクトのインタフェースです。


内部クラスの概要
static interface Highlighter.Highlight
           
static interface Highlighter.HighlightPainter
          ハイライトを描画します。
 
メソッドの概要
 Object addHighlight(int p0, int p1, Highlighter.HighlightPainter p)
          ビューにハイライトを追加します。
 void changeHighlight(Object tag, int p0, int p1)
          指定されたハイライトを、ドキュメントの異なる部分を占めるように変更します。
 void deinstall(JTextComponent c)
          JTextComponent のインタフェースから UI を削除している時に呼び出されます。
 Highlighter.Highlight[] getHighlights()
          ハイライトの現在のリストを取り出します。
 void install(JTextComponent c)
          JTextComponent のインタフェースに UI をインストールしている時に呼び出されます。
 void paint(Graphics g)
          ハイライトを描画します。
 void removeAllHighlights()
          このハイライタが関係するすべてのハイライトを削除します。
 void removeHighlight(Object tag)
          ビューからハイライトを削除します。
 

メソッドの詳細

install

public void install(JTextComponent c)
JTextComponent のインタフェースに UI をインストールしている時に呼び出されます。このメソッドを使うと、このインタフェースの実装によってナビゲートされているモデルにアクセスできます。
パラメータ:
c - JTextComponent エディタ

deinstall

public void deinstall(JTextComponent c)
JTextComponent のインタフェースから UI を削除している時に呼び出されます。このメソッドを使うと、接続されていたリスナーの登録をすべて解除できます。
パラメータ:
c - JTextComponent エディタ

paint

public void paint(Graphics g)
ハイライトを描画します。
パラメータ:
g - グラフィックスコンテキスト

addHighlight

public Object addHighlight(int p0,
                           int p1,
                           Highlighter.HighlightPainter p)
                    throws BadLocationException
ビューにハイライトを追加します。ハイライトの参照に使用できるタグを返します。
パラメータ:
p0 - 範囲の始点 >= 0
p1 - 範囲の終点 >= p0
p - 実際のハイライトに使うペインタ
戻り値:
ハイライトを参照するオブジェクト
例外:
BadLocationException - 範囲指定が無効な場合

removeHighlight

public void removeHighlight(Object tag)
ビューからハイライトを削除します。
パラメータ:
tag - 削除対象のハイライト

removeAllHighlights

public void removeAllHighlights()
このハイライタが関係するすべてのハイライトを削除します。

changeHighlight

public void changeHighlight(Object tag,
                            int p0,
                            int p1)
                     throws BadLocationException
指定されたハイライトを、ドキュメントの異なる部分を占めるように変更します。このメソッドは、変更対象だけを扱って選択範囲を拡大縮小しているとき (マウスのドラッグ操作など) に行う削除や追加よりも効率的です。
パラメータ:
tag - 変更対象のハイライト
p0 - 範囲の始点 >= 0
p1 - 範囲の終点 >= p0
例外:
BadLocationException - 範囲指定が無効な場合

getHighlights

public Highlighter.Highlight[] getHighlights()
ハイライトの現在のリストを取り出します。
戻り値:
ハイライトリスト

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.