Package com.inductiveautomation.factorypmi.application

Class FPMIWindow

  • All Implemented Interfaces:
    BindingRoot, DesignableContainer, TopLevelContainer, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    public class FPMIWindow
extends javax.swing.JInternalFrame
implements TopLevelContainer
    Each window in the Vision module is an instance of this class.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FPMIWindow.DoNotOpenWindow  

      • Nested classes/interfaces inherited from class javax.swing.JInternalFrame

        javax.swing.JInternalFrame.AccessibleJInternalFrame, javax.swing.JInternalFrame.JDesktopIcon

      • 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
      static int CACHE_ALWAYS  
      static int CACHE_AUTO  
      static int CACHE_NEVER  
      static int DOCK_EAST  
      static int DOCK_FLOAT  
      static int DOCK_NORTH  
      static int DOCK_SOUTH  
      static int DOCK_WEST  
      protected javax.swing.event.EventListenerList listenerList  
      protected LocaleListener localeListener  
      static java.lang.String PARENT_WINDOW_NAME
      Special string that will resolve to the FPMIWindow itself for calls to getComponentForPath() and getPathForComponent()
      static int SHOW_ALWAYS  
      static int SHOW_NEVER  
      static int SHOW_NOT_MAXIMIZED  

      • Fields inherited from class javax.swing.JInternalFrame

        closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

      • Fields inherited from class javax.swing.JComponent

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

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Constructor Summary

      Constructors 
      Constructor Description
      FPMIWindow​(java.lang.String name)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addVisionWindowListener​(VisionWindowListener listener)  
      void createRef​(java.lang.Object o)  
      void doDefaultCloseAction()  
      void fireVisionWindowClosed()  
      void fireVisionWindowOpened()  
      VisionClientContext getAppContext()  
      int getBorderDisplayPolicy()  
      java.awt.Insets getBorderInsets()
      Returns an Insets object that represents the normal size of borders/titlebar area that will appear on this window when it is opened.
      int getCachePolicy()  
      javax.swing.JComponent getComponentForPath​(java.lang.String path)  
      int getDockIndex()  
      int getDockPosition()  
      InteractionController getInteractionController()  
      java.awt.Component getMostRecentFocusOwner()
      This causes the window to make sure that NO COMPONENT receives input focus when the window is selected.
      java.lang.String getPath()  
      java.lang.String getPathForComponent​(java.awt.Component c)  
      ResourcePath getResourcePath()  
      BasicContainer getRootContainer()  
      java.awt.Component getRuntimeGlassPane()  
      java.awt.Point getStartingLocation()  
      javax.swing.JComponent getTitleBar()  
      int getTitlebarDisplayPolicy()  
      java.awt.Font getTitlebarFont()  
      int getTitlebarHeight()  
      VisionWindowListener[] getVisionWindowListeners()  
      void initialize​(VisionClientContext context)
      Initialize this root.
      static void initializeUIRoot​(VisionClientContext context, DefaultInteractionController interactions, VisionContainer rootContainer, boolean bindInitVisitRoot, LoggerEx log)  
      boolean isRunning()
      Returns true if this BindingRoot is considered to be "running".
      boolean isStartMaximized()  
      void removeVisionWindowListener​(VisionWindowListener listener)  
      void setBorderDisplayPolicy​(int borderDisplayPolicy)  
      void setCachePolicy​(int cachePolicy)  
      void setCloser​(WindowCloser closer)  
      void setContentPane​(java.awt.Container c)  
      void setDockIndex​(int dockIndex)  
      void setDockPosition​(int newPosition)  
      void setGeneralAdapters​(java.util.HashMap<java.awt.Component,​java.util.List<Adapter>> map)
      Deprecated.
      void setIconifiable​(boolean b)  
      void setInteractionController​(InteractionController controller)  
      void setLayer​(java.lang.Integer layer)  
      void setMaximizable​(boolean b)  
      void setNameBypass​(java.lang.String name)  
      void setOpenOnStart​(boolean b)
      Deprecated.
      void setPropertyAdapters​(java.util.HashMap<PropertyKey,​PropertyAdapter> map)
      Deprecated.
      void setResizable​(boolean b)  
      void setResourcePath​(ResourcePath resourcePath)  
      void setRuntimeGlassPane​(java.awt.Component component)  
      void setSecuritySettings​(java.lang.String name, SecuritySettings settings)
      Deprecated.
      void setSerializationVersion​(int i)
      Deprecated.
      void setSize​(java.awt.Dimension newSize)  
      void setStartingLocation​(java.awt.Point newLocation)  
      void setStartMaximized​(boolean b)  
      void setTitle​(java.lang.String title)  
      void setTitlebarDisplayPolicy​(int titlebarDisplayPolicy)  
      void setTitlebarFont​(java.awt.Font titlebarFont)  
      void setTitlebarHeight​(int titlebarHeight)  
      void shutdown()
      Shutdown the root.
      void startup()
      Start up the root.
      java.lang.String toString()  
      void updateUI()  
      boolean wouldBeResizable()  

      • Methods inherited from class javax.swing.JInternalFrame

        addImpl, addInternalFrameListener, createRootPane, dispose, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLastCursor, getLayer, getLayeredPane, getMenuBar, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setJMenuBar, setLayer, setLayeredPane, setLayout, setMaximum, setMenuBar, setNormalBounds, setRootPane, setRootPaneCheckingEnabled, setSelected, setUI, show, toBack, toFront

      • 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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

        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, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FPMIWindow

        public FPMIWindow​(java.lang.String name)

    • Method Detail

      • setCloser

        public void setCloser​(WindowCloser closer)

      • doDefaultCloseAction

        public void doDefaultCloseAction()
        Overrides:
        doDefaultCloseAction in class javax.swing.JInternalFrame

      • setSerializationVersion

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

      • createRef

        public void createRef​(java.lang.Object o)

      • setLayer

        public void setLayer​(java.lang.Integer layer)
              throws org.python.core.PyIgnoreMethodTag
        Overrides:
        setLayer in class javax.swing.JInternalFrame
        Throws:
        org.python.core.PyIgnoreMethodTag

      • getPath

        public java.lang.String getPath()

      • getBorderInsets

        public java.awt.Insets getBorderInsets()
        Returns an Insets object that represents the normal size of borders/titlebar area that will appear on this window when it is opened.

      • getMostRecentFocusOwner

        public java.awt.Component getMostRecentFocusOwner()
        This causes the window to make sure that NO COMPONENT receives input focus when the window is selected.
        Overrides:
        getMostRecentFocusOwner in class javax.swing.JInternalFrame

      • updateUI

        public void updateUI()
        Overrides:
        updateUI in class javax.swing.JInternalFrame

      • setContentPane

        public void setContentPane​(java.awt.Container c)
        Specified by:
        setContentPane in interface javax.swing.RootPaneContainer
        Overrides:
        setContentPane in class javax.swing.JInternalFrame

      • startup

        public void startup()
        Description copied from interface: BindingRoot
        Start up the root. Start-up adapters, and start-up any children ComponentLifecycles.
        Specified by:
        startup in interface BindingRoot

      • shutdown

        public void shutdown()
        Description copied from interface: BindingRoot
        Shutdown the root. Shut-down adapters, and shut-down any children ComponentLifecycles.
        Specified by:
        shutdown in interface BindingRoot

      • isRunning

        public boolean isRunning()
        Description copied from interface: BindingRoot
        Returns true if this BindingRoot is considered to be "running". Typically, this means that its initialized and has been started and hasn't been shutdown.
        Specified by:
        isRunning in interface BindingRoot

      • setNameBypass

        public void setNameBypass​(java.lang.String name)

      • setTitle

        public void setTitle​(java.lang.String title)
        Overrides:
        setTitle in class javax.swing.JInternalFrame

      • getRuntimeGlassPane

        public java.awt.Component getRuntimeGlassPane()

      • setRuntimeGlassPane

        public void setRuntimeGlassPane​(java.awt.Component component)

      • getTitleBar

        public javax.swing.JComponent getTitleBar()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.awt.Component

      • setOpenOnStart

        @Deprecated
