| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>GridView (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.coverage, class: GridView"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.gui.coverage.GridView class"> |
| <meta name="keywords" content="imageProperty"> |
| <meta name="keywords" content="bandProperty"> |
| <meta name="keywords" content="headerWidth"> |
| <meta name="keywords" content="cellWidth"> |
| <meta name="keywords" content="cellHeight"> |
| <meta name="keywords" content="cellSpacing"> |
| <meta name="keywords" content="headerBackground"> |
| <meta name="keywords" content="getImage()"> |
| <meta name="keywords" content="setImage()"> |
| <meta name="keywords" content="getBand()"> |
| <meta name="keywords" content="setBand()"> |
| <meta name="keywords" content="cellFormatPattern()"> |
| <meta name="keywords" content="createDefaultSkin()"> |
| <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/GridView.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><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="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.gui.coverage</a></div> |
| <h1 title="Class GridView" class="title">Class GridView</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">Node |
| <div class="inheritance">Parent |
| <div class="inheritance">Region |
| <div class="inheritance">Control |
| <div class="inheritance">GridView</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>Styleable</code>, <code>EventTarget</code>, <code>Skinnable</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@DefaultProperty("image") |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">GridView</span> |
| <span class="extends-implements">extends Control</span></div> |
| <div class="block">A view of numerical values in a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link"><code>RenderedImage</code></a>. The rendered image is typically a two dimensional slice |
| of a <a href="../../coverage/grid/GridCoverage.html" title="class in org.apache.sis.coverage.grid"><code>GridCoverage</code></a>. The number of rows is the image height and the number of columns is the image width. |
| The view shows one band at a time, but the band to show can be changed (thus providing a navigation in a third |
| dimension). |
| |
| <p>This class is designed for large images, with tiles loaded in a background thread only when first needed. |
| This is not a general purpose grid viewer; for matrices of relatively small size (e.g. less than 100 columns), |
| consider using the standard JavaFX <code>TableView</code> instead.</p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>1.1</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="CoverageExplorer.html" title="class in org.apache.sis.gui.coverage"><code>CoverageExplorer</code></a></li> |
| </ul> |
| </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-Control">Properties inherited from class Control</h3> |
| <code>contextMenu, skin, tooltip</code></div> |
| <div class="inherited-list"> |
| <h3 id="properties-inherited-from-class-Region">Properties inherited from class Region</h3> |
| <code>background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width</code></div> |
| <div class="inherited-list"> |
| <h3 id="properties-inherited-from-class-Parent">Properties inherited from class Parent</h3> |
| <code>needsLayout</code></div> |
| <div class="inherited-list"> |
| <h3 id="properties-inherited-from-class-Node">Properties inherited from class Node</h3> |
| <code>accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible</code></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>final IntegerProperty</code></div> |
| <div class="col-second even-row-color"><code><a href="#bandProperty" class="member-name-link">bandProperty</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The image band to show in the table.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final DoubleProperty</code></div> |
| <div class="col-second odd-row-color"><code><a href="#cellHeight" class="member-name-link">cellHeight</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Height of all rows in the grid.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final DoubleProperty</code></div> |
| <div class="col-second even-row-color"><code><a href="#cellSpacing" class="member-name-link">cellSpacing</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Horizontal space between cells, as a number equals or greater than zero.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final DoubleProperty</code></div> |
| <div class="col-second odd-row-color"><code><a href="#cellWidth" class="member-name-link">cellWidth</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Width of data cell to be shown in other columns than the header column.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final ObjectProperty<Paint></code></div> |
| <div class="col-second even-row-color"><code><a href="#headerBackground" class="member-name-link">headerBackground</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The background color of row and column headers.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final DoubleProperty</code></div> |
| <div class="col-second odd-row-color"><code><a href="#headerWidth" class="member-name-link">headerWidth</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Width of header cells to be shown in the first column.</div> |
| </div> |
| <div class="col-first even-row-color"><code>final ObjectProperty<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#imageProperty" class="member-name-link">imageProperty</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The data shown in this table.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-Region">Fields inherited from class Region</h3> |
| <code>USE_COMPUTED_SIZE, USE_PREF_SIZE</code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-Node">Fields inherited from class Node</h3> |
| <code>BASELINE_OFFSET_SAME_AS_HEIGHT</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()" class="member-name-link">GridView</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates an initially empty grid view.</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><StringProperty></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cellFormatPattern()" class="member-name-link">cellFormatPattern</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The property for the pattern of values in cells.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final Skin<<a href="GridView.html" title="class in org.apache.sis.gui.coverage">GridView</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createDefaultSkin()" class="member-name-link">createDefaultSkin</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a new instance of the skin responsible for rendering this grid view.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBand()" class="member-name-link">getBand</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 index of the band shown in this grid view.</div> |
| </div> |
| <div class="col-first odd-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.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getImage()" class="member-name-link">getImage</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 source of sample values for this table.</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="#setBand(int)" class="member-name-link">setBand</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the number of the band to show in this grid view.</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="#setImage(java.awt.image.RenderedImage)" class="member-name-link">setImage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a> image)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the image to show in this table.</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="#setImage(org.apache.sis.gui.coverage.ImageRequest)" class="member-name-link">setImage</a><wbr>(<a href="ImageRequest.html" title="class in org.apache.sis.gui.coverage">ImageRequest</a> source)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Loads image in a background thread from the given source.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Control">Methods inherited from class Control</h3> |
| <code>computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Region">Methods inherited from class Region</h3> |
| <code>backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Parent">Methods inherited from class Parent</h3> |
| <code>getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds</code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Node">Methods inherited from class Node</h3> |
| <code>accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty</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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Styleable">Methods inherited from interface Styleable</h3> |
| <code>getStyleableNode</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="imageProperty"> |
| <h3>imageProperty</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">ObjectProperty<<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a>></span> <span class="element-name">imageProperty</span></div> |
| <div class="block">The data shown in this table. Note that setting this property to a non-null value may not |
| modify the grid content immediately. Instead, a background process will request the tiles.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getImage()"><code>getImage()</code></a></li> |
| <li><a href="#setImage(java.awt.image.RenderedImage)"><code>setImage(RenderedImage)</code></a></li> |
| <li><a href="#setImage(org.apache.sis.gui.coverage.ImageRequest)"><code>setImage(ImageRequest)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bandProperty"> |
| <h3>bandProperty</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">IntegerProperty</span> <span class="element-name">bandProperty</span></div> |
| <div class="block">The image band to show in the table. |
| It should be a number between 0 inclusive and <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/SampleModel.html#getNumBands()" title="class or interface in java.awt.image" class="external-link"><code>SampleModel.getNumBands()</code></a> exclusive.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getBand()"><code>getBand()</code></a></li> |
| <li><a href="#setBand(int)"><code>setBand(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="headerWidth"> |
| <h3>headerWidth</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">DoubleProperty</span> <span class="element-name">headerWidth</span></div> |
| <div class="block">Width of header cells to be shown in the first column. |
| The first (header) column contains the row indices, or sometimes the coordinate values. |
| This size includes the <a href="#cellSpacing">cell spacing</a>. |
| It shall be a number strictly greater than zero. |
| |
| <div class="note"><b>API note:</b> |
| We do not provide getter/setter for this property; use <code>WritableDoubleValue.set(double)</code> |
| directly instead. We omit the "Property" suffix for making this operation more natural.</div></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellWidth"> |
| <h3>cellWidth</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">DoubleProperty</span> <span class="element-name">cellWidth</span></div> |
| <div class="block">Width of data cell to be shown in other columns than the header column. |
| This size includes the <a href="#cellSpacing">cell spacing</a>. |
| It shall be a number strictly greater than zero. |
| |
| <div class="note"><b>API note:</b> |
| We do not provide getter/setter for this property; use <code>WritableDoubleValue.set(double)</code> |
| directly instead. We omit the "Property" suffix for making this operation more natural.</div></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellHeight"> |
| <h3>cellHeight</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">DoubleProperty</span> <span class="element-name">cellHeight</span></div> |
| <div class="block">Height of all rows in the grid. |
| It shall be a number strictly greater than zero. |
| |
| <div class="note"><b>API note:</b> |
| We do not provide getter/setter for this property; use <code>WritableDoubleValue.set(double)</code> |
| directly instead. We omit the "Property" suffix for making this operation more natural.</div></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellSpacing"> |
| <h3>cellSpacing</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">DoubleProperty</span> <span class="element-name">cellSpacing</span></div> |
| <div class="block">Horizontal space between cells, as a number equals or greater than zero. |
| There is no property for vertical cell spacing because increasing the |
| <a href="#cellHeight">cell height</a> should be sufficient. |
| |
| <div class="note"><b>API note:</b> |
| We do not provide getter/setter for this property; use <code>WritableDoubleValue.set(double)</code> |
| directly instead. We omit the "Property" suffix for making this operation more natural.</div></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="headerBackground"> |
| <h3>headerBackground</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">ObjectProperty<Paint></span> <span class="element-name">headerBackground</span></div> |
| <div class="block">The background color of row and column headers. |
| |
| <div class="note"><b>API note:</b> |
| We do not provide getter/setter for this property; use <code>WritableObjectValue.set(Object)</code> |
| directly instead. We omit the "Property" suffix for making this operation more natural.</div></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>()"> |
| <h3>GridView</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">GridView</span>()</div> |
| <div class="block">Creates an initially empty grid view. The content can be set after |
| construction by a call to <a href="#setImage(java.awt.image.RenderedImage)"><code>setImage(RenderedImage)</code></a>.</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="getImage()"> |
| <h3>getImage</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.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a></span> <span class="element-name">getImage</span>()</div> |
| <div class="block">Returns the source of sample values for this table. |
| This method, like all other methods in this class, shall be invoked from the JavaFX thread.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the image shown in this table, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#imageProperty"><code>imageProperty</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setImage(java.awt.image.RenderedImage)"> |
| <h3>setImage</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">setImage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image" class="external-link">RenderedImage</a> image)</span></div> |
| <div class="block">Sets the image to show in this table. |
| This method shall be invoked from JavaFX thread and returns quickly; it does not attempt to fetch any tile. |
| Calls to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/image/RenderedImage.html#getTile(int,int)" title="class or interface in java.awt.image" class="external-link"><code>RenderedImage.getTile(int, int)</code></a> will be done in a background thread when first needed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>image</code> - the image to show in this table, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#imageProperty"><code>imageProperty</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setImage(org.apache.sis.gui.coverage.ImageRequest)"> |
| <h3>setImage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setImage</span><wbr><span class="parameters">(<a href="ImageRequest.html" title="class in org.apache.sis.gui.coverage">ImageRequest</a> source)</span></div> |
| <div class="block">Loads image 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.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>source</code> - the coverage or resource to load, or <code>null</code> if none.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="CoverageExplorer.html#setCoverage(org.apache.sis.gui.coverage.ImageRequest)"><code>CoverageExplorer.setCoverage(ImageRequest)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBand()"> |
| <h3>getBand</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getBand</span>()</div> |
| <div class="block">Returns the index of the band shown in this grid view.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>index of the currently visible band number.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#bandProperty"><code>bandProperty</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBand(int)"> |
| <h3>setBand</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">setBand</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Sets the number of the band to show in this grid view. |
| This value should be from 0 (inclusive) to the number of bands in the image (exclusive).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the band to make visible.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given band index is out of bounds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellFormatPattern()"> |
| <h3>cellFormatPattern</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/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><StringProperty></span> <span class="element-name">cellFormatPattern</span>()</div> |
| <div class="block">The property for the pattern of values in cells. Note that this pattern depends on current locale. |
| It is provided for user interactions (i.e. in a GUI control) instead of programmatic action.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the <em>localized</em> format pattern property, or an empty value if the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/NumberFormat.html" title="class or interface in java.text" class="external-link"><code>NumberFormat</code></a> |
| used for writing cell values is not an instance of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/DecimalFormat.html" title="class or interface in java.text" class="external-link"><code>DecimalFormat</code></a>.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/DecimalFormat.html#toLocalizedPattern()" title="class or interface in java.text" class="external-link"><code>DecimalFormat.toLocalizedPattern()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createDefaultSkin()"> |
| <h3>createDefaultSkin</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">Skin<<a href="GridView.html" title="class in org.apache.sis.gui.coverage">GridView</a>></span> <span class="element-name">createDefaultSkin</span>()</div> |
| <div class="block">Creates a new instance of the skin responsible for rendering this grid view. |
| From the perspective of this <code>Control</code>, the <code>Skin</code> is a black box. |
| It listens and responds to changes in state of this grid view. This method is |
| called if no skin is provided via CSS or <code>Control.setSkin(Skin)</code>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code>createDefaultSkin</code> in class <code>Control</code></dd> |
| <dt>Returns:</dt> |
| <dd>the renderer of this grid view.</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> |