Package com.inductiveautomation.factorypmi.designer.workspace

Class WindowWorkspace

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTabbedPane

com.jidesoft.swing.JideTabbedPane

com.inductiveautomation.ignition.designer.designable.AbstractDesignableWorkspace

com.inductiveautomation.ignition.designer.designable.DefaultDesignableWorkspace

com.inductiveautomation.factorypmi.designer.workspace.WindowWorkspace

All Implemented Interfaces:

ResourceWorkspace, ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class WindowWorkspace
extends DefaultDesignableWorkspace

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowWorkspace.DependencyViewMode	Defines the options available for drawing dependency arrows
class	WindowWorkspace.Handler

Nested classes/interfaces inherited from class com.jidesoft.swing.JideTabbedPane

com.jidesoft.swing.JideTabbedPane.ColorProvider, com.jidesoft.swing.JideTabbedPane.GradientColorProvider, com.jidesoft.swing.JideTabbedPane.IgnoreableSingleSelectionModel, com.jidesoft.swing.JideTabbedPane.NoFocusButton, com.jidesoft.swing.JideTabbedPane.PageLastFocusTracker, com.jidesoft.swing.JideTabbedPane.TabListCellRenderer

Nested classes/interfaces inherited from class javax.swing.JTabbedPane

JTabbedPane.AccessibleJTabbedPane, JTabbedPane.ModelListener

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final Object	COMMIT_HINT	Key object to use on a FPMIWindow.setClientProperty(COMMIT_HINT, boolean) before you close it to see if the window should be committed or not.
static final String	WINDOW_WORKSPACE_KEY

Fields inherited from class com.inductiveautomation.ignition.designer.designable.DefaultDesignableWorkspace

designerContext, rootLayerPanel

Fields inherited from class com.inductiveautomation.ignition.designer.designable.AbstractDesignableWorkspace

currentTool, DESIGNABLE_CONTAINER_ICON_KEY, DESIGNTIME_PROPNAME, listeners, log, openContainers, selectedItems, selectionControl, selectionTool

Fields inherited from class com.jidesoft.swing.JideTabbedPane

_focusChangeListener, _tabEditingAllowed, _tabEditValidator, BOLDACTIVETAB_PROPERTY, BOX_STYLE_PROPERTY, BUTTON_CLOSE, BUTTON_EAST, BUTTON_LIST, BUTTON_NORTH, BUTTON_SOUTH, BUTTON_WEST, COLOR_THEME_DEFAULT, COLOR_THEME_OFFICE2003, COLOR_THEME_VSNET, COLOR_THEME_WIN2K, COLOR_THEME_WINXP, GRIPPER_PROPERTY, HIDE_IF_ONE_TAB_PROPERTY, ONENOTE_COLOR_PROVIDER, PROPERTY_COLOR_THEME, PROPERTY_CONTENT_BORDER_INSETS, PROPERTY_DRAG_OVER_DISABLED, PROPERTY_SELECTED_INDEX, PROPERTY_SHOW_CLOSE_BUTTON_ON_MOUSE_OVER, PROPERTY_TAB_AREA_INSETS, PROPERTY_TAB_COLOR_PROVIDER, PROPERTY_TAB_INSETS, PROPERTY_TAB_LEADING_COMPONENT, PROPERTY_TAB_RESIZE_MODE, PROPERTY_TAB_SHAPE, PROPERTY_TAB_TRAILING_COMPONENT, RESIZE_MODE_COMPRESSED, RESIZE_MODE_DEFAULT, RESIZE_MODE_FIT, RESIZE_MODE_FIXED, RESIZE_MODE_NONE, SCROLL_TAB_ON_WHEEL_PROPERTY, SHAPE_BOX, SHAPE_DEFAULT, SHAPE_ECLIPSE, SHAPE_ECLIPSE3X, SHAPE_EXCEL, SHAPE_FLAT, SHAPE_OFFICE2003, SHAPE_ROUNDED_FLAT, SHAPE_ROUNDED_VSNET, SHAPE_VSNET, SHAPE_WINDOWS, SHAPE_WINDOWS_SELECTED, SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, SHOW_CLOSE_BUTTON_PROPERTY, SHOW_ICONS_PROPERTY, SHOW_TAB_AREA_PROPERTY, SHOW_TAB_BUTTONS_PROPERTY, SHOW_TAB_CONTENT_PROPERTY, SHRINK_TAB_PROPERTY, TAB_CLOSABLE_PROPERTY, USE_DEFAULT_SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, USE_DEFAULT_SHOW_ICONS_PROPERTY

Fields inherited from class javax.swing.JTabbedPane

changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
WindowWorkspace(VisionDesignerImpl ctx)

Method Summary

Modifier and Type	Method	Description
void	add(VisionContainer container, JComponent comp)	Method that adds the brand new component comp to the container.
protected void	close(DesignableContainer container)	Closes the DesignPanel for the given container, if it is open.
void	closeDesignable(DesignableContainer container)
void	commitAll(SaveContext save)	Commits each open designable container
void	commitDesignable(ResourcePath path)	Commits the window to the project.
void	deleteTopLevelContainer(ResourcePath id, boolean confirm)	Deletes the named window.
void	dispose()	Called when the workspace should be completely disposed.
void	doSelectAll(boolean byType, boolean entireWindow)
Optional<ResourcePath>	duplicateDesignable(ResourcePath path)	Duplicates the designable with the given id.
TopLevelContainer	findDesignableContainer(ResourcePath resourcePath)	Finds a DesignableContainer that is currently open for editing in this workspace.
JComponent	findDropTarget(List<JComponent> itemsUnderDrop, DropTargetDragEvent dtde)	Override to allow dropping onto items
int	getAcceptableDropActions(DropTargetDragEvent dtde)
DesignerContext	getDesignerContext()
CopyPasteHandler	getEditActionHandler()	The handler that responds to common edit actions, like cut, copy, paste, and delete
Collection<ResourceWorkspaceFrame>	getFrames()	Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace.
IDesignTool	getGradientTool()
IGridSettings	getGridSettings()	Returns the settings for the grid/guide/snapping system
WindowWorkspace.Handler	getHandler()
DesignableDelegate	getItemDelegate(DesignableContainer container)	Called to provide the DesignableDelegate that is appropriate for the given DesignableContainer
String	getKey()	Returns a keyname for the workspace.
LayoutManipulator	getLayoutManipulator()
MenuBarMerge	getMenu()	Returns a menu merge for the menu options that should be present when this workspace is active.
protected JPopupMenu	getPopupMenu(DesignPanel panel)
PropertyTablePanel	getPropertyTablePanel()
FPMIApp	getRoot()
TopLevelContainer	getSelectedContainer()	The currently selected designable container, or null if none is selected
JPopupMenu	getSelectionPopupMenu(List<JComponent> items)	Gives the workspace a chance to provide a popup menu for the currently selected items
List<com.jidesoft.action.CommandBar>	getToolbars()	Returns the toolbars that will be added when this workspace is active.
VisionDesignerImpl	getVisionDesigner()
JComponent	getWorkspace()	The component that makes up the workspace itself.
void	handleDoubleClick(Point p)	Called when the user double-clicks using the selection tool.
boolean	handleDrop(Object droppedOn, DropTargetDropEvent event)
void	handleEditClick(Point p)	Called when the user edit-clicks a component (clicks on an already selected component)
protected void	init()
void	initStartupPanel()
boolean	isZoomingEnabled()	Returns whether or not the zoom level of design panels can be altered.
protected LoggerEx	newLogger()
protected IDesignTool	newSelectionTool()
void	onActivation()	Called when the resource workspace will become the active workspace and will be displayed.
protected boolean	onBeforeClose(DesignableContainer container)	If the project isn't set as auto-commit, ask if they want to commit, and set the response in the COMMIT_HINT property.
void	onClose(DesignableContainer container)	Provides subclasses a chance to handle when a tab is closed
protected void	onCurrentToolChanged(IDesignTool oldTool, IDesignTool newTool)	Provides AbstractDesignableWorkspace subclasses a way to be notified when the design tool has been changed.
void	onDeactivation()	Called when the resource workspace will be swapped out for a different workspace.
void	onEditorPaint(DesignPanel panel, Graphics graphics)	Provides subclasses a chance to paint onto each tab's DesignPanel background
void	openTemplate(ResourcePath templateId)	Opens the template identified by the provided templateId.
void	openTemplate(ResourcePath templateId, VisionTemplate template)	Opens a deserialized template instance and ensures it gets initialized correctly for the designer
void	openTemplate(String templatePath)
void	openWindow(String path)	Opens window at path, and sets it as the selected object.
void	paintInteractionLayerHigh(Graphics2D g, DesignableContainer container)
void	paintInteractionLayerLow(Graphics2D g, DesignableContainer container)
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"
boolean	restrictMovementToParentBounds()
void	setOpenOnStart(ResourcePath windowId, boolean set)	Set whether or not this window is a startup window
void	shutdown()
void	toggleAboutWindow(ResourcePath path)	Will toggle the given window's about window status.
void	updateMouseLocation(int x, int y)	Called when the mouse moves over the design area.

