javax.swing.text
クラス Segment

java.lang.Object
  |
  +--javax.swing.text.Segment

すべての実装インタフェース:

CharacterIterator, Cloneable

public class Segment

extends Object

implements Cloneable, CharacterIterator

テキストのフラグメントを表す文字配列のセグメントです。配列に直接アクセスできても、セグメントを変更しないでください。文字をコピーするオーバーヘッドのない、テキストのフラグメントに速くアクセスできます。事実上、保護されていない文字列です。

Segment は、テキストを文字列にコピーせずに国際化 (i18n) サポートの使用を提供するために java.text.CharacterIterator インタフェースを実装します。

フィールドの概要

char[]	array 処理対象のテキストを含む配列です。
int	count 処理対象のテキストを構成する配列要素の数です。
int	offset 目的のテキストが始まる配列へのオフセットです。

インタフェース java.text.CharacterIterator から継承したフィールド

DONE

コンストラクタの概要

Segment()
新しいセグメントを作成します。

Segment(char[] array, int offset, int count)
既存の配列を参照する新しいセグメントを作成します。

メソッドの概要

Object	clone() シャローコピーを作成します。
char	current() 現在位置 (getIndex() によって返される位置) にある文字を取得します。
char	first() 位置を getBeginIndex() に設定して、その位置にある文字を返します。
int	getBeginIndex() テキストの開始インデックスを返します。
int	getEndIndex() テキストの終了インデックスを返します。
int	getIndex() 現在のインデックスを返します。
boolean	isPartialReturn() 部分的戻り値が有効であることを表すフラグです。
char	last() 位置を getEndIndex()-1 (テキストが空の場合は getEndIndex()) に設定して、その位置にある文字を返します。
char	next() 反復子のインデックスを 1 増やし、新しいインデックスにある文字を返します。
char	previous() 反復子のインデックスを 1 減らし、新しいインデックスにある文字を返します。
char	setIndex(int position) 位置を指定されたテキストの位置に設定して、その文字を返します。
void	setPartialReturn(boolean p) 部分的戻り値が有効であることを表すフラグです。
String	toString() セグメントを文字列に変換します。

クラス java.lang.Object から継承したメソッド

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

array

public char[] array

処理対象のテキストを含む配列です。この配列は変更しないでください。効率を向上させるためだけに使用されます。

offset

public int offset

目的のテキストが始まる配列へのオフセットです。

count

public int count

処理対象のテキストを構成する配列要素の数です。

コンストラクタの詳細

Segment

public Segment()

新しいセグメントを作成します。

Segment

public Segment(char[] array,
               int offset,
               int count)

既存の配列を参照する新しいセグメントを作成します。

パラメータ:

array - 参照する配列

offset - 配列へのオフセット

count - 文字数

メソッドの詳細

setPartialReturn

public void setPartialReturn(boolean p)

部分的戻り値が有効であることを表すフラグです。フラグが true の場合、インタフェースメソッド Document.getText(position,length,Segment) の実装では、コピーを作らずに可能な限り多くのテキストが返されます。フラグのデフォルトの状態は false で、Document.getText(position,length,Segment) に常に同じ戻り動作を行わせます。これは要求によってテキストを複製する場合としない場合があります。

パラメータ:

p - 部分的戻り値が有効かどうか

導入されたバージョン:

1.4

isPartialReturn

public boolean isPartialReturn()

部分的戻り値が有効であることを表すフラグです。

戻り値:

部分的戻り値が有効かどうか

導入されたバージョン:

1.4

toString

public String toString()

セグメントを文字列に変換します。

オーバーライド:

クラス Object 内の toString

戻り値:

文字列

first

public char first()

位置を getBeginIndex() に設定して、その位置にある文字を返します。

定義:

インタフェース CharacterIterator 内の first

戻り値:

テキスト内の先頭文字。テキストが空の場合は DONE

関連項目:

getBeginIndex()

last

public char last()

位置を getEndIndex()-1 (テキストが空の場合は getEndIndex()) に設定して、その位置にある文字を返します。

定義:

インタフェース CharacterIterator 内の last

戻り値:

テキスト内の最後の文字。テキストが空の場合は DONE

関連項目:

getEndIndex()

current

public char current()

現在位置 (getIndex() によって返される位置) にある文字を取得します。

定義:

インタフェース CharacterIterator 内の current

戻り値:

現在位置にある文字。現在位置がテキストの終わりを過ぎている場合は DONE

関連項目:

getIndex()

next

public char next()

反復子のインデックスを 1 増やし、新しいインデックスにある文字を返します。結果のインデックスが getEndIndex() より大きいか、それに等しい場合、現在のインデックスが getEndIndex() にリセットされ、値 DONE が返されます。

定義:

インタフェース CharacterIterator 内の next

戻り値:

新しい位置にある文字。新しい位置がテキスト範囲の終わりを過ぎている場合は DONE

previous

public char previous()

反復子のインデックスを 1 減らし、新しいインデックスにある文字を返します。現在のインデックスが getBeginIndex() の場合、インデックスは getBeginIndex() のまま変わらず、値 DONE が返されます。

定義:

インタフェース CharacterIterator 内の previous

戻り値:

新しい位置にある文字。現在の位置が getBeginIndex() に等しい場合は DONE

setIndex

public char setIndex(int position)

位置を指定されたテキストの位置に設定して、その文字を返します。

定義:

インタフェース CharacterIterator 内の setIndex

パラメータ:

position - テスト内の位置。この値は、getBeginIndex() 〜 getEndIndex() の範囲内になければならない。無効な値を指定すると、IllegalArgumentException がスローされる

戻り値:

指定された位置にある文字。指定された位置が getEndIndex() に等しい場合は DONE

getBeginIndex

public int getBeginIndex()

テキストの開始インデックスを返します。

定義:

インタフェース CharacterIterator 内の getBeginIndex

戻り値:

テキストが始まる位置のインデックス

getEndIndex

public int getEndIndex()

テキストの終了インデックスを返します。このインデックスは、テキストの終わりの次の文字のインデックスです。

定義:

インタフェース CharacterIterator 内の getEndIndex

戻り値:

テキスト内の最後の文字の次のインデックス

getIndex

public int getIndex()

現在のインデックスを返します。

定義:

インタフェース CharacterIterator 内の getIndex

戻り値:

現在のインデックス

clone

public Object clone()

シャローコピーを作成します。

定義:

インタフェース CharacterIterator 内の clone

オーバーライド:

クラス Object 内の clone

戻り値:

コピー