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, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class IgnitionDesigner
extends com.jidesoft.action.DefaultDockableBarDockableHolder

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 static class	IgnitionDesigner.LoadedModule Holds a reference to each Module that is loaded up in the designer.
protected class	IgnitionDesigner.LoadGWName
protected class	IgnitionDesigner.UpdateTask

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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 and Description
protected IgnitionDesigner.Handler	handler Handles general events for the Designer
protected java.util.List<IgnitionDesigner.LoadedModule>	modules
protected boolean	notPublishedGlobalOnSave Already saved without publishing the Global Project
protected PublishDialog.PublishPref	publishPref Users preference for publishing global project resources (shared scripts)
protected NamedQueryWorkspace	queryWorkspace
protected ScriptWorkspaceManager	scriptWorkspaceManager
protected StatusBar	status The Status bar component displayed at the bottom of the designer

Fields inherited from class com.jidesoft.docking.DefaultDockableHolder

_autoDispose, _contentContainer, _dockingManager

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, 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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Method Summary

Modifier and Type	Method and Description
protected PublishDialog.PublishPref	askGlobalPublishPreference() Returns null if the dialog was closed with no preference chosen (a Cancel operation)
protected boolean	canPublishProject(GlobalProps global, User user)
protected boolean	canSaveProject(GlobalProps global, User user)
void	closeFrames()
ProjectExporter	export(java.util.Collection<java.lang.Long> resourceIds, ProjectScope scope) Exports the current global or local project, with only the given resources selected
ProjectExporter	export(ProjectScope scope) Exports the current global or local project, selecting all resources by default
ConnectionHealthListener	getConnectionHealthListener()
DesignerContext	getContext()
javax.swing.Action	getCopyAction()
protected AuthenticatedUser	getCurrentUser()
javax.swing.Action	getCutAction()
javax.swing.Action	getDeleteAction()
protected DesignerLocalizationManager	getDesignerLocalizationManager()
PersistentProperties	getDesignerPrefs()
javax.swing.Action	getExitAction()
javax.swing.Action	getExportAction()
static javax.swing.JFrame	getFrame() Returns the Top level frame for the application.
DesignerLocalizationManager	getLocalizationManager()
protected LoggerEx	getLogger()
java.util.List<ModuleInfo>	getModules()
NavTreePanel	getNavTreePanel()
OPCBrowserPanel	getOPCBrowserPanel()
javax.swing.Action	getPasteAction()
PropertyEditorDialog	getPropertyEditor()
QueryBrowser	getQueryBrowserPanel()
StatusBar	getStatusBar()
TagBrowserPanel	getTagBrowserPanel()
TagEditor	getTagEditor()
WorkspaceManager	getWorkspace()
protected boolean	handleSave(boolean saveAs, java.lang.String newName, boolean commitOnly, boolean skipReOpen) Serializes all open windows, and then saves project to gateway
protected void	initComponents()
protected void	initLocalPrefs()
void	loadProject(long id, boolean allowCancel) Loads the project with the given ID.
void	loadProject(Project project, Project globalProject, ProgressListener listener)
void	resetLayout()
protected Project	saveGlobalProjectToGateway(boolean publishGlobal)
protected void	setDesignerContext(DesignerContextImpl context)
void	setEditActionHandler(EditActionHandler eaHandler) Sets the currently focused edit action handler.
protected void	setScriptModuleEditor(ModuleEditor legacyEditor) Sets an instance of the legacy (pre-7.7) script module editor
protected void	showError(java.lang.Exception e)
protected void	showError(java.lang.String message)
protected void	showError(java.lang.String message, java.lang.Exception e)
void	showGlobalScriptEditor()
void	showProjectPropertyEditor()
void	showQueryBrowser()
void	showScriptModuleEditor()
void	showScriptPlayground()
void	showScriptWorkspace(java.lang.Boolean global)
void	showTranslationManager()
void	startup() Called by the DesignerStartupHook after the login has completed
protected void	updateDesignerScriptManager()
protected void	updateScriptModules() Called when pylib/ is updated

Methods inherited from class com.jidesoft.action.DefaultDockableBarDockableHolder

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

Methods inherited from class com.jidesoft.docking.DefaultDockableHolder

createDockingManager, 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, getPeer, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, 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 Detail

status

protected StatusBar status

The Status bar component displayed at the bottom of the designer

modules

protected java.util.List<IgnitionDesigner.LoadedModule> modules

handler

protected IgnitionDesigner.Handler handler

Handles general events for the Designer

scriptWorkspaceManager

protected ScriptWorkspaceManager scriptWorkspaceManager

queryWorkspace

protected NamedQueryWorkspace queryWorkspace

publishPref