Methods inherited from class com.inductiveautomation.ignition.designer.designable.DefaultDesignableWorkspace

getTabToolTip, setStatusMessage

Methods inherited from class com.inductiveautomation.ignition.designer.designable.AbstractDesignableWorkspace

addDesignableWorkspaceListener, createWorkspaceHomeTab, getCurrentTool, getEditorBackground, getOpenContainerCount, getSelectedDesignPanel, getSelectedItems, getSelectedItemsCount, getSelectionControl, getSelectionTool, getTabPopupMenu, isDesignTime, isOpen, isOpen, newDesignPanel, open, openArbitraryTab, removeDesignableWorkspaceListener, removeTab, setCurrentTool, setDesignTime, setSelectedContainer, setSelectedItems, setSelectedItems, setupWorkspaceHomeTab, toggleItemSelection, updateSelectionControl, updateStatusBarText

Methods inherited from class com.jidesoft.swing.JideTabbedPane

add, addNotify, addTabEditingListener, calculateTabListPopupPosition, cancelTabEditing, clearVisComp, createFocusChangeListener, createNoFocusButton, createTabList, createTabListPopup, editTabAt, fireStateChanged, fireTabEditing, getCloseAction, getColorTheme, getContentBorderInsets, getDefaultColorTheme, getDefaultTabResizeMode, getDefaultTabStyle, getDisplayTitleAt, getEditingTabIndex, getIconForTab, getLastFocusedComponent, getPageLastFocusTrackers, getResourceString, getSelectedTabFont, getStringConverter, getTabAlignment, getTabAreaInsets, getTabAtLocation, getTabColorProvider, getTabEditingListeners, getTabEditingValidator, getTabHeight, getTabInsets, getTabLeadingComponent, getTabListCellRenderer, getTabResizeMode, getTabShape, getTabTrailingComponent, getUI, getUIClassID, hasFocusComponent, hideTabListPopup, insertTab, isAutoFocusOnTabHideClose, isAutoRequestFocus, isBoldActiveTab, isCloseTabOnMouseMiddleButton, isDragOverDisabled, isHideOneTab, isHideTrailingWhileNoButtons, isLayoutTrailingComponentBeforeButtons, isRightClickSelect, isScrollSelectedTabOnWheel, isShowCloseButton, isShowCloseButtonOnMouseOver, isShowCloseButtonOnSelectedTab, isShowCloseButtonOnTab, isShowGripper, isShowIconsOnTab, isShowTabArea, isShowTabButtons, isShowTabContent, isSuppressSetSelectedIndex, isSuppressStateChangedEvents, isTabClosableAt, isTabEditing, isTabEditingAllowed, isTabEditingAllowed, isTabListPopupVisible, isTabShown, isUseDefaultShowCloseButtonOnTab, isUseDefaultShowIconsOnTab, moveSelectedTabTo, popupSelectedIndex, processMouseSelection, removeAll, removeNotify, removeTabAt, removeTabEditingListener, repaintContentBorder, repaintTabAreaAndContentBorder, requestFocusForVisibleComponent, resetDefaultCloseAction, scrollSelectedTabToVisible, setAutoFocusOnTabHideClose, setAutoRequestFocus, setBoldActiveTab, setCloseAction, setCloseTabOnMouseMiddleButton, setColorTheme, setComponentAt, setContentBorderInsets, setDragOverDisabled, setHideOneTab, setHideTrailingWhileNoButtons, setLayoutTrailingComponentBeforeButtons, setRightClickSelect, setScrollSelectedTabOnWheel, setSelectedIndex, setSelectedTabFont, setShowCloseButton, setShowCloseButtonOnMouseOver, setShowCloseButtonOnSelectedTab, setShowCloseButtonOnTab, setShowGripper, setShowIconsOnTab, setShowTabArea, setShowTabButtons, setShowTabContent, setStringConverter, setSuppressSetSelectedIndex, setSuppressStateChangedEvents, setTabAlignment, setTabAreaInsets, setTabClosableAt, setTabColorProvider, setTabEditingAllowed, setTabEditingValidator, setTabInsets, setTabLeadingComponent, setTabListCellRenderer, setTabResizeMode, setTabShape, setTabTrailingComponent, setUI, setUseDefaultShowCloseButtonOnTab, setUseDefaultShowIconsOnTab, showTabListPopup, stopTabEditing, updateUI

Methods inherited from class javax.swing.JTabbedPane

add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabComponentAt, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, indexOfTabComponent, isEnabledAt, paramString, remove, remove, removeChangeListener, setBackgroundAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setTabComponentAt, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, 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, 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

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, 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

