| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>ResourceExplorer (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.dataset, class: ResourceExplorer"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.gui.dataset.ResourceExplorer class"> |
| <meta name="keywords" content="getLocale()"> |
| <meta name="keywords" content="getView()"> |
| <meta name="keywords" content="getOnResourceLoaded()"> |
| <meta name="keywords" content="setOnResourceLoaded()"> |
| <meta name="keywords" content="getOnResourceClosed()"> |
| <meta name="keywords" content="setOnResourceClosed()"> |
| <meta name="keywords" content="loadResources()"> |
| <meta name="keywords" content="removeAndClose()"> |
| <meta name="keywords" content="getSelectedResource()"> |
| <meta name="keywords" content="selectedResourceProperty()"> |
| <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/ResourceExplorer.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>Nested</li> |
| <li>Field</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>Field</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>Field | </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>Field | </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.dataset</a></div> |
| <h1 title="Class ResourceExplorer" class="title">Class ResourceExplorer</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="../Widget.html" title="class in org.apache.sis.gui">Widget</a> |
| <div class="inheritance">ResourceExplorer</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> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ResourceExplorer</span> |
| <span class="extends-implements">extends <a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></span></div> |
| <div class="block">A panel showing a <a href="ResourceTree.html" title="class in org.apache.sis.gui.dataset">tree of resources</a> together with their metadata and data views. |
| This panel also contains a "new window" button for creating new windows showing the same data but potentially |
| a different locations and times. <code>ResourceExplorer</code> contains a list of windows created by this widget.</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="caption"><span>Properties</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Type</div> |
| <div class="table-header col-second">Property</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>final ReadOnlyProperty<<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#selectedResourceProperty" class="member-name-link">selectedResource</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Returns the property for currently selected resource.</div> |
| </div> |
| </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()" class="member-name-link">ResourceExplorer</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new panel for exploring resources.</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 <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale()" class="member-name-link">getLocale</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the locale for controls and messages.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOnResourceClosed()" class="member-name-link">getOnResourceClosed</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 function to be called when a resource is closed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOnResourceLoaded()" class="member-name-link">getOnResourceLoaded</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the function to be called after a resource has been loaded from a file or URL.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSelectedResource()" class="member-name-link">getSelectedResource</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 currently selected resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final Region</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getView()" class="member-name-link">getView</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the region containing the resource tree, metadata panel and any other control managed |
| by this <code>ResourceExplorer</code>.</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="#loadResources(java.util.Collection)" class="member-name-link">loadResources</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><?> files)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Loads all given sources in background threads and add them to the resource tree.</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="#removeAndClose(org.apache.sis.storage.Resource)" class="member-name-link">removeAndClose</a><wbr>(<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a> resource)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes the given resource from the tree and eventually closes it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final ReadOnlyProperty<<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#selectedResourceProperty()" class="member-name-link">selectedResourceProperty</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 property for currently selected resource.</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="#setOnResourceClosed(javafx.event.EventHandler)" class="member-name-link">setOnResourceClosed</a><wbr>(EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>> handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies a function to be called when a resource is closed.</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="#setOnResourceLoaded(javafx.event.EventHandler)" class="member-name-link">setOnResourceLoaded</a><wbr>(EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>> handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies a function to be called after a resource has been loaded from a file or URL.</div> |
| </div> |
| </div> |
| </div> |
| </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#toString()" title="class or interface in java.lang" class="external-link">toString</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"> |
| <!-- ============ PROPERTY DETAIL =========== --> |
| <li> |
| <section class="property-details" id="property-detail"> |
| <h2>Property Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="selectedResourceProperty"> |
| <h3>selectedResource</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">ReadOnlyProperty<<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a>></span> <span class="element-name">selectedResourceProperty</span></div> |
| <div class="block">Returns the property for currently selected resource.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#selectedResourceProperty()"><code>selectedResourceProperty()</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>()"> |
| <h3>ResourceExplorer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ResourceExplorer</span>()</div> |
| <div class="block">Creates a new panel for exploring resources.</div> |
| </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="getLocale()"> |
| <h3>getLocale</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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></span> <span class="element-name">getLocale</span>()</div> |
| <div class="block">Returns the locale for controls and messages.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../util/Localized.html#getLocale()">getLocale</a></code> in interface <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../Widget.html#getLocale()">getLocale</a></code> in class <code><a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the locale for controls in this widget.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getView()"> |
| <h3>getView</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">Region</span> <span class="element-name">getView</span>()</div> |
| <div class="block">Returns the region containing the resource tree, metadata panel and any other control managed |
| by this <code>ResourceExplorer</code>. The subclass is implementation dependent and may change in |
| any future version.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Widget.html#getView()">getView</a></code> in class <code><a href="../Widget.html" title="class in org.apache.sis.gui">Widget</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the region to show.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOnResourceLoaded()"> |
| <h3>getOnResourceLoaded</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>></span> <span class="element-name">getOnResourceLoaded</span>()</div> |
| <div class="block">Returns the function to be called after a resource has been loaded from a file or URL. |
| This is an accessor for the <a href="ResourceTree.html#onResourceLoaded"><code>ResourceTree.onResourceLoaded</code></a> property value.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>current function to be called after a resource has been loaded, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ResourceTree.html#onResourceLoaded"><code>ResourceTree.onResourceLoaded</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOnResourceLoaded(javafx.event.EventHandler)"> |
| <h3>setOnResourceLoaded</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOnResourceLoaded</span><wbr><span class="parameters">(EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>> handler)</span></div> |
| <div class="block">Specifies a function to be called after a resource has been loaded from a file or URL. |
| This is a setter for the <a href="ResourceTree.html#onResourceLoaded"><code>ResourceTree.onResourceLoaded</code></a> property value. |
| If this method is never invoked, then the default value is <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>handler</code> - new function to be called after a resource has been loaded, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ResourceTree.html#onResourceLoaded"><code>ResourceTree.onResourceLoaded</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOnResourceClosed()"> |
| <h3>getOnResourceClosed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>></span> <span class="element-name">getOnResourceClosed</span>()</div> |
| <div class="block">Returns the function to be called when a resource is closed. |
| This is an accessor for the <a href="ResourceTree.html#onResourceClosed"><code>ResourceTree.onResourceClosed</code></a> property value.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>current function to be called when a resource is closed, or <code>null</code> if none.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ResourceTree.html#onResourceClosed"><code>ResourceTree.onResourceClosed</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOnResourceClosed(javafx.event.EventHandler)"> |
| <h3>setOnResourceClosed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setOnResourceClosed</span><wbr><span class="parameters">(EventHandler<<a href="ResourceEvent.html" title="class in org.apache.sis.gui.dataset">ResourceEvent</a>> handler)</span></div> |
| <div class="block">Specifies a function to be called when a resource is closed. |
| This is a setter for the <a href="ResourceTree.html#onResourceClosed"><code>ResourceTree.onResourceClosed</code></a> property value. |
| If this method is never invoked, then the default value is <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>handler</code> - new function to be called when a resource is closed, or <code>null</code> if none.</dd> |
| <dt>Since:</dt> |
| <dd>1.2</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ResourceTree.html#onResourceClosed"><code>ResourceTree.onResourceClosed</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadResources(java.util.Collection)"> |
| <h3>loadResources</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">loadResources</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><?> files)</span></div> |
| <div class="block">Loads all given sources in background threads and add them to the resource tree. |
| The given collection typically contains files to load, |
| but may also contain <a href="../../storage/Resource.html" title="interface in org.apache.sis.storage"><code>Resource</code></a> instances to add directly. |
| This method forwards the files to <a href="ResourceTree.html#loadResource(java.lang.Object)"><code>ResourceTree.loadResource(Object)</code></a>, |
| which will allocate a background thread for each resource to load.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>files</code> - the source of the resource to load. They are usually |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link"><code>File</code></a> or <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>Path</code></a> instances.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="ResourceTree.html#loadResource(java.lang.Object)"><code>ResourceTree.loadResource(Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAndClose(org.apache.sis.storage.Resource)"> |
| <h3>removeAndClose</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeAndClose</span><wbr><span class="parameters">(<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a> resource)</span></div> |
| <div class="block">Removes the given resource from the tree and eventually closes it. |
| If the given resource is not in this tree explorer or cannot be removed, |
| then this method does nothing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resource</code> - the resource to remove, or <code>null</code>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="ResourceTree.html#removeAndClose(org.apache.sis.storage.Resource)"><code>ResourceTree.removeAndClose(Resource)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSelectedResource()"> |
| <h3>getSelectedResource</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a></span> <span class="element-name">getSelectedResource</span>()</div> |
| <div class="block">Returns the currently selected resource.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the currently selected resource, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="selectedResourceProperty()"> |
| <h3>selectedResourceProperty</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">ReadOnlyProperty<<a href="../../storage/Resource.html" title="interface in org.apache.sis.storage">Resource</a>></span> <span class="element-name">selectedResourceProperty</span>()</div> |
| <div class="block">Returns the property for currently selected resource.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>property for currently selected resource.</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> |