javax.swing.text
クラス CompositeView

java.lang.Object
  |
  +--javax.swing.text.View
        |
        +--javax.swing.text.CompositeView

直接の既知のサブクラス:

BoxView

public abstract class CompositeView

extends View

子ボックスを持つテキストモデルのビューです。行、あるいは段落のコレクションなどを表示するのに便利です。ボックスが水平方向の場合は、折り返しのない行の表示に使えます。

クラス javax.swing.text.View から継承したフィールド

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

コンストラクタの概要

CompositeView(Element elem)
指定された要素の CompositeView を構築します。

メソッドの概要

void	append(View v) 子ビューを 1 つ追加します。
protected abstract void	childAllocation(int index, Rectangle a) 指定された子への割り当てを返します。
protected boolean	flipEastAndWestAtEnds(int position, Position.Bias bias) サブクラスでは、位置に基づく条件を満たす場合に true を返すように、このメソッドをオーバーライドできます。
protected short	getBottomInset() 下のインセットを取得します。
Shape	getChildAllocation(int index, Shape a) 指定された子ビューへの割り当てを取得します。
protected Rectangle	getInsideAllocation(Shape a) ビューに指定された割り当てを、内部の構成に使用する割り当てに変換します。
protected short	getLeftInset() 左のインセットを取得します。
protected int	getNextEastWestVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) カーソルを置くことのできる、次の視覚的な位置を返します。
protected int	getNextNorthSouthVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) カーソルを置くことのできる、次の視覚的な位置を返します。
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet) キャレットを置くことのできる、次に視覚的に表示されるモデル内の位置を判断する方法を提供します。
protected short	getRightInset() 右のインセットを取得します。
protected short	getTopInset() 上のインセットを取得します。
View	getView(int n) コンテナ内の n 番目のビューを取得します。
protected abstract View	getViewAtPoint(int x, int y, Rectangle alloc) 指定された点の子ビューを取得します。
protected View	getViewAtPosition(int pos, Rectangle a) モデル内の指定された位置を示す子ビューを取得します。
int	getViewCount() このビューにあるビューの数を返します。
protected int	getViewIndexAtPosition(int pos) モデル内の指定された位置を表す、子ビューのインデックスを取得します。
void	insert(int offs, View v) 子ビューを 1 つ挿入します。
protected abstract boolean	isAfter(int x, int y, Rectangle alloc) ある点が、矩形範囲の後にあるかどうかを判定します。
protected abstract boolean	isBefore(int x, int y, Rectangle alloc) ある点が、矩形範囲の前にあるかどうかを判定します。
protected void	loadChildren(ViewFactory f) 子をすべてロードして、ビューを初期化します。
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) ドキュメントモデルの座標空間から、ビューの座標空間へのマッピングを提供します。
Shape	modelToView(int pos, Shape a, Position.Bias b) ドキュメントモデルの座標空間から、それにマップされているビューの座標空間へのマッピングを提供します。
void	removeAll() 子をすべて削除します。
void	replace(int offset, int length, View[] views) レイアウトを無効にし、要求/割り当てのキャッシュのサイズを変更して、子ビューの置き換えができるようにします。
protected void	setInsets(short top, short left, short bottom, short right) ビューのインセットを設定します。
protected void	setParagraphInsets(AttributeSet attr) 指定された属性から選ばれた段落属性から、インセットを設定します。
void	setParent(View parent) ビューの親を設定します。
int	viewToModel(float x, float y, Shape a, Position.Bias[] bias) ビューの座標空間から、モデルの論理座標空間へのマッピングを提供します。

クラス javax.swing.text.View から継承したメソッド

breakView, changedUpdate, createFragment, getAlignment, getAttributes, getBreakWeight, getContainer, getDocument, getElement, getEndOffset, getMaximumSpan, getMinimumSpan, getParent, getPreferredSpan, getResizeWeight, getStartOffset, getViewFactory, insertUpdate, isVisible, modelToView, paint, preferenceChanged, removeUpdate, setSize, viewToModel

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

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

コンストラクタの詳細

CompositeView

public CompositeView(Element elem)

指定された要素の CompositeView を構築します。

パラメータ:

elem - このビューが扱う要素

メソッドの詳細

loadChildren

protected void loadChildren(ViewFactory f)

子をすべてロードして、ビューを初期化します。これは、setParent メソッドによって呼び出されます。サブクラスは、これの実装をやり直して、子ビューを違った形に初期化することもできます。デフォルトの実装では、個々の子要素に子ビューが作成されます。

パラメータ:

f - ビューファクトリ

removeAll

public void removeAll()

子をすべて削除します。

insert

public void insert(int offs,
                   View v)

子ビューを 1 つ挿入します。

パラメータ:

offs - ビューを挿入する位置のオフセット >= 0

v - ビュー

append

public void append(View v)

子ビューを 1 つ追加します。