Field Details

WINDOW_WORKSPACE_KEY

public static final String WINDOW_WORKSPACE_KEY

See Also:

• Constant Field Values

COMMIT_HINT

public static final Object COMMIT_HINT

Key object to use on a FPMIWindow.setClientProperty(COMMIT_HINT, boolean) before you close it to see if the window should be committed or not.

Constructor Details

WindowWorkspace

public WindowWorkspace(VisionDesignerImpl ctx)

Method Details

init

protected void init()

getPopupMenu

protected JPopupMenu getPopupMenu(DesignPanel panel)

initStartupPanel

public void initStartupPanel()

getDesignerContext

public DesignerContext getDesignerContext()

Overrides:

getDesignerContext in class DefaultDesignableWorkspace

getWorkspace

public 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

Overrides:

getWorkspace in class DefaultDesignableWorkspace

newSelectionTool

protected IDesignTool newSelectionTool()

Overrides:

newSelectionTool in class AbstractDesignableWorkspace

newLogger

protected LoggerEx newLogger()

Overrides:

newLogger in class AbstractDesignableWorkspace

getSelectedContainer

public TopLevelContainer getSelectedContainer()

Description copied from class: AbstractDesignableWorkspace

The currently selected designable container, or null if none is selected

Overrides:

getSelectedContainer in class AbstractDesignableWorkspace

isZoomingEnabled

public boolean isZoomingEnabled()

Description copied from class: AbstractDesignableWorkspace

Returns whether or not the zoom level of design panels can be altered. Default is always true.

Overrides:

isZoomingEnabled in class AbstractDesignableWorkspace

findDesignableContainer

public TopLevelContainer findDesignableContainer(ResourcePath resourcePath)

Description copied from class: AbstractDesignableWorkspace

Finds a DesignableContainer that is currently open for editing in this workspace.

Overrides:

findDesignableContainer in class AbstractDesignableWorkspace

Parameters:

resourcePath - The resource path of the resource container to look for

Returns:

The container with the given id and scope, or null if that resource isn't currently open.

onCurrentToolChanged

protected void onCurrentToolChanged(IDesignTool oldTool,
 IDesignTool newTool)

Description copied from class: AbstractDesignableWorkspace

Provides AbstractDesignableWorkspace subclasses a way to be notified when the design tool has been changed.

Overrides:

onCurrentToolChanged in class AbstractDesignableWorkspace

onBeforeClose

protected boolean onBeforeClose(DesignableContainer container)

If the project isn't set as auto-commit, ask if they want to commit, and set the response in the COMMIT_HINT property. Update the snapshot.

Overrides:

onBeforeClose in class AbstractDesignableWorkspace

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

Overrides:

onActivation in class DefaultDesignableWorkspace

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

Overrides:

onDeactivation in class DefaultDesignableWorkspace

onClose

public void onClose(DesignableContainer container)

Description copied from class: AbstractDesignableWorkspace

Provides subclasses a chance to handle when a tab is closed

Overrides:

onClose in class AbstractDesignableWorkspace

onEditorPaint

public void onEditorPaint(DesignPanel panel,
 Graphics graphics)

Description copied from class: AbstractDesignableWorkspace

Provides subclasses a chance to paint onto each tab's DesignPanel background

Overrides:

onEditorPaint in class AbstractDesignableWorkspace

getGridSettings

public IGridSettings getGridSettings()

Description copied from class: AbstractDesignableWorkspace

Returns the settings for the grid/guide/snapping system

Specified by:

getGridSettings in class AbstractDesignableWorkspace

getSelectionPopupMenu

public JPopupMenu getSelectionPopupMenu(List<JComponent> items)

Description copied from class: AbstractDesignableWorkspace

Gives the workspace a chance to provide a popup menu for the currently selected items

Overrides:

getSelectionPopupMenu in class AbstractDesignableWorkspace

updateMouseLocation

public void updateMouseLocation(int x,
 int y)

Description copied from class: AbstractDesignableWorkspace

Called when the mouse moves over the design area. Coordinates will be (-1, -1) when the mouse leaves the area.

Overrides:

updateMouseLocation in class AbstractDesignableWorkspace

getItemDelegate

public DesignableDelegate getItemDelegate(DesignableContainer container)

Description copied from class: AbstractDesignableWorkspace

Called to provide the DesignableDelegate that is appropriate for the given DesignableContainer

Specified by:

getItemDelegate in class AbstractDesignableWorkspace

restrictMovementToParentBounds

public boolean restrictMovementToParentBounds()

Overrides:

restrictMovementToParentBounds in class AbstractDesignableWorkspace

