com.klg.jclass.swing.gauge
Interface JCRange

All Known Implementing Classes:

JCAbstractRange

public interface JCRange

The interface for range objects. Those wishing to use their own ranges should implement this interface.

Since:

Version 5.0.0

Method Summary

Color	getForeground() The foreground color of the range.
double	getInnerExtent() Specifies where the inner boundary of the range is.
double	getOuterExtent() Returns where the outer boundary of the range is.
String	getRangeName() Gets the name of this range.
com.klg.jclass.swing.gauge.JCScale	getScale() Returns the scale associated with this range.
double	getStartValue() Returns the scale value (not angle or position) at which to begin the range.
double	getStopValue() Returns the scale value (not angle or position) at which to stop the range.
void	setInnerExtent(double innerExtent) Sets where the inner boundary of the range is.
void	setOuterExtent(double outerExtent) Sets where the outer boundary of the range is.
void	setRangeName(String rangeName) Sets the range's name.
void	setStartValue(double startValue) Sets the scale value (not angle or position) at which to begin the range.
void	setStopValue(double stopValue) Sets the scale value (not angle or position) at which to stop the range.

Method Detail

getForeground

public Color getForeground()

The foreground color of the range.

Returns:

the foreground color of the range

getInnerExtent

public double getInnerExtent()

Specifies where the inner boundary of the range is. Values are ratios based on the scale's radius, width, or height (depending on the scale's type and orientation). For example, for circular scale, an inner extent of 0.8 means start drawing this range 80% of the radius' size away from the center.

Returns:

the inner extent

getOuterExtent

public double getOuterExtent()

Returns where the outer boundary of the range is. Values are ratios based on the scale's radius, width, or height (depending on the scale's type and orientation). For example, for circular scale, an outer extent of 0.8 means stop drawing this range 80% of the radius' size away from the center.

Returns:

the outer extent

getRangeName

public String getRangeName()

Gets the name of this range. This is the name which will appear in the legend. If no name is supplied, a name of the form "Range <x>" will be automatically generated.

Returns:

the range's name

getScale

public com.klg.jclass.swing.gauge.JCScale getScale()

Returns the scale associated with this range.

Returns:

the scale for the JCRange component

getStartValue

public double getStartValue()

Returns the scale value (not angle or position) at which to begin the range.

Returns:

the range's start value

getStopValue

public double getStopValue()

Returns the scale value (not angle or position) at which to stop the range.

Returns:

the range's stop value

setInnerExtent

public void setInnerExtent(double innerExtent)

Sets where the inner boundary of the range is. Values are ratios based on the scale's radius, width, or height (depending on the scale's type and orientation). For example, for horizontal linear scale, an inner extent of 0.9 means start drawing this range 90% of the scale's height away from the top of the scale.

Parameters:

innerExtent - The inner extent of the range

setOuterExtent

public void setOuterExtent(double outerExtent)

Sets where the outer boundary of the range is. Values are ratios based on the scale's radius, width, or height (depending on the scale's type and orientation). For example, for vertical linear scale, an outer extent of 0.9 means stop drawing this range 90% of the scale's width away from the left of the scale.

Parameters:

outerExtent - the outer extent of the range

setRangeName

public void setRangeName(String rangeName)

Sets the range's name. This is the name which will appear in the legend.

Parameters:

rangeName - the name to appear in the legend

setStartValue

public void setStartValue(double startValue)

Sets the scale value (not angle or position) at which to begin the range.

Parameters:

startValue - the start value for the range

setStopValue

public void setStopValue(double stopValue)

Sets the scale value (not angle or position) at which to stop the range.

Parameters:

stopValue - the stop value for the range