Class FPMIWindow
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JInternalFrame
-
- com.inductiveautomation.factorypmi.application.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 classFPMIWindow.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
-
-
Field Summary
Fields Modifier and Type Field Description static intCACHE_ALWAYSstatic intCACHE_AUTOstatic intCACHE_NEVERstatic intDOCK_EASTstatic intDOCK_FLOATstatic intDOCK_NORTHstatic intDOCK_SOUTHstatic intDOCK_WESTprotected javax.swing.event.EventListenerListlistenerListprotected LocaleListenerlocaleListenerstatic java.lang.StringPARENT_WINDOW_NAMESpecial string that will resolve to the FPMIWindow itself for calls to getComponentForPath() and getPathForComponent()static intSHOW_ALWAYSstatic intSHOW_NEVERstatic intSHOW_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
-
-
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 voidaddVisionWindowListener(VisionWindowListener listener)voidcreateRef(java.lang.Object o)voiddoDefaultCloseAction()voidfireVisionWindowClosed()voidfireVisionWindowOpened()VisionClientContextgetAppContext()intgetBorderDisplayPolicy()java.awt.InsetsgetBorderInsets()Returns an Insets object that represents the normal size of borders/titlebar area that will appear on this window when it is opened.intgetCachePolicy()javax.swing.JComponentgetComponentForPath(java.lang.String path)intgetDockIndex()intgetDockPosition()InteractionControllergetInteractionController()java.awt.ComponentgetMostRecentFocusOwner()This causes the window to make sure that NO COMPONENT receives input focus when the window is selected.java.lang.StringgetPath()java.lang.StringgetPathForComponent(java.awt.Component c)ResourcePathgetResourcePath()BasicContainergetRootContainer()java.awt.ComponentgetRuntimeGlassPane()java.awt.PointgetStartingLocation()javax.swing.JComponentgetTitleBar()intgetTitlebarDisplayPolicy()java.awt.FontgetTitlebarFont()intgetTitlebarHeight()VisionWindowListener[]getVisionWindowListeners()voidinitialize(VisionClientContext context)Initialize this root.static voidinitializeUIRoot(VisionClientContext context, DefaultInteractionController interactions, VisionContainer rootContainer, boolean bindInitVisitRoot, LoggerEx log)booleanisStartMaximized()voidremoveVisionWindowListener(VisionWindowListener listener)voidsetBorderDisplayPolicy(int borderDisplayPolicy)voidsetCachePolicy(int cachePolicy)voidsetCloser(WindowCloser closer)voidsetContentPane(java.awt.Container c)voidsetDockIndex(int dockIndex)voidsetDockPosition(int newPosition)voidsetGeneralAdapters(java.util.HashMap<java.awt.Component,java.util.List<Adapter>> map)Deprecated.voidsetIconifiable(boolean b)voidsetInteractionController(InteractionController controller)voidsetLayer(java.lang.Integer layer)voidsetMaximizable(boolean b)voidsetNameBypass(java.lang.String name)voidsetOpenOnStart(boolean b)Deprecated.voidsetPropertyAdapters(java.util.HashMap<PropertyKey,PropertyAdapter> map)Deprecated.voidsetResizable(boolean b)voidsetResourcePath(ResourcePath resourcePath)voidsetRuntimeGlassPane(java.awt.Component component)voidsetSecuritySettings(java.lang.String name, SecuritySettings settings)Deprecated.voidsetSerializationVersion(int i)Deprecated.voidsetSize(java.awt.Dimension newSize)voidsetStartingLocation(java.awt.Point newLocation)voidsetStartMaximized(boolean b)voidsetTitle(java.lang.String title)voidsetTitlebarDisplayPolicy(int titlebarDisplayPolicy)voidsetTitlebarFont(java.awt.Font titlebarFont)voidsetTitlebarHeight(int titlebarHeight)voidshutdown()Shutdown the root.voidstartup()Start up the root.java.lang.StringtoString()voidupdateUI()booleanwouldBeResizable()-
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
-
Methods inherited from interface com.inductiveautomation.ignition.client.designable.DesignableContainer
addPropertyChangeListener, addPropertyChangeListener, getClientProperty, getName, putClientProperty, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Field Detail
-
DOCK_FLOAT
public static final int DOCK_FLOAT
- See Also:
- Constant Field Values
-
DOCK_NORTH
public static final int DOCK_NORTH
- See Also:
- Constant Field Values
-
DOCK_EAST
public static final int DOCK_EAST
- See Also:
- Constant Field Values
-
DOCK_WEST
public static final int DOCK_WEST
- See Also:
- Constant Field Values
-
DOCK_SOUTH
public static final int DOCK_SOUTH
- See Also:
- Constant Field Values
-
CACHE_AUTO
public static final int CACHE_AUTO
- See Also:
- Constant Field Values
-
CACHE_NEVER
public static final int CACHE_NEVER
- See Also:
- Constant Field Values
-
CACHE_ALWAYS
public static final int CACHE_ALWAYS
- See Also:
- Constant Field Values
-
SHOW_ALWAYS
public static final int SHOW_ALWAYS
- See Also:
- Constant Field Values
-
SHOW_NEVER
public static final int SHOW_NEVER
- See Also:
- Constant Field Values
-
SHOW_NOT_MAXIMIZED
public static final int SHOW_NOT_MAXIMIZED
- See Also:
- Constant Field Values
-
PARENT_WINDOW_NAME
public static final java.lang.String PARENT_WINDOW_NAME
Special string that will resolve to the FPMIWindow itself for calls to getComponentForPath() and getPathForComponent()- See Also:
- Constant Field Values
-
localeListener
protected LocaleListener localeListener
-
listenerList
protected javax.swing.event.EventListenerList listenerList
-
-
Method Detail
-
setCloser
public void setCloser(WindowCloser closer)
-
doDefaultCloseAction
public void doDefaultCloseAction()
- Overrides:
doDefaultCloseActionin classjavax.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:
setLayerin classjavax.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:
getMostRecentFocusOwnerin classjavax.swing.JInternalFrame
-
updateUI
public void updateUI()
- Overrides:
updateUIin classjavax.swing.JInternalFrame
-
setContentPane
public void setContentPane(java.awt.Container c)
- Specified by:
setContentPanein interfacejavax.swing.RootPaneContainer- Overrides:
setContentPanein classjavax.swing.JInternalFrame
-
initialize
public void initialize(VisionClientContext context)
Description copied from interface:BindingRootInitialize this root. Should connect any bindings, but shouldn't start anything up.- Specified by:
initializein interfaceBindingRoot
-
initializeUIRoot
public static void initializeUIRoot(VisionClientContext context, DefaultInteractionController interactions, VisionContainer rootContainer, boolean bindInitVisitRoot, LoggerEx log)
-
startup
public void startup()
Description copied from interface:BindingRootStart up the root. Start-up adapters, and start-up any children ComponentLifecycles.- Specified by:
startupin interfaceBindingRoot
-
shutdown
public void shutdown()
Description copied from interface:BindingRootShutdown the root. Shut-down adapters, and shut-down any children ComponentLifecycles.- Specified by:
shutdownin interfaceBindingRoot
-
getInteractionController
public InteractionController getInteractionController()
- Specified by:
getInteractionControllerin interfaceBindingRoot
-
setInteractionController
public void setInteractionController(InteractionController controller)
-
setNameBypass
public void setNameBypass(java.lang.String name)
-
setTitle
public void setTitle(java.lang.String title)
- Overrides:
setTitlein classjavax.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:
toStringin classjava.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
-
getRootContainer
public BasicContainer getRootContainer()
-
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:
getPathForComponentin interfaceBindingRoot
-
getComponentForPath
public javax.swing.JComponent getComponentForPath(java.lang.String path)
- Specified by:
getComponentForPathin interfaceBindingRoot
-
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:
setResizablein classjavax.swing.JInternalFrame
-
setIconifiable
public void setIconifiable(boolean b)
- Overrides:
setIconifiablein classjavax.swing.JInternalFrame
-
setMaximizable
public void setMaximizable(boolean b)
- Overrides:
setMaximizablein classjavax.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)
-
getResourcePath
public ResourcePath getResourcePath()
- Specified by:
getResourcePathin interfaceDesignableContainer
-
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:
setSizein classjava.awt.Component
-
getAppContext
public VisionClientContext getAppContext()
-
addVisionWindowListener
public void addVisionWindowListener(VisionWindowListener listener)
-
removeVisionWindowListener
public void removeVisionWindowListener(VisionWindowListener listener)
-
getVisionWindowListeners
public VisionWindowListener[] getVisionWindowListeners()
-
fireVisionWindowOpened
public void fireVisionWindowOpened()
-
fireVisionWindowClosed
public void fireVisionWindowClosed()
-
-