|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.sourceforge.chart2d.WarningRegionProperties
The properties of a warning region for GraphChart2D charts. A warning region is a rectangular region of a graph that when a graph component enters it, the graph component in that region is painted with a specific color; also the background of that region is also a specific color. Pass this to any number of GraphChart2D objects.
Field Summary | |
static java.awt.Color |
BACKGROUND_COLOR_DEFAULT
The default is Color.pink. |
static boolean |
BACKGROUND_EXISTENCE_DEFAULT
The default is true. |
static java.awt.Color |
COMPONENT_COLOR_DEFAULT
The default is Color.red. |
static float |
HIGH
Indicates the high value should be the maximum. |
static float |
HIGH_DEFAULT
The default is HIGH. |
static float |
LOW
Indicates the low value should be the minimum. |
static float |
LOW_DEFAULT
The default is LOW. |
Constructor Summary | |
WarningRegionProperties()
Creates a WarningRegionProperties object with the documented default values. |
|
WarningRegionProperties(net.sourceforge.chart2d.WarningRegionProperties warningRegionProps)
Creates a WarningRegionProperties object with property values copied from another object. |
Method Summary | |
java.awt.Color |
getBackgroundColor()
Gets the color that the graph background becomes in this region if the graph background exists. |
boolean |
getBackgroundExistence()
Gets the existence of the background irrespective of the existence of the graph's background. |
java.awt.Color |
getComponentColor()
Gets the color that any component entering this region should become. |
float |
getHigh()
Gets the high value of this warning region. |
float |
getLow()
Gets the low value of this warning region. |
void |
setBackgroundColor(java.awt.Color c)
Sets the color that the graph background becomes in this region if the graph background exists. |
void |
setBackgroundExistence(boolean existence)
Sets the existence of the background irrespective of the existence of the graph's background. |
void |
setComponentColor(java.awt.Color c)
Sets the color that any component entering this region should become. |
void |
setHigh(float h)
Sets the high value of this warning region. |
void |
setLow(float l)
Sets the low value of this warning region. |
void |
setToDefaults()
Sets all properties to their default values. |
void |
setWarningRegionProperties(net.sourceforge.chart2d.WarningRegionProperties warningRegionProps)
Sets all properties to be the values of another WarningRegionProperties object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final float HIGH
public static final float LOW
public static final float HIGH_DEFAULT
public static final float LOW_DEFAULT
public static final java.awt.Color COMPONENT_COLOR_DEFAULT
public static final boolean BACKGROUND_EXISTENCE_DEFAULT
public static final java.awt.Color BACKGROUND_COLOR_DEFAULT
Constructor Detail |
public WarningRegionProperties()
public WarningRegionProperties(net.sourceforge.chart2d.WarningRegionProperties warningRegionProps)
warningRegionProps
- The properties to copy.Method Detail |
public final void setToDefaults()
public final void setWarningRegionProperties(net.sourceforge.chart2d.WarningRegionProperties warningRegionProps)
warningRegionProps
- The properties to copy.public final void setHigh(float h)
h
- The high value of this region.public final void setLow(float l)
l
- The low value of this region.public final void setComponentColor(java.awt.Color c)
c
- The color of the components sections in the region.public final void setBackgroundExistence(boolean existence)
existence
- If true, then the background of the warning region will exist.public final void setBackgroundColor(java.awt.Color c)
c
- The color of the section of the graph background.public final float getHigh()
public final float getLow()
public final java.awt.Color getComponentColor()
public final boolean getBackgroundExistence()
public final java.awt.Color getBackgroundColor()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |