Package com.inductiveautomation.ignition.client.util.gui

Class ErrorUtil

java.lang.Object

com.inductiveautomation.ignition.client.util.gui.ErrorUtil

public class ErrorUtil
extends java.lang.Object

Used to display errors, warning, etc. to the user in the client.

Handles dispatching events to the EDT, so errors can be reported from other threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ErrorUtil.ErrorReportingService
protected static class	ErrorUtil.ErrorUpdater
static interface	ErrorUtil.MultiDesktopQuery	Vision clients should implement this so that this class can be secondary desktop aware.

Field Summary

Fields

Modifier and Type	Field	Description
protected static javax.swing.JDesktopPane	desktopParent
protected static ErrorUtil.MultiDesktopQuery	multiDesktopQuery
protected static java.awt.Component	parent

Method Summary

Modifier and Type	Method	Description
protected static void	_addError(ErrorPanel panel, PopupWindowParent panelParent, DisplayableError error, java.awt.Component currentDesktop)
static void	centerComponent(java.awt.Component source, java.awt.Component parent)
static void	destroy()	Used to clear default button references to avoid keyboard manager memory leak.
static boolean	errorAlwaysOnTop()
static void	errorSetAlwaysOnTop(boolean alwaysOnTop)
protected static java.lang.Object	getMessageObject(java.lang.String message)
static java.awt.Component	getParent()
static void	init(ErrorUtil.ErrorReportingService service)	Initialize the frames for the error and warning popups This method uses default always on top Jframes for the popup parents
static void	init(PopupWindowParent errorParent, PopupWindowParent warningParent, ErrorUtil.ErrorReportingService service)
static boolean	isBringToFront()
static void	reportError(java.lang.String message, java.lang.String title, java.lang.Throwable exception)
static void	setBringToFront(boolean toFront)
static void	setDesktopParent(javax.swing.JDesktopPane desktopParent)
static void	setMultiDesktopQuery(ErrorUtil.MultiDesktopQuery queryObj)
static void	setParent(java.awt.Component p)
static java.lang.Boolean	showConfirm(java.awt.Component parent, java.lang.String question, java.lang.String title)
static java.lang.Boolean	showConfirm(java.awt.Component parent, java.lang.String question, java.lang.String title, java.lang.Object[] opts)
static java.lang.Boolean	showConfirm(java.awt.Component parent, java.lang.String question, java.lang.String title, java.lang.Object[] opts, java.lang.Boolean allowCancel)
static java.lang.Boolean	showConfirm(java.lang.String question, java.lang.String title)
static java.lang.Boolean	showConfirm(java.lang.String question, java.lang.String title, boolean allowCancel)
static java.lang.Boolean	showConfirm(java.lang.String question, java.lang.String title, java.lang.Object[] opts)
protected static int	showConfirmFullscreen(java.awt.Component parent, java.lang.Object message, java.lang.String title, java.lang.Object[] opts, int dialogType)
static void	showError(java.awt.Component currentDesktop, java.lang.String msg, java.lang.String title)
static void	showError(java.lang.String message)
static void	showError(java.lang.String message, java.lang.String title)
static void	showError(java.lang.String message, java.lang.String title, boolean log)
static void	showError(java.lang.String message, java.lang.String title, java.lang.Throwable exception)
static void	showError(java.lang.String message, java.lang.String title, java.lang.Throwable exception, boolean log)
static void	showError(java.lang.String message, java.lang.Throwable exception)
static void	showError(java.lang.String message, java.lang.Throwable exception, boolean log)
static void	showError(java.lang.Throwable exception)
static void	showError(java.lang.Throwable exception, boolean log)
static void	showInfo(java.awt.Component parent, java.lang.String msg, java.lang.String title)
static void	showInfo(java.awt.Component parent, java.lang.String msg, java.lang.String title, int type)
static void	showInfo(java.lang.String msg, java.lang.String title)
protected static void	showInfoFullscreen(java.awt.Component parent, java.lang.String msg, java.lang.String title, int type)
static java.lang.String	showInput(java.awt.Component parent, java.lang.String message, java.lang.String def)	Displays an input box with the given default value and message.
static java.lang.String	showInput(java.lang.String message, java.lang.String def)
protected static java.lang.String	showInputFullscreen(java.awt.Component parent, java.lang.Object message, java.lang.String def)
static java.lang.String	showPasswordPrompt(java.awt.Component parent, java.lang.String message, java.lang.String title, java.lang.String echoChar)
static java.lang.String	showPasswordPrompt(java.lang.String message, java.lang.String title)
static java.lang.String	showPasswordPrompt(java.lang.String message, java.lang.String title, java.lang.String echoChar)
protected static int	showPasswordPromptFullscreen(java.awt.Component parent, java.lang.Object message, java.lang.String title)
static void	showWarning(java.awt.Component currentDesktop, java.lang.String msg, java.lang.String title)
static void	showWarning(java.lang.String msg)
static void	showWarning(java.lang.String msg, java.lang.String title)
static void	showWarning(java.lang.String msg, java.lang.String title, boolean log)

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected static java.awt.Component parent

desktopParent

protected static javax.swing.JDesktopPane desktopParent

multiDesktopQuery

@Nullable
protected static ErrorUtil.MultiDesktopQuery multiDesktopQuery

Method Detail

setDesktopParent

