Package pamViewFX

Class PamGuiFX

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.layout.Pane
javafx.scene.layout.StackPane
pamViewFX.PamGuiFX
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, PamViewInterface
public class PamGuiFX extends javafx.scene.layout.StackPane implements PamViewInterface
A pane which holds a set of tabs.
Author:
Jamie Macaulay

  • Property Summary

    Properties inherited from class javafx.scene.layout.StackPane

    alignment

    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 
    PamGuiFX.ToolBarPane
    Create the tool bar pane.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final double
    SIDE_PANE_PREF_WIDTH
    The preferred width of the side pane.

    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
    PamGuiFX(javafx.stage.Stage stage, PamGuiManagerFX pamGuiManagerFX)
     
    PamGuiFX(PamTabPane mainTabPane, javafx.stage.Stage stage, PamGuiManagerFX pamGuiManagerFX)
    Create a new PamGUIFX.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAllTabs(List<PamGuiTabFX> pamGuiTabFXs)
    Add tabs to the tab pane.
    void
    addControlledUnit(PamControlledUnit unit)
    Called whenever a pamcontrolled unit is added ot the model.
    DataModelPaneFX
    addDataModelTab()
    Add a tab for the data model.
    PamGuiTabFX
    addPamTab(TabInfo tabInfo, UserDisplayNodeFX content, boolean detachable)
    Convenience function to add a closable tab to the display with a new UserDisplayNodeFX.
    void
    addTab(PamGuiTabFX pamGuiTabFX)
    Add a tab to the tab pane.
    void
    enableGUIControl(boolean enable)
    Enable and disable the entire GUI.
    int
    getFrameNumber()
     
    JFrame
    getGuiFrame()
     
    PamLoadingPane
    getLoadPane()
    Get the load pane for the PamGuiFX- shows loading data and other status updates.
    int
    getNumTabs()
    Get the number of tabs currently open.
    PamGuiManagerFX
    getPamGuiManagerFX()
    Get the PamGuiManagerFX which controls the PamGuiF X
    PamGuiTabFX
    getPamTab(int i)
    Get a PamTabFX at a specified index
    PamVBox
    getSidePane()
    Get the side pane.
    PamGuiTabFX
    getTab(int i)
    Get a tab
    ArrayList<PamGuiTabFX>
    getTabs()
    Get all tabs for this PamGuiFX
    boolean
    isShowLoadMode()
    Check whether the frame is in mode showing loadpanes.
    void
    modelChanged(int changeType)
     
    void
    notifyLoadProgress(PamTaskUpdate pamTaskUpdate)
    Notify load progress.
    void
    pamEnded()
     
    void
    pamStarted()
     
    void
    removeControlledUnit(PamControlledUnit unit)
    Called whenever a controlled unit is removed.
    void
    removeInternalPane(UserDisplayNodeFX removeNode)
    Remove an internal pane if it is contained within any tabs within the PamGuiFX
    void
    renameTab(String selectedItem, int tabIndex)
    Rename a tab at a selected index.
    void
    selectTab(int j)
    Select a tab
    void
    setTitle(String title)
     
    void
    show()
    Show this PamGUIFX.
    void
    showControlledUnit(PamControlledUnit unit)
    Show the GUI for a specific controlled unit
    void
    showLoadingPane(boolean show)
    Show the PamLoadPnae- this shows the pane that contains progress bars for loading data.
    void
    showLoadMode(boolean loadMode)
    Change the GUI to show load mode.
    void
    showSidePane(boolean show)
    Show the side pane.

    Methods inherited from class javafx.scene.layout.StackPane

    alignmentProperty, clearConstraints, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, requestLayout, setAlignment, setAlignment, setMargin

    Methods inherited from class javafx.scene.layout.Pane

    getChildren

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, 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

    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

    • SIDE_PANE_PREF_WIDTH

      public static final double SIDE_PANE_PREF_WIDTH
      The preferred width of the side pane.
      See Also:

  • Constructor Details

    • PamGuiFX

      public PamGuiFX(PamTabPane mainTabPane, javafx.stage.Stage stage, PamGuiManagerFX pamGuiManagerFX)
      Create a new PamGUIFX.
      Parameters:
      mainTabPane - - the tabPane.
      stage - - the stage in which the PamGuiFX will reside.
      pamGuiManagerFX - - the GUI manager.

    • PamGuiFX

      public PamGuiFX(javafx.stage.Stage stage, PamGuiManagerFX pamGuiManagerFX)

  • Method Details

    • getLoadPane

      public PamLoadingPane getLoadPane()
      Get the load pane for the PamGuiFX- shows loading data and other status updates.
      Returns:
      the PamLoadingf Pane

    • show

      public void show()
      Show this PamGUIFX.

    • addPamTab

      public PamGuiTabFX addPamTab(TabInfo tabInfo, UserDisplayNodeFX content, boolean detachable)
      Convenience function to add a closable tab to the display with a new UserDisplayNodeFX.
      Parameters:
      content - - content to add to the tab. Can be null;
      name - - tab name.

    • addDataModelTab

      public DataModelPaneFX addDataModelTab()
      Add a tab for the data model.
      Parameters:
      dataModelPaneFX - - the data model

    • getTabs

      public ArrayList<PamGuiTabFX> getTabs()
      Get all tabs for this PamGuiFX
      Returns:
      list of tabs in the PamGuiFX

    • addTab

      public void addTab(PamGuiTabFX pamGuiTabFX)
      Add a tab to the tab pane.
      Parameters:
      pamGuiTabFX - - the tab to add

    • addAllTabs

      public void addAllTabs(List<PamGuiTabFX> pamGuiTabFXs)
      Add tabs to the tab pane.
      Parameters:
      pamGuiTabFX - - the tabs to add

    • getNumTabs

      public int getNumTabs()
      Get the number of tabs currently open.
      Returns:
      the number of tabs.

    • getTab

      public PamGuiTabFX getTab(int i)
      Get a tab
      Parameters:
      i - - tab index
      Returns:
      the ith PamGuiTab

    • selectTab

      public void selectTab(int j)
      Select a tab
      Parameters:
      j - - index

    • removeInternalPane

      public void removeInternalPane(UserDisplayNodeFX removeNode)
      Remove an internal pane if it is contained within any tabs within the PamGuiFX
      Parameters:
      removeNode - - remove the pane if it contains this node.

    • showLoadingPane

      public void showLoadingPane(boolean show)
      Show the PamLoadPnae- this shows the pane that contains progress bars for loading data.
      Parameters:
      show - - true to show pane.

    • showLoadMode

      public void showLoadMode(boolean loadMode)
      Change the GUI to show load mode.
      Parameters:
      loadMode - - true to show load mode.

    • notifyLoadProgress

      public void notifyLoadProgress(PamTaskUpdate pamTaskUpdate)
      Notify load progress.
      Parameters:
      pamTaskUpdate - - information on a thread which s currently doing some work.

    • pamStarted

      public void pamStarted()
      Specified by:
      pamStarted in interface PamViewInterface

    • pamEnded

      public void pamEnded()
      Specified by:
      pamEnded in interface PamViewInterface

    • modelChanged

      public void modelChanged(int changeType)
      Specified by:
      modelChanged in interface PamViewInterface

    • addControlledUnit

      public void addControlledUnit(PamControlledUnit unit)
      Description copied from interface: PamViewInterface
      Called whenever a pamcontrolled unit is added ot the model.
      Specified by:
      addControlledUnit in interface PamViewInterface
      Parameters:
      unit - - the added controlled unit.

    • removeControlledUnit

      public void removeControlledUnit(PamControlledUnit unit)
      Description copied from interface: PamViewInterface
      Called whenever a controlled unit is removed.
      Specified by:
      removeControlledUnit in interface PamViewInterface

    • showControlledUnit

      public void showControlledUnit(PamControlledUnit unit)
      Description copied from interface: PamViewInterface
      Show the GUI for a specific controlled unit
      Specified by:
      showControlledUnit in interface PamViewInterface
      Parameters:
      unit - -the controlled unit to show.

    • setTitle

      public void setTitle(String title)
      Specified by:
      setTitle in interface PamViewInterface

    • getFrameNumber

      public int getFrameNumber()
      Specified by:
      getFrameNumber in interface PamViewInterface
      Returns:
      Frame number used by the multiple GUI frames. All other objects, such as the model view should return invalid input: '<' 0.

    • getGuiFrame

      public JFrame getGuiFrame()
      Specified by:
      getGuiFrame in interface PamViewInterface

    • enableGUIControl

      public void enableGUIControl(boolean enable)
      Description copied from interface: PamViewInterface
      Enable and disable the entire GUI.
      Specified by:
      enableGUIControl in interface PamViewInterface
      Parameters:
      enable - - true to enable the GUI/

    • isShowLoadMode

      public boolean isShowLoadMode()
      Check whether the frame is in mode showing loadpanes.
      Returns:
      true if in load mode.

    • getPamGuiManagerFX

      public PamGuiManagerFX getPamGuiManagerFX()
      Get the PamGuiManagerFX which controls the PamGuiF X
      Returns:
      the PamGuiManagerFX

    • getPamTab

      public PamGuiTabFX getPamTab(int i)
      Get a PamTabFX at a specified index
      Parameters:
      i - - the index of the tab
      Returns:
      the tab at index i.

    • getSidePane

      public PamVBox getSidePane()
      Get the side pane. The side pane holds extra quick access controls for modules.
      Returns:
      the side pane.

    • showSidePane

      public void showSidePane(boolean show)
      Show the side pane. The side pane holds extra quick access controls for modules.
      Parameters:
      show - - true to show the pane.

    • renameTab

      public void renameTab(String selectedItem, int tabIndex)
      Rename a tab at a selected index.
      Parameters:
      selectedItem - - the new name
      tabIndex - - the tab index