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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Map­Canvas­AWT.Renderer	A snapshot of Map­Canvas­AWT state to paint as an image.

Nested classes/interfaces inherited from class MapCanvas

Map­Canvas.Static­Graphics

Modifier and Type	Class	Description
static class	Map­Canvas.Static­Graphics	JavaFX nodes rendered using a snapshot of the objective to display transform.

Property Summary

Properties inherited from class MapCanvas

error, positional­Accuracy, rendering

Type	Property	Description
final Read­Only­Object­Property<Throwable>	error	Returns a property giving the exception or error that occurred during last rendering operation.
final Read­Only­Object­Property<Length>	positional­Accuracy	Returns a property which gives an estimation of positional accuracy, typically in metres.
final Read­Only­Boolean­Property	rendering	Returns a property telling whether a rendering is in progress.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Image­View	image	The node where the rendered map will be shown.
final Object­Property<Insets>	image­Margin	Number of additional pixels to paint on each sides of the image, outside the viewing area.

Fields inherited from class MapCanvas

fixed­Pane, floating­Pane

Modifier and Type	Field	Description
protected final Stack­Pane	fixed­Pane	The pane showing the map and other JavaFX nodes to keep at fixed position regardless pans, zooms or rotations applied on the map.
protected final Pane	floating­Pane	The pane showing the map and any other JavaFX nodes to scale and translate together with the map.

Fields inherited from class PlanarCanvas

BIDIMENSIONAL, objective­To­Display

Modifier and Type	Field	Description
protected static final int	BIDIMENSIONAL	The 2 constant for identifying code specific to bi-dimensional case.
protected final Affine­Transform	objective­To­Display	The conversion from objective CRS to the display coordinate system as a Java2D affine transform.

Fields inherited from class Canvas

DISPLAY_BOUNDS_PROPERTY, OBJECTIVE_CRS_PROPERTY, OBJECTIVE_TO_DISPLAY_PROPERTY, POINT_OF_INTEREST_PROPERTY

Modifier and Type	Field	Description
static final String	DISPLAY_BOUNDS_PROPERTY	The "displayBounds" property name, used for notifications about changes in bounds of display device.
static final String	OBJECTIVE_CRS_PROPERTY	The "objectiveCRS" property name, used for notifications about changes in objective CRS.
static final String	OBJECTIVE_TO_DISPLAY_PROPERTY	The "objectiveToDisplay" property name, used for notifications about changes in objective to display conversion.
static final String	POINT_OF_INTEREST_PROPERTY	The "pointOfInterest" property name, used for notifications about changes in point of interest.

Constructor Summary

Constructors

Constructor	Description
Map­Canvas­AWT(Locale locale)	Creates a new canvas for JavaFX application.

Method Summary

Modifier and Type	Method	Description
protected abstract Map­Canvas­AWT.Renderer	create­Renderer()	Invoked in JavaFX thread for creating a renderer to be executed in a background thread.

Methods inherited from class MapCanvas

clear­Error, error­Occurred, error­Property, get­Content­Identifier, get­Objective­Bounds, initialize, positional­Accuracy­Property, rendering­Property, request­Repaint, reset, run­After­Rendering, set­Objective­Bounds, set­Objective­To­Display, set­Positional­Accuracy, to­String, transform­Display­Coordinates, transform­Objective­Coordinates, using­Fixed­Transform

