javax.swing
インタフェース BoundedRangeModel

既知の実装クラスの一覧:

DefaultBoundedRangeModel

public interface BoundedRangeModel

スライダや進捗バーなどのコンポーネントが使用するデータモデルを定義します。4 つの、相互に関連した整数型のプロパティ minimum、maximum、extent、および value を定義します。これらの整数は、入れ子になった 2 つの範囲を次のようにして定義します。

 minimum <= value <= value+extent <= maximum

外側の範囲は minimum,maximum で、内側の範囲は value,value+extent になります。内側の範囲は、外側の範囲内に収まっていなければなりません。すなわち、value の値は maximum の値以下でなければならず、value+extent の値は、minimum の値以上、maximum の値は minimum 以上でなければなりません。このモデルのいくつかの機能は少し異質なものですが、これらはスライダやスクロールバーのような、Swing の BoundedRangeModel のクライアントのために存在しています。

• minimum および maximum 設定メソッドは、他の 3 つのプロパティを、新しい値の引数に合わせます。たとえば、モデルの minimum を設定すると、maximum、value、および extent プロパティも (その順序で) その設定に合わせて変更され、前述した条件を維持します。
• value および extent 設定メソッドは、他の 3 つのプロパティによって定義された制限に引数を合わせます。たとえば、value == maximum の場合、setExtent(10) は extent をゼロに戻します。
• BoundedRangeModel の 4 つの値は Java Beans のプロパティとして定義されていますが、Swing の ChangeEvent は、PropertyChangeEvent よりも変更をクライアントに通知する用途によく使われます。これによって、BoundRangeModel を監視するオーバーヘッドを低く保つことができます。変更は、しばしば MouseDragged のレートの形でレポートされます。

スライダによってカスタム限界範囲モデルを指定する例は、「The Java Tutorial」の「The Anatomy of a Swing-Based Program」を参照してください。

関連項目:

DefaultBoundedRangeModel

メソッドの概要

void	addChangeListener(ChangeListener x) モデルのリスナーリストに ChangeListener を追加します。
int	getExtent() モデルの extent の値、すなわち、モデルの value から始まる、内側の範囲の長さを返します。
int	getMaximum() モデルの maximum を返します。
int	getMinimum() minimum に使用できる値を返します。
int	getValue() モデルの現在の値を返します。
boolean	getValueIsAdjusting() value プロパティへの現在の変更が、一連の変更の一部である場合に true を返します。
void	removeChangeListener(ChangeListener x) モデルのリスナーリストから ChangeListener を削除します。
void	setExtent(int newExtent) モデルの extent の値を設定します。
void	setMaximum(int newMaximum) モデルの maximum を newMaximum に設定します。
void	setMinimum(int newMinimum) モデルの minimum を newMinimum に設定します。
void	setRangeProperties(int value, int extent, int min, int max, boolean adjusting) 1 回のメソッド呼び出しで、モデルのデータをすべて設定できるメソッドです。
void	setValue(int newValue) newValue がモデルの条件式を満たす場合に、モデルの現在の値を newValue に設定します。
void	setValueIsAdjusting(boolean b) モデルの値に対する変更を単一のイベントとして扱うことを示す属性です。

メソッドの詳細

getMinimum

public int getMinimum()

minimum に使用できる値を返します。

戻り値:

minimum プロパティの値

関連項目:

setMinimum(int)

setMinimum

public void setMinimum(int newMinimum)

モデルの minimum を newMinimum に設定します。それに応じてほかの 3 つのプロパティも変更され、次の条件式を満たすようにします。

 minimum <= value <= value+extent <= maximum

モデルが変更された場合、すべてのリスナーに通知されます。

パラメータ:

newMinimum - モデルの新しい minimum

関連項目:

getMinimum(), addChangeListener(javax.swing.event.ChangeListener)

getMaximum

public int getMaximum()

モデルの maximum を返します。モデルの値の上限は (maximum - extent) である点に注意してください。

戻り値:

maximum プロパティの値

関連項目:

setMaximum(int), setExtent(int)

setMaximum

public void setMaximum(int newMaximum)

モデルの maximum を newMaximum に設定します。それに応じてほかの 3 つのプロパティも変更され、次の条件式を満たすようにします。

 minimum <= value <= value+extent <= maximum

