Package com.inductiveautomation.sfc.designer.workspace

Class SfcWorkspace

  • All Implemented Interfaces:
    ResourceWorkspace, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class SfcWorkspace
extends javax.swing.JPanel
implements ResourceWorkspace
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  SfcWorkspace.MonitoringListener  

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String KEY  

      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

      • Fields inherited from class java.awt.Component

        accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void closeChart​(ResourcePath resourceId)  
      void commitEditorFrame()  
      void commitIfOpen​(ResourcePath resourceId)
      Commits the chart if it's open
      void commitOpenCharts​(SaveContext save)
      Serializes any open charts.
      ChartControlPanel getCompilationFeedback()  
      DesignerContext getContext()  
      IDesignTool getCurrentTool()  
      com.inductiveautomation.sfc.designer.workspace.SfcWorkspace.TabbedWorkspace.Delegate getDelegate()  
      EditActionHandler getEditActionHandler()
      The handler that responds to common edit actions, like cut, copy, paste, and delete
      java.util.Collection<ResourceWorkspaceFrame> getFrames()
      This returns a mutable list on purpose.
      AbstractDesignableWorkspace getInnerWorkspace()  
      java.lang.String getKey()
      Returns a keyname for the workspace.
      MenuBarMerge getMenu()
      Returns a menu merge for the menu options that should be present when this workspace is active.
      SfcPalette getPalette()  
      SfcRpcFunctions getRpc()  
      SfcDesignableContainer getSelectedContainer()  
      DesignPanel getSelectedDesignPanel()  
      java.util.List<javax.swing.JComponent> getSelectedItems()  
      IDesignTool getSelectionTool()  
      java.util.List<com.jidesoft.action.CommandBar> getToolbars()
      Returns the toolbars that will be added when this workspace is active.
      javax.swing.JComponent getWorkspace()
      The component that makes up the workspace itself.
      boolean isActiveWorkspace()  
      boolean isOpen​(ResourcePath resourceId)  
      void onActivation()
      Called when the resource workspace will become the active workspace and will be displayed.
      void onDeactivation()
      Called when the resource workspace will be swapped out for a different workspace.
      void openChart​(ResourcePath resourcePath)  
      void resetFrames​(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager)
      Programmatically set the options on the frames and bars that represent the workspace's "defaults"
      void selectElementWithId​(java.util.UUID id)  
      void selectElementWithIds​(java.util.Collection<java.util.UUID> ids)  
      void selectWelcomeTab()  
      void setCurrentTool​(IDesignTool newTool)  
      void setSelectedItems​(java.util.List<javax.swing.JComponent> newSelection)  
      void setSelectedItems​(javax.swing.JComponent... newSelection)  

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • openChart

        public void openChart​(ResourcePath resourcePath)

      • commitIfOpen

        public void commitIfOpen​(ResourcePath resourceId)
                  throws java.lang.Exception
        Commits the chart if it's open
        Throws:
        java.lang.Exception

      • commitOpenCharts

        public void commitOpenCharts​(SaveContext save)
        Serializes any open charts.
        Parameters:
        save - Save workspace, may be null.

      • commitEditorFrame

        public void commitEditorFrame()

      • selectWelcomeTab

        public void selectWelcomeTab()

      • selectElementWithId

        public void selectElementWithId​(java.util.UUID id)

      • selectElementWithIds

        public void selectElementWithIds​(java.util.Collection<java.util.UUID> ids)

      • isOpen

        public boolean isOpen​(ResourcePath resourceId)

      • closeChart

        public void closeChart​(ResourcePath resourceId)

      • getSelectedItems

        public java.util.List<javax.swing.JComponent> getSelectedItems()

      • getSelectedDesignPanel

        public DesignPanel getSelectedDesignPanel()

      • setSelectedItems

        public void setSelectedItems​(java.util.List<javax.swing.JComponent> newSelection)

      • setSelectedItems

        public void setSelectedItems​(javax.swing.JComponent... newSelection)

      • setCurrentTool

        public void setCurrentTool​(IDesignTool newTool)

      • getSelectionTool

        public IDesignTool getSelectionTool()

      • getDelegate

        public com.inductiveautomation.sfc.designer.workspace.SfcWorkspace.TabbedWorkspace.Delegate getDelegate()

      • getWorkspace

        public javax.swing.JComponent getWorkspace()
        Description copied from interface: ResourceWorkspace
        The component that makes up the workspace itself. Must not be null
        Specified by:
        getWorkspace in interface ResourceWorkspace

      • getKey

        public java.lang.String getKey()
        Description copied from interface: ResourceWorkspace
        Returns a keyname for the workspace. Used by nav tree nodes to specify which workspace to switch to when they are selected.
        Specified by:
        getKey in interface ResourceWorkspace

      • getToolbars

        public java.util.List<com.jidesoft.action.CommandBar> getToolbars()
        Description copied from interface: ResourceWorkspace
        Returns the toolbars that will be added when this workspace is active. May be null or empty.
        Specified by:
        getToolbars in interface ResourceWorkspace

      • resetFrames

        public void resetFrames​(com.jidesoft.docking.DockingManager dockingManager,
                        com.jidesoft.action.DockableBarManager barManager)
        Description copied from interface: ResourceWorkspace
        Programmatically set the options on the frames and bars that represent the workspace's "defaults"
        Specified by:
        resetFrames in interface ResourceWorkspace

      • onActivation

        public void onActivation()
        Description copied from interface: ResourceWorkspace
        Called when the resource workspace will become the active workspace and will be displayed.
        Specified by:
        onActivation in interface ResourceWorkspace

      • onDeactivation

        public void onDeactivation()
        Description copied from interface: ResourceWorkspace
        Called when the resource workspace will be swapped out for a different workspace.
        Specified by:
        onDeactivation in interface ResourceWorkspace

      • isActiveWorkspace

        public boolean isActiveWorkspace()