org.askalon.graph.chart.viewer
Class ChartPanel

java.lang.Object
  extended by org.askalon.graph.chart.viewer.ChartPanel

public abstract class ChartPanel
extends Object

this class represents a wrapper for the GUI component supporting the actual rendering process.

Author:
Herbert Jordan

Constructor Summary
ChartPanel()
          internal constructor
 
Method Summary
abstract  void addFPSListener(org.askalon.graph.utilities.FPSListener f)
           
 void addPanelListener(ChartPanelListener listener)
          register a new chart panel listener to this component.
 boolean chartAutofit()
           
abstract  void cleanUp()
          this method is called when finishing up this object
abstract  void enableFPSCounter(boolean b)
           
 Chart getChart()
          get the chart installed in this panel
 ChartConfiguration getChartConfiguration()
           
 ViewPosition getCurrentView()
           
abstract  BufferedImage getImage()
          this method should provide a image showing the current rendering output.
 Component getPanelComponent()
          this method should provide the actual rendering panel
 JMenu getRenderOptionMenu()
          This method provides a JMenu listing all kind of rendering options supported by this ChartPanel.
 String getXAxisText()
           
 String getYAxisText()
           
 boolean isCoordinateGridVisible()
           
 boolean isDescriptionsVisible()
          check if descriptions are currently visible
 boolean isFloorVisible()
           
 boolean isKeyBehaviourEnabled()
           
 boolean isMousePanEnabled()
           
 boolean isMouseRotateEnabled()
           
 boolean isMouseZoomEnabled()
           
 boolean isRotationInverted()
           
 boolean isRotationRestricted()
           
 void refreshConfiguration()
           
abstract  void removeFPSListener(org.askalon.graph.utilities.FPSListener f)
           
 void removePanelListener(ChartPanelListener listener)
          unregister a chart listener from this component.
 void resetConfiguration()
          reset current configuration of this Chart Panel
 void setChart(Chart chart)
          exchange the chart currently rendered.
 void setChartAutofit(boolean autofit)
           
 void setCoordinateGridVisible(boolean cgVisible)
           
 void setDescriptionsVisible(boolean b)
           
 void setFloorVisible(boolean floorVisible)
           
 void setKeyBehaviourEnabled(boolean keyhandling)
           
 void setMousePanEnabled(boolean mousePan)
           
 void setMouseRotateEnabled(boolean mouseRotate)
           
 void setMouseZoomEnabled(boolean mouseZoom)
           
 void setRotationInverted(boolean invertRotation)
           
 void setRotationRestricted(boolean restrict)
           
 void setViewPosition(ViewPosition cv)
           
 void setXAxisText(String x)
           
 void setYAxisText(String y)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChartPanel

public ChartPanel()
internal constructor

Method Detail

addPanelListener

public void addPanelListener(ChartPanelListener listener)
register a new chart panel listener to this component.

Parameters:
listener - the new listener

removePanelListener

public void removePanelListener(ChartPanelListener listener)
unregister a chart listener from this component.

Parameters:
listener - the listener to remove

resetConfiguration

public void resetConfiguration()
reset current configuration of this Chart Panel


refreshConfiguration

public void refreshConfiguration()

getChart

public Chart getChart()
get the chart installed in this panel

Returns:
the current chart

getChartConfiguration

public ChartConfiguration getChartConfiguration()

isMousePanEnabled

public boolean isMousePanEnabled()

setMousePanEnabled

public void setMousePanEnabled(boolean mousePan)

isMouseZoomEnabled

public boolean isMouseZoomEnabled()

setMouseZoomEnabled

public void setMouseZoomEnabled(boolean mouseZoom)

isMouseRotateEnabled

public boolean isMouseRotateEnabled()

setMouseRotateEnabled

public void setMouseRotateEnabled(boolean mouseRotate)

isRotationInverted

public boolean isRotationInverted()

setRotationInverted

public void setRotationInverted(boolean invertRotation)

isKeyBehaviourEnabled

public boolean isKeyBehaviourEnabled()

setKeyBehaviourEnabled

public void setKeyBehaviourEnabled(boolean keyhandling)

chartAutofit

public boolean chartAutofit()

setChartAutofit

public void setChartAutofit(boolean autofit)

isRotationRestricted

public boolean isRotationRestricted()

setRotationRestricted

public void setRotationRestricted(boolean restrict)

isDescriptionsVisible

public boolean isDescriptionsVisible()
check if descriptions are currently visible

Returns:
true if descriptions are visible, false otherwise

setDescriptionsVisible

public void setDescriptionsVisible(boolean b)

isCoordinateGridVisible

public boolean isCoordinateGridVisible()

setCoordinateGridVisible

public void setCoordinateGridVisible(boolean cgVisible)

isFloorVisible

public boolean isFloorVisible()

setFloorVisible

public void setFloorVisible(boolean floorVisible)

setChart

public void setChart(Chart chart)
              throws IllegalArgumentException
exchange the chart currently rendered. This method may be overridden by any subclass.

Parameters:
chart - the new chart to render
Throws:
IllegalArgumentException - if this type of chart is not supported

cleanUp

public abstract void cleanUp()
this method is called when finishing up this object


getPanelComponent

public Component getPanelComponent()
this method should provide the actual rendering panel

Returns:
the GUI component doing the rendering job

getCurrentView

public ViewPosition getCurrentView()

setXAxisText

public void setXAxisText(String x)

setYAxisText

public void setYAxisText(String y)

getYAxisText

public String getYAxisText()

getXAxisText

public String getXAxisText()

getImage

public abstract BufferedImage getImage()
this method should provide a image showing the current rendering output.

Returns:
a Buffered image showing the output

getRenderOptionMenu

public JMenu getRenderOptionMenu()
This method provides a JMenu listing all kind of rendering options supported by this ChartPanel.

Returns:
a JMenu listing all kind of rendering options

setViewPosition

public void setViewPosition(ViewPosition cv)

addFPSListener

public abstract void addFPSListener(org.askalon.graph.utilities.FPSListener f)

removeFPSListener

public abstract void removeFPSListener(org.askalon.graph.utilities.FPSListener f)

enableFPSCounter

public abstract void enableFPSCounter(boolean b)


Part of:
Askalon_Logo
ASKALON Visualisation Diagrams