Eclipse Draw2d
2.1

org.eclipse.draw2d
Interface RangeModel

All Known Implementing Classes:
DefaultRangeModel

public interface RangeModel

This interface represents a range of possible values as well as the current values. There is a minumum and maximum value, a current value, and the extent. One use for a RangeModel is a scrollbar. There is a minimum value (the top of the scrollbar), a maximum value (the bottom of the scrollbar), a current value (the top of the thumb), and an extent (the length of the thumb).


Field Summary
static String PROPERTY_EXTENT
          Extent property name
static String PROPERTY_MAXIMUM
          Maximum property name
static String PROPERTY_MINIMUM
          Minimum property name
static String PROPERTY_VALUE
          Value property name
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Registers listener as a PropertyChangeListener of this RangeModel.
 int getExtent()
          Returns the extent.
 int getMaximum()
          Returns the maximum value in the range.
 int getMinimum()
          Returns the minimum value in the range.
 int getValue()
          Returns the current value.
 boolean isEnabled()
          Returns true if this RangeModel is enabled.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Removes the given listener from this RangeModel's list of PropertyChangeListeners.
 void setAll(int min, int extent, int max)
          Sets min, extent, and max all at once.
 void setExtent(int extent)
          Sets the extent.
 void setMaximum(int max)
          Sets the maximum value of the range.
 void setMinimum(int min)
          Sets the minimum value of the range.
 void setValue(int value)
          Sets the current value.
 

Field Detail

PROPERTY_VALUE

public static final String PROPERTY_VALUE
Value property name

See Also:
Constant Field Values

PROPERTY_EXTENT

public static final String PROPERTY_EXTENT
Extent property name

See Also:
Constant Field Values

PROPERTY_MINIMUM

public static final String PROPERTY_MINIMUM
Minimum property name

See Also:
Constant Field Values

PROPERTY_MAXIMUM

public static final String PROPERTY_MAXIMUM
Maximum property name

See Also:
Constant Field Values
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Registers listener as a PropertyChangeListener of this RangeModel. Listeners will be notified of changes to value, extent, minimum and maximum properties.

Parameters:
listener - The listener to add

getExtent

public int getExtent()
Returns the extent.

Returns:
The extent

getMaximum

public int getMaximum()
Returns the maximum value in the range.

Returns:
The maximum value

getMinimum

public int getMinimum()
Returns the minimum value in the range.

Returns:
The minimum value

getValue

public int getValue()
Returns the current value.

Returns:
The current value

isEnabled

public boolean isEnabled()
Returns true if this RangeModel is enabled.

Returns:
true if this Rangel Model is enabled

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Removes the given listener from this RangeModel's list of PropertyChangeListeners.

Parameters:
listener - The listener to remove

setAll

public void setAll(int min,
                   int extent,
                   int max)
Sets min, extent, and max all at once.

Parameters:
min - the new mininum
extent - the new extent
max - the new maximum

setExtent

public void setExtent(int extent)
Sets the extent.

Parameters:
extent - The extent

setMaximum

public void setMaximum(int max)
Sets the maximum value of the range.

Parameters:
max - The maximum value

setMinimum

public void setMinimum(int min)
Sets the minimum value of the range.

Parameters:
min - The minimum value

setValue

public void setValue(int value)
Sets the current value.

Parameters:
value - The current value

Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.