com.swfm.mica.widgets
Interface MiiAdjuster

All Known Implementing Classes:

MiAdjuster

public interface MiiAdjuster

Version:

%I% %G%

Author:

Michael L. Davis

Method Summary

void	adjustValueFromVector(MiVector delta) Sets the position of the associated 'thumb' of this widget.
void	decreaseOneChunk() Decreases the value of this adjuster widget by one chunk.
void	decreaseOnePage() Decreases the value of this adjuster widget by one page.
void	decreaseOneUnit() Decreases the value of this adjuster widget by one unit.
void	decreaseToMinimum() Decreases the value of this adjuster widget to the maximum amount.
double	getCurrentValue() Gets the value of this adjuster widget.
double	getMaximumValue() Gets the maximum value of this adjuster widget.
double	getMinimumValue() Gets the minimum value of this adjuster widget.
double	getNormalizedValue() Gets the value of this adjuster widget.
void	increaseOneChunk() Increases the value of this adjuster widget by one chunk.
void	increaseOnePage() Increases the value of this adjuster widget by one page.
void	increaseOneUnit() Increases the value of this adjuster widget by one unit.
void	increaseToMaximum() Increases the value of this adjuster widget to the maximum amount.
void	moveOneChunkTowardsLocation(MiPoint point) Moves the position of the associated 'thumb' of this widget.
void	setCurrentValue(double value) Sets the value of this adjuster widget.
void	setMaximumValue(double value) Sets the maximum value of this adjuster widget.
void	setMinimumValue(double value) Sets the minimum value of this adjuster widget.
void	setNormalizedValue(double value) Sets the value of this adjuster widget.
void	setUnitIncrement(double amount) Sets the normalized amount of the unit increment for this widget.
void	setValueFromLocation(MiPoint point) Sets the position of the associated 'thumb' of this widget.

Method Detail

setMinimumValue

public void setMinimumValue(double value)

Sets the minimum value of this adjuster widget.

Parameters:

value - the minimum value

See Also:

setCurrentValue(double)

getMinimumValue

public double getMinimumValue()

Gets the minimum value of this adjuster widget.

Returns:

the minimum value

setMaximumValue

public void setMaximumValue(double value)

Sets the maximum value of this adjuster widget.

Parameters:

value - the maximum value

See Also:

setCurrentValue(double)

getMaximumValue

public double getMaximumValue()

Gets the maximum value of this adjuster widget.

Returns:

the maximum value

setCurrentValue

public void setCurrentValue(double value)

Sets the value of this adjuster widget. The value should be between the minimum and maximum values.

Parameters:

value - the current value

See Also:

setMinimumValue(double), setMaximumValue(double), getCurrentValue(), setNormalizedValue(double)

getCurrentValue

public double getCurrentValue()

Gets the value of this adjuster widget. The value is be between the minimum and maximum values.

Returns:

the current value

See Also:

setCurrentValue(double)

setNormalizedValue

public void setNormalizedValue(double value)

Sets the value of this adjuster widget. The value should be between 0.0 and 1.0 inclusive.

Parameters:

value - the normalized value

See Also:

setCurrentValue(double)

getNormalizedValue

public double getNormalizedValue()

Gets the value of this adjuster widget. The value is be between 0.0 and 1.0 inclusive.

Returns:

the normalized value

See Also:

getCurrentValue()

setUnitIncrement

public void setUnitIncrement(double amount)

Sets the normalized amount of the unit increment for this widget.

Parameters:

amount - the amount (between 0.0 and 1.0)

setValueFromLocation

public void setValueFromLocation(MiPoint point)

Sets the position of the associated 'thumb' of this widget. This is used when the user clicks on an interactive implementation of this interface.

Parameters:

point - the point at which the thumb is positioned.

moveOneChunkTowardsLocation

public void moveOneChunkTowardsLocation(MiPoint point)

Moves the position of the associated 'thumb' of this widget. This is used when the user clicks on an interactive implementation of this interface.

Parameters:

point - the point in which direction the thumb is to be positioned.

adjustValueFromVector

public void adjustValueFromVector(MiVector delta)

Sets the position of the associated 'thumb' of this widget. This is used when the user drags on an interactive implementation of this interface.

Parameters:

delta - the distance the user has moved the thumb.

increaseOneUnit

public void increaseOneUnit()

Increases the value of this adjuster widget by one unit.

See Also:

setUnitIncrement(double)

decreaseOneUnit

public void decreaseOneUnit()

Decreases the value of this adjuster widget by one unit.

See Also:

setUnitIncrement(double)

increaseOneChunk

public void increaseOneChunk()

Increases the value of this adjuster widget by one chunk.

See Also:

setUnitIncrement(double)

decreaseOneChunk

public void decreaseOneChunk()

Decreases the value of this adjuster widget by one chunk.

See Also:

setUnitIncrement(double)

increaseOnePage

public void increaseOnePage()

Increases the value of this adjuster widget by one page.

See Also:

setUnitIncrement(double)

decreaseOnePage

public void decreaseOnePage()

Decreases the value of this adjuster widget by one page.

See Also:

setUnitIncrement(double)

increaseToMaximum

public void increaseToMaximum()

Increases the value of this adjuster widget to the maximum amount.

decreaseToMinimum

public void decreaseToMinimum()

Decreases the value of this adjuster widget to the maximum amount.