| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>PlanarCanvas (Apache SIS 1.4 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="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.portrayal, package: org.apache.sis.portrayal, class: PlanarCanvas"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.portrayal.PlanarCanvas class"> |
| <meta name="keywords" content="BIDIMENSIONAL"> |
| <meta name="keywords" content="objectiveToDisplay"> |
| <meta name="keywords" content="getDisplayBounds()"> |
| <meta name="keywords" content="transformObjectiveCoordinates()"> |
| <meta name="keywords" content="transformDisplayCoordinates()"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.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="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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>Nested</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>Nested | </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="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.portrayal</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.portrayal</a></div> |
| <h1 title="Class PlanarCanvas" class="title">Class PlanarCanvas</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/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="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a> |
| <div class="inheritance">PlanarCanvas</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/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="../../../../../org.apache.sis.gui/org/apache/sis/gui/map/MapCanvas.html" title="class in org.apache.sis.gui.map">MapCanvas</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">PlanarCanvas</span> |
| <span class="extends-implements">extends <a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></span></div> |
| <div class="block">A canvas for two-dimensional display device using a Cartesian coordinate system. |
| Data are reduced to a two-dimensional slice before to be displayed. |
| |
| <h2 id="multi-threading-heading">Multi-threading</h2> |
| <code>PlanarCanvas</code> is not thread-safe. Synchronization, if desired, must be done by the caller. |
| Another common strategy is to interact with <code>PlanarCanvas</code> from a single thread, |
| for example the Swing or JavaFX event queue.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#BIDIMENSIONAL" class="member-name-link">BIDIMENSIONAL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The 2 constant for identifying code specific to bi-dimensional case.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#objectiveToDisplay" class="member-name-link">objectiveToDisplay</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The conversion from <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> to the display coordinate system as a |
| Java2D affine transform.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-Canvas">Fields inherited from class <a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3> |
| <code><a href="Canvas.html#DISPLAY_BOUNDS_PROPERTY">DISPLAY_BOUNDS_PROPERTY</a>, <a href="Canvas.html#OBJECTIVE_CRS_PROPERTY">OBJECTIVE_CRS_PROPERTY</a>, <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">OBJECTIVE_TO_DISPLAY_PROPERTY</a>, <a href="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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Locale)" class="member-name-link">PlanarCanvas</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/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 two-dimensional canvas.</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-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/11/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/11/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="#firePropertyChange(java.beans.PropertyChangeEvent)" class="member-name-link">firePropertyChange</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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/11/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><a href="../../../../../org.apache.sis.referencing/org/apache/sis/geometry/Envelope2D.html" title="class in org.apache.sis.geometry">Envelope2D</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDisplayBounds()" class="member-name-link">getDisplayBounds</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the size and location of the display device.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final boolean</code></div> |
| <div class="col-second even-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/11/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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second odd-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/11/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/11/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Unregisters a property listener.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformDisplayCoordinates(java.awt.geom.AffineTransform)" class="member-name-link">transformDisplayCoordinates</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> after)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>after</em> |
| the current transform.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformObjectiveCoordinates(java.awt.geom.AffineTransform)" class="member-name-link">transformObjectiveCoordinates</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> before)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>before</em> |
| the current transform.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Canvas">Methods inherited from class <a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></h3> |
| <code><a href="Canvas.html#getDisplayCRS()">getDisplayCRS</a>, <a href="Canvas.html#getGeographicArea()">getGeographicArea</a>, <a href="Canvas.html#getGridGeometry()">getGridGeometry</a>, <a href="Canvas.html#getLocale()">getLocale</a>, <a href="Canvas.html#getObjectiveCRS()">getObjectiveCRS</a>, <a href="Canvas.html#getObjectiveToDisplay()">getObjectiveToDisplay</a>, <a href="Canvas.html#getPointOfInterest(boolean)">getPointOfInterest</a>, <a href="Canvas.html#getSpatialResolution()">getSpatialResolution</a>, <a href="Canvas.html#setDisplayBounds(org.opengis.geometry.Envelope)">setDisplayBounds</a>, <a href="Canvas.html#setGridGeometry(org.apache.sis.coverage.grid.GridGeometry)">setGridGeometry</a>, <a href="Canvas.html#setObjectiveCRS(org.opengis.referencing.crs.CoordinateReferenceSystem,org.opengis.geometry.DirectPosition)">setObjectiveCRS</a>, <a href="Canvas.html#setObjectiveToDisplay(org.apache.sis.referencing.operation.transform.LinearTransform)">setObjectiveToDisplay</a>, <a href="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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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="BIDIMENSIONAL"> |
| <h3>BIDIMENSIONAL</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name">BIDIMENSIONAL</span></div> |
| <div class="block">The 2 constant for identifying code specific to bi-dimensional case.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.sis.portrayal.PlanarCanvas.BIDIMENSIONAL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="objectiveToDisplay"> |
| <h3>objectiveToDisplay</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a></span> <span class="element-name">objectiveToDisplay</span></div> |
| <div class="block">The conversion from <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> to the display coordinate system as a |
| Java2D affine transform. This transform will be modified in-place when user applies zoom, translation or |
| rotation on the view area. Subclasses should generally not modify this affine transform directly; invoke |
| one of the <code>transform<var>Foo</var>Coordinates(AffineTransform)</code> methods instead.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="Canvas.html#getObjectiveToDisplay()"><code>Canvas.getObjectiveToDisplay()</code></a></li> |
| <li><a href="#transformObjectiveCoordinates(java.awt.geom.AffineTransform)"><code>transformObjectiveCoordinates(AffineTransform)</code></a></li> |
| <li><a href="#transformDisplayCoordinates(java.awt.geom.AffineTransform)"><code>transformDisplayCoordinates(AffineTransform)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>PlanarCanvas</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">PlanarCanvas</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/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 two-dimensional canvas.</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="getDisplayBounds()"> |
| <h3>getDisplayBounds</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../../../org.apache.sis.referencing/org/apache/sis/geometry/Envelope2D.html" title="class in org.apache.sis.geometry">Envelope2D</a></span> <span class="element-name">getDisplayBounds</span>()</div> |
| <div class="block">Returns the size and location of the display device. The unit of measurement is |
| <a href="../../../../../org.apache.sis.util/org/apache/sis/measure/Units.html#PIXEL"><code>Units.PIXEL</code></a> and coordinate values are usually (but not necessarily) integers. |
| |
| <p>This value may be <code>null</code> on newly created <code>Canvas</code>, before data are added and canvas |
| is configured. It should not be <code>null</code> anymore once a <code>Canvas</code> is ready for displaying. |
| The returned envelope is a copy; display changes happening after this method invocation will not be |
| reflected in the returned envelope.</p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Canvas.html#getDisplayBounds()">getDisplayBounds</a></code> in class <code><a href="Canvas.html" title="class in org.apache.sis.portrayal">Canvas</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>size and location of the display device in pixel coordinates.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="Canvas.html#setDisplayBounds(org.opengis.geometry.Envelope)"><code>Canvas.setDisplayBounds(Envelope)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="transformObjectiveCoordinates(java.awt.geom.AffineTransform)"> |
| <h3>transformObjectiveCoordinates</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">transformObjectiveCoordinates</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> before)</span></div> |
| <div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>before</em> |
| the current transform. For example if the given <code>before</code> transform is a translation, then the translation |
| vector is in units of the <a href="Canvas.html#getObjectiveCRS()">objective CRS</a> (typically metres on the map). |
| |
| <p>This method does nothing if the given transform is identity. |
| Otherwise an <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">"objectiveToDisplay"</a> property change event will be sent with the |
| <a href="TransformChangeEvent.Reason.html#OBJECTIVE_NAVIGATION"><code>TransformChangeEvent.Reason.OBJECTIVE_NAVIGATION</code></a> reason after the change became effective. |
| Depending on the implementation, the change may not take effect immediately. |
| For example, subclasses may do the rendering in a background thread.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>before</code> - coordinate conversion to apply before the current <cite>objective to display</cite> transform.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="TransformChangeEvent.html#getObjectiveChange()"><code>TransformChangeEvent.getObjectiveChange()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="transformDisplayCoordinates(java.awt.geom.AffineTransform)"> |
| <h3>transformDisplayCoordinates</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">transformDisplayCoordinates</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/java/awt/geom/AffineTransform.html" title="class or interface in java.awt.geom" class="external-link">AffineTransform</a> after)</span></div> |
| <div class="block">Updates the <cite>objective to display</cite> transform as if the given transform was applied <em>after</em> |
| the current transform. For example if the given <code>after</code> transform is a translation, then the translation |
| vector is in pixel units. |
| |
| <p>This method does nothing if the given transform is identity. |
| Otherwise an <a href="Canvas.html#OBJECTIVE_TO_DISPLAY_PROPERTY">"objectiveToDisplay"</a> property change event will be sent with the |
| <a href="TransformChangeEvent.Reason.html#DISPLAY_NAVIGATION"><code>TransformChangeEvent.Reason.DISPLAY_NAVIGATION</code></a> reason after the change became effective. |
| Depending on the implementation, the change may not take effect immediately. |
| For example, subclasses may do the rendering in a background thread.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>after</code> - coordinate conversion to apply after the current <cite>objective to display</cite> transform.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list-long"> |
| <li><a href="TransformChangeEvent.html#getDisplayChange()"><code>TransformChangeEvent.getDisplayChange()</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/11/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/11/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/11/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/11/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/11/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> |
| </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/11/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/11/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/11/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/11/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="tag-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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="tag-list"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/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/11/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> |
| </div> |
| </div> |
| </body> |
| </html> |