Class MapCanvasAWT

Object
Observable
Canvas
PlanarCanvas
MapCanvas
MapCanvasAWT
All Implemented Interfaces:
Localized
Direct Known Subclasses:
Coverage­Canvas
public abstract class MapCanvasAWT extends MapCanvas
A canvas for maps to be rendered using Java2D from Abstract Window Toolkit. The map is rendered using Java2D in a background thread, then copied in a JavaFX image. Java2D is used for rendering the map because it may contain too many elements for a scene graph. After the map has been rendered, other JavaFX nodes can be put on top of the map, typically for controls by the user.
Since:
1.1

  • Field Details

    • imageMargin

      public final ObjectProperty<Insets> imageMargin
      Number of additional pixels to paint on each sides of the image, outside the viewing area. Computing a larger image reduces the black borders that user sees during translations or during zoom out before the new image is repainted.

    • image

      protected final ImageView image
      The node where the rendered map will be shown. Its content is prepared in a background thread by Map­Canvas­AWT​.Renderer. Subclasses should not set the image content directly.

  • Constructor Details

    • MapCanvasAWT

      public MapCanvasAWT(Locale locale)
      Creates a new canvas for JavaFX application.
      Parameters:
      locale - the locale to use for labels and some messages, or null for default.

  • Method Details

    • createRenderer

      protected abstract MapCanvasAWT.Renderer createRenderer()
      Invoked in JavaFX thread for creating a renderer to be executed in a background thread. Subclasses should copy in this method all Map­Canvas properties that the background thread will need for performing the rendering process.
      Specified by:
      create­Renderer in class Map­Canvas
      Returns:
      rendering process to be executed in background thread, or null if there is nothing to paint.

    • clear

      protected void clear()
      Clears the image and all intermediate buffer. Invoking this method may help to release memory when the map is no longer shown.

      Usage

      Overriding methods in subclasses should invoke super​.clear(). Other methods should generally not invoke this method directly, and use the following code instead: 
      runAfterRendering(this::clear);
      Overrides:
      clear in class Map­Canvas
      See Also: