Package org.apache.sis.gui.coverage
Class CoverageExplorer
- All Implemented Interfaces:
- Localized
An image or tabular view of 
GridCoverage together with controls for band selection and other operations.
 The class contains two properties:
 - A GridCoveragesupplied by user. May be specified indirectly with anImageRequestfor loading the coverage.
- A CoverageExplorer.Viewtype which specify how to show the coverage:- using GridViewfor showing numerical values in a table, or
- using CoverageCanvasfor showing the coverage as an image.
 
- using 
Limitations
Current implementation is restricted toGridCoverage instances, but a future
 implementation may generalize to org.opengis.coverage.Coverage instances.- Since:
- 1.1
- See Also:
Defined in the sis-javafx module
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic enumType of view shown in the explorer.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionfinal ObjectProperty<GridCoverage>The data shown in this canvas.final ObjectProperty<GridCoverageResource>The source of coverage data shown in this explorer.final ObjectProperty<CoverageExplorer.View>The type of view (image or tabular data) shown in this explorer.
- 
Constructor SummaryConstructorsConstructorDescriptionDeprecated.CoverageExplorer(CoverageExplorer source) Creates an explorer initialized with the same coverage or resource than the given explorer.Creates an initially empty explorer with the specified view type.
- 
Method SummaryModifier and TypeMethodDescriptionfinal CoverageCanvasReturns the canvas where the image is shown.final TitledPane[]Returns the panes containing the controls, without data visualization component.final GridCoverageReturns the source of sample values for this explorer.final RegionReturns the region containing the data visualization component, without controls other than navigation.final GridCoverageResourceReturns the source of coverages for this explorer.final RegiongetView()Returns the region containing the grid or coverage view, band selector and any control managed by thisCoverageExplorer.final CoverageExplorer.ViewReturns the type of view (image or tabular data) shown in this explorer.final WindowHandlerReturns the handler of the window showing this coverage view.final voidsetCoverage(GridCoverage coverage) Sets the coverage to show in this explorer.final voidsetCoverage(ImageRequest source) Loads coverage in a background thread from the given source.final voidsetResource(GridCoverageResource resource) Sets the source of coverages shown in this explorer.final voidSets the type of view to show in this explorer.Methods inherited from class WidgetgetLocale
- 
Field Details- 
viewTypePropertyThe type of view (image or tabular data) shown in this explorer.- See Also:
 
- 
resourcePropertyThe source of coverage data shown in this explorer. If this property value is non-null, thencoveragePropertyvalue will change at any time (potentially many times) depending on the zoom level or other user interaction. Conversely if a value is set explicitly oncoverageProperty, then thisresourcePropertyis cleared.Relationship with view propertiesThis property is "weakly bound" toCoverageCanvas.resourceProperty: the two properties generally have the same value but are not necessarily updated in same time. After a value is set on one property, the other property may be updated only after some background process (e.g. loading) finished. If a view is not the currently visible view, its property may be updated only when the view become visible.- Since:
- 1.2
- See Also:
 
- 
coveragePropertyThe data shown in this canvas. This property value may be set implicitly or explicitly:- If the resourcePropertyvalue is non-null, then the value will change automatically at any time (potentially many times) depending on user interaction.
- Conversely if an explicit value is set on this property,
       then the resourcePropertyis cleared.
 Current implementation is restricted to GridCoverageinstances, but a future implementation may generalize toorg.opengis.coverage.Coverageinstances.Relationship with view propertiesThis property is "weakly bound" toCoverageCanvas.coverageProperty: the two properties generally have the same value but are not necessarily updated in same time. After a value is set on one property, the other property may be updated only after some background process (e.g. loading) finished. If a view is not the currently visible view, its property may be updated only when the view become visible.
- If the 
 
