com.klg.jclass.chart
Class PlotArea

java.lang.Object
  |
  +--com.klg.jclass.chart.PlotArea

All Implemented Interfaces:

Serializable

public class PlotArea

extends Object

implements Serializable

PlotArea is a utility class used inside JCChart to represent the background of the ChartArea.

See Also:

Serialized Form

Field Summary

protected com.klg.jclass.chart.DerivedInt	bottom
protected com.klg.jclass.util.ImageMapInfo	imageMapInfo The image map information for the PlotArea.
protected com.klg.jclass.chart.DerivedInt	left
protected com.klg.jclass.chart.ChartRegion	parent Connetion to the chart region on which the PlotArea appears.
protected com.klg.jclass.chart.DerivedInt	right
protected com.klg.jclass.chart.DerivedInt	top

Constructor Summary

PlotArea()

PlotArea(com.klg.jclass.chart.ChartRegion p)
Constructor that connects the PlotArea to a parent ChartRegion.

Method Summary

Color	getBackground() Gets the value of the Background property.
int	getBottom() Gets the value of the Bottom property.
boolean	getBottomIsDefault() Gets the value of the BottomIsDefault property.
Color	getForeground() Gets the value of the Foreground property.
com.klg.jclass.util.ImageMapInfo	getImageMapInfo() Retrieve the image map information for this PlotArea.
int	getLeft() Gets the value of the Left property.
boolean	getLeftIsDefault() Gets the value of the LeftIsDefault property.
com.klg.jclass.chart.ChartRegion	getParent() Gets the ChartArea that contains this Plot Area.
int	getRight() Gets the value of the Right property.
boolean	getRightIsDefault() Gets the value of the RightIsDefault property.
int	getTop() Gets the value of the Top property.
boolean	getTopIsDefault() Gets the value of the TopIsDefault property.
void	setBackground(Color c) Sets the value of the Background property.
void	setBottom(int t) Sets the value of the Bottom property.
void	setBottomIsDefault(boolean d) Sets the value of the BottomIsDefault property.
void	setForeground(Color c) Sets the value of the Foreground property.
void	setImageMapInfo(com.klg.jclass.util.ImageMapInfo imageMapInfo) Set the image map information for this PlotArea.
void	setLeft(int t) Sets the value of the Left property.
void	setLeftIsDefault(boolean d) Sets the value of the LeftIsDefault property.
void	setRight(int t) Sets the value of the Right property.
void	setRightIsDefault(boolean d) Sets the value of the RightIsDefault property.
void	setTop(int t) Sets the value of the Top property.
void	setTopIsDefault(boolean d) Sets the value of the TopIsDefault property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

left

protected com.klg.jclass.chart.DerivedInt left

top

protected com.klg.jclass.chart.DerivedInt top

bottom

protected com.klg.jclass.chart.DerivedInt bottom

right

protected com.klg.jclass.chart.DerivedInt right

imageMapInfo

protected com.klg.jclass.util.ImageMapInfo imageMapInfo

The image map information for the PlotArea.

parent

protected com.klg.jclass.chart.ChartRegion parent

Connetion to the chart region on which the PlotArea appears.

Constructor Detail

PlotArea

public PlotArea()

PlotArea

public PlotArea(com.klg.jclass.chart.ChartRegion p)

Constructor that connects the PlotArea to a parent ChartRegion.

Parameters:

p - parent chart region

Method Detail

getForeground

public Color getForeground()

Gets the value of the Foreground property. The Foreground property determines the color used to draw the axis bounding box controlled by JCChartArea.
Note: The Foreground property is inherited from the parent ChartRegion.

Returns:

color used to draw the axis bounding box

setForeground

public void setForeground(Color c)

Sets the value of the Foreground property. The Foreground property determines the color used to draw the axis bounding box controlled by JCChartArea.
Note: The Foreground property is inherited from the parent ChartRegion.

Parameters:

c - color used to draw the axis bounding box

See Also:

JCChartArea.setAxisBoundingBox(boolean)

getBackground

public Color getBackground()

Gets the value of the Background property. The Background property determines the background color used to draw inside the chart region. The Background property is derived as follows: If the property has been set by a user, that value is used. Otherwise, it is inherited from the object's parent. If the parent is null, null is returned.

Returns:

background color used to draw the chart region

setBackground

public void setBackground(Color c)

