com.inductiveautomation.factorypmi.application

Class FPMIApp

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

javax.swing.JDesktopPane

com.inductiveautomation.factorypmi.application.FPMIApp

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class FPMIApp
extends javax.swing.JDesktopPane

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FPMIApp.ShutdownEvent Javabean-style class used for the shutdown allowed script
static interface	FPMIApp.WindowInitializer Implementors of this class will be used to initialize a window right before its bindings are connected and started up.

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

javax.swing.JDesktopPane.AccessibleJDesktopPane

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

javax.swing.JLayeredPane.AccessibleJLayeredPane

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 and Description
static int	DEFAULT_QUERY_THREAD_COUNT
static int	DEFAULT_UPDATE_THREAD_COUNT
protected DiagnosticsDialog	diagnosticsDialog
protected PopupWindowParent	diagnosticsParent
static java.lang.String	TIMEZONE_CLIENT
static java.lang.String	TIMEZONE_GATEWAY

Fields inherited from class javax.swing.JDesktopPane

LIVE_DRAG_MODE, OUTLINE_DRAG_MODE

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

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

Constructor Summary

Constructors

Constructor and Description
FPMIApp(ClientContext context, int threadCount, int updateThreadCount) FHMIApp constructor.

Method Summary

Modifier and Type	Method and Description
void	addDesktopListener(DesktopListener l)
protected void	addImpl(java.awt.Component frame, java.lang.Object constraints, int layer)
void	applyDiff(Project diff, ProgressListener listener) Applies the given project as a diff.
static FPMIApp	createApp(ClientContext context, ProgressListener listener)
protected void	fireWindowEvent(FPMIWindow window, int eventType)
VisionClientContext	getAdapterContext()
FPMIDesktopManager.AxisPrecedence	getAxisPrecedence()
ClientContext	getClientContext()
ClientPanel	getClientPanel()
ClientDatasetUtilities	getDatasetUtil()
java.lang.String	getDefaultTimeZone()
FPMIFileUtilities	getFileUtil()
WindowUtilities	getGuiUtil()
static FPMIApp	getInstance() Deprecated.
long	getLastActivity()
LaunchContext	getLaunchContext()
ClientLocalizationManager	getLocalizationManager()
java.awt.Font	getMenuFont()
java.awt.Dimension	getMinSize()
NavUtilities	getNavUtil()
java.util.List<FPMIWindow>	getOpenedWindows() Returns a List<FHMIWindow> of all open windows
java.lang.String	getPath(FPMIWindow window)
PrintUtilities	getPrintUtil()
ProjectTagManager	getProjectTags()
ClientScriptConfig	getScriptConfig()
ScriptManager	getScriptManager()
SecurityUtilities	getSecurityUtil()
java.lang.String	getSelectedWindowTitle()
ClientSystemUtilities	getSystemUtil()
TemplateManager	getTemplateManager()
int	getThreadCount()
int	getUpdateBase()
int	getUpdateThreadCount()
FPMIWindow	getWindow(long id) Returns the opened window with resource id id.
FPMIWindow	getWindow(java.lang.String path) Returns the opened window of name name.
WindowCache	getWindowCache()
FPMIWindow[]	getWindows(long id) Returns all opened windows with the given resource id.
FPMIWindow[]	getWindows(java.lang.String path) Returns all opened windows with the given name.
boolean	isHideWindowsMenu()
boolean	isRestrictFloatingFrames()
boolean	isTouchscreenMode()
void	layoutDocks() This function verifies the layout of the docked windows, by checking to see if they are in the correct position, and moving/resizing them if necessary.
void	notifyWindowDeleted(long id) Removes (permanently) the window of the specified name.
javax.swing.RootPaneContainer	openWindow(long id)
javax.swing.RootPaneContainer	openWindow(java.lang.String path) Opens, or brings to front, the window with name name.
javax.swing.RootPaneContainer	openWindow(java.lang.String path, FPMIApp.WindowInitializer initializer)
javax.swing.RootPaneContainer	openWindow(java.lang.String path, FPMIApp.WindowInitializer initializer, boolean openAdditional)
void	paintComponent(java.awt.Graphics _g)
void	remove(java.awt.Component c)
void	removeDesktopListener(DesktopListener l)
void	setAxisPrecedence(FPMIDesktopManager.AxisPrecedence axisPrecedence)
void	setBackground(java.awt.Color bg)
void	setBounds(int x, int y, int w, int h)
void	setDefaultDSN(java.lang.String string) Deprecated.
void	setDefaultTimeZone(java.lang.String timezoneId)
void	setDeployParams(java.util.Map map) Deprecated.
void	setDesignImagePath(java.lang.String string) Deprecated.
void	setGateway(java.lang.String x)
void	setHideWindowsMenu(boolean hideWindowsMenu)
static void	setInstance(FPMIApp i) Sets the publicly accessible static FHMIApp instance
protected void	setLastActivity(long lastActivity)
void	setMenuFont(java.awt.Font menuFont)
void	setMinSize(java.awt.Dimension minSize)
void	setPaused(boolean paused)
void	setProjectTags(ProjectTagManager projectTags)
void	setRestrictFloatingFrames(boolean restrictFloatingFrames)
void	setScriptConfig(ClientScriptConfig newConfig, boolean install)
void	setSelectedWindowTitle(java.lang.String selectedWindowTitle)
void	setShowActiveThreads(boolean b) Deprecated.
void	setThreadCount(int i)
void	setTouchscreenMode(boolean touchscreenMode)
void	setUpdateBase(int i)
void	setUpdateThreadCount(int i)
void	setWindowOpener(WindowOpener windowOpener)
void	showFPMIDiagnostics()
void	shutdown(boolean runScript) Shuts down this FHMIApp gracefully.
boolean	shutdownAllowed() This function call's the applications shutdown allowed event handler, which can cancel the shutdown event, in which case this function will return false.
void	shutdownDesigner() Special version of shutdown for use in the designer.
void	startup(ClientPanel clientPanel, WindowStateCollection windowState, java.lang.String[] startupWindows, java.util.Map<java.lang.String,org.python.core.PyObject> params) Starts up the FPMIApp.
void	startupDesigner(java.util.TimeZone gatewayTimeZone)
java.lang.String	toString()

