Module org.apache.sis.gui

Package org.apache.sis.gui.coverage

Class CoverageCanvas

Object

Canvas

PlanarCanvas

MapCanvas

MapCanvasAWT

CoverageCanvas

All Implemented Interfaces:

Localized

@DefaultProperty("coverage")
public class CoverageCanvas
extends MapCanvasAWT

A canvas for Rendered­Image provided by a Grid­Coverage or a Grid­Coverage­Resource. In the latter case where the source of data is specified by resource­Property, the grid coverage instance (given by coverage­Property) will change automatically according the zoom level.

Since:

1.1

See Also:

• Coverage­Explorer

Property Summary

Properties inherited from class MapCanvas

error, rendering

Nested Class Summary

Nested classes/interfaces inherited from class MapCanvasAWT

Map­Canvas­AWT.Renderer

Field Summary

Fields

Modifier and Type	Field	Description
final Object­Property<Grid­Coverage>	coverage­Property	The data shown in this canvas.
final Object­Property<Interpolation>	interpolation­Property	The interpolation method to use for resampling the image.
final Object­Property<Grid­Coverage­Resource>	resource­Property	The source of coverage data shown in this canvas.
final Object­Property<Grid­Extent>	slice­Extent­Property	A subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

Fields inherited from class MapCanvasAWT

image, image­Margin

Fields inherited from class MapCanvas

fixed­Pane, floating­Pane

Fields inherited from class PlanarCanvas

BIDIMENSIONAL, objective­To­Display

Fields inherited from class Canvas

DISPLAY_BOUNDS_PROPERTY, OBJECTIVE_CRS_PROPERTY, OBJECTIVE_TO_DISPLAY_PROPERTY, POINT_OF_INTEREST_PROPERTY

Constructor Summary

Constructors

Constructor	Description
Coverage­Canvas()	Creates a new two-dimensional canvas for Rendered­Image.

Method Summary

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	clear()	Removes the image shown and releases memory.
protected Map­Canvas­AWT.Renderer	create­Renderer()	Invoked in JavaFX thread for creating a renderer to be executed in a background thread.
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.
final Grid­Coverage	get­Coverage()	Returns the source of image for this viewer.
final Interpolation	get­Interpolation()	Gets the interpolation method used during resample operations.
final Grid­Coverage­Resource	get­Resource()	Returns the source of coverages for this viewer.
final Grid­Extent	get­Slice­Extent()	Returns a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.
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.
final void	set­Coverage(Grid­Coverage coverage)	Sets the coverage to show in this viewer.
final void	set­Interpolation(Interpolation interpolation)	Sets the interpolation method to use during resample operations.
final void	set­Resource(Grid­Coverage­Resource resource)	Sets the source of coverages shown in this viewer.
final void	set­Slice­Extent(Grid­Extent slice­Extent)	Sets a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.
String	to­String()	Returns a string representation for debugging purposes.

Methods inherited from class MapCanvas

clear­Error, error­Occurred, error­Property, get­Objective­Bounds, initialize, rendering­Property, request­Repaint, reset, run­After­Rendering, set­Objective­Bounds, set­Objective­To­Display, transform­Display­Coordinates, transform­Objective­Coordinates

Methods inherited from class PlanarCanvas

get­Display­Bounds

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­Point­Of­Interest

Methods inherited from class Object

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

Field Details

resourceProperty

public final ObjectProperty<GridCoverageResource> resourceProperty

The source of coverage data shown in this canvas. If this property value is non-null, then coverage­Property value will change at any time (potentially many times) depending on the zoom level or other user interaction. Conversely if a value is set explicitly on coverage­Property, then this resource­Property is cleared.

Since:

1.2

See Also:

• get­Resource()
• set­Resource(Grid­Coverage­Resource)
• Coverage­Explorer.resource­Property

coverageProperty

public final ObjectProperty<GridCoverage> coverageProperty

The data shown in this canvas. This property value may be set implicitly or explicitly:

• If the resource­Property value is non-null, then the value will change automatically at any time (potentially many times) depending on user interaction.
• Conversely if an explicit value is set on this property, then the resource­Property is cleared.

Note that a change in this property value may not modify the canvas content immediately. Instead, a background process will request the tiles and update the canvas content later, when data are ready.

Current implementation is restricted to Grid­Coverage instances, but a future implementation may generalize to org.opengis.coverage.Coverage instances.

See Also:

• get­Coverage()
• set­Coverage(Grid­Coverage)
• Coverage­Explorer.coverage­Property

sliceExtentProperty

public final ObjectProperty<GridExtent> sliceExtentProperty

A subspace of the grid coverage extent where all dimensions except two have a size of 1 cell. May be null if the grid coverage has only two dimensions with a size greater than 1 cell.

See Also:

• get­Slice­Extent()
• set­Slice­Extent(Grid­Extent)
• Grid­Coverage.render(Grid­Extent)

