Class NavUtilitiesDispatcher
- java.lang.Object
-
- com.inductiveautomation.factorypmi.application.script.builtin.NavUtilitiesDispatcher
-
- All Implemented Interfaces:
INavUtilities
public class NavUtilitiesDispatcher extends java.lang.Object implements INavUtilities
This is the class mounted at system.nav, but the real implementation is in NavUtilities.
This class exists in order to automatically detect what desktop the call is coming in from and to dispatch the invocation to the correct NavUtilities instance, based upon the thread local in VisionDesktop.CURRENT_DESKTOP.
This class also contains one special method which is not part of INavUtilities - the
desktop(String)
method. This method returns the NavUtilities for a named desktop instance. In this way, scripts may alter the nav of desktops other than their own, like so:system.nav.desktop("OtherDesktop").openWindow("...")
-
-
Constructor Summary
Constructors Constructor Description NavUtilitiesDispatcher(FPMIApp app)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
centerWindow(FPMIWindow win)
void
centerWindow(java.lang.String path)
void
closeParentWindow(java.util.EventObject event)
void
closeWindow(FPMIWindow win)
void
closeWindow(java.lang.String path)
INavUtilities
desktop()
INavUtilities
desktop(int screen)
INavUtilities
desktop(java.lang.String handle)
java.lang.String
getCurrentWindow()
org.python.core.PyObject
goBack()
org.python.core.PyObject
goForward()
org.python.core.PyObject
goHome()
org.python.core.PyObject
openWindow(java.lang.String path)
org.python.core.PyObject
openWindow(java.lang.String path, org.python.core.PyDictionary params)
org.python.core.PyObject
openWindowImpl(java.lang.String path, org.python.core.PyDictionary params, boolean openAdditional)
org.python.core.PyObject
openWindowInstance(java.lang.String path)
org.python.core.PyObject
openWindowInstance(java.lang.String path, org.python.core.PyDictionary params)
org.python.core.PyObject
swapTo(java.lang.String name)
org.python.core.PyObject
swapTo(java.lang.String name, org.python.core.PyDictionary dict)
org.python.core.PyObject
swapWindow(java.lang.String swapFrom, java.lang.String swapTo)
org.python.core.PyObject
swapWindow(java.lang.String swapFrom, java.lang.String swapTo, org.python.core.PyDictionary params)
org.python.core.PyObject
swapWindow(java.util.EventObject event, java.lang.String name)
org.python.core.PyObject
swapWindow(java.util.EventObject event, java.lang.String name, org.python.core.PyDictionary params)
-
-
-
Constructor Detail
-
NavUtilitiesDispatcher
public NavUtilitiesDispatcher(FPMIApp app)
-
-
Method Detail
-
desktop
public INavUtilities desktop()
-
desktop
public INavUtilities desktop(int screen)
-
desktop
public INavUtilities desktop(java.lang.String handle)
-
getCurrentWindow
public java.lang.String getCurrentWindow()
- Specified by:
getCurrentWindow
in interfaceINavUtilities
-
swapTo
public org.python.core.PyObject swapTo(java.lang.String name)
- Specified by:
swapTo
in interfaceINavUtilities
-
swapTo
public org.python.core.PyObject swapTo(java.lang.String name, org.python.core.PyDictionary dict)
- Specified by:
swapTo
in interfaceINavUtilities
-
goHome
public org.python.core.PyObject goHome()
- Specified by:
goHome
in interfaceINavUtilities
-
goBack
public org.python.core.PyObject goBack()
- Specified by:
goBack
in interfaceINavUtilities
-
goForward
public org.python.core.PyObject goForward()
- Specified by:
goForward
in interfaceINavUtilities
-
swapWindow
public org.python.core.PyObject swapWindow(java.lang.String swapFrom, java.lang.String swapTo)
- Specified by:
swapWindow
in interfaceINavUtilities
-
swapWindow
public org.python.core.PyObject swapWindow(java.lang.String swapFrom, java.lang.String swapTo, org.python.core.PyDictionary params)
- Specified by:
swapWindow
in interfaceINavUtilities
-
swapWindow
public org.python.core.PyObject swapWindow(java.util.EventObject event, java.lang.String name)
- Specified by:
swapWindow
in interfaceINavUtilities
-
swapWindow
public org.python.core.PyObject swapWindow(java.util.EventObject event, java.lang.String name, org.python.core.PyDictionary params)
- Specified by:
swapWindow
in interfaceINavUtilities
-
openWindowInstance
public org.python.core.PyObject openWindowInstance(java.lang.String path)
- Specified by:
openWindowInstance
in interfaceINavUtilities
-
openWindowInstance
public org.python.core.PyObject openWindowInstance(java.lang.String path, org.python.core.PyDictionary params)
- Specified by:
openWindowInstance
in interfaceINavUtilities
-
openWindow
public org.python.core.PyObject openWindow(java.lang.String path)
- Specified by:
openWindow
in interfaceINavUtilities
-
openWindow
public org.python.core.PyObject openWindow(java.lang.String path, org.python.core.PyDictionary params)
- Specified by:
openWindow
in interfaceINavUtilities
-
openWindowImpl
public org.python.core.PyObject openWindowImpl(java.lang.String path, org.python.core.PyDictionary params, boolean openAdditional)
- Specified by:
openWindowImpl
in interfaceINavUtilities
-
centerWindow
public void centerWindow(java.lang.String path)
- Specified by:
centerWindow
in interfaceINavUtilities
-
centerWindow
public void centerWindow(FPMIWindow win)
- Specified by:
centerWindow
in interfaceINavUtilities
-
closeWindow
public void closeWindow(java.lang.String path)
- Specified by:
closeWindow
in interfaceINavUtilities
-
closeWindow
public void closeWindow(FPMIWindow win)
- Specified by:
closeWindow
in interfaceINavUtilities
-
closeParentWindow
public void closeParentWindow(java.util.EventObject event)
- Specified by:
closeParentWindow
in interfaceINavUtilities
-
-