インタフェースAttributedCharacterIterator

すべてのスーパー・インタフェース:
CharacterIterator, Cloneable
public interface AttributedCharacterIterator extends CharacterIterator
AttributedCharacterIteratorは、テキストとそのテキストに関連する属性情報を、どちらも反復処理できるようにします。

属性はキーと値のペアであり、キーで識別されます。 1つの文字に対して複数の属性キーを定義することはできません。

属性の値は不変です。つまり、クライアントやストレージによって変更できません。 属性の値は常に参照渡しです。複製されることはありません。

次の場合、属性についてのランは、最大テキスト範囲です。

  • 属性が範囲全体に対して未定義またはnullである、あるいは
  • 属性値が定義され、範囲全体に対してnull以外の同じ値を持つ。

属性セットについてのランは、それぞれのメンバー属性について上記の条件が成立する最大テキスト範囲です。

明示的な属性を指定せずにランを取得すると(すなわち、getRunStart()およびgetRunLimit()を呼び出すと)、同じ属性(同じ属性/値ペア・セット)を持つ連続したテキスト・セグメントは、属性がそれらのテキスト・セグメントに個別に与えられている場合、別個のランとして扱われます。

返されるインデックスは、イテレータの範囲に限定されます。

返される属性情報は、現在の文字を保持するランに限定されます。

属性キーは、AttributedCharacterIterator.Attributeおよびそのサブクラス(TextAttributeなど)のインスタンスです。

導入されたバージョン:
1.2
関連項目:

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インタフェース
    説明
    static class 
    AttributedCharacterIterator.Attribute
    テキスト属性の識別に使用する属性キーを定義します。

  • フィールドのサマリー

    インタフェースで宣言されたフィールド CharacterIterator

    DONE
    修飾子と型
    フィールド
    説明
    static final char
    DONE
    イテレータがテキストの終わりか始めに達したときに返される定数です。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Set<AttributedCharacterIterator.Attribute>
    getAllAttributeKeys()
    イテレータのテキスト範囲で定義されたすべての属性のキーを返します。
    Object
    getAttribute(AttributedCharacterIterator.Attribute attribute)
    現在の文字について指定されたattributeの値を返します。
    Map<AttributedCharacterIterator.Attribute, Object>
    getAttributes()
    現在の文字に定義された属性を持つマップを返します。
    int
    getRunLimit()
    現在の文字を保持するすべての属性について、ランの次に来る先頭文字のインデックスを返します。
    int
    getRunLimit(AttributedCharacterIterator.Attribute attribute)
    現在の文字を保持する指定されたattributeについて、ランの次に来る先頭文字のインデックスを返します。
    int
    getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
    現在の文字を保持する指定されたattributesについて、ランの次に来る先頭文字のインデックスを返します。
    int
    getRunStart()
    現在の文字を保持するすべての属性について、ランの先頭文字のインデックスを返します。
    int
    getRunStart(AttributedCharacterIterator.Attribute attribute)
    現在の文字を保持する指定されたattributeについて、ランの先頭文字のインデックスを返します。
    int
    getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
    現在の文字を保持する指定されたattributesについて、ランの先頭文字のインデックスを返します。

    インタフェースで宣言されたメソッド CharacterIterator

    clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex
    修飾子と型
    メソッド
    説明
    Object
    clone()
    イテレータのコピーを作成します。
    char
    current()
    現在位置(getIndex()によって返される位置)にある文字を取得します。
    char
    first()
    位置をgetBeginIndex()に設定して、その位置にある文字を返します。
    int
    getBeginIndex()
    テキストの開始インデックスを返します。
    int
    getEndIndex()
    テキストの終了インデックスを返します。
    int
    getIndex()
    現在のインデックスを返します。
    char
    last()
    位置をgetEndIndex()-1 (テキストが空の場合はgetEndIndex())に設定して、その位置にある文字を返します。
    char
    next()
    イテレータのインデックスを1増やし、新しいインデックスにある文字を返します。
    char
    previous()
    イテレータのインデックスを1減らし、新しいインデックスにある文字を返します。
    char
    setIndex(int position)
    位置を指定されたテキストの位置に設定して、その文字を返します。

  • メソッドの詳細

    • getRunStart

      int getRunStart()
      現在の文字を保持するすべての属性について、ランの先頭文字のインデックスを返します。

      同じ属性(同じ属性/値ペア・セット)を持つ連続したテキスト・セグメントは、属性がそれらのテキスト・セグメントに個別に与えられている場合、別個のランとして扱われます。

      戻り値:
      ランの先頭文字のインデックス

    • getRunStart

      int getRunStart(AttributedCharacterIterator.Attribute attribute)
      現在の文字を保持する指定されたattributeについて、ランの先頭文字のインデックスを返します。
      パラメータ:
      attribute - 目的の属性。
      戻り値:
      ランの先頭文字のインデックス

    • getRunStart

      int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)
      現在の文字を保持する指定されたattributesについて、ランの先頭文字のインデックスを返します。
      パラメータ:
      attributes - 目的の属性のセット。
      戻り値:
      ランの先頭文字のインデックス

    • getRunLimit

      int getRunLimit()
      現在の文字を保持するすべての属性について、ランの次に来る先頭文字のインデックスを返します。

      同じ属性(同じ属性/値ペア・セット)を持つ連続したテキスト・セグメントは、属性がそれらのテキスト・セグメントに個別に与えられている場合、別個のランとして扱われます。

      戻り値:
      ランの次に来る先頭文字のインデックス

    • getRunLimit

      int getRunLimit(AttributedCharacterIterator.Attribute attribute)
      現在の文字を保持する指定されたattributeについて、ランの次に来る先頭文字のインデックスを返します。
      パラメータ:
      attribute - 目的の属性
      戻り値:
      ランの次に来る先頭文字のインデックス

    • getRunLimit

      int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)
      現在の文字を保持する指定されたattributesについて、ランの次に来る先頭文字のインデックスを返します。
      パラメータ:
      attributes - 目的の属性のセット
      戻り値:
      ランの次に来る先頭文字のインデックス

    • getAttributes

      Map<AttributedCharacterIterator.Attribute, Object> getAttributes()
      現在の文字に定義された属性を持つマップを返します。
      戻り値:
      現在の文字に定義された属性を持つマップ

    • getAttribute

      Object getAttribute(AttributedCharacterIterator.Attribute attribute)
      現在の文字について指定されたattributeの値を返します。 attributeが定義されていない場合はnullを返します。
      パラメータ:
      attribute - 目的の属性
      戻り値:
      指定されたattributeの値、またはnull

    • getAllAttributeKeys

      Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()
      イテレータのテキスト範囲で定義されたすべての属性のキーを返します。 属性が定義されていない場合、セットは空です。
      戻り値:
      すべての属性のキー