Package dataPlotsFX.spectrogramPlotFX

Class SpectrogramControlPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.BorderPane
pamViewFX.fxNodes.PamBorderPane
dataPlotsFX.spectrogramPlotFX.SpectrogramControlPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
Direct Known Subclasses:
Plot2DControPane
public class SpectrogramControlPane extends PamBorderPane
A general pane with a frequency slider, colour bar slider and colour combo box. These nodes are interconnected so when colour combo box is changed colours change. Other than that this pane does nothing but all slider value properties are available to be used in another class or subclass. This means this control pane should be available to be used for any spectrogram/3D colour image.
Author:
Jamie Macaulay

  • Property Summary

    Properties inherited from class javafx.scene.layout.BorderPane

    bottom, center, left, right, top

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    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

  • Field Summary

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpectrogramControlPane()
    Constructor for the spectrogram control pane.
    SpectrogramControlPane(javafx.geometry.Orientation orientation, boolean showComboColour, boolean showFreqSlider, boolean showColSlider)
    Constructor for the spectrogram control pane.
    SpectrogramControlPane(javafx.geometry.Orientation orientation, boolean showComboColour, boolean showFreqSlider, boolean showColSlider, boolean labels)
    Constructor for the spectrogram control pane.

  • Method Summary

    Modifier and Type
    Method
    Description
    ColorComboBox
    getColorBox()
    Get the colour combo box.
    ColourArray.ColourArrayType
    getColourArrayType()
    Get the current colourArrayType used.
    ColourRangeSlider
    getColourSlider()
    Get the colour range slider usually used to change limits of colour map;
    javafx.scene.control.Label
    getFreqLabel()
    Get the frequency label pane
    PamRangeSlider
    getFrequencySlider()
    Get the range slider, usually used to change frequency.
    double
    getHighValue()
    Convenience class to get high value from colour slider.
    double
    getLowValue()
    Convenience class to get low value from colour slider.
    javafx.scene.paint.Color
    getTrackColour()
    Get the track colour for the frequency slider.
    void
    setAmplitudeProperties(javafx.beans.property.DoubleProperty[] amplitudeLimits, double[] amplitudeRange)
    Set listeners, min max amplitude, amplitude low and high values.
    void
    setAmplitudeRange(double[] amplitudeLimits, double[] amplitudeMaxRange)
    Set the amplitude range of the colour slider.
    void
    setColourArrayType(ColourArray.ColourArrayType colourArrayType)
    Set the current colourArrayType used.
    void
    setColours()
    Set colours depending on current colour selection in combo box.

    Methods inherited from class pamViewFX.fxNodes.PamBorderPane

    setBottomSpace, setLeftSpace, setRightSpace, setTopSpace

    Methods inherited from class javafx.scene.layout.BorderPane

    bottomProperty, centerProperty, clearConstraints, getAlignment, getBottom, getCenter, getContentBias, getLeft, getMargin, getRight, getTop, leftProperty, rightProperty, setAlignment, setBottom, setCenter, setLeft, setMargin, setRight, setTop, topProperty

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPositionX, snapPositionY, snapSizeX, snapSizeY, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout

    Methods inherited from class javafx.scene.Node

    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, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, setEffect, setEventDispatcher, setFocusTraversable, 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, 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

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Constructor Details

    • SpectrogramControlPane

      public SpectrogramControlPane()
      Constructor for the spectrogram control pane.

    • SpectrogramControlPane

      public SpectrogramControlPane(javafx.geometry.Orientation orientation, boolean showComboColour, boolean showFreqSlider, boolean showColSlider)
      Constructor for the spectrogram control pane.
      Parameters:
      orientation - default orientation of the controls.
      showComboColour - true to show the colour selection combobox.
      showFreqSlider - true to show the frequency slider.
      showColSlider - true to show the colour scale slider.

    • SpectrogramControlPane

      public SpectrogramControlPane(javafx.geometry.Orientation orientation, boolean showComboColour, boolean showFreqSlider, boolean showColSlider, boolean labels)
      Constructor for the spectrogram control pane.
      Parameters:
      orientation - default orientation of the controls.
      showComboColour - true to show the colour selection combobox.
      showFreqSlider - true to show the frequency slider.
      showColSlider - true to show the colour scale slider.
      labels - label the sliders e.g. Frequency, Amplitude

  • Method Details

    • setColours

      public void setColours()
      Set colours depending on current colour selection in combo box.

    • getTrackColour

      public javafx.scene.paint.Color getTrackColour()
      Get the track colour for the frequency slider. This is based on the colour array shown in the colour slider.
      Returns:
      - the colour that the frequency slider should show.

    • getFrequencySlider

      public PamRangeSlider getFrequencySlider()
      Get the range slider, usually used to change frequency.
      Returns:
      range slider usually sued to change frequency.

    • getColourSlider

      public ColourRangeSlider getColourSlider()
      Get the colour range slider usually used to change limits of colour map;
      Returns:
      the colour range slider.

    • getColorBox

      public ColorComboBox getColorBox()
      Get the colour combo box. Used to change the colur sliders
      Returns:
      the colour combo box which controls spectrogram colour array.

    • getColourArrayType

      public ColourArray.ColourArrayType getColourArrayType()
      Get the current colourArrayType used.
      Returns:
      the current colourArrayType used.

    • setColourArrayType

      public void setColourArrayType(ColourArray.ColourArrayType colourArrayType)
      Set the current colourArrayType used.
      Parameters:
      the - current colourArrayType used.

    • getFreqLabel

      public javafx.scene.control.Label getFreqLabel()
      Get the frequency label pane

    • setAmplitudeProperties

      public void setAmplitudeProperties(javafx.beans.property.DoubleProperty[] amplitudeLimits, double[] amplitudeRange)
      Set listeners, min max amplitude, amplitude low and high values.
      Parameters:
      amplitudeLimits - . Double properties for amplitude limits. amplitudeLimits[0]=min amplitude (dB). amplitudeLimits[1]=max amplitude (dB)

    • setAmplitudeRange

      public void setAmplitudeRange(double[] amplitudeLimits, double[] amplitudeMaxRange)
      Set the amplitude range of the colour slider.
      Parameters:
      amplitudeLimits - - the amplitude values to set the slider min max to.
      maxAmplitudeLimits - - the range of amplitude limits of the colour bar.

    • getLowValue

      public double getLowValue()
      Convenience class to get low value from colour slider.
      Returns:
      the low value from the colour slider

    • getHighValue

      public double getHighValue()
      Convenience class to get high value from colour slider.
      Returns:
      the high value from the colour slider