public static void setDesktopParent(javax.swing.JDesktopPane desktopParent)

setParent

public static void setParent(java.awt.Component p)

setMultiDesktopQuery

public static void setMultiDesktopQuery(ErrorUtil.MultiDesktopQuery queryObj)

getParent

public static java.awt.Component getParent()

setBringToFront

public static void setBringToFront(boolean toFront)

isBringToFront

public static boolean isBringToFront()

init

public static void init(ErrorUtil.ErrorReportingService service)

Initialize the frames for the error and warning popups This method uses default always on top Jframes for the popup parents

init

public static void init(PopupWindowParent errorParent,
                        PopupWindowParent warningParent,
                        ErrorUtil.ErrorReportingService service)

errorAlwaysOnTop

public static boolean errorAlwaysOnTop()

errorSetAlwaysOnTop

public static void errorSetAlwaysOnTop(boolean alwaysOnTop)

destroy

public static void destroy()

Used to clear default button references to avoid keyboard manager memory leak.

centerComponent

public static void centerComponent(java.awt.Component source,
                                   java.awt.Component parent)

showInfo

public static void showInfo(java.awt.Component parent,
                            java.lang.String msg,
                            java.lang.String title)

showInfo

public static void showInfo(java.lang.String msg,
                            java.lang.String title)

showInfo

public static void showInfo(java.awt.Component parent,
                            java.lang.String msg,
                            java.lang.String title,
                            int type)

showInfoFullscreen

protected static void showInfoFullscreen(java.awt.Component parent,
                                         java.lang.String msg,
                                         java.lang.String title,
                                         int type)

showInput

@Nullable
public static java.lang.String showInput(java.awt.Component parent,
                                         java.lang.String message,
                                         java.lang.String def)

Displays an input box with the given default value and message. Returns the input, or null if cancel was chosen.

showInput

@Nullable
public static java.lang.String showInput(java.lang.String message,
                                         java.lang.String def)

showInputFullscreen

@Nullable
protected static java.lang.String showInputFullscreen(java.awt.Component parent,
                                                      java.lang.Object message,
                                                      java.lang.String def)

showPasswordPrompt

@Nullable
public static java.lang.String showPasswordPrompt(java.awt.Component parent,
                                                  java.lang.String message,
                                                  java.lang.String title,
                                                  java.lang.String echoChar)

showPasswordPrompt

@Nullable
public static java.lang.String showPasswordPrompt(java.lang.String message,
                                                  java.lang.String title)

showPasswordPrompt

@Nullable
public static java.lang.String showPasswordPrompt(java.lang.String message,
                                                  java.lang.String title,
                                                  java.lang.String echoChar)

showPasswordPromptFullscreen

protected static int showPasswordPromptFullscreen(java.awt.Component parent,
                                                  java.lang.Object message,
                                                  java.lang.String title)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.awt.Component parent,
                                            java.lang.String question,
                                            java.lang.String title)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.awt.Component parent,
                                            java.lang.String question,
                                            java.lang.String title,
                                            java.lang.Object[] opts)

showConfirmFullscreen

protected static int showConfirmFullscreen(java.awt.Component parent,
                                           java.lang.Object message,
                                           java.lang.String title,
                                           java.lang.Object[] opts,
                                           int dialogType)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.awt.Component parent,
                                            java.lang.String question,
                                            java.lang.String title,
                                            java.lang.Object[] opts,
                                            java.lang.Boolean allowCancel)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.lang.String question,
                                            java.lang.String title)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.lang.String question,
                                            java.lang.String title,
                                            java.lang.Object[] opts)

showConfirm

@Nullable
public static java.lang.Boolean showConfirm(java.lang.String question,
                                            java.lang.String title,
                                            boolean allowCancel)

showError

public static void showError(java.lang.String message)

showError

public static void showError(java.lang.String message,
                             java.lang.String title)

showError

public static void showError(java.awt.Component currentDesktop,
                             java.lang.String msg,
                             java.lang.String title)

showError

public static void showError(java.lang.String message,
                             java.lang.String title,
                             boolean log)

showError

public static void showError(java.lang.Throwable exception)

showError

public static void showError(java.lang.Throwable exception,
                             boolean log)

showError

public static void showError(java.lang.String message,
                             java.lang.Throwable exception)

showError

public static void showError(java.lang.String message,
                             java.lang.Throwable exception,
                             boolean log)

showError

public static void showError(java.lang.String message,
                             java.lang.String title,
                             java.lang.Throwable exception)

showError

public static void showError(java.lang.String message,
                             java.lang.String title,
                             java.lang.Throwable exception,
                             boolean log)

_addError

protected static void _addError(ErrorPanel panel,
                                PopupWindowParent panelParent,
                                DisplayableError error,
                                java.awt.Component currentDesktop)

reportError

public static void reportError(java.lang.String message,
                               java.lang.String title,
                               java.lang.Throwable exception)

showWarning

public static void showWarning(java.lang.String msg)

showWarning

public static void showWarning(java.lang.String msg,
                               java.lang.String title)

showWarning

public static void showWarning(java.lang.String msg,
                               java.lang.String title,
                               boolean log)

showWarning

public static void showWarning(java.awt.Component currentDesktop,
                               java.lang.String msg,
                               java.lang.String title)

getMessageObject

protected static java.lang.Object getMessageObject(java.lang.String message)