Class SfcWorkspace
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.inductiveautomation.sfc.designer.workspace.SfcWorkspace
- All Implemented Interfaces:
Locatable, ResourceWorkspace, ImageObserver, MenuContainer, Serializable, Accessible
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcloseChart(ResourcePath resourceId) voidvoidcommitIfOpen(ResourcePath resourceId) Commits the chart if it's openvoidcommitOpenCharts(SaveContext save) Serializes any open charts.@Nullable ResourcePathReturns theResourcePathof whatever is actively open in this workspace.com.inductiveautomation.sfc.designer.workspace.SfcWorkspace.TabbedWorkspace.DelegateThe handler that responds to common edit actions, like cut, copy, paste, and deleteThis returns a mutable list on purpose.getKey()Returns a keyname for the workspace.getMenu()Returns a menu merge for the menu options that should be present when this workspace is active.getRpc()List<com.jidesoft.action.CommandBar> Returns the toolbars that will be added when this workspace is active.The component that makes up the workspace itself.booleanbooleanisOpen(ResourcePath resourceId) voidvoidCalled when the resource workspace will become the active workspace and will be displayed.voidCalled when the resource workspace will be swapped out for a different workspace.voidopenChart(ResourcePath resourcePath) voidresetFrames(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"voidvoidvoidvoidsetCurrentTool(IDesignTool newTool) voidsetSelectedItems(List<JComponent> newSelection) voidsetSelectedItems(JComponent... newSelection) Methods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, updateMethods inherited from class 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, validateTreeMethods inherited from class 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, transferFocusUpCycleMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface ResourceWorkspace
dispose
-
Field Details
-
KEY
- See Also:
-
-
Constructor Details
-
SfcWorkspace
-
-
Method Details
-
getCompilationFeedback
-
getRpc
-
getContext
-
openChart
-
commitIfOpen
Commits the chart if it's open- Throws:
Exception
-
commitOpenCharts
Serializes any open charts.- Parameters:
save- Save workspace, may be null.- Throws:
Exception
-
commitEditorFrame
public void commitEditorFrame() -
selectWelcomeTab
public void selectWelcomeTab() -
selectElementWithId
-
selectElementWithIds
-
isOpen
-
closeChart
-
getSelectedItems
-
getSelectedDesignPanel
-
getSelectedContainer
-
setSelectedItems
-
setSelectedItems
-
getCurrentTool
-
setCurrentTool
-
getSelectionTool
-
getDelegate
public com.inductiveautomation.sfc.designer.workspace.SfcWorkspace.TabbedWorkspace.Delegate getDelegate() -
getInnerWorkspace
-
getWorkspace
Description copied from interface:ResourceWorkspaceThe component that makes up the workspace itself. Must not be null- Specified by:
getWorkspacein interfaceResourceWorkspace
-
getKey
Description copied from interface:ResourceWorkspaceReturns a keyname for the workspace. Used by nav tree nodes to specify which workspace to switch to when they are selected.- Specified by:
getKeyin interfaceResourceWorkspace
-
getMenu
Description copied from interface:ResourceWorkspaceReturns a menu merge for the menu options that should be present when this workspace is active. May be null.- Specified by:
getMenuin interfaceResourceWorkspace
-
getToolbars
Description copied from interface:ResourceWorkspaceReturns the toolbars that will be added when this workspace is active. May be null or empty.- Specified by:
getToolbarsin interfaceResourceWorkspace
-
getFrames
This returns a mutable list on purpose. 3rd party folks inject their own frames into this list.- Specified by:
getFramesin interfaceResourceWorkspace
-
getEditActionHandler
Description copied from interface:ResourceWorkspaceThe handler that responds to common edit actions, like cut, copy, paste, and delete- Specified by:
getEditActionHandlerin interfaceResourceWorkspace
-
resetFrames
public void resetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager) Description copied from interface:ResourceWorkspaceProgrammatically set the options on the frames and bars that represent the workspace's "defaults"- Specified by:
resetFramesin interfaceResourceWorkspace
-
onActivation
public void onActivation()Description copied from interface:ResourceWorkspaceCalled when the resource workspace will become the active workspace and will be displayed.- Specified by:
onActivationin interfaceResourceWorkspace
-
onDeactivation
public void onDeactivation()Description copied from interface:ResourceWorkspaceCalled when the resource workspace will be swapped out for a different workspace.- Specified by:
onDeactivationin interfaceResourceWorkspace
-
isActiveWorkspace
public boolean isActiveWorkspace() -
getPalette
-
locate
-
getActiveResourcePath
Description copied from interface:ResourceWorkspaceReturns theResourcePathof whatever is actively open in this workspace.- Specified by:
getActiveResourcePathin interfaceResourceWorkspace- Returns:
- null if nothing is open.
-