モジュール java.desktop
パッケージ 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)
    UIがJTextComponentのインタフェースから削除されたときに呼び出されます。
    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)
      UIがJTextComponentのインタフェースから削除されたときに呼び出されます。 このメソッドは、追加されたリスナーの登録を解除するために使用されます。
      パラメータ:
      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()
      ハイライトの現在のリストを取得します。
      戻り値:
      ハイライト・リスト