javax.swing

インタフェース BoundedRangeModel

既知のすべての実装クラス:

DefaultBoundedRangeModel

public interface BoundedRangeModel

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

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

外側の範囲は minimum,maximum で、内側の範囲は value,value+extent になります。内側の範囲は、外側の範囲内に収まっていなければいけません。つまり、value の値は maximum の値以下でなければならず、value+extent の値は、minimum の値以上、maximum の値は minimum 以上である必要があります。このモデルのいくつかの機能は少し異質なものです。これらは、Slider や ScrollBar のような 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

int getMinimum()

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

戻り値:

minimum プロパティーの値

関連項目:

setMinimum(int)

setMinimum

void setMinimum(int newMinimum)

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

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

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

パラメータ:

newMinimum - モデルの新しい minimum

関連項目:

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

getMaximum

int getMaximum()

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

戻り値:

maximum プロパティーの値

関連項目:

setMaximum(int), setExtent(int)

setMaximum

void setMaximum(int newMaximum)

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

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

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

パラメータ:

newMaximum - モデルの新しい maximum

関連項目:

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

getValue

int getValue()

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

戻り値:

モデルの値

関連項目:

setValue(int)

setValue

void setValue(int newValue)

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

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

それ以外の場合は、newValue が minimum よりも小さい場合、minimum に設定されます。maximum よりも大きい場合は、maximum に設定されます。value+extent よりも大きい場合は、value+extent に設定されます。

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

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

パラメータ:

newValue - モデルの新しい値

関連項目:

getValue()

setValueIsAdjusting

void setValueIsAdjusting(boolean b)

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

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

パラメータ:

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

getValueIsAdjusting

boolean getValueIsAdjusting()

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

戻り値:

valueIsAdjustingProperty

関連項目:

setValueIsAdjusting(boolean)

getExtent

int getExtent()

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

戻り値:

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

関連項目:

setExtent(int), setValue(int)

setExtent

void setExtent(int newExtent)

モデルの extent の値を設定します。newExtent は、ゼロ以上で、maximum - value 以下である必要があります。

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

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

パラメータ:

newExtent - モデルの新しい extent

関連項目:

getExtent(), setValue(int)

setRangeProperties

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

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

パラメータ:

value - 現在の値を指定する整数値

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

min - 最小値を指定する整数値

max - 最大値を指定する整数値

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

関連項目:

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

addChangeListener

void addChangeListener(ChangeListener x)

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

パラメータ:

x - 追加する ChangeListener

関連項目:

removeChangeListener(javax.swing.event.ChangeListener)

removeChangeListener

void removeChangeListener(ChangeListener x)

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

パラメータ:

x - 削除する ChangeListener

関連項目:

addChangeListener(javax.swing.event.ChangeListener)