khartzToolz
Class KhartzBaseChart

java.lang.Object
  |
  +--khartzToolz.KhartzBaseChart
Direct Known Subclasses:
KhartzElectionBar, khartzToolz.KhartzPie

public class KhartzBaseChart
extends java.lang.Object

This is the base class for all chart objects


Constructor Summary
KhartzBaseChart()
           
 
Method Summary
 int getBottomMargin()
          Access method for the bottomMargin property.
 int getChartMargin()
          Access method for the chartMargin property.
 java.awt.Rectangle getChartSize()
          Access method for the chartSize property.
 java.lang.String getChartTitle()
          Access method for the chartTitle property.
 java.awt.Color[] getColorArray()
          Access method for the colorArray property.
 java.lang.String getLabel(int i)
          Returns the label at index i
 java.lang.String[] getLabels()
          Access method for the labels property.
 int getLeftMargin()
          Access method for the leftMargin property.
 double getMaxValue()
          Returns the max value for the array of values that the chart holds
 double getMinValue()
          Returns the lowest from the array of chart values.
 int getRightMargin()
          Access method for the rightMargin property.
 java.awt.Font getTextFont()
          Access method for the textFont property.
 int getTopMargin()
          Access method for the topMargin property.
 double getValue(int i)
          Returns an individual value from the array of values
 double[] getValues()
          Access method for the values property.
 java.lang.String getVersionMessage()
          Access method for the versionMessage property.
 void setBottomMargin(int aBottomMargin)
          Sets the value of the bottomMargin property.
 void setChartMargin(int aChartMargin)
          Sets the value of the chartMargin property.
 void setChartSize(java.awt.Rectangle aChartSize)
          Sets the value of the chartSize property.
 void setChartTitle(java.lang.String aChartTitle)
          Sets the value of the chartTitle property.
 void setColorArray(java.awt.Color[] aColorArray)
          Sets the value of the colorArray property.
 void setLabels(java.lang.String[] aLabels)
          Sets the value of the labels property.
 void setLeftMargin(int aLeftMargin)
          Sets the value of the leftMargin property.
 void setRightMargin(int aRightMargin)
          Sets the value of the rightMargin property.
 void setTextFont(java.awt.Font aTextFont)
          Sets the value of the textFont property.
 void setTopMargin(int aTopMargin)
          Sets the value of the topMargin property.
 void setValues(double[] aValues)
          Sets the value of the values property.
 void setVersionMessage(java.lang.String aVersionMessage)
          Sets the value of the versionMessage property.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KhartzBaseChart

public KhartzBaseChart()
Since:
30/12/2002
Method Detail

getValues

public double[] getValues()
Access method for the values property.
Returns:
the current value of the values property

setValues

public void setValues(double[] aValues)
Sets the value of the values property.
Parameters:
aValues - the new value of the values property

getLabels

public java.lang.String[] getLabels()
Access method for the labels property.
Returns:
the current value of the labels property

setLabels

public void setLabels(java.lang.String[] aLabels)
Sets the value of the labels property.
Parameters:
aLabels - the new value of the labels property

getChartTitle

public java.lang.String getChartTitle()
Access method for the chartTitle property.
Returns:
the current value of the chartTitle property

setChartTitle

public void setChartTitle(java.lang.String aChartTitle)
Sets the value of the chartTitle property.
Parameters:
aChartTitle - the new value of the chartTitle property

getChartSize

public java.awt.Rectangle getChartSize()
Access method for the chartSize property.
Returns:
the current value of the chartSize property

setChartSize

public void setChartSize(java.awt.Rectangle aChartSize)
Sets the value of the chartSize property.
Parameters:
aChartSize - the new value of the chartSize property

getTextFont

public java.awt.Font getTextFont()
Access method for the textFont property.
Returns:
the current value of the textFont property

setTextFont

public void setTextFont(java.awt.Font aTextFont)
Sets the value of the textFont property.
Parameters:
aTextFont - the new value of the textFont property

getColorArray

public java.awt.Color[] getColorArray()
Access method for the colorArray property.
Returns:
the current value of the colorArray property

setColorArray

public void setColorArray(java.awt.Color[] aColorArray)
Sets the value of the colorArray property.
Parameters:
aColorArray - the new value of the colorArray property

getChartMargin

public int getChartMargin()
Access method for the chartMargin property.
Returns:
the current value of the chartMargin property

setChartMargin

public void setChartMargin(int aChartMargin)
Sets the value of the chartMargin property.
Parameters:
aChartMargin - the new value of the chartMargin property

getLeftMargin

public int getLeftMargin()
Access method for the leftMargin property.
Returns:
the current value of the leftMargin property

setLeftMargin

public void setLeftMargin(int aLeftMargin)
Sets the value of the leftMargin property.
Parameters:
aLeftMargin - the new value of the leftMargin property

getRightMargin

public int getRightMargin()
Access method for the rightMargin property.
Returns:
the current value of the rightMargin property

setRightMargin

public void setRightMargin(int aRightMargin)
Sets the value of the rightMargin property.
Parameters:
aRightMargin - the new value of the rightMargin property

getTopMargin

public int getTopMargin()
Access method for the topMargin property.
Returns:
the current value of the topMargin property

setTopMargin

public void setTopMargin(int aTopMargin)
Sets the value of the topMargin property.
Parameters:
aTopMargin - the new value of the topMargin property

getBottomMargin

public int getBottomMargin()
Access method for the bottomMargin property.
Returns:
the current value of the bottomMargin property

setBottomMargin

public void setBottomMargin(int aBottomMargin)
Sets the value of the bottomMargin property.
Parameters:
aBottomMargin - the new value of the bottomMargin property

getVersionMessage

public java.lang.String getVersionMessage()
Access method for the versionMessage property.
Returns:
the current value of the versionMessage property

setVersionMessage

public void setVersionMessage(java.lang.String aVersionMessage)
Sets the value of the versionMessage property.
Parameters:
aVersionMessage - the new value of the versionMessage property

getValue

public double getValue(int i)
                throws java.lang.ArrayIndexOutOfBoundsException
Returns an individual value from the array of values
Parameters:
i - The index of the value to be returned
Returns:
A double - the value from the values array at the selected index
Throws:
java.lang.ArrayIndexOutOfBoundsException - The index value must be positive and less than or equal to the length of values - 1
Since:
30/12/2002

getLabel

public java.lang.String getLabel(int i)
Returns the label at index i
Parameters:
i - An integer represeting the index of the required label.
Returns:
Returns a String representing the label at index i
Since:
30/12/2002

getMaxValue

public double getMaxValue()
Returns the max value for the array of values that the chart holds
Returns:
double
Since:
30/12/2002

getMinValue

public double getMinValue()
Returns the lowest from the array of chart values.
Returns:
double
Since:
30/12/2002