Package com.inductiveautomation.ignition.designer

Class IgnitionDesigner

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

com.jidesoft.docking.DefaultDockableHolder

com.jidesoft.action.DefaultDockableBarDockableHolder

com.inductiveautomation.ignition.designer.IgnitionDesigner

All Implemented Interfaces:

com.jidesoft.action.DockableBarDockableHolder, com.jidesoft.action.DockableBarHolder, com.jidesoft.docking.DockableHolder, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public final class IgnitionDesigner
extends com.jidesoft.action.DefaultDockableBarDockableHolder

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	IgnitionDesigner.Handler	Handles registering for and delegating action and item events that the FPMIDesigner deals with, as well as managing some UI elements like the menu and toolbars
protected class	IgnitionDesigner.LoadGWName

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 String	PERSPECTIVE_MODULE_ID
static final String	VISION_MODULE_ID

Fields inherited from class com.jidesoft.docking.DefaultDockableHolder

_autoDispose, _contentContainer, _dockingManager

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

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

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Method Summary

Modifier and Type	Method	Description
protected com.jidesoft.docking.DockingManager	createDockingManager(Container container)
ProjectExporter	export()	Exports a project stack, selecting all resources by default
ProjectExporter	export(Collection<ResourcePath> resourceIds)	Exports the current project, with only the given resources selected
ProjectExporter	export(Collection<ResourcePath> resourceIds, boolean allowSendTo)
ConnectionHealthListener	getConnectionHealthListener()
DesignerContext	getContext()
Action	getCopyAction()
Action	getCutAction()
Action	getDeleteAction()
PersistentProperties	getDesignerPrefs()
Action	getExitAction()
Action	getExportAction()
static JFrame	getFrame()	Returns the Top level frame for the application.
GlobalScriptEditor	getGlobalScriptEditor()
DesignerLocalizationManager	getLocalizationManager()
NavTreePanel	getNavTreePanel()
OPCBrowserPanel	getOPCBrowserPanel()
Action	getPasteAction()
PropertyEditorDialog	getPropertyEditor()
QueryBrowser	getQueryBrowserPanel()
NamedQueryWorkspace	getQueryWorkspace()
Action	getRenameAction()
DesignerResourceEditManager	getResourceEditManager()
StatusBar	getStatusBar()
com.inductiveautomation.ignition.designer.tags.frame.TagBrowserFrame	getTagBrowserPanel()
TagEditor	getTagEditor()
WorkspaceManager	getWorkspace()
protected void	initComponents()
void	resetLayout()
protected void	setDesignerContext(DesignerContextImpl context)
void	setEditActionHandler(EditActionHandler eaHandler)	Sets the currently focused edit action handler.
protected void	showError(Exception e)
protected void	showError(String message)
protected void	showError(String message, Exception e)
void	showGlobalScriptEditor()	Deprecated. - prefer getGlobalScriptEditor() and open() instead.
void	showProjectPropertyEditor()
void	showScriptModuleEditor()
void	startup()	Called by the DesignerStartupHook after the login has completed
void	updateProject()	Perform a pull to update project resources
void	updateScriptPlayground()

Methods inherited from class com.jidesoft.action.DefaultDockableBarDockableHolder

createContentContainer, createDockableBarManager, dispose, getDockableBarManager, getJMenuBar, getLayoutPersistence, initFrame

Methods inherited from class com.jidesoft.docking.DefaultDockableHolder

getDockingManager, isAutoDispose, isContentPaneCheckingEnabled, setAutoDispose, setContentPaneCheckingEnabled

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.docking.DockableHolder

getDockingManager

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Details

VISION_MODULE_ID

public static final String VISION_MODULE_ID

See Also:

• Constant Field Values

PERSPECTIVE_MODULE_ID

public static final String PERSPECTIVE_MODULE_ID

See Also:

• Constant Field Values

Method Details

createDockingManager

protected com.jidesoft.docking.DockingManager createDockingManager(Container container)

Overrides:

createDockingManager in class com.jidesoft.docking.DefaultDockableHolder

getFrame

public static JFrame getFrame()

Returns the Top level frame for the application. This is useful for popping up option panes.

getConnectionHealthListener

public ConnectionHealthListener getConnectionHealthListener()

startup

public void startup()

Called by the DesignerStartupHook after the login has completed

setDesignerContext

protected void setDesignerContext(DesignerContextImpl context)

initComponents

protected void initComponents()

resetLayout

public void resetLayout()

updateProject

public void updateProject()

Perform a pull to update project resources

getContext

public DesignerContext getContext()

showScriptModuleEditor

public void showScriptModuleEditor()

export

@Nullable
public ProjectExporter export()

Exports a project stack, selecting all resources by default

export

public ProjectExporter export(Collection<ResourcePath> resourceIds)

Exports the current project, with only the given resources selected

export

public ProjectExporter export(Collection<ResourcePath> resourceIds,
 boolean allowSendTo)

showGlobalScriptEditor

@Deprecated(since="8.1.8")
public void showGlobalScriptEditor()

Deprecated.

- prefer getGlobalScriptEditor() and open() instead.

getGlobalScriptEditor

public GlobalScriptEditor getGlobalScriptEditor()

showProjectPropertyEditor

public void showProjectPropertyEditor()

getPropertyEditor

public PropertyEditorDialog getPropertyEditor()

showError

protected void showError(String message)

showError

protected void showError(Exception e)

showError

protected void showError(String message,
 Exception e)

updateScriptPlayground

public void updateScriptPlayground()

getTagBrowserPanel

public com.inductiveautomation.ignition.designer.tags.frame.TagBrowserFrame getTagBrowserPanel()

getOPCBrowserPanel

public OPCBrowserPanel getOPCBrowserPanel()

getTagEditor

public TagEditor getTagEditor()

getQueryBrowserPanel

public QueryBrowser getQueryBrowserPanel()

getStatusBar

public StatusBar getStatusBar()

getResourceEditManager

public DesignerResourceEditManager getResourceEditManager()

getCutAction

public Action getCutAction()

getCopyAction

public Action getCopyAction()

getPasteAction

public Action getPasteAction()

getDeleteAction

public Action getDeleteAction()

getRenameAction

public Action getRenameAction()

getExportAction

public Action getExportAction()

getExitAction

public Action getExitAction()

getDesignerPrefs

public PersistentProperties getDesignerPrefs()

getLocalizationManager

public DesignerLocalizationManager getLocalizationManager()

setEditActionHandler

public void setEditActionHandler(EditActionHandler eaHandler)

Sets the currently focused edit action handler.

getWorkspace

public WorkspaceManager getWorkspace()

getQueryWorkspace

public NamedQueryWorkspace getQueryWorkspace()

getNavTreePanel

public NavTreePanel getNavTreePanel()