protected PublishDialog.PublishPref publishPref

Users preference for publishing global project resources (shared scripts)

notPublishedGlobalOnSave

protected boolean notPublishedGlobalOnSave

Already saved without publishing the Global Project

Method Detail

getFrame

public static javax.swing.JFrame getFrame()

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

getConnectionHealthListener

public ConnectionHealthListener getConnectionHealthListener()

getLogger

protected LoggerEx getLogger()

startup

public void startup()

Called by the DesignerStartupHook after the login has completed

setDesignerContext

protected void setDesignerContext(DesignerContextImpl context)

initLocalPrefs

protected void initLocalPrefs()

initComponents

protected void initComponents()

resetLayout

public void resetLayout()

getModules

public java.util.List<ModuleInfo> getModules()

loadProject

public void loadProject(long id,
                        boolean allowCancel)
                 throws java.util.concurrent.CancellationException,
                        java.lang.Exception

Loads the project with the given ID. If the user cancels the action, a CancellationException is thrown.

Throws:

java.util.concurrent.CancellationException

java.lang.Exception

loadProject

public void loadProject(Project project,
                        Project globalProject,
                        ProgressListener listener)

closeFrames

public void closeFrames()

getContext

public DesignerContext getContext()

showScriptModuleEditor

public void showScriptModuleEditor()

showScriptWorkspace

public void showScriptWorkspace(java.lang.Boolean global)

showScriptPlayground

public void showScriptPlayground()

showQueryBrowser

public void showQueryBrowser()

showTranslationManager

public void showTranslationManager()

export

public ProjectExporter export(ProjectScope scope)

Exports the current global or local project, selecting all resources by default

export

public ProjectExporter export(java.util.Collection<java.lang.Long> resourceIds,
                              ProjectScope scope)

Exports the current global or local project, with only the given resources selected

showGlobalScriptEditor

public void showGlobalScriptEditor()

showProjectPropertyEditor

public void showProjectPropertyEditor()

getPropertyEditor

public PropertyEditorDialog getPropertyEditor()

showError

protected void showError(java.lang.String message)

handleSave

protected boolean handleSave(boolean saveAs,
                             java.lang.String newName,
                             boolean commitOnly,
                             boolean skipReOpen)
                      throws java.lang.Exception

Serializes all open windows, and then saves project to gateway

Parameters:

saveAs - if true, the project will be saved as another name. After the saveas is complete, a load will occur on that new project

newName - The new name if saveAs is true

commitOnly - if true, the project will go through the motions of saving, but not actually send the project to the server.

skipReOpen - if true, modules will not get notifyProjectSaveDone() called on their hooks. This is to not waste effort when doing a save-on-close.

Returns:

true if the save was completed, false if it was cancelled

Throws:

java.lang.Exception

showError

protected void showError(java.lang.Exception e)

showError

protected void showError(java.lang.String message,
                         java.lang.Exception e)

saveGlobalProjectToGateway

protected Project saveGlobalProjectToGateway(boolean publishGlobal)
                                      throws GatewayException

Throws:

GatewayException

getDesignerLocalizationManager

protected DesignerLocalizationManager getDesignerLocalizationManager()

canSaveProject

protected boolean canSaveProject(GlobalProps global,
                                 User user)

canPublishProject

protected boolean canPublishProject(GlobalProps global,
                                    User user)

getCurrentUser

protected AuthenticatedUser getCurrentUser()
                                    throws GatewayException

Throws:

GatewayException

updateDesignerScriptManager

protected void updateDesignerScriptManager()

updateScriptModules

protected void updateScriptModules()

Called when pylib/ is updated

getTagBrowserPanel

public TagBrowserPanel getTagBrowserPanel()

getOPCBrowserPanel

public OPCBrowserPanel getOPCBrowserPanel()

getTagEditor

public TagEditor getTagEditor()

getQueryBrowserPanel

public QueryBrowser getQueryBrowserPanel()

getStatusBar

public StatusBar getStatusBar()

getCutAction

public javax.swing.Action getCutAction()

getCopyAction

public javax.swing.Action getCopyAction()

getPasteAction

public javax.swing.Action getPasteAction()

getDeleteAction

public javax.swing.Action getDeleteAction()

getExportAction

public javax.swing.Action getExportAction()

getExitAction

public javax.swing.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()

getNavTreePanel

public NavTreePanel getNavTreePanel()

askGlobalPublishPreference

protected PublishDialog.PublishPref askGlobalPublishPreference()

Returns null if the dialog was closed with no preference chosen (a Cancel operation)

setScriptModuleEditor

protected void setScriptModuleEditor(ModuleEditor legacyEditor)

Sets an instance of the legacy (pre-7.7) script module editor