|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.quinncurtis.chart3djava.ChartObj
com.quinncurtis.chart3djava.GraphObj
com.quinncurtis.chart3djava.Background
public class Background
The Background manages and displays the background of the graph area and the plotting area of the chart.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
Background()
The default Background constructor. |
|
Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color bgcolor)
This constructor creates a simple Background object that uses the specified chart scale, background type and color. |
|
Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color color1,
java.awt.Color color2,
double barwidth,
int dir)
This constructor creates an Background object that uses the specified chart scale, background type and gradient. |
|
Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color startcolor,
java.awt.Color stopcolor,
int dir)
This constructor creates an Background object that uses the specified chart scale, background type and gradient. |
|
Background(PhysicalCoordinates transform,
int bgtype,
java.awt.GradientPaint gradient)
This constructor creates an Background object that uses the specified chart scale, background type and gradient. |
|
Background(PhysicalCoordinates transform,
int bgtype,
java.awt.TexturePaint texture)
This constructor creates an Background object that uses the specified chart scale, background type and texture. |
|
| Method Summary | |
|---|---|
boolean |
checkIntersection(ChartPoint3D testpoint,
NearestPointData np)
Returns true if the test point intersects a background object. |
java.lang.Object |
clone()
Returns an object that is a clone of this Background object. |
void |
copy(Background source)
Copies the source chart background. |
void |
draw(java.awt.Graphics2D g2)
The draw method for this class. |
int |
errorCheck(int nerror)
Checks the current background object for common errors. |
java.awt.GradientPaint |
getBackgroundGradient()
Returns the user-defined gradient used when the USERGRADIENTMODE mode is selected. |
int |
getBackgroundMode()
Returns the background mode. |
java.awt.TexturePaint |
getBackgroundTexture()
Returns the user-defined texture used when the USERTEXTUREMODE mode is selected. |
int |
getBackgroundType()
Returns the background type. |
double |
getBarWidth()
Get the barwidth used when the ALTBARMODE mode is selected. |
ChartAttribute |
getBorderAttributes()
Get the ChartAttributes of the border. |
boolean |
getEnableBorder()
Returns true if the border property is set. |
java.awt.Color |
getFillColor()
Get the main background color. |
int |
getGradientDirection()
Returns the gradient direction used when the SIMPLEGRADIENTMODE mode is selected. |
java.awt.Color |
getGradientStartColor()
Returns the starting color of the gradient used when the SIMPLEGRADIENTMODE mode is selected. |
java.awt.Color |
getGradientStopColor()
Returns the ending color of the gradient used when the SIMPLEGRADIENTMODE mode is selected. |
boolean |
getPlotAreaWallFlags(int plane)
Get the plot area background wall flag for a specific plane. |
boolean |
getWallRemoval()
Returns true if the automatic wall removal is enabled. |
void |
initBackground(PhysicalCoordinates transform,
int bgtype,
java.awt.Color bgcolor)
This method initializes a simple Background object that uses the specified chart scale, background type and color. |
void |
setBackgroundGradient(java.awt.GradientPaint gradient)
Sets the user-defined gradient used when the USERGRADIENTMODE mode is selected. |
void |
setBackgroundTexture(java.awt.TexturePaint texture)
Sets the user-defined texture used when the USERTEXTUREMODE mode is selected. |
void |
setBackgroundType(int backgroundtype)
Sets the background type. |
void |
setBarWidth(double value)
Set the barwidth used when the ALTBARMODE mode is selected. |
void |
setBorderAttributes(ChartAttribute value)
The attributes of the border. |
void |
setEnableBorder(boolean value)
Set true to enable the border option |
void |
setFillColor(java.awt.Color value)
Set the main background color. |
void |
setGradientDirection(int gradientdir)
Sets the gradient direction used when the SIMPLEGRADIENTMODE mode is selected. |
void |
setGradientStartColor(java.awt.Color color)
Sets the starting color of a gradient used when the SIMPLEGRADIENTMODE mode is selected. |
void |
setGradientStopColor(java.awt.Color color)
Sets the ending color of a gradient used when the SIMPLEGRADIENTMODE mode is selected. |
void |
setPlotAreaWallFlags(int plane,
boolean flag)
Set the main background color. |
void |
setWallRemoval(boolean value)
Set the automatic wall removal option. |
| Methods inherited from class com.quinncurtis.chart3djava.ChartObj |
|---|
copy, getChartObjIDCntr, getChartObjType, getThisChartObjID |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Background()
public Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color bgcolor)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting
area of the chart, while specifying the GRAPH_BACKGROUND type fills the entire
graph area of the chart.bgcolor - The background fill color.
public Background(PhysicalCoordinates transform,
int bgtype,
java.awt.GradientPaint gradient)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting
area of the chart, while specifying the GRAPH_BACKGROUND type fills the entire
graph area of the chart.gradient - The user defined background gradient.
public Background(PhysicalCoordinates transform,
int bgtype,
java.awt.TexturePaint texture)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting
area of the chart, while specifying the GRAPH_BACKGROUND type fills the entire
graph area of the chart.texture - The user defined background texture.
public Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color startcolor,
java.awt.Color stopcolor,
int dir)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting
area of the chart, while specifying the GRAPH_BACKGROUND type fills the entire
graph area of the chart.startcolor - Specifies the starting color value of the gradient.stopcolor - Specifies the ending color value of the gradient.dir - Specifies the direction of the gradient.
public Background(PhysicalCoordinates transform,
int bgtype,
java.awt.Color color1,
java.awt.Color color2,
double barwidth,
int dir)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting
area of the chart, while specifying the GRAPH_BACKGROUND type fills the entire
graph area of the chart.color1 - Specifies the starting color value of the gradient.color2 - Specifies the ending color value of the gradient.barwidth - Specifies the width of a single background bar.dir - Specifies the direction of the gradient.| Method Detail |
|---|
public int errorCheck(int nerror)
errorCheck in class GraphObjnerror - Current error state
public void copy(Background source)
source - The source chart background object.public java.lang.Object clone()
clone in class GraphObj
public void initBackground(PhysicalCoordinates transform,
int bgtype,
java.awt.Color bgcolor)
transform - The scale associated with the chart background.bgtype - The chart background type. Use one of the chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND. Specifying the PLOT_BACKGROUND type fills the plotting area
of the chart, while specifying the GRAPH_BACKGROUND type fills the entire graph area of the chart.bgcolor - The background fill color.public void draw(java.awt.Graphics2D g2)
draw in class GraphObjg2 - The graphics context.public int getBackgroundType()
public int getBackgroundMode()
public java.awt.TexturePaint getBackgroundTexture()
public java.awt.GradientPaint getBackgroundGradient()
public java.awt.Color getGradientStartColor()
public java.awt.Color getGradientStopColor()
public int getGradientDirection()
public void setBackgroundType(int backgroundtype)
backgroundtype - Sets the background type. Use one of the Chart background type constants:
PLOT_BACKGROUND or GRAPH_BACKGROUND.public void setBackgroundTexture(java.awt.TexturePaint texture)
texture - References a user defined texture used when the USERTEXTUREMODE mode is selected.public void setBackgroundGradient(java.awt.GradientPaint gradient)
gradient - References a user defined gradient used when the USERGRADIENTMODE mode is selected.public void setGradientStartColor(java.awt.Color color)
color - Sets the starting color of a gradient used when the SIMPLEGRADIENTMODE mode is selected.public void setGradientStopColor(java.awt.Color color)
color - Sets the ending color of a gradient used when the SIMPLEGRADIENTMODE mode is selected.public void setGradientDirection(int gradientdir)
gradientdir - Sets the gradient direction of a gradient used when the SIMPLEGRADIENTMODE mode is selected.
public boolean checkIntersection(ChartPoint3D testpoint,
NearestPointData np)
checkIntersection in class GraphObjtestpoint - The test pointnp - Nearest point information for data based objects.
public double getBarWidth()
public void setBarWidth(double value)
value - Set the barwidth used when the ALTBARMODE mode is selected.public java.awt.Color getFillColor()
public void setFillColor(java.awt.Color value)
value - Sets the main background colorr.public boolean getEnableBorder()
public void setEnableBorder(boolean value)
value - Set true to enable the border option.public ChartAttribute getBorderAttributes()
public void setBorderAttributes(ChartAttribute value)
value - Set the attributes of the border.
public void setPlotAreaWallFlags(int plane,
boolean flag)
plane - Specifies the plane that is set.flag - True enable sthe wall flag for the specified plane.public boolean getPlotAreaWallFlags(int plane)
plane - Specify one of the plane constants: XY_MINZ_PLANE, XZ_MINY_PLANE, YZ_MINX_PLANE,
XY_MAXZ_PLANE, XZ_MAXY_PLANE, YZ_MAXX_PLANE.
public boolean getWallRemoval()
public void setWallRemoval(boolean value)
value - Set to true to enable the automatic wall removal option.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||