パラメータ:

v - ビュー

replace

public void replace(int offset,
                    int length,
                    View[] views)

レイアウトを無効にし、要求/割り当てのキャッシュのサイズを変更して、子ビューの置き換えができるようにします。

パラメータ:

offset - 子ビューの挿入位置のオフセット >= 0

length - 影響を受ける子ビューの数 >= 0

views - 置き換えに使用する子ビュー

setParent

public void setParent(View parent)

ビューの親を設定します。loadChildren メソッドの呼び出しとともにスーパークラスの動作を提供するために実装し直されます。子をコンストラクタの中にロードしないようにしてください。これは、親を設定する動作が原因となって、たとえば収容側コンテナを取得するために、子が階層をさかのぼって検索しようとするからです。

パラメータ:

parent - ビューの親。ない場合は null

オーバーライド:

クラス View 内の setParent

getViewCount

public int getViewCount()

このビューにあるビューの数を返します。

戻り値:

ビューの数 >= 0

オーバーライド:

クラス View 内の getViewCount

関連項目:

getView(int)

getView

public View getView(int n)

コンテナ内の n 番目のビューを取得します。

パラメータ:

n - 取得するビューの番号 >= 0 && < getViewCount()

戻り値:

ビュー

オーバーライド:

クラス View 内の getView

getChildAllocation

public Shape getChildAllocation(int index,
                                Shape a)

指定された子ビューへの割り当てを取得します。さまさまなビューの配置を、それらの場所を格納しているビューを仮定しなくても探せます。

パラメータ:

index - 子のインデックス >= 0 && < getViewCount()

a - ビューへの割り当て

戻り値:

子への割り当て

オーバーライド:

クラス View 内の getChildAllocation

modelToView

public Shape modelToView(int pos,
                         Shape a,
                         Position.Bias b)
                  throws BadLocationException

ドキュメントモデルの座標空間から、それにマップされているビューの座標空間へのマッピングを提供します。

パラメータ:

pos - 変換する位置 >= 0

a - 描画に割り当てられた領域

戻り値:

指定された位置のバウンディングボックス

例外:

BadLocationException - 指定された位置が、関連付けられたドキュメントの有効な位置を表さない場合

オーバーライド:

クラス View 内の modelToView

関連項目:

View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

modelToView

public Shape modelToView(int p0,
                         Position.Bias b0,
                         int p1,
                         Position.Bias b1,
                         Shape a)
                  throws BadLocationException

ドキュメントモデルの座標空間から、ビューの座標空間へのマッピングを提供します。

パラメータ:

p0 - 変換する位置 >= 0

b0 - p0 で表現される文字の直前または直後方向へのバイアス。位置が 2 つのビューの境界の場合に使用

p1 - 変換する位置 >= 0

b1 - p1 で表現される文字の直前または直後方向へのバイアス。位置が 2 つのビューの境界の場合に使用

a - 描画先として割り当てられた領域

戻り値:

指定された位置のバウンディングボックス

例外:

BadLocationException - 指定された位置が、関連付けられたドキュメント内の有効な場所を表していない場合

IllegalArgumentException - バイアスの引数が無効な場合

オーバーライド:

クラス View 内の modelToView

関連項目:

View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

viewToModel

public int viewToModel(float x,
                       float y,
                       Shape a,
                       Position.Bias[] bias)

ビューの座標空間から、モデルの論理座標空間へのマッピングを提供します。

パラメータ:

x - 変換するビュー位置の x 座標 >= 0

y - 変換するビュー位置の y 座標 >= 0

a - 描画に割り当てられた領域

戻り値:

ビューの指定された点を最適に表すモデル内の位置 >= 0

オーバーライド:

クラス View 内の viewToModel

関連項目:

View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

getNextVisualPositionFrom

public int getNextVisualPositionFrom(int pos,
                                     Position.Bias b,
                                     Shape a,
                                     int direction,
                                     Position.Bias[] biasRet)
                              throws BadLocationException

キャレットを置くことのできる、次に視覚的に表示されるモデル内の位置を判断する方法を提供します。ビューによっては、表示されなかったり、モデル内と同じ順序でなかったり、またはモデル内の位置へのアクセスが許可されないことがあります。

パラメータ:

pos - 変換する位置 >= 0

a - 描画先として割り当てられた領域

direction - キーボードにある矢印キーに対応する、現在位置からの方向。SwingConstants.WEST、SwingConstants.EAST、SwingConstants.NORTH、SwingConstants.SOUTH のどれかを指定する

戻り値:

視覚的に表示される次の位置をもっとも適切に表現するモデル内の位置

例外:

BadLocationException -

IllegalArgumentException - 方向が無効な場合

オーバーライド:

クラス View 内の getNextVisualPositionFrom

isBefore

protected abstract boolean isBefore(int x,
                                    int y,
                                    Rectangle alloc)