Modifier and Type	Method	Description
protected final void	clear­Error()	Clears the error message in the status bar.
protected void	error­Occurred(Throwable ex)	Sets the error property to the given value.
final Read­Only­Object­Property<Throwable>	error­Property()	Returns a property giving the exception or error that occurred during last rendering operation.
Optional<Identifier>	get­Content­Identifier()	Returns an identifier of the rendered data.
Envelope	get­Objective­Bounds()	Returns the data bounds to use for computing the initial "objective to display" transform.
protected void	initialize(Grid­Geometry visible­Area)	Sets the objective bounds and/or the zoom level and objective CRS to use for the initial view of data.
final Read­Only­Object­Property<Length>	positional­Accuracy­Property()	Returns a property which gives an estimation of positional accuracy, typically in metres.
final Read­Only­Boolean­Property	rendering­Property()	Returns a property telling whether a rendering is in progress.
final void	request­Repaint()	Requests the map to be rendered again, possibly with new data.
void	reset()	Resets the map view to its default zoom level and default position with no rotation.
protected boolean	run­After­Rendering(Runnable task)	Registers a task to execute after the background thread finished its current rendering task.
void	set­Objective­Bounds(Envelope visible­Area)	Sets the data bounds to use for computing the initial value of Planar­Canvas.objective­To­Display.
void	set­Objective­To­Display(Linear­Transform new­Value)	Sets the conversion from objective CRS to display coordinate system.
protected void	set­Positional­Accuracy(Quantity<Length> accuracy)	Sets an estimation of the positional accuracy of the pixels or features that are rendered on the map.
String	to­String()	Returns a string representation of this canvas for debugging purposes.
void	transform­Display­Coordinates(Affine­Transform after)	Updates the objective to display transform with the given transform in pixel coordinates.
void	transform­Objective­Coordinates(Affine­Transform before)	Updates the objective to display transform with the given transform in objective coordinates.
Map­Canvas.Static­Graphics	using­Fixed­Transform()	Returns a pane where graphics can be added as if the objective to display transform was static.

Methods inherited from class PlanarCanvas

get­Display­Bounds

Modifier and Type	Method	Description
Envelope2D	get­Display­Bounds()	Returns the size and location of the display device.

Methods inherited from class Canvas

get­Display­CRS, get­Geographic­Area, get­Grid­Geometry, get­Locale, get­Objective­CRS, get­Objective­To­Display, get­Point­Of­Interest, get­Spatial­Resolution, set­Display­Bounds, set­Grid­Geometry, set­Objective­CRS, set­Point­Of­Interest

Modifier and Type	Method	Description
final Engineering­CRS	get­Display­CRS()	Returns the Coordinate Reference System of the display device.
Optional<Geographic­Bounding­Box>	get­Geographic­Area()	Returns the geographic bounding box encompassing the area shown on the display device.
Grid­Geometry	get­Grid­Geometry()	Returns canvas properties (CRS, display bounds, conversion) encapsulated in a grid geometry.
Locale	get­Locale()	Returns the locale used for texts or for producing some error messages.
Coordinate­Reference­System	get­Objective­CRS()	Returns the Coordinate Reference System in which all data are transformed before displaying.
Linear­Transform	get­Objective­To­Display()	Returns the (usually affine) conversion from objective CRS to display coordinate system.
Direct­Position	get­Point­Of­Interest(boolean objective)	Returns the coordinates of a point considered representative of the data.
Optional­Double	get­Spatial­Resolution()	Returns an estimation of the resolution (in metres) at the point of interest.
void	set­Display­Bounds(Envelope new­Value)	Sets the size and location of the display device.
void	set­Grid­Geometry(Grid­Geometry new­Value)	Sets canvas properties from the given grid geometry.
void	set­Objective­CRS(Coordinate­Reference­System new­Value, Direct­Position anchor)	Sets the Coordinate Reference System in which all data are transformed before displaying.
void	set­Point­Of­Interest(Direct­Position new­Value)	Sets the coordinates of a representative point inside the data bounding box.

Methods inherited from class Observable

add­Property­Change­Listener, fire­Property­Change, fire­Property­Change, has­Property­Change­Listener, remove­Property­Change­Listener

Modifier and Type	Method	Description
final void	add­Property­Change­Listener(String property­Name, Property­Change­Listener listener)	Registers a listener for the property of the given name.
protected void	fire­Property­Change(Property­Change­Event event)	Notifies all registered listeners that a property changed its value.
protected void	fire­Property­Change(String property­Name, Object old­Value, Object new­Value)	Notifies all registered listeners that a property of the given name changed its value.
protected final boolean	has­Property­Change­Listener(String property­Name)	Returns true if the given property has at least one listener.
final void	remove­Property­Change­Listener(String property­Name, Property­Change­Listener listener)	Unregisters a property listener.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

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.