Methods inherited from class javax.swing.JDesktopPane

getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, paramString, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI

Methods inherited from class javax.swing.JLayeredPane

getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition

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, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, 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, 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, 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, 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, getPeer, 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, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUERY_THREAD_COUNT

public static final int DEFAULT_QUERY_THREAD_COUNT

See Also:

Constant Field Values

DEFAULT_UPDATE_THREAD_COUNT

public static final int DEFAULT_UPDATE_THREAD_COUNT

See Also:

Constant Field Values

TIMEZONE_GATEWAY

public static final java.lang.String TIMEZONE_GATEWAY

See Also:

Constant Field Values

TIMEZONE_CLIENT

public static final java.lang.String TIMEZONE_CLIENT

See Also:

Constant Field Values

diagnosticsDialog

protected DiagnosticsDialog diagnosticsDialog

diagnosticsParent

protected PopupWindowParent diagnosticsParent

Constructor Detail

FPMIApp

public FPMIApp(ClientContext context,
               int threadCount,
               int updateThreadCount)

FHMIApp constructor. Sets the semi-singleton static instance variable to this. Starts up the QueryManager. Starts up the ScriptManager.

See Also:

instance, QueryManager, ScriptManager

Method Detail

createApp

public static FPMIApp createApp(ClientContext context,
                                ProgressListener listener)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getClientContext

public ClientContext getClientContext()

applyDiff

public void applyDiff(Project diff,
                      ProgressListener listener)
               throws java.lang.Exception

Applies the given project as a diff. Should only be done when all windows are closed.