ある点が、矩形範囲の前にあるかどうかを判定します。

パラメータ:

x - x 座標 >= 0

y - y 座標 >= 0

alloc - 矩形

戻り値:

点が指定された範囲の前にある場合に true

isAfter

protected abstract boolean isAfter(int x,
                                   int y,
                                   Rectangle alloc)

ある点が、矩形範囲の後にあるかどうかを判定します。

パラメータ:

x - x 座標 >= 0

y - y 座標 >= 0

alloc - 矩形

戻り値:

点が指定された範囲の後にある場合に true

getViewAtPoint

protected abstract View getViewAtPoint(int x,
                                       int y,
                                       Rectangle alloc)

指定された点の子ビューを取得します。

パラメータ:

x - x 座標 >= 0

y - y 座標 >= 0

alloc - 入り口での親の割り当て。出口では、子への割り当てに変更される

戻り値:

子ビュー

childAllocation

protected abstract void childAllocation(int index,
                                        Rectangle a)

指定された子への割り当てを返します。

パラメータ:

index - 子のインデックス >= 0 && < getViewCount()

a - 入り口での、ボックスの内部への割り当て。および、出口での、割り当てられた位置を含むビューへの割り当て

getViewAtPosition

protected View getViewAtPosition(int pos,
                                 Rectangle a)

モデル内の指定された位置を示す子ビューを取得します。それぞれの子要素に子ビューがある場合に、ビューを取得するために実装されています。

パラメータ:

pos - 位置 >= 0

a - 入り口での、ボックスの内部への割り当て。および、出口での、割り当てられた位置を含むビューへの割り当て

戻り値:

指定された位置を示すビュー、ない場合は null

getViewIndexAtPosition

protected int getViewIndexAtPosition(int pos)

モデル内の指定された位置を表す、子ビューのインデックスを取得します。このメソッドは、それぞれの子要素に対して子ビューがある場合に、ビューを取得するために実装されています。

パラメータ:

pos - 位置 >= 0

戻り値:

指定された位置を表すビューのインデックス。その位置を表すインデックスがない場合は -1

getInsideAllocation

protected Rectangle getInsideAllocation(Shape a)

ビューに指定された割り当てを、内部の構成に使用する割り当てに変換します。指定されているマージンは、すべて考慮されます。

パラメータ:

a - ビューに指定された割り当て

戻り値:

マージンがすべて削除された後の、ビューの内部を示す割り当て。指定された割り当てが null であれば、戻り値も null

setParagraphInsets

protected final void setParagraphInsets(AttributeSet attr)

指定された属性から選ばれた段落属性から、インセットを設定します。

パラメータ:

attr - 属性

setInsets

protected final void setInsets(short top,
                               short left,
                               short bottom,
                               short right)

ビューのインセットを設定します。

パラメータ:

top - 上のインセット >= 0

left - 左のインセット >= 0

bottom - 下のインセット >= 0

right - 右のインセット >= 0

getLeftInset

protected final short getLeftInset()

左のインセットを取得します。

戻り値:

インセット >= 0

getRightInset

protected final short getRightInset()

右のインセットを取得します。

戻り値:

インセット >= 0

getTopInset

protected final short getTopInset()

上のインセットを取得します。

戻り値:

インセット >= 0

getBottomInset

protected final short getBottomInset()

下のインセットを取得します。

戻り値:

インセット >= 0

getNextNorthSouthVisualPositionFrom

protected int getNextNorthSouthVisualPositionFrom(int pos,
                                                  Position.Bias b,
                                                  Shape a,
                                                  int direction,
                                                  Position.Bias[] biasRet)
                                           throws BadLocationException

カーソルを置くことのできる、次の視覚的な位置を返します。方向は上 (north) または下 (south) になります。

戻り値:

渡された位置から下方向の次の位置

getNextEastWestVisualPositionFrom

protected int getNextEastWestVisualPositionFrom(int pos,
                                                Position.Bias b,
                                                Shape a,
                                                int direction,
                                                Position.Bias[] biasRet)
                                         throws BadLocationException

カーソルを置くことのできる、次の視覚的な位置を返します。方向は右 (east) または左 (west) になります。

戻り値:

渡された位置から左方向の次の位置

flipEastAndWestAtEnds

protected boolean flipEastAndWestAtEnds(int position,
                                        Position.Bias bias)

サブクラスでは、位置に基づく条件を満たす場合に true を返すように、このメソッドをオーバーライドできます。戻り値の true は、ビューが getNextVisualPositionFrom メソッドで -1 を返した場合に、右側 (east) の次のビューが現在のインデックスに対してオフセットが -1 となり、左側 (west) の次のビューがオフセット 1 になることを示します。通常の方向では、右 (east) のオフセットが 1、左 (west) のオフセットが -1 です (左から右に記述するテキストの場合)。

戻り値:

false