interpolationProperty

public final ObjectProperty<Interpolation> interpolationProperty

The interpolation method to use for resampling the image.

See Also:

• get­Interpolation()
• set­Interpolation(Interpolation)

Constructor Details

CoverageCanvas

public CoverageCanvas()

Creates a new two-dimensional canvas for Rendered­Image.

Method Details

getResource

public final GridCoverageResource getResource()

Returns the source of coverages for this viewer. This method, like all other methods in this class, shall be invoked from the JavaFX thread.

Returns:

the source of coverages shown in this viewer, or null if none.

Since:

1.2

See Also:

• resource­Property

setResource

public final void setResource(GridCoverageResource resource)

Sets the source of coverages shown in this viewer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and the coverage­Property value will be updated after an undetermined amount of time.

Parameters:

resource - the source of data to show in this viewer, or null if none.

Since:

1.2

See Also:

• resource­Property

getCoverage

public final GridCoverage getCoverage()

Returns the source of image for this viewer. This method, like all other methods in this class, shall be invoked from the JavaFX thread. Note that this value may change at any time (depending on user interaction) if the resource­Property has a non-null value.

Returns:

the coverage shown in this explorer, or null if none.

See Also:

• coverage­Property

setCoverage

public final void setCoverage(GridCoverage coverage)

Sets the coverage to show in this viewer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and will appear after an undetermined amount of time.

Invoking this method sets the resource­Property value to null.

Parameters:

coverage - the data to show in this viewer, or null if none.

See Also:

• coverage­Property

getSliceExtent

public final GridExtent getSliceExtent()

Returns a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

Returns:

subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

See Also:

• slice­Extent­Property
• Grid­Coverage.render(Grid­Extent)

setSliceExtent

public final void setSliceExtent(GridExtent sliceExtent)

Sets a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell. Note that values set on this property may be overwritten at any time by user interactions if this Coverage­Canvas is associated with a Grid­Slice­Selector.

Parameters:

slice­Extent - subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

See Also:

• slice­Extent­Property
• Grid­Coverage.render(Grid­Extent)

getInterpolation

public final Interpolation getInterpolation()

Gets the interpolation method used during resample operations.

Returns:

the current interpolation method.

See Also:

• interpolation­Property

setInterpolation

public final void setInterpolation(Interpolation interpolation)

Sets the interpolation method to use during resample operations.

Parameters:

interpolation - the new interpolation method.

See Also:

• interpolation­Property

createRenderer

protected MapCanvasAWT.Renderer createRenderer()

Invoked in JavaFX thread for creating a renderer to be executed in a background thread. This method prepares the information needed but does not start the rendering itself. The rendering will be done later by a call to Map­Canvas­AWT.Renderer.paint(Graphics2D).

Specified by:

create­Renderer in class Map­Canvas­AWT

Returns:

rendering process to be executed in background thread, or null if there is nothing to paint.

clear

protected void clear()

Removes the image shown and releases memory.

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­AWT

See Also:

• Map­Canvas.run­After­Rendering(Runnable)

toString

public String toString()

Returns a string representation for debugging purposes. The string content may change in any future version.

Overrides:

to­String in class Map­Canvas

Returns:

debug string (may change in any future version).

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Registers a listener for the property of the given name. The listener will be notified every time that the property of the given name got a new value. If the same listener is registered twice for the same property, then it will be notified twice (this method does not perform duplication checks).

Parameters:

property­Name - name of the property to listen (should be one of the *_PROPERTY constants).

listener - property listener to register.

removePropertyChangeListener

public final void removePropertyChangeListener(String propertyName,
 PropertyChangeListener listener)

Unregisters a property listener. The given property­Name should be the name used during listener registration. If the specified listener is not registered for the named property, then nothing happen. If the listener has been registered twice, then only one registration is removed (one registration will remain).

Parameters:

property­Name - name of the listened property.

listener - property listener to unregister.

hasPropertyChangeListener

protected final boolean hasPropertyChangeListener(String propertyName)

Returns true if the given property has at least one listener.

Parameters:

property­Name - name of the property to test.

Returns:

true if the given property has at least one listener.

firePropertyChange

protected void firePropertyChange(String propertyName,
 Object oldValue,
 Object newValue)

Notifies all registered listeners that a property of the given name changed its value. The change event source will be this. It is caller responsibility to verify that the old and new values are different (this method does not check for equality).

Parameters:

property­Name - name of the property that changed its value.

old­Value - the old property value (may be null).

new­Value - the new property value (may be null).

See Also:

• Property­Change­Event
• Property­Change­Listener

firePropertyChange

protected void firePropertyChange(PropertyChangeEvent event)

Notifies all registered listeners that a property changed its value. It is caller responsibility to verify that the event source and property name are valid.

Parameters:

event - the event to forward. Cannot be null.

See Also:

• Property­Change­Event
• Property­Change­Listener