モデルが変更された場合、すべてのリスナーに通知されます。

パラメータ:

newMaximum - モデルの新しい maximum

関連項目:

getMaximum(), addChangeListener(javax.swing.event.ChangeListener)

getValue

public int getValue()

モデルの現在の値を返します。モデルの値の上限は maximum - extent であり、下限は minimum である点に注意してください。

戻り値:

モデルの値

関連項目:

setValue(int)

setValue

public void setValue(int newValue)

newValue がモデルの条件式を満たす場合に、モデルの現在の値を newValue に設定します。条件式は次のとおりです。

 minimum <= value <= value+extent <= maximum

そのほか、newValue が minimum よりも小さい場合、モデルの現在の値は minimum に設定されます。maximum よりも大きい場合は、maximum に設定されます。value+extent よりも大きい場合は、value+extent に設定されます。

BoundedRange モデルがスクロールバーに使用されているとき、この値はスクロールバーのノブ (「つまみ」あるいは「スライダ」とも呼ばれる) の原点を指定します。通常この値は、スクロールされるオブジェクトの可視部分の原点を示します。

モデルが変更された場合、すべてのリスナーに通知されます。

パラメータ:

newValue - モデルの新しい値

関連項目:

getValue()

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

モデルの値に対する変更を単一のイベントとして扱うことを示す属性です。値に一連の変更が加えられる前に、この値を true に設定します。変更が終了したら、値を false に設定します。通常の使い方では、値の最終的な変更が確定された場合にのみ、リスナーがアクションを実行するようにします。これで、変更中の過渡的な値に対応する更新が不要になります。

スライダとスクロールバーは、ドラッグ中にこのプロパティを使用します。

パラメータ:

b - value プロパティへの変更を、一連の変更の一部とする場合は true

getValueIsAdjusting

public boolean getValueIsAdjusting()

value プロパティへの現在の変更が、一連の変更の一部である場合に true を返します。

戻り値:

valueIsAdjustingProperty

関連項目:

setValueIsAdjusting(boolean)

getExtent

public int getExtent()

モデルの extent の値、すなわち、モデルの value から始まる、内側の範囲の長さを返します。

戻り値:

モデルの extent プロパティの値

関連項目:

setExtent(int), setValue(int)

setExtent

public void setExtent(int newExtent)

モデルの extent の値を設定します。newExtent は、ゼロ以上で、maximum - value の値以下でなければなりません。

BoundedRange モデルがスクロールバーに使用されているとき、extent はスクロールバーのノブ (「つまみ」または「スライダ」とも呼ばれる) の長さを定義します。通常、extent は、スクロールされるオブジェクトのうちの可視になる部分の量を示します。スライダに使用する場合、extent はその値だけ「ジャンプ」する量を示します。たとえば、PgUp や PgDn キーを押した場合のスクロール量です。

モデルが変更された場合、すべてのリスナーに通知されます。

パラメータ:

newExtent - モデルの新しい extent

関連項目:

getExtent(), setValue(int)

setRangeProperties

public void setRangeProperties(int value,
                               int extent,
                               int min,
                               int max,
                               boolean adjusting)

1 回のメソッド呼び出しで、モデルのデータをすべて設定できるメソッドです。結果として、単一の変更イベントが生成されます。モデルのデータをすべて同時に調整しながら、個々の変更イベントが発生するのを避けるのに便利です。

パラメータ:

value - 現在の値を指定する int 値

extent - 値が「ジャンプ」できる量を指定する int 値

min - 最小値を指定する int 値

max - 最大値を指定する int 値

isAdjusting - boolean 値。一連の変更が進行中である場合は true

関連項目:

setValue(int), setExtent(int), setMinimum(int), setMaximum(int), setValueIsAdjusting(boolean)

addChangeListener

public void addChangeListener(ChangeListener x)

モデルのリスナーリストに ChangeListener を追加します。

パラメータ:

x - 追加する ChangeListener

関連項目:

removeChangeListener(javax.swing.event.ChangeListener)

removeChangeListener

public void removeChangeListener(ChangeListener x)

モデルのリスナーリストから ChangeListener を削除します。

パラメータ:

x - 削除する ChangeListener

関連項目:

addChangeListener(javax.swing.event.ChangeListener)