public void setOpenOnStart​(boolean b)
        Deprecated.
        This function is no longer used, it is for backwards compatibility so that older serialized classes don't break

      • setPropertyAdapters

        @Deprecated
public void setPropertyAdapters​(java.util.HashMap<PropertyKey,​PropertyAdapter> map)
        Deprecated.
        Only here for backwards compatibility with old serialized windows. Deprecated in 7.4.

      • setGeneralAdapters

        @Deprecated
public void setGeneralAdapters​(java.util.HashMap<java.awt.Component,​java.util.List<Adapter>> map)
        Deprecated.
        Only here for backwards compatibility with old serialized windows. Deprecated in 7.4.

      • getPathForComponent

        public java.lang.String getPathForComponent​(java.awt.Component c)
        Specified by:
        getPathForComponent in interface BindingRoot

      • getComponentForPath

        public javax.swing.JComponent getComponentForPath​(java.lang.String path)
        Specified by:
        getComponentForPath in interface BindingRoot

      • setSecuritySettings

        @Deprecated
public void setSecuritySettings​(java.lang.String name,
                                SecuritySettings settings)
        Deprecated.
        Only here for backwards compatability with old serialized windows.

      • isStartMaximized

        public boolean isStartMaximized()

      • setStartMaximized

        public void setStartMaximized​(boolean b)

      • setResizable

        public void setResizable​(boolean b)
        Overrides:
        setResizable in class javax.swing.JInternalFrame

      • setIconifiable

        public void setIconifiable​(boolean b)
        Overrides:
        setIconifiable in class javax.swing.JInternalFrame

      • setMaximizable

        public void setMaximizable​(boolean b)
        Overrides:
        setMaximizable in class javax.swing.JInternalFrame

      • wouldBeResizable

        public boolean wouldBeResizable()

      • getDockPosition

        public int getDockPosition()

      • setDockPosition

        public void setDockPosition​(int newPosition)

      • getDockIndex

        public int getDockIndex()

      • setDockIndex

        public void setDockIndex​(int dockIndex)

      • getCachePolicy

        public int getCachePolicy()

      • setCachePolicy

        public void setCachePolicy​(int cachePolicy)

      • getBorderDisplayPolicy

        public int getBorderDisplayPolicy()

      • setBorderDisplayPolicy

        public void setBorderDisplayPolicy​(int borderDisplayPolicy)

      • getTitlebarDisplayPolicy

        public int getTitlebarDisplayPolicy()

      • setTitlebarDisplayPolicy

        public void setTitlebarDisplayPolicy​(int titlebarDisplayPolicy)

      • getTitlebarFont

        public java.awt.Font getTitlebarFont()

      • setTitlebarFont

        public void setTitlebarFont​(java.awt.Font titlebarFont)

      • getTitlebarHeight

        public int getTitlebarHeight()

      • setTitlebarHeight

        public void setTitlebarHeight​(int titlebarHeight)

      • setResourcePath

        public void setResourcePath​(ResourcePath resourcePath)

      • getStartingLocation

        public java.awt.Point getStartingLocation()

      • setStartingLocation

        public void setStartingLocation​(java.awt.Point newLocation)

      • setSize

        public void setSize​(java.awt.Dimension newSize)
        Overrides:
        setSize in class java.awt.Component

      • removeVisionWindowListener

        public void removeVisionWindowListener​(VisionWindowListener listener)

      • fireVisionWindowOpened

        public void fireVisionWindowOpened()

      • fireVisionWindowClosed

        public void fireVisionWindowClosed()