Sets the value of the Background property. The Background property determines the foreground color used to draw inside the chart region.
Note: The Background property is inherited from the parent ChartRegion. Also note that the Opaque property of the parent JCChartArea object needs to be set to true for the background color to be visible.
JCChartArea is transparent by default.

Parameters:

c - background color used to draw the chart region

setTop

public void setTop(int t)

Sets the value of the Top property. The Top property determines the location of the top of the ChartRegion.

Parameters:

t - top value in pixels

getTop

public int getTop()

Gets the value of the Top property. The Top property determines the location of the top of the ChartRegion.

Returns:

top value in pixels.

setTopIsDefault

public void setTopIsDefault(boolean d)

Sets the value of the TopIsDefault property. The TopIsDefault property determines whether the top position of the chart region is calculated by Chart (true) or taken from the Top property (false).

Parameters:

d - true if the position is to be calculated, false otherwise

getTopIsDefault

public boolean getTopIsDefault()

Gets the value of the TopIsDefault property. The TopIsDefault property determines whether the top position of the chart region is calculated by Chart (true) or taken from the Top property (false).

Returns:

true if the position is to be calculated, false otherwise

setLeft

public void setLeft(int t)

Sets the value of the Left property. The Left property determines the location of the left of the ChartRegion.

Parameters:

t - left value in pixels

getLeft

public int getLeft()

Gets the value of the Left property. The Left property determines the location of the left of the ChartRegion.

Returns:

left value in pixels

setLeftIsDefault

public void setLeftIsDefault(boolean d)

Sets the value of the LeftIsDefault property. The LeftIsDefault property determines whether the left position of the chart region is calculated by Chart (true) or taken from the Left property (false).

Parameters:

d - true if the position is to be calculated, false otherwise

getLeftIsDefault

public boolean getLeftIsDefault()

Gets the value of the LeftIsDefault property. The LeftIsDefault property determines whether the left position of the chart region is calculated by Chart (true) or taken from the Left property (false).

Returns:

true if the position is to be calculated, false otherwise

setBottom

public void setBottom(int t)

Sets the value of the Bottom property. The Bottom property determines the bottom of the ChartRegion.

Parameters:

t - bottom value in pixels

getBottom

public int getBottom()

Gets the value of the Bottom property. The Bottom property determines the location of the bottom of the ChartRegion.

Returns:

bottom value in pixels

setBottomIsDefault

public void setBottomIsDefault(boolean d)

Sets the value of the BottomIsDefault property. The BottomIsDefault property determines whether the bottom of the chart region is calculated by Chart (true) or taken from the Bottom property (false).

Parameters:

d - true if the bottom is to be calculated; false otherwise

getBottomIsDefault

public boolean getBottomIsDefault()

Gets the value of the BottomIsDefault property. The BottomIsDefault property determines whether the bottom of the chart region is calculated by Chart (true) or taken from the Bottom property (false).

Returns:

true if the bottom is to be calculated; false otherwise

setRight

public void setRight(int t)

Sets the value of the Right property. The Right property determines the right of the ChartRegion.

Parameters:

t - right value in pixels

getRight

public int getRight()

Gets the value of the Right property. The Right property determines the location of the right of the ChartRegion.

Returns:

right value in pixels

setRightIsDefault

public void setRightIsDefault(boolean d)

Sets the value of the RightIsDefault property. The RightIsDefault property determines whether the right of the chart region is calculated by Chart (true) or taken from the Right property (false).

Parameters:

d - true if the right is to be calculated; false otherwise

getRightIsDefault

public boolean getRightIsDefault()

Gets the value of the RightIsDefault property. The RightIsDefault property determines whether the right of the chart region is calculated by Chart (true) or taken from the Right property (false).

Returns:

true if the right is to be calculated; false otherwise

getParent

public com.klg.jclass.chart.ChartRegion getParent()

Gets the ChartArea that contains this Plot Area.

Returns:

the parent ChartRegion

getImageMapInfo

public com.klg.jclass.util.ImageMapInfo getImageMapInfo()

Retrieve the image map information for this PlotArea.

Returns:

The current image map information.

setImageMapInfo

public void setImageMapInfo(com.klg.jclass.util.ImageMapInfo imageMapInfo)

Set the image map information for this PlotArea.

Parameters:

imageMapInfo - The new image map information.