Package pamViewFX.fxNodes.utilityPanes

Class GroupedSourcePaneFX

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.fxNodes.utilityPanes.SourcePaneFX
pamViewFX.fxNodes.utilityPanes.GroupedSourcePaneFX
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
public class GroupedSourcePaneFX extends SourcePaneFX
Pane which shows a combo box to select a parent data block and has channel check boxes which can be grouped.
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/interfaces inherited from class pamViewFX.fxNodes.utilityPanes.SourcePaneFX

    SourcePaneFX.SourceSelection

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    GROUP_ALL
     
    static final int
    GROUP_SINGLES
     
    static final int
    GROUP_USER
     

    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
    GroupedSourcePaneFX(Class sourceType, boolean hasChannels, boolean includeSubClasses, boolean autoGrouping)
     
    GroupedSourcePaneFX(String borderTitle, Class sourceType, boolean hasChannels, boolean includeSubClasses, boolean autoGrouping)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    countChannelGroups(int channelMap, int[] groupList)
     
    void
    enableGroupBoxes()
     
    int[]
    getChannelGroups()
     
    PamGridPane
    getChannelListPane()
    Get the channel list pane- this is the grid pane in which channels and combo boxes sit.
    javafx.scene.layout.Pane
    getChannelPane()
    The pane that holds the channels and the group settings.
    static int
    getGroupChannels(int group, int channelMap, int[] groupList)
     
    static int
    getGroupIndex(int groupMap, int channelMap, int[] groupList)
     
    int
    getGrouping()
     
    static String
    getGroupList(int group, int channelMap, int[] groupList)
     
    static int
    getGroupMap(int channelMap, int[] groupList)
    Creates a bitmap for the groups, the same idea as a channelmap.
    boolean
    getParams(GroupedSourceParameters params)
    Saves the values in the GUI to the passed parameters object
    PamGridPane
    getSourcePane()
    Get the grid pane which all main nodes.
    boolean
    isAutoGrouping()
     
    void
    setAutoGrouping(boolean autoGrouping)
     
    void
    setChannelGroups(int[] channelGroups)
     
    void
    setGrouping(int groupType)
     
    void
    setParams(GroupedSourceParameters params)
    Set the source pane parameters.

    Methods inherited from class pamViewFX.fxNodes.utilityPanes.SourcePaneFX

    addSelectionListener, addSource, addSourcePanelMonitor, addSourceType, clearExcludeList, excludeDataBlock, getBorderTitle, getChannelBoxes, getChannelLabel, getChannelList, getChannelValidator, getDataBlockBox, getLocalisationRequirements, getSource, getSourceCount, getSourceIndex, getSourceLongName, getSourceName, getSourceTypes, getTitleLabel, isAChannelSelected, isHasChannels, removeSource, removeSourcePanelMonitor, setBorderTitle, setChannelList, setDataBlockClassType, setEnabled, setEnabledWithChannels, setHasChannels, setLocalisationRequirements, setSource, setSource, setSourceIndex, setSourceList, setSourceList, setSourceToolTip, setTitleFont, sourceChanged

    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

  • Field Details

  • Constructor Details

    • GroupedSourcePaneFX

      public GroupedSourcePaneFX(Class sourceType, boolean hasChannels, boolean includeSubClasses, boolean autoGrouping)

    • GroupedSourcePaneFX

      public GroupedSourcePaneFX(String borderTitle, Class sourceType, boolean hasChannels, boolean includeSubClasses, boolean autoGrouping)

  • Method Details

    • setChannelGroups

      public void setChannelGroups(int[] channelGroups)

    • isAutoGrouping

      public boolean isAutoGrouping()

    • setAutoGrouping

      public void setAutoGrouping(boolean autoGrouping)

    • setGrouping

      public void setGrouping(int groupType)

    • enableGroupBoxes

      public void enableGroupBoxes()

    • getGrouping

      public int getGrouping()

    • getChannelGroups

      public int[] getChannelGroups()

    • setParams

      public void setParams(GroupedSourceParameters params)
      Set the source pane parameters.
      Parameters:
      params - the grouped source parameters to set.

    • getParams

      public boolean getParams(GroupedSourceParameters params)
      Saves the values in the GUI to the passed parameters object
      Parameters:
      params - object to save the GUI values into
      Returns:
      true.

    • getGroupMap

      public static int getGroupMap(int channelMap, int[] groupList)
      Creates a bitmap for the groups, the same idea as a channelmap. The groupList array that is passed is of length [numChannels], and each index holds the group number for that channel (e.g. if channel 3 is in group 5, groupList[3]=5). For channels that are not in a group, the groupList array will hold a -1.
      Parameters:
      channelMap - the channels that are available
      groupList - an array of length [numChannels] holding the group number for each channel
      Returns:

    • countChannelGroups

      public static int countChannelGroups(int channelMap, int[] groupList)

    • getGroupChannels

      public static int getGroupChannels(int group, int channelMap, int[] groupList)

    • getGroupList

      public static String getGroupList(int group, int channelMap, int[] groupList)

    • getGroupIndex

      public static int getGroupIndex(int groupMap, int channelMap, int[] groupList)

    • getSourcePane

      public PamGridPane getSourcePane()
      Get the grid pane which all main nodes.
      Returns:
      the main source pane.

    • getChannelListPane

      public PamGridPane getChannelListPane()
      Get the channel list pane- this is the grid pane in which channels and combo boxes sit.
      Returns:
      channel list pane

    • getChannelPane

      public javafx.scene.layout.Pane getChannelPane()
      The pane that holds the channels and the group settings.
      Returns:
      the channel pane.