Package pamViewFX.symbol

Class StandardSymbolModifierPane

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.BorderPane
pamViewFX.fxNodes.PamBorderPane
pamViewFX.symbol.SymbolModifierPane
pamViewFX.symbol.StandardSymbolModifierPane
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, DynamicSettings
Direct Known Subclasses:
DLSymbolOptionPane, PeakFreqOptionsPane
public class StandardSymbolModifierPane extends SymbolModifierPane
A symbol modifier pane that allows users to select a colour for symbol, symbol line and symbol shape.
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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    StandardSymbolModifierPane.ColorChooserPane
    The colour chooser pane allows users to select a colour for a symbol.
    class 
    StandardSymbolModifierPane.SymbolChooserControls
    The symbol chooser pane which allows users to select a particular property
    class 
    StandardSymbolModifierPane.SymbolChooserPane
    The symbol chooser pane which allows users to select a symbol type.

  • 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
    StandardSymbolModifierPane(SymbolModifier symbolModifer)
    Create a default set of check boxes that allow the user to select how they wish to alter t
    StandardSymbolModifierPane(SymbolModifier symbolModifer, javafx.geometry.Orientation orientation, boolean checkBox, int selectable)
    Create a standard symbol modifier pane.

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.scene.layout.Pane
    createSymbolPane(SymbolModifier symbolmodifier, javafx.geometry.Orientation orientaiton, boolean checkBox, int userSelectable)
    Create the pane for the symbol manager.
    StandardSymbolOptions
    getParams()
    Get the parameter for a symbol modifier.
    PamVBox
    getSymbolBox()
    Get the main holder pane.
    void
    getSymbolData(SymbolData symbolData)
    Set the symbol data based on the current panes.
    boolean
    isUseCheckBox()
    Check whether check boxes have been shown.
    void
    setDefaultFillOpacity(double opacity)
    Set the default opacity for selected colours from the colour picker.
    void
    setParams()
    Set the controls to show params in the symbol modifer.
    void
    setSymbolData(SymbolData symbolData)
    Set the symbol data based on the current panes.

    Methods inherited from class pamViewFX.symbol.SymbolModifierPane

    addSettingsListener, getSymbolModifier, isAllowNotify, notifySettingsListeners, paneInitialized, removeSettingsListener, setAllowNotify

    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

    • StandardSymbolModifierPane

      public StandardSymbolModifierPane(SymbolModifier symbolModifer)
      Create a default set of check boxes that allow the user to select how they wish to alter t
      Parameters:
      symbolModifer - - the symbol modifier.

    • StandardSymbolModifierPane

      public StandardSymbolModifierPane(SymbolModifier symbolModifer, javafx.geometry.Orientation orientation, boolean checkBox, int selectable)
      Create a standard symbol modifier pane. This shows the modifiable options such as fill, line, symbol and can also show user selectable options for each mod e.g. a colour selector for fill.
      Parameters:
      symbolModifer - - the symbol modifier
      orientation - - the orientation - VERTICAL or HORIZONTAL layout.
      checkBox - - true to show check boxes for each selectable option.
      selectable - - a bitmap of mod options in which to allow the user to manually select the colour/symbol etc. Set to zero for only check boxes.

  • Method Details

    • isUseCheckBox

      public boolean isUseCheckBox()
      Check whether check boxes have been shown. If not then it is assumed all mod options have been set to true.
      Returns:
      true of user selectable check boxes are shown

    • getParams

      public StandardSymbolOptions getParams()
      Description copied from class: SymbolModifierPane
      Get the parameter for a symbol modifier.
      Overrides:
      getParams in class SymbolModifierPane
      Returns:
      reference to the same symbol modifier but with params now changed.

    • setParams

      public void setParams()
      Description copied from class: SymbolModifierPane
      Set the controls to show params in the symbol modifer.
      Overrides:
      setParams in class SymbolModifierPane

    • createSymbolPane

      public javafx.scene.layout.Pane createSymbolPane(SymbolModifier symbolmodifier, javafx.geometry.Orientation orientaiton, boolean checkBox, int userSelectable)
      Create the pane for the symbol manager.
      Parameters:
      orientaiton - - the orientation of the pane.
      checkBox - - the selectable check box.
      selectable - - a bitmap of the symbol types that can be user selectable (0 for not user selectabnle)
      Returns:
      the pane.

    • getSymbolData

      public void getSymbolData(SymbolData symbolData)
      Set the symbol data based on the current panes.
      Parameters:
      symbolData - - the symbol data to set.

    • setSymbolData

      public void setSymbolData(SymbolData symbolData)
      Set the symbol data based on the current panes.
      Parameters:
      symbolData - - the symbol data to set.

    • getSymbolBox

      public PamVBox getSymbolBox()
      Get the main holder pane.
      Returns:
      the pane.

    • setDefaultFillOpacity

      public void setDefaultFillOpacity(double opacity)
      Set the default opacity for selected colours from the colour picker. The default opacity is the the opacity when a user selects a new colour. The user can alter this with advanced colour controls.
      Parameters:
      opacity - - the default opacity for fill colours.