getAcceptableDropActions

public int getAcceptableDropActions(DropTargetDragEvent dtde)

Overrides:

getAcceptableDropActions in class AbstractDesignableWorkspace

findDropTarget

public JComponent findDropTarget(List<JComponent> itemsUnderDrop,
 DropTargetDragEvent dtde)

Description copied from class: AbstractDesignableWorkspace

Override to allow dropping onto items

Overrides:

findDropTarget in class AbstractDesignableWorkspace

handleDrop

public boolean handleDrop(Object droppedOn,
 DropTargetDropEvent event)

Overrides:

handleDrop in class AbstractDesignableWorkspace

handleDoubleClick

public void handleDoubleClick(Point p)

Description copied from class: AbstractDesignableWorkspace

Called when the user double-clicks using the selection tool.

Overrides:

handleDoubleClick in class AbstractDesignableWorkspace

handleEditClick

public void handleEditClick(Point p)

Description copied from class: AbstractDesignableWorkspace

Called when the user edit-clicks a component (clicks on an already selected component)

Overrides:

handleEditClick in class AbstractDesignableWorkspace

paintInteractionLayerLow

public void paintInteractionLayerLow(Graphics2D g,
 DesignableContainer container)

Overrides:

paintInteractionLayerLow in class AbstractDesignableWorkspace

paintInteractionLayerHigh

public void paintInteractionLayerHigh(Graphics2D g,
 DesignableContainer container)

Overrides:

paintInteractionLayerHigh in class AbstractDesignableWorkspace

getGradientTool

public IDesignTool getGradientTool()

getHandler

public WindowWorkspace.Handler getHandler()

shutdown

public void shutdown()

dispose

public void dispose()

Description copied from interface: ResourceWorkspace

Called when the workspace should be completely disposed.

commitAll

public void commitAll(SaveContext save)

Commits each open designable container

getRoot

public FPMIApp getRoot()

getVisionDesigner

public VisionDesignerImpl getVisionDesigner()

getKey

public 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.

getMenu

public MenuBarMerge getMenu()

Description copied from interface: ResourceWorkspace

Returns a menu merge for the menu options that should be present when this workspace is active. May be null.

getToolbars

public 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.

getFrames

public Collection<ResourceWorkspaceFrame> getFrames()

Description copied from interface: ResourceWorkspace

Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace. May be null or empty.

getEditActionHandler

public CopyPasteHandler getEditActionHandler()

Description copied from interface: ResourceWorkspace

The handler that responds to common edit actions, like cut, copy, paste, and delete

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"

getPropertyTablePanel

public PropertyTablePanel getPropertyTablePanel()

getLayoutManipulator

public LayoutManipulator getLayoutManipulator()

add

public void add(VisionContainer container,
 JComponent comp)

Method that adds the brand new component comp to the container.

Parameters:

container - Container for Component

comp - Component to add

openWindow

public void openWindow(String path)

Opens window at path, and sets it as the selected object. If this window is currently open, brings it to the front.

closeDesignable

public void closeDesignable(DesignableContainer container)

commitDesignable

public void commitDesignable(ResourcePath path)

Commits the window to the project. This means that the window is serialized and the serialized code is updated in the WindowCache's WindowInfo. Also updates the snapshot for the window.

duplicateDesignable

public Optional<ResourcePath> duplicateDesignable(ResourcePath path)

Duplicates the designable with the given id. If the window is open it is committed first. This works on closed windows (unlike doDuplicateSelection)

doSelectAll

public void doSelectAll(boolean byType,
 boolean entireWindow)

toggleAboutWindow

public void toggleAboutWindow(ResourcePath path)

Will toggle the given window's about window status. If another window is currently the about window, that window's about status will also be cleared.

setOpenOnStart

public void setOpenOnStart(ResourcePath windowId,
 boolean set)

Set whether or not this window is a startup window

deleteTopLevelContainer

public void deleteTopLevelContainer(ResourcePath id,
 boolean confirm)

Deletes the named window. If confirm=true, a confirmation box will be shown first

openTemplate

public void openTemplate(ResourcePath templateId)

Opens the template identified by the provided templateId. If the template is not already open, it deserializes and opens an instance of the template

openTemplate

public void openTemplate(ResourcePath templateId,
 VisionTemplate template)

Opens a deserialized template instance and ensures it gets initialized correctly for the designer

openTemplate

public void openTemplate(String templatePath)

close

protected void close(DesignableContainer container)

Description copied from class: AbstractDesignableWorkspace

Closes the DesignPanel for the given container, if it is open.

Overrides:

close in class AbstractDesignableWorkspace