| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>MapCanvasAWT (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.gui.map, class: MapCanvasAWT"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.gui.map.MapCanvasAWT class"> |
| <meta name="keywords" content="imageMargin"> |
| <meta name="keywords" content="image"> |
| <meta name="keywords" content="createRenderer()"> |
| <meta name="keywords" content="clear()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/MapCanvasAWT.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li><a href="#nested-class-summary">Nested</a></li> |
| <li><a href="#field-summary">Field</a></li> |
| <li><a href="#constructor-summary">Constr</a></li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li><a href="#field-detail">Field</a></li> |
| <li><a href="#constructor-detail">Constr</a></li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.gui.map</a></div> |
| <h1 title="Class MapCanvasAWT" class="title">Class MapCanvasAWT</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance"><a href="../../portrayal/Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> |
| <div class="inheritance"><a href="../../portrayal/PlanarCanvas.html" title="class in org.apache.sis.portrayal">PlanarCanvas</a> |
| <div class="inheritance"><a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a> |
| <div class="inheritance">MapCanvasAWT</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../coverage/CoverageCanvas.html" title="class in org.apache.sis.gui.coverage">CoverageCanvas</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">MapCanvasAWT</span> |
| <span class="extends-implements">extends <a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></span></div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-javafx</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== PROPERTY SUMMARY =========== --> |
| <li> |
| <section class="property-summary" id="property-summary"> |
| <h2>Property Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="properties-inherited-from-class-MapCanvas">Properties inherited from class <a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></h3> |
| <code><a href="MapCanvas.html#errorProperty">error</a>, <a href="MapCanvas.html#renderingProperty">rendering</a></code></div> |
| </section> |
| </li> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected static class </code></div> |
| <div class="col-second even-row-color"><code><a href="MapCanvasAWT.Renderer.html" class="type-name-link" title="class in org.apache.sis.gui.map">MapCanvasAWT.Renderer</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A snapshot of <a href="MapCanvasAWT.html" title="class in org.apache.sis.gui.map"><code>MapCanvasAWT</code></a> state to paint as an image.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected final ImageView</code></div> |
| <div class="col-second even-row-color"><code><a href="#image" class="member-name-link">image</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The node where the rendered map will be shown.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final ObjectProperty<Insets></code></div> |
| <div class="col-second odd-row-color"><code><a href="#imageMargin" class="member-name-link">imageMargin</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Number of additional pixels to paint on each sides of the image, outside the viewing area.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-MapCanvas">Fields inherited from class <a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></h3> |
| <code><a href="MapCanvas.html#fixedPane">fixedPane</a>, <a href="MapCanvas.html#floatingPane">floatingPane</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-PlanarCanvas">Fields inherited from class <a href="../../portrayal/PlanarCanvas.html" title="class in org.apache.sis.portrayal">PlanarCanvas</a></h3> |
| <code><a href="../../portrayal/PlanarCanvas.html#BIDIMENSIONAL">BIDIMENSIONAL</a>, <a href="../../portrayal/PlanarCanvas.html#objectiveToDisplay">objectiveToDisplay</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-Canvas">Fields inherited from class <a href="../../portrayal/Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3> |
| <code><a href="../../portrayal/Canvas.html#DISPLAY_BOUNDS_PROPERTY">DISPLAY_BOUNDS_PROPERTY</a>, <a href="../../portrayal/Canvas.html#OBJECTIVE_CRS_PROPERTY">OBJECTIVE_CRS_PROPERTY</a>, <a href="../../portrayal/Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">OBJECTIVE_TO_DISPLAY_PROPERTY</a>, <a href="../../portrayal/Canvas.html#POINT_OF_INTEREST_PROPERTY">POINT_OF_INTEREST_PROPERTY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Locale)" class="member-name-link">MapCanvasAWT</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new canvas for JavaFX application.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)" class="member-name-link">addPropertyChangeListener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a listener for the property of the given name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clears the image and all intermediate buffer.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="MapCanvasAWT.Renderer.html" title="class in org.apache.sis.gui.map">MapCanvasAWT.Renderer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createRenderer()" class="member-name-link">createRenderer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Invoked in JavaFX thread for creating a renderer to be executed in a background thread.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#firePropertyChange(java.beans.PropertyChangeEvent)" class="member-name-link">firePropertyChange</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Notifies all registered listeners that a property changed its value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#firePropertyChange(java.lang.String,java.lang.Object,java.lang.Object)" class="member-name-link">firePropertyChange</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> oldValue, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> newValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Notifies all registered listeners that a property of the given name changed its value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasPropertyChangeListener(java.lang.String)" class="member-name-link">hasPropertyChangeListener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if the given property has at least one listener.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)" class="member-name-link">removePropertyChangeListener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Unregisters a property listener.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-MapCanvas">Methods inherited from class <a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></h3> |
| <code><a href="MapCanvas.html#clearError()">clearError</a>, <a href="MapCanvas.html#errorOccurred(java.lang.Throwable)">errorOccurred</a>, <a href="MapCanvas.html#errorProperty()">errorProperty</a>, <a href="MapCanvas.html#getObjectiveBounds()">getObjectiveBounds</a>, <a href="MapCanvas.html#initialize(org.apache.sis.coverage.grid.GridGeometry)">initialize</a>, <a href="MapCanvas.html#renderingProperty()">renderingProperty</a>, <a href="MapCanvas.html#requestRepaint()">requestRepaint</a>, <a href="MapCanvas.html#reset()">reset</a>, <a href="MapCanvas.html#runAfterRendering(java.lang.Runnable)">runAfterRendering</a>, <a href="MapCanvas.html#setObjectiveBounds(org.opengis.geometry.Envelope)">setObjectiveBounds</a>, <a href="MapCanvas.html#setObjectiveToDisplay(org.apache.sis.referencing.operation.transform.LinearTransform)">setObjectiveToDisplay</a>, <a href="MapCanvas.html#toString()">toString</a>, <a href="MapCanvas.html#transformDisplayCoordinates(java.awt.geom.AffineTransform)">transformDisplayCoordinates</a>, <a href="MapCanvas.html#transformObjectiveCoordinates(java.awt.geom.AffineTransform)">transformObjectiveCoordinates</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-PlanarCanvas">Methods inherited from class <a href="../../portrayal/PlanarCanvas.html" title="class in org.apache.sis.portrayal">PlanarCanvas</a></h3> |
| <code><a href="../../portrayal/PlanarCanvas.html#getDisplayBounds()">getDisplayBounds</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Canvas">Methods inherited from class <a href="../../portrayal/Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3> |
| <code><a href="../../portrayal/Canvas.html#getDisplayCRS()">getDisplayCRS</a>, <a href="../../portrayal/Canvas.html#getGeographicArea()">getGeographicArea</a>, <a href="../../portrayal/Canvas.html#getGridGeometry()">getGridGeometry</a>, <a href="../../portrayal/Canvas.html#getLocale()">getLocale</a>, <a href="../../portrayal/Canvas.html#getObjectiveCRS()">getObjectiveCRS</a>, <a href="../../portrayal/Canvas.html#getObjectiveToDisplay()">getObjectiveToDisplay</a>, <a href="../../portrayal/Canvas.html#getPointOfInterest(boolean)">getPointOfInterest</a>, <a href="../../portrayal/Canvas.html#getSpatialResolution()">getSpatialResolution</a>, <a href="../../portrayal/Canvas.html#setDisplayBounds(org.opengis.geometry.Envelope)">setDisplayBounds</a>, <a href="../../portrayal/Canvas.html#setGridGeometry(org.apache.sis.coverage.grid.GridGeometry)">setGridGeometry</a>, <a href="../../portrayal/Canvas.html#setObjectiveCRS(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.geometry.DirectPosition)">setObjectiveCRS</a>, <a href="../../portrayal/Canvas.html#setPointOfInterest(org.opengis.geometry.DirectPosition)">setPointOfInterest</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="imageMargin"> |
| <h3>imageMargin</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">ObjectProperty<Insets></span> <span class="element-name">imageMargin</span></div> |
| <div class="block">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.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="image"> |
| <h3>image</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">ImageView</span> <span class="element-name">image</span></div> |
| <div class="block">The node where the rendered map will be shown. Its content is prepared in a background thread |
| by <a href="MapCanvasAWT.Renderer.html" title="class in org.apache.sis.gui.map"><code>MapCanvasAWT.Renderer</code></a>. Subclasses should not set the image content directly.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.util.Locale)"> |
| <h3>MapCanvasAWT</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MapCanvasAWT</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block">Creates a new canvas for JavaFX application.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - the locale to use for labels and some messages, or <code>null</code> for default.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createRenderer()"> |
| <h3>createRenderer</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="MapCanvasAWT.Renderer.html" title="class in org.apache.sis.gui.map">MapCanvasAWT.Renderer</a></span> <span class="element-name">createRenderer</span>()</div> |
| <div class="block">Invoked in JavaFX thread for creating a renderer to be executed in a background thread. |
| Subclasses should copy in this method all <code>MapCanvas</code> properties that the background thread |
| will need for performing the rendering process.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="MapCanvas.html#createRenderer()">createRenderer</a></code> in class <code><a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>rendering process to be executed in background thread, |
| or <code>null</code> if there is nothing to paint.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Clears the image and all intermediate buffer. |
| Invoking this method may help to release memory when the map is no longer shown. |
| |
| <h4>Usage</h4> |
| Overriding methods in subclasses should invoke <code>super.clear()</code>. |
| Other methods should generally not invoke this method directly, |
| and use the following code instead: |
| |
| <blockquote><pre><b>runAfterRendering</b>(<font color="green">this</font>::clear);</pre></blockquote></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="MapCanvas.html#clear()">clear</a></code> in class <code><a href="MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="MapCanvas.html#runAfterRendering(java.lang.Runnable)"><code>MapCanvas.runAfterRendering(Runnable)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)"> |
| <h3>addPropertyChangeListener</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">addPropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</span></div> |
| <div class="block">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).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propertyName</code> - name of the property to listen (should be one of the <code>*_PROPERTY</code> constants).</dd> |
| <dd><code>listener</code> - property listener to register.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removePropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)"> |
| <h3>removePropertyChangeListener</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">removePropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link">PropertyChangeListener</a> listener)</span></div> |
| <div class="block">Unregisters a property listener. The given <code>propertyName</code> should be the name used during |
| <a href="#addPropertyChangeListener(java.lang.String,java.beans.PropertyChangeListener)">listener registration</a>. |
| 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).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propertyName</code> - name of the listened property.</dd> |
| <dd><code>listener</code> - property listener to unregister.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasPropertyChangeListener(java.lang.String)"> |
| <h3>hasPropertyChangeListener</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">boolean</span> <span class="element-name">hasPropertyChangeListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName)</span></div> |
| <div class="block">Returns <code>true</code> if the given property has at least one listener.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propertyName</code> - name of the property to test.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the given property has at least one listener.</dd> |
| <dt>Since:</dt> |
| <dd>1.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="firePropertyChange(java.lang.String,java.lang.Object,java.lang.Object)"> |
| <h3>firePropertyChange</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">firePropertyChange</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> propertyName, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> oldValue, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> newValue)</span></div> |
| <div class="block">Notifies all registered listeners that a property of the given name changed its value. |
| The <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/EventObject.html#getSource()" title="class or interface in java.util" class="external-link">change event source</a> will be <code>this</code>. |
| It is caller responsibility to verify that the old and new values are different |
| (this method does not check for equality).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propertyName</code> - name of the property that changed its value.</dd> |
| <dd><code>oldValue</code> - the old property value (may be <code>null</code>).</dd> |
| <dd><code>newValue</code> - the new property value (may be <code>null</code>).</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link"><code>PropertyChangeEvent</code></a></li> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link"><code>PropertyChangeListener</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="firePropertyChange(java.beans.PropertyChangeEvent)"> |
| <h3>firePropertyChange</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">firePropertyChange</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link">PropertyChangeEvent</a> event)</span></div> |
| <div class="block">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.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the event to forward. Cannot be null.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeEvent.html" title="class or interface in java.beans" class="external-link"><code>PropertyChangeEvent</code></a></li> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/beans/PropertyChangeListener.html" title="class or interface in java.beans" class="external-link"><code>PropertyChangeListener</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |