Class WindowUtilities
- java.lang.Object
-
- com.inductiveautomation.factorypmi.application.script.builtin.WindowUtilities
-
- Direct Known Subclasses:
WindowUtilitiesForDesktop
public class WindowUtilities extends java.lang.Object
These are the scripting functions mounted at system.gui.* Changes to this class must be made carefully, as some of the true implementations actually reside in the subclass, WindowUtilitiesForDesktop. Any method that is relative to a specific desktop needs to be implemented in the subclass, and then the version inside this class must delegate to that one using the WindowUtilites object returned by gui()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WindowUtilities.JyPopupMenu
static class
WindowUtilities.PopupContext
An object that is used to let the windowing system know when a popup is about to be shown, and when it has hidden.
-
Field Summary
Fields Modifier and Type Field Description static int
ACCL_CONSTANT
static int
ACCL_EASE
static int
ACCL_FAST_TO_SLOW
static int
ACCL_NONE
static int
ACCL_SLOW_TO_FAST
static int
COORD_DESIGNER
static int
COORD_SCREEN
-
Constructor Summary
Constructors Constructor Description WindowUtilities(FPMIApp app)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.awt.Color
chooseColor(java.awt.Color initial)
java.awt.Color
chooseColor(java.awt.Color initial, java.lang.String title)
void
closeDesktop(java.lang.String handle)
static java.awt.Color
color(int r, int g, int b)
static java.awt.Color
color(int r, int g, int b, int alpha)
static java.awt.Color
color(java.lang.String color)
java.lang.Boolean
confirm(java.lang.String message)
java.lang.Boolean
confirm(java.lang.String message, java.lang.String title)
java.lang.Boolean
confirm(java.lang.String message, java.lang.String title, java.lang.Boolean allowCancel)
static org.python.core.PyTuple
convertPointToScreen(int x, int y, java.util.EventObject event)
static WindowUtilities.PopupContext
createPopupContext()
static javax.swing.JPopupMenu
createPopupMenu(org.python.core.PyDictionary dict)
Deprecated.static javax.swing.JPopupMenu
createPopupMenu(org.python.core.PySequence keys, org.python.core.PySequence functions)
WindowUtilities
desktop()
WindowUtilities
desktop(int screen)
WindowUtilities
desktop(java.lang.String handle)
void
errorBox(java.lang.String message)
void
errorBox(java.lang.String message, java.lang.String title)
static WindowUtilities
find(javax.swing.JComponent component)
Finds the WindowUtilities for any component within the hierarchy of a Vision Window.java.util.List<PyComponentWrapper>
findWindow(java.lang.String path)
Searches through the open windows for windows with the given path.java.lang.String
getCurrentDesktop()
org.python.core.PySequence
getDesktopHandles()
org.python.core.PyTuple
getOpenedWindowNames()
org.python.core.PyTuple
getOpenedWindows()
static org.python.core.PyObject
getParentWindow(java.util.EventObject event)
QualityCode
getQuality(javax.swing.JComponent comp, java.lang.String propertyName)
int
getScreenIndex()
static org.python.core.PySequence
getScreens()
static org.python.core.PyObject
getSibling(java.util.EventObject event, java.lang.String name)
org.python.core.PyObject
getWindow(java.lang.String name)
org.python.core.PyTuple
getWindowNames()
java.lang.String
inputBox(java.lang.String message)
java.lang.String
inputBox(java.lang.String message, java.lang.String defaultTxt)
static boolean
isTouchscreenMode()
Deprecated.boolean
isTouchscreenModeEnabled()
void
messageBox(java.lang.String message)
void
messageBox(java.lang.String message, java.lang.String title)
static void
moveComponent(javax.swing.JComponent comp, int x, int y)
Deprecated.javax.swing.JFrame
openDesktop(org.python.core.PyObject[] values, java.lang.String[] keywords)
void
openDiagnostics()
java.lang.String
passwordBox(java.lang.String message)
java.lang.String
passwordBox(java.lang.String message, java.lang.String title)
java.lang.String
passwordBox(java.lang.String message, java.lang.String title, java.lang.String echoChar)
static void
reshapeComponent(javax.swing.JComponent comp, int x, int y, int w, int h)
Deprecated.static void
resizeComponent(javax.swing.JComponent comp, int w, int h)
Deprecated.void
setScreenIndex(int index)
void
setTouchscreenMode(boolean b)
Deprecated.void
setTouchscreenModeEnabled(boolean b)
java.lang.Number
showNumericKeypad(java.lang.Number initial)
java.lang.Number
showNumericKeypad(java.lang.Number initial, int fontSize)
java.lang.Number
showNumericKeypad(java.lang.Number initial, int fontSize, boolean usePasswordMode)
java.lang.String
showTouchscreenKeyboard(java.lang.String initial)
java.lang.String
showTouchscreenKeyboard(java.lang.String initial, int fontSize)
java.lang.String
showTouchscreenKeyboard(java.lang.String initial, int fontSize, boolean password)
org.python.core.PyObject
transform(org.python.core.PyObject[] values, java.lang.String[] keywords)
void
warningBox(java.lang.String message)
void
warningBox(java.lang.String message, java.lang.String title)
-
-
-
Field Detail
-
ACCL_NONE
public static final int ACCL_NONE
- See Also:
- Constant Field Values
-
ACCL_CONSTANT
public static final int ACCL_CONSTANT
- See Also:
- Constant Field Values
-
ACCL_FAST_TO_SLOW
public static final int ACCL_FAST_TO_SLOW
- See Also:
- Constant Field Values
-
ACCL_SLOW_TO_FAST
public static final int ACCL_SLOW_TO_FAST
- See Also:
- Constant Field Values
-
ACCL_EASE
public static final int ACCL_EASE
- See Also:
- Constant Field Values
-
COORD_SCREEN
public static final int COORD_SCREEN
- See Also:
- Constant Field Values
-
COORD_DESIGNER
public static final int COORD_DESIGNER
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WindowUtilities
public WindowUtilities(FPMIApp app)
-
-
Method Detail
-
find
public static WindowUtilities find(javax.swing.JComponent component)
Finds the WindowUtilities for any component within the hierarchy of a Vision Window. Returns null if the Vision window hierarchy isn't present in the given component's ancestor tree.
-
desktop
public WindowUtilities desktop()
-
desktop
public WindowUtilities desktop(int screen)
-
desktop
public WindowUtilities desktop(java.lang.String handle)
-
createPopupContext
public static WindowUtilities.PopupContext createPopupContext()
-
openDesktop
public javax.swing.JFrame openDesktop(org.python.core.PyObject[] values, java.lang.String[] keywords)
-
getCurrentDesktop
public java.lang.String getCurrentDesktop()
-
closeDesktop
public void closeDesktop(java.lang.String handle)
-
getDesktopHandles
public org.python.core.PySequence getDesktopHandles()
-
moveComponent
@Deprecated public static void moveComponent(javax.swing.JComponent comp, int x, int y)
Deprecated.
-
resizeComponent
@Deprecated public static void resizeComponent(javax.swing.JComponent comp, int w, int h)
Deprecated.
-
reshapeComponent
@Deprecated public static void reshapeComponent(javax.swing.JComponent comp, int x, int y, int w, int h)
Deprecated.
-
transform
public org.python.core.PyObject transform(org.python.core.PyObject[] values, java.lang.String[] keywords)
-
chooseColor
public java.awt.Color chooseColor(java.awt.Color initial)
-
chooseColor
public java.awt.Color chooseColor(java.awt.Color initial, java.lang.String title)
-
color
public static java.awt.Color color(java.lang.String color)
-
color
public static java.awt.Color color(int r, int g, int b)
-
color
public static java.awt.Color color(int r, int g, int b, int alpha)
-
getSibling
public static org.python.core.PyObject getSibling(java.util.EventObject event, java.lang.String name)
-
getWindow
public org.python.core.PyObject getWindow(java.lang.String name)
-
getOpenedWindows
public org.python.core.PyTuple getOpenedWindows()
-
getOpenedWindowNames
public org.python.core.PyTuple getOpenedWindowNames()
-
getWindowNames
public org.python.core.PyTuple getWindowNames()
-
findWindow
public java.util.List<PyComponentWrapper> findWindow(java.lang.String path)
Searches through the open windows for windows with the given path. May return none (empty list) or multiple depending on the state of the running client.
-
getParentWindow
public static org.python.core.PyObject getParentWindow(java.util.EventObject event)
-
errorBox
public void errorBox(java.lang.String message)
-
errorBox
public void errorBox(java.lang.String message, java.lang.String title)
-
warningBox
public void warningBox(java.lang.String message)
-
warningBox
public void warningBox(java.lang.String message, java.lang.String title)
-
messageBox
public void messageBox(java.lang.String message)
-
messageBox
public void messageBox(java.lang.String message, java.lang.String title)
-
confirm
public java.lang.Boolean confirm(java.lang.String message)
-
confirm
public java.lang.Boolean confirm(java.lang.String message, java.lang.String title)
-
confirm
public java.lang.Boolean confirm(java.lang.String message, java.lang.String title, java.lang.Boolean allowCancel)
-
inputBox
public java.lang.String inputBox(java.lang.String message)
-
inputBox
public java.lang.String inputBox(java.lang.String message, java.lang.String defaultTxt)
-
passwordBox
public java.lang.String passwordBox(java.lang.String message)
-
passwordBox
public java.lang.String passwordBox(java.lang.String message, java.lang.String title)
-
passwordBox
public java.lang.String passwordBox(java.lang.String message, java.lang.String title, java.lang.String echoChar)
-
showNumericKeypad
public java.lang.Number showNumericKeypad(java.lang.Number initial)
-
showNumericKeypad
public java.lang.Number showNumericKeypad(java.lang.Number initial, int fontSize)
-
showNumericKeypad
public java.lang.Number showNumericKeypad(java.lang.Number initial, int fontSize, boolean usePasswordMode)
-
showTouchscreenKeyboard
public java.lang.String showTouchscreenKeyboard(java.lang.String initial)
-
showTouchscreenKeyboard
public java.lang.String showTouchscreenKeyboard(java.lang.String initial, int fontSize)
-
showTouchscreenKeyboard
public java.lang.String showTouchscreenKeyboard(java.lang.String initial, int fontSize, boolean password)
-
isTouchscreenMode
@Deprecated public static boolean isTouchscreenMode()
Deprecated.
-
isTouchscreenModeEnabled
public boolean isTouchscreenModeEnabled()
-
setTouchscreenMode
@Deprecated public void setTouchscreenMode(boolean b)
Deprecated.
-
setTouchscreenModeEnabled
public void setTouchscreenModeEnabled(boolean b)
-
convertPointToScreen
public static org.python.core.PyTuple convertPointToScreen(int x, int y, java.util.EventObject event)
-
createPopupMenu
@Deprecated public static javax.swing.JPopupMenu createPopupMenu(org.python.core.PyDictionary dict)
Deprecated.
-
createPopupMenu
public static javax.swing.JPopupMenu createPopupMenu(org.python.core.PySequence keys, org.python.core.PySequence functions)
-
setScreenIndex
public void setScreenIndex(int index)
-
getScreenIndex
public int getScreenIndex()
-
getQuality
public QualityCode getQuality(javax.swing.JComponent comp, java.lang.String propertyName)
-
getScreens
public static org.python.core.PySequence getScreens()
-
openDiagnostics
public void openDiagnostics()
-
-