Parameters:

diff -

Throws:

java.lang.Exception

paintComponent

public void paintComponent(java.awt.Graphics _g)

Overrides:

paintComponent in class javax.swing.JComponent

setBounds

public void setBounds(int x,
                      int y,
                      int w,
                      int h)

Overrides:

setBounds in class java.awt.Component

setGateway

public void setGateway(java.lang.String x)

addImpl

protected void addImpl(java.awt.Component frame,
                       java.lang.Object constraints,
                       int layer)

Overrides:

addImpl in class javax.swing.JDesktopPane

remove

public void remove(java.awt.Component c)

Overrides:

remove in class javax.swing.JDesktopPane

layoutDocks

public void layoutDocks()

This function verifies the layout of the docked windows, by checking to see if they are in the correct position, and moving/resizing them if necessary.

notifyWindowDeleted

public void notifyWindowDeleted(long id)

Removes (permanently) the window of the specified name. All code for the window is deleted.

Parameters:

id -

startupDesigner

public void startupDesigner(java.util.TimeZone gatewayTimeZone)

startup

public void startup(ClientPanel clientPanel,
                    WindowStateCollection windowState,
                    java.lang.String[] startupWindows,
                    java.util.Map<java.lang.String,org.python.core.PyObject> params)

Starts up the FPMIApp. Should be called after the constructor if in run mode. This will run the startup jython script, and then open all startup windows, in that order.

shutdownAllowed

public boolean shutdownAllowed()

This function call's the applications shutdown allowed event handler, which can cancel the shutdown event, in which case this function will return false.

Returns:

shutdown

public void shutdown(boolean runScript)

Shuts down this FHMIApp gracefully. This will run the jython shutdown script, stop the time script manager, stop the query manager, and close all windows

shutdownDesigner

public void shutdownDesigner()

Special version of shutdown for use in the designer. Doesn't run the shutdown script, doesn't stop the singleton query manager (it will have already been re-created by virtue of a new project being opened), and doesn't close windows.

setPaused

public void setPaused(boolean paused)

getLocalizationManager

public ClientLocalizationManager getLocalizationManager()

openWindow

public javax.swing.RootPaneContainer openWindow(long id)

openWindow

public javax.swing.RootPaneContainer openWindow(java.lang.String path)

Opens, or brings to front, the window with name name.

Parameters:

path - the path of the window to open/select

Returns:

the window that was opened or selected.

openWindow

public javax.swing.RootPaneContainer openWindow(java.lang.String path,
                                                FPMIApp.WindowInitializer initializer)

openWindow

public javax.swing.RootPaneContainer openWindow(java.lang.String path,
                                                FPMIApp.WindowInitializer initializer,
                                                boolean openAdditional)

getWindow

public FPMIWindow getWindow(java.lang.String path)

Returns the opened window of name name. If there is no open window with the given name, null is returned.

Parameters:

path - The path of the window to find

Returns:

getPath

public java.lang.String getPath(FPMIWindow window)

getWindows

public FPMIWindow[] getWindows(java.lang.String path)

Returns all opened windows with the given name. Returns an empty array if there are none.

Parameters:

path -

Returns:

getWindow

public FPMIWindow getWindow(long id)

Returns the opened window with resource id id. If there is no open window with the given id, null is returned.

Parameters:

id -

Returns:

getWindows

public FPMIWindow[] getWindows(long id)

Returns all opened windows with the given resource id. Returns an empty array if there are none.

Parameters:

id -

Returns:

getOpenedWindows

public java.util.List<FPMIWindow> getOpenedWindows()

Returns a List<FHMIWindow> of all open windows

Returns:

addDesktopListener

public void addDesktopListener(DesktopListener l)

removeDesktopListener

public void removeDesktopListener(DesktopListener l)

fireWindowEvent

protected void fireWindowEvent(FPMIWindow window,
                               int eventType)

getWindowCache

public WindowCache getWindowCache()

