Module org.apache.sis.gui

Package org.apache.sis.gui.dataset

Class ResourceExplorer

Object

Widget

ResourceExplorer

All Implemented Interfaces:

Localized

public class ResourceExplorer
extends Widget

A panel showing a tree of resources 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. Resource­Explorer contains a list of windows created by this widget.

Since:

1.1

Property Summary

Properties

Type	Property	Description
final Read­Only­Property<Resource>	selected­Resource	Returns the property for currently selected resource.

Constructor Summary

Constructors

Constructor	Description
Resource­Explorer()	Creates a new panel for exploring resources.

Method Summary

Modifier and Type	Method	Description
final Locale	get­Locale()	Returns the locale for controls and messages.
Event­Handler<Resource­Event>	get­On­Resource­Closed()	Returns the function to be called when a resource is closed.
Event­Handler<Resource­Event>	get­On­Resource­Loaded()	Returns the function to be called after a resource has been loaded from a file or URL.
final Resource	get­Selected­Resource()	Returns the currently selected resource.
final Region	get­View()	Returns the region containing the resource tree, metadata panel and any other control managed by this Resource­Explorer.
void	load­Resources(Collection<?> files)	Loads all given sources in background threads and add them to the resource tree.
void	remove­And­Close(Resource resource)	Removes the given resource from the tree and eventually closes it.
final Read­Only­Property<Resource>	selected­Resource­Property()	Returns the property for currently selected resource.
void	set­On­Resource­Closed(Event­Handler<Resource­Event> handler)	Specifies a function to be called when a resource is closed.
void	set­On­Resource­Loaded(Event­Handler<Resource­Event> handler)	Specifies a function to be called after a resource has been loaded from a file or URL.

Methods inherited from class Object

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

Property Details

selectedResource

public final ReadOnlyProperty<Resource> selectedResourceProperty

Returns the property for currently selected resource.

See Also:

• selected­Resource­Property()

Constructor Details

ResourceExplorer

public ResourceExplorer()

Creates a new panel for exploring resources.

Method Details

getLocale

public final Locale getLocale()

Returns the locale for controls and messages.

Specified by:

get­Locale in interface Localized

Overrides:

get­Locale in class Widget

Returns:

the locale for controls in this widget.

getView

public final Region getView()

Returns the region containing the resource tree, metadata panel and any other control managed by this Resource­Explorer. The subclass is implementation dependent and may change in any future version.

Specified by:

get­View in class Widget

Returns:

the region to show.

getOnResourceLoaded

public EventHandler<ResourceEvent> getOnResourceLoaded()

Returns the function to be called after a resource has been loaded from a file or URL. This is an accessor for the Resource­Tree.on­Resource­Loaded property value.

Returns:

current function to be called after a resource has been loaded, or null if none.

See Also:

• Resource­Tree.on­Resource­Loaded

setOnResourceLoaded

public void setOnResourceLoaded(EventHandler<ResourceEvent> handler)

Specifies a function to be called after a resource has been loaded from a file or URL. This is a setter for the Resource­Tree.on­Resource­Loaded property value. If this method is never invoked, then the default value is null.

Parameters:

handler - new function to be called after a resource has been loaded, or null if none.

See Also:

• Resource­Tree.on­Resource­Loaded

getOnResourceClosed

public EventHandler<ResourceEvent> getOnResourceClosed()

Returns the function to be called when a resource is closed. This is an accessor for the Resource­Tree.on­Resource­Closed property value.

Returns:

current function to be called when a resource is closed, or null if none.

Since:

1.2

See Also:

• Resource­Tree.on­Resource­Closed

setOnResourceClosed

public void setOnResourceClosed(EventHandler<ResourceEvent> handler)

Specifies a function to be called when a resource is closed. This is a setter for the Resource­Tree.on­Resource­Closed property value. If this method is never invoked, then the default value is null.

Parameters:

handler - new function to be called when a resource is closed, or null if none.

Since:

1.2

See Also:

• Resource­Tree.on­Resource­Closed

loadResources

public void loadResources(Collection<?> files)

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 Resource instances to add directly. This method forwards the files to Resource­Tree.load­Resource(Object), which will allocate a background thread for each resource to load.

Parameters:

files - the source of the resource to load. They are usually File or Path instances.

See Also:

• Resource­Tree.load­Resource(Object)

removeAndClose

public void removeAndClose(Resource resource)

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.

Parameters:

resource - the resource to remove, or null.

See Also:

• Resource­Tree.remove­And­Close(Resource)

getSelectedResource

public final Resource getSelectedResource()

Returns the currently selected resource.

Returns:

the currently selected resource, or null if none.

selectedResourceProperty

public final ReadOnlyProperty<Resource> selectedResourceProperty()

Returns the property for currently selected resource.

Returns:

property for currently selected resource.