JavaTM 2 Platform
Standard Ed. 5.0

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

既知の実装クラスの一覧:
BasicTextUI.BasicHighlighter, DefaultHighlighter, 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

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

パラメータ:
c - JTextComponent エディタ

deinstall

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

パラメータ:
c - JTextComponent エディタ

paint

void paint(Graphics g)
ハイライトを描画します。

パラメータ:
g - グラフィックスコンテキスト

addHighlight

Object addHighlight(int p0,
                    int p1,
                    Highlighter.HighlightPainter p)
                    throws BadLocationException
ビューにハイライトを追加します。ハイライトの参照に使用できるタグを返します。

パラメータ:
p0 - 範囲の始点 >= 0
p1 - 範囲の終点 >= p0
p - 実際のハイライトに使うペインタ
戻り値:
ハイライトを参照するオブジェクト
例外:
BadLocationException - 範囲指定が無効な場合

removeHighlight

void removeHighlight(Object tag)
ビューからハイライトを削除します。

パラメータ:
tag - 削除対象のハイライト

removeAllHighlights

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


changeHighlight

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

パラメータ:
tag - 変更対象のハイライト
p0 - 範囲の始点 >= 0
p1 - 範囲の終点 >= p0
例外:
BadLocationException - 範囲指定が無効な場合

getHighlights

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

戻り値:
ハイライトリスト

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。