getTemplateManager

public TemplateManager getTemplateManager()

toString

public java.lang.String toString()

Overrides:

toString in class java.awt.Component

getInstance

@Deprecated
public static FPMIApp getInstance()

Deprecated.

Returns the most recently created FHMIApp instance

setInstance

public static void setInstance(FPMIApp i)

Sets the publicly accessible static FHMIApp instance

Parameters:

i -

getThreadCount

public int getThreadCount()

setThreadCount

public void setThreadCount(int i)

setShowActiveThreads

@Deprecated
public void setShowActiveThreads(boolean b)

Deprecated.

For backwards compatability. This property no longer exists.

getUpdateThreadCount

public int getUpdateThreadCount()

setUpdateThreadCount

public void setUpdateThreadCount(int i)

setDesignImagePath

@Deprecated
public void setDesignImagePath(java.lang.String string)

Deprecated.

setDeployParams

@Deprecated
public void setDeployParams(java.util.Map map)

Deprecated.

getScriptConfig

public ClientScriptConfig getScriptConfig()

setScriptConfig

public void setScriptConfig(ClientScriptConfig newConfig,
                            boolean install)

getUpdateBase

public int getUpdateBase()

setUpdateBase

public void setUpdateBase(int i)

setDefaultDSN

@Deprecated
public void setDefaultDSN(java.lang.String string)

Deprecated.

Parameters:

string -

isTouchscreenMode

public boolean isTouchscreenMode()

setTouchscreenMode

public void setTouchscreenMode(boolean touchscreenMode)

getMenuFont

public java.awt.Font getMenuFont()

setMenuFont

public void setMenuFont(java.awt.Font menuFont)

setBackground

public void setBackground(java.awt.Color bg)

Overrides:

setBackground in class javax.swing.JComponent

isHideWindowsMenu

public boolean isHideWindowsMenu()

setHideWindowsMenu

public void setHideWindowsMenu(boolean hideWindowsMenu)

getMinSize

public java.awt.Dimension getMinSize()

setMinSize

public void setMinSize(java.awt.Dimension minSize)

setAxisPrecedence

public void setAxisPrecedence(FPMIDesktopManager.AxisPrecedence axisPrecedence)

getAxisPrecedence

public FPMIDesktopManager.AxisPrecedence getAxisPrecedence()

setRestrictFloatingFrames

public void setRestrictFloatingFrames(boolean restrictFloatingFrames)

isRestrictFloatingFrames

public boolean isRestrictFloatingFrames()

getLastActivity

public long getLastActivity()

setLastActivity

protected void setLastActivity(long lastActivity)

getDefaultTimeZone

public java.lang.String getDefaultTimeZone()

setDefaultTimeZone

public void setDefaultTimeZone(java.lang.String timezoneId)

getProjectTags

public ProjectTagManager getProjectTags()

setProjectTags

public void setProjectTags(ProjectTagManager projectTags)

getAdapterContext

public VisionClientContext getAdapterContext()

getScriptManager

public ScriptManager getScriptManager()

getNavUtil

public NavUtilities getNavUtil()

getGuiUtil

public WindowUtilities getGuiUtil()

getPrintUtil

public PrintUtilities getPrintUtil()

getDatasetUtil

public ClientDatasetUtilities getDatasetUtil()

getFileUtil

public FPMIFileUtilities getFileUtil()

getSecurityUtil

public SecurityUtilities getSecurityUtil()

getSelectedWindowTitle

public java.lang.String getSelectedWindowTitle()

setSelectedWindowTitle

public void setSelectedWindowTitle(java.lang.String selectedWindowTitle)

getLaunchContext

public LaunchContext getLaunchContext()

getSystemUtil

public ClientSystemUtilities getSystemUtil()

getClientPanel

public ClientPanel getClientPanel()

setWindowOpener

public void setWindowOpener(WindowOpener windowOpener)

showFPMIDiagnostics

public void showFPMIDiagnostics()