GraphicsPlotCanvas (PlantUML 1.2022.1 API)

java.lang.Object
- jcckit.plot.PlotCanvas
- - jcckit.GraphicsPlotCanvas

All Implemented Interfaces:

PlotListener
```
public class GraphicsPlotCanvas
extends PlotCanvas
```
Class which handles plotting into a Graphics context based on the jcckit.renderer.GraphicsRenderer. This class is not a subclass of java.awt.Component. The actual AWT component presenting the plot is an innerclass. Its instance wrapped by GraphicsPlotCanvas can be obtained with #getGraphicsCanvas.
The plot is painted by using double-buffering and pre-rendered view of the coordinate system. That is, the coordinate system is drawn into an off-screen image. It will be redrawn only if the size of the embedding AWT component is changed.

Author:

Franz-Josef Elmer

Field Summary

Fields
Modifier and Type Field Description

static String BACKGROUND_KEY
Key of a configuration parameter.

static String DOUBLE_BUFFERING_KEY

static String FOREGROUND_KEY
- Fields inherited from class jcckit.plot.PlotCanvas
  HORIZONTAL_ANCHOR_KEY, PAPER_KEY, PLOT_KEY, VERTICAL_ANCHOR_KEY

Constructor Summary

Constructors
Constructor Description

GraphicsPlotCanvas(ConfigParameters config, BufferedImage img3)
Creates an instance from the specified configuration parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`calculateTransformation(Dimension size)`	Calculate the transformation form device-independent coordinates into device-dependent coordinates according to the specified canvas size.
`protected Renderer`	`createRenderer()`	Creates an appropriated `Renderer` for the specified `Graphics` context.
`void`	`paint()`	Paints the plot.
`protected void`	`prepare()`	Prepare graphics context before drawing the pre-rendered view of the coordinate system.
`void`	`setMarker(GraphicalElement marker)`	Defines a graphical marker which will be drawn on top of the plot.
`void`	`setRenderer(String className)`	Sets the renderer used to render the plot.

Methods inherited from class jcckit.plot.PlotCanvas
connect, getHorizontalAnchor, getPaper, getPlot, getVerticalAnchor, plotChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- BACKGROUND_KEY
```
public static final String BACKGROUND_KEY
```
  Key of a configuration parameter.
  
  See Also:
  
  Constant Field Values
- FOREGROUND_KEY
```
public static final String FOREGROUND_KEY
```
  See Also:
  
  Constant Field Values
- DOUBLE_BUFFERING_KEY
```
public static final String DOUBLE_BUFFERING_KEY
```
  See Also:
  
  Constant Field Values

Constructor Detail

GraphicsPlotCanvas

public GraphicsPlotCanvas(ConfigParameters config,
                          BufferedImage img3)

Creates an instance from the specified configuration parameters.

Key & Default Value	Type	Mandatory	Description
`background =` default background color of the wrapped AWT component	`Color`	no	Background color of the wrapped AWT component.
`foreground =` default foreground color of the wrapped AWT component	`Color`	no	Foreground color of the wrapped AWT component.
`doubleBuffering = true`	`boolean`	no	If `true` the plot will be painted by using double-buffering and pre-rendered view of the coordinate system.

In addition the configuration parameters of the constructor of the superclass PlotCanvas apply.

Method Detail
- paint
```
public void paint()
```
  Paints the plot. If GraphicsPlotCanvas#_doubleBuffering is set double-buffering and pre-rendered view of the coordinate system is used.
- prepare
```
protected void prepare()
```
  Prepare graphics context before drawing the pre-rendered view of the coordinate system. Does nothing but will be used in subclasses.
- calculateTransformation
```
protected void calculateTransformation(Dimension size)
```
  Calculate the transformation form device-independent coordinates into device-dependent coordinates according to the specified canvas size.
- createRenderer
```
protected Renderer createRenderer()
```
  Creates an appropriated Renderer for the specified Graphics context.
- setRenderer
```
public void setRenderer(String className)
```
  Sets the renderer used to render the plot. The default value is GraphicsRenderer.
  
  Parameters:
  
  className - Fully qualified name of the renderer class.
- setMarker
```
public void setMarker(GraphicalElement marker)
```
  Defines a graphical marker which will be drawn on top of the plot. To remove the marker call this method with argument null.
  
  Parameters:
  
  marker - Marker element. Can be null.