Package com.inductiveautomation.factorypmi.application

Class FPMIApp

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class FPMIApp
extends VisionDesktop
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FPMIApp.ShutdownEvent
      Javabean-style class used for the shutdown allowed script

      • 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 Description
      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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static FPMIApp createApp​(ClientContext context, ProgressListener listener)  
      ClientPanel getClientPanel()  
      ClientDatasetUtilities getDatasetUtil()  
      java.lang.String getDefaultTimeZone()  
      SecondaryDesktops getDesktops()  
      FPMIFileUtilities getFileUtil()  
      static FPMIApp getInstance()
      Deprecated.
      long getLastActivity()  
      LaunchContext getLaunchContext()  
      ClientLocalizationManager getLocalizationManager()  
      java.awt.Font getMenuFont()  
      PrintUtilities getPrintUtil()  
      ProjectTagManager getProjectTags()  
      ClientScriptConfig getScriptConfig()  
      SecondaryDesktops getSecondaryDesktops()  
      SecurityUtilities getSecurityUtil()  
      ClientSystemUtilities getSystemUtil()  
      TemplateManager getTemplateManager()  
      protected VisionClientContext initContext​(ClientContext context)
      Called from super's contsructor to initialize the vision client context field
      boolean isHideWindowsMenu()  
      boolean isTouchscreenMode()  
      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)
      Deprecated.
      void setHideWindowsMenu​(boolean hideWindowsMenu)  
      static void setInstance​(FPMIApp i)
      Sets the publicly accessible static FPMIApp instance
      void setMenuFont​(java.awt.Font menuFont)  
      void setPaused​(boolean paused)  
      void setProjectTags​(ProjectTagManager projectTags)  
      void setScriptConfig​(ClientScriptConfig newConfig, boolean install)  
      void setShowActiveThreads​(boolean b)
      Deprecated.
      void setThreadCount​(int i)
      Deprecated.
      void setTouchscreenMode​(boolean touchscreenMode)  
      void setUpdateBase​(int i)  
      void setUpdateThreadCount​(int i)
      Deprecated.
      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()  
      void updateResources​(java.util.List<? extends ChangeOperation> changes, ProgressListener listener)
      Applies the resource changes.

      • 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, 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, 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, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

    • Method Detail

      • updateResources

        public void updateResources​(java.util.List<? extends ChangeOperation> changes,
                            ProgressListener listener)
                     throws java.lang.Exception
        Applies the resource changes. Should only be done when all windows are closed. For that reason we call in manually when we know that's true, instead of just making FPMIApp a project listener.
        Throws:
        java.lang.Exception

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

      • 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
        Overrides:
        shutdown in class VisionDesktop

      • 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)

      • 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 FPMIApp instance

      • setInstance

        public static void setInstance​(FPMIApp i)
        Sets the publicly accessible static FPMIApp instance

      • setThreadCount

        @Deprecated
public void setThreadCount​(int i)
        Deprecated.

      • setShowActiveThreads

        @Deprecated
public void setShowActiveThreads​(boolean b)
        Deprecated.

      • setUpdateThreadCount

        @Deprecated
public void setUpdateThreadCount​(int i)
        Deprecated.

      • setGateway

        @Deprecated
public void setGateway​(java.lang.String x)
        Deprecated.

      • setDesignImagePath

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

      • setDeployParams

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

      • setScriptConfig

        public void setScriptConfig​(ClientScriptConfig newConfig,
                            boolean install)

      • setUpdateBase

        public void setUpdateBase​(int i)

      • setDefaultDSN

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

      • isTouchscreenMode

        public boolean isTouchscreenMode()

      • setTouchscreenMode

        public void setTouchscreenMode​(boolean touchscreenMode)

      • getMenuFont

        public java.awt.Font getMenuFont()

      • setMenuFont

        public void setMenuFont​(java.awt.Font menuFont)

      • isHideWindowsMenu

        public boolean isHideWindowsMenu()

      • setHideWindowsMenu

        public void setHideWindowsMenu​(boolean hideWindowsMenu)

      • getLastActivity

        public long getLastActivity()

      • getDefaultTimeZone

        public java.lang.String getDefaultTimeZone()

      • setDefaultTimeZone

        public void setDefaultTimeZone​(java.lang.String timezoneId)

      • showFPMIDiagnostics

        public void showFPMIDiagnostics()