org.askalon.graph.chart
Interface Chart

All Superinterfaces:
Cleanable
All Known Subinterfaces:
HierarchyChart, LinearChart, LineBarChart, MultipleSurfaceChart, OrderedChart, PieChart, RibbonChart, SectionChart, SurfaceChart, SurfacesChart, XMLEventChart, XYChart, XYXMLChart
All Known Implementing Classes:
AbstractChart

public interface Chart
extends Cleanable

This interface is implemented by every chart and provides some basic common functionality.

Author:
Georg Schild and Franz Endstrasser
See Also:
Cleanable

Method Summary
 ChartConfiguration getChartConfiguration()
           
 JMenu getChartMenu()
          Gets the menu item for this chart.
 String getChartName()
          Gets the name of this chart.
 Legend getLegend()
          Gets the legend of this chart.
 String getUnit()
          Gets the unit string displayed next to the values.
 String getXAxisText()
          Gets the text of the x-axis.
 String getYAxisText()
          Gets the text of the y-axis.
 boolean isDisableUpdate()
          Gets the state of updates (enabled/disabled) for the chart.
 boolean isEdgesVisible()
          Gets the visibility of edges.
 void refreshConfiguration()
          Refreshes the configuration of this chart, which makes changes visible.
 void resetConfiguration()
          Resets the whole configuration (fonts, colors, ...) for the chart to the default values.
 void setChartConfiguration(ChartConfiguration cc)
          Sets a new configuration for this chart.
 void setDisableUpdate(boolean disableUpdate)
          Disables updates for the chart.
 void setEdgesVisible(boolean b)
          Enables/disables the visibility of edges for this chart.
 void setUnit(String unit)
          Sets the current unit of this chart and updates it accordingly.
 void setXAxisText(String x)
          Sets the text of the x-axis for this chart.
 void setYAxisText(String y)
          Sets the text of the y-axis for this chart.
 
Methods inherited from interface org.askalon.graph.chart.base.Cleanable
cleanUp
 

Method Detail

getChartName

String getChartName()
Gets the name of this chart.

Returns:
the chart's name as string

resetConfiguration

void resetConfiguration()
Resets the whole configuration (fonts, colors, ...) for the chart to the default values.

See Also:
ChartConfiguration, refreshConfiguration(), setChartConfiguration(ChartConfiguration)

refreshConfiguration

void refreshConfiguration()
Refreshes the configuration of this chart, which makes changes visible. Is called automatically by the supported actions.

See Also:
ChartConfiguration, resetConfiguration(), setChartConfiguration(ChartConfiguration)

setChartConfiguration

void setChartConfiguration(ChartConfiguration cc)
Sets a new configuration for this chart.

Parameters:
cc - the new chart configuration
See Also:
ChartConfiguration, resetConfiguration(), refreshConfiguration()

getChartConfiguration

ChartConfiguration getChartConfiguration()
Returns:
the chart's ChartConfiguration or null if none was set
See Also:
ChartConfiguration, resetConfiguration(), refreshConfiguration()

isDisableUpdate

boolean isDisableUpdate()
Gets the state of updates (enabled/disabled) for the chart.

Returns:
true if the chart updates are enabled, false if not
See Also:
setDisableUpdate(boolean)

setDisableUpdate

void setDisableUpdate(boolean disableUpdate)
Disables updates for the chart.

Parameters:
disableUpdate - true to disable updates, false to enable updates
See Also:
isDisableUpdate()

getXAxisText

String getXAxisText()
Gets the text of the x-axis.

Returns:
the text of the x-axis of this chart as string
See Also:
setXAxisText(String)

setXAxisText

void setXAxisText(String x)
Sets the text of the x-axis for this chart.

Parameters:
x - the new axis label for the x-axis
See Also:
getXAxisText()

getYAxisText

String getYAxisText()
Gets the text of the y-axis.

Returns:
the text of the y-axis of this chart as string
See Also:
setYAxisText(String)

setYAxisText

void setYAxisText(String y)
Sets the text of the y-axis for this chart.

Parameters:
y - the new axis label for the y-axis
See Also:
getYAxisText()

getUnit

String getUnit()
Gets the unit string displayed next to the values.

Returns:
the unit used by this chart.
See Also:
setUnit(String)

setUnit

void setUnit(String unit)
Sets the current unit of this chart and updates it accordingly.

Parameters:
unit - the new unit string to use
See Also:
getUnit()

getChartMenu

JMenu getChartMenu()
Gets the menu item for this chart.

Returns:
the menu of the chart
See Also:
JMenu

getLegend

Legend getLegend()
Gets the legend of this chart.

Returns:
the legend of this chart
See Also:
Legend

setEdgesVisible

void setEdgesVisible(boolean b)
Enables/disables the visibility of edges for this chart.

Parameters:
b - true to show edges, false to hide them
See Also:
isEdgesVisible()

isEdgesVisible

boolean isEdgesVisible()
Gets the visibility of edges.

Returns:
true if edges are visible, false otherwise
See Also:
setEdgesVisible(boolean)


Part of:
Askalon_Logo
ASKALON Visualisation Diagrams