- 
- 
Constructor Details- 
CoverageExplorerDeprecated.Creates an initially empty explorer with default view type. By defaultCoverageExplorerwill show a coverage as a table of values, i.e. the default view type isCoverageExplorer.View.TABLE.API note: the reason for setting default value to tabular data is because it requires loading much less data withRenderedImages supporting deferred tile loading. By contrastCoverageExplorer.View.IMAGEmay require loading the full image.
- 
CoverageExplorerCreates an initially empty explorer with the specified view type.- Parameters:
- type- the way to show coverages in this explorer.
- Since:
- 1.2
- See Also:
 
- 
CoverageExplorerCreates an explorer initialized with the same coverage or resource than the given explorer.- Parameters:
- source- the source explorer from which to take the initial coverage or resource.
- Since:
- 1.2
 
 
- 
- 
Method Details- 
getWindowHandlerReturns the handler of the window showing this coverage view. Those windows are created when the user clicks on the "New window" button. Each window provides the area where data are shown and where the user interacts. The window can be a JavaFX top-level window (Stage), but not necessarily. It may also be a tile in a mosaic of windows.- Returns:
- the handler of the window showing this coverage view.
- Since:
- 1.3
 
- 
getCanvasReturns the canvas where the image is shown.- Returns:
- the canvas where the image is shown.
- Since:
- 1.2
 
- 
getViewpublic final Region getView()Returns the region containing the grid or coverage view, band selector and any control managed by thisCoverageExplorer. TheRegionsubclass returned by this method is implementation dependent and may change in any future version.
- 
getDataViewReturns the region containing the data visualization component, without controls other than navigation. This is aGridVieworCoverageCanvastogether with theirStatusBarand navigation controls for selecting the slice in a n-dimensional data cube. TheRegionsubclass returned by this method is implementation dependent and may change in any future version.- Parameters:
- type- whether to obtain a- GridViewor- CoverageCanvas.
- Returns:
- the requested view for the value of resourcePropertyorcoverageProperty.
 
- 
getControlsReturns the panes containing the controls, without data visualization component. TheTitledPanecontents are implementation dependent and may change in any future version.- Parameters:
- type- whether to obtain controls for- GridViewor- CoverageCanvas.
- Returns:
- the controls on specified data view.
 
- 
getViewTypeReturns the type of view (image or tabular data) shown in this explorer. The default value isCoverageExplorer.View.TABLE.- Returns:
- the way to show coverages in this explorer.
- See Also:
 
- 
setViewTypeSets the type of view to show in this explorer.- Parameters:
- type- the new way to show coverages in this explorer.
- See Also:
 
- 
getResourceReturns the source of coverages for this explorer. This method, like all other methods in this class, shall be invoked from the JavaFX thread.- Returns:
- the source of coverages shown in this explorer, or nullif none.
- Since:
- 1.2
- See Also:
 
- 
setResourceSets the source of coverages shown in this explorer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and thecoveragePropertyvalue will be updated after an undetermined amount of time.- Parameters:
- resource- the source of data to show in this explorer, or- nullif none.
- Since:
- 1.2
- See Also:
 
- 
getCoverageReturns the source of sample values for this explorer. This method, like all other methods in this class, shall be invoked from the JavaFX thread. Note that this value may change at any time (depending on user interaction) if theresourcePropertyhas a non-null value.- Returns:
- the coverage shown in this explorer, or nullif none.
- See Also:
 
- 
setCoverageSets the coverage to show in this explorer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and will appear after an undetermined amount of time.Invoking this method sets the resourcePropertyvalue tonull.- Parameters:
- coverage- the data to show in this explorer, or- nullif none.
- See Also:
 
- 
setCoverageLoads coverage in a background thread from the given source. This method shall be invoked from JavaFX thread and returns immediately. The grid content may appear unmodified after this method returns; the modifications will appear after an undetermined amount of time.- Parameters:
- source- the coverage or resource to load, or- nullif none.
- See Also:
 
 
- 
CoverageExplorer(View).