Package com.flowingcode.vaadin.addons.errorwindow

Class ErrorWindow

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.dialog.GeneratedVaadinDialog<Dialog>

com.vaadin.flow.component.dialog.Dialog

com.flowingcode.vaadin.addons.errorwindow.ErrorWindow

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasComponents, HasElement, HasEnabled, HasSize, HasTheme, Serializable

@CssImport("./flowingcode/error-window.css")
public class ErrorWindow
extends Dialog

Component to visualize an error, caused by an exception, as a modal sub-window. When in production mode it shows a code to report. When in debug mode it allows to visualize the stack trace of the error.

This class has several constructors that allow specifying the cause of the error, an error message, whether the application is in production mode, and the internationalization of the error message.

This class also provides constructors that accept an ErrorDetails instance, which provides additional information about the error.

A unique identifier is assigned to the dialog window, for use in reporting the error when in production mode.

Author:

pbartolo

See Also:

• ErrorDetails
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.dialog.Dialog

Dialog.DialogCloseActionEvent, Dialog.DialogResizeEvent

Nested classes/interfaces inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog

GeneratedVaadinDialog.OpenedChangeEvent<R extends GeneratedVaadinDialog<R>>

Constructor Summary

Constructors

Constructor	Description
ErrorWindow(ErrorDetails errorDetails)
ErrorWindow(ErrorDetails errorDetails, boolean productionMode)
ErrorWindow(ErrorDetails errorDetails, ErrorWindowI18n i18n)	Constructs and initializes an ErrorWindow object with the supplied error details and internationalization.
ErrorWindow(Throwable cause)	Constructs and initializes an ErrorWindow object with the supplied cause and default production mode and i18n.
ErrorWindow(Throwable cause, ErrorWindowI18n i18n)	Constructs and initializes an ErrorWindow object with the supplied details and and default production mode.
ErrorWindow(Throwable cause, String errorMessage)	Deprecated. The error message specified with this constructor is only displayed when production mode is false.
ErrorWindow(Throwable cause, String errorMessage, boolean productionMode)	Constructs and initializes an ErrorWindow object with the supplied details and default i18n.
ErrorWindow(Throwable cause, String errorMessage, boolean productionMode, ErrorWindowI18n i18n)	Constructs and initializes an ErrorWindow object with the supplied details.
ErrorWindow(Throwable cause, String errorMessage, ErrorWindowI18n i18n)	Constructs and initializes an ErrorWindow object with the supplied details and default production mode.

Method Summary

Modifier and Type	Method	Description
protected Component	createErrorLabel()
protected Component	createStackTraceArea()
Stream<Component>	getChildren()

Methods inherited from class com.vaadin.flow.component.dialog.Dialog

add, addAttachListener, addComponentAtIndex, addDetachListener, addDialogCloseActionListener, addOpenedChangeListener, addResizeListener, addThemeVariants, close, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, isCloseOnEsc, isCloseOnOutsideClick, isDraggable, isModal, isOpened, isResizable, onAttach, open, remove, removeAll, removeThemeVariants, setCloseOnEsc, setCloseOnOutsideClick, setDraggable, setHeight, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setModal, setOpened, setResizable, setWidth

Methods inherited from class com.vaadin.flow.component.dialog.GeneratedVaadinDialog

getAriaLabelString, isOpenedBoolean, setAriaLabel

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, addComponentAsFirst

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeightUnit, getWidthUnit, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Constructor Details

ErrorWindow

public ErrorWindow(Throwable cause)

Constructs and initializes an ErrorWindow object with the supplied cause and default production mode and i18n.

Parameters:

cause - The cause of the error

ErrorWindow

public ErrorWindow(Throwable cause,
 ErrorWindowI18n i18n)

Constructs and initializes an ErrorWindow object with the supplied details and and default production mode.

Parameters:

cause - The cause of the error

i18n - The internationalization of the ErrorWindow

ErrorWindow

@Deprecated
public ErrorWindow(Throwable cause,
 String errorMessage)

Deprecated.

The error message specified with this constructor is only displayed when production mode is false. Use ErrorWindow(Throwable, ErrorWindowI18n) for specifying both debug and production mode messages.

Constructs and initializes an ErrorWindow object with the supplied details and default production mode and i18n.

Parameters:

cause - The cause of the error

errorMessage - An optional error message that is displayed when production mode is false

ErrorWindow

public ErrorWindow(Throwable cause,
 String errorMessage,
 ErrorWindowI18n i18n)

Constructs and initializes an ErrorWindow object with the supplied details and default production mode.

Parameters:

cause - The cause of the error

errorMessage - An optional error message that is displayed when production mode is false

i18n - The internationalization of the ErrorWindow

ErrorWindow

public ErrorWindow(Throwable cause,
 String errorMessage,
 boolean productionMode)

Constructs and initializes an ErrorWindow object with the supplied details and default i18n.

Parameters:

cause - The cause of the error

errorMessage - An optional error message that is displayed when production mode is false

productionMode - The mode in which the Application is running. If true, a code is displayed with error details, else debug information is shown

ErrorWindow

public ErrorWindow(Throwable cause,
 String errorMessage,
 boolean productionMode,
 ErrorWindowI18n i18n)

Constructs and initializes an ErrorWindow object with the supplied details.

Parameters:

cause - The cause of the error

errorMessage - An optional error message that is displayed when production mode is false

productionMode - The mode in which the Application is running. If true, a code is displayed with error details, else debug information is shown

i18n - The internationalization of the ErrorWindow

ErrorWindow

public ErrorWindow(ErrorDetails errorDetails)

ErrorWindow

public ErrorWindow(ErrorDetails errorDetails,
 boolean productionMode)

ErrorWindow

public ErrorWindow(ErrorDetails errorDetails,
 ErrorWindowI18n i18n)

Constructs and initializes an ErrorWindow object with the supplied error details and internationalization. This constructor allows for provision of additional information, which is an ErrorDetails object.

Parameters:

errorDetails - The ErrorDetails object

i18n - The internationalization of the ErrorWindow

Method Details

getChildren

public Stream<Component> getChildren()

Overrides:

getChildren in class Dialog

createStackTraceArea

protected Component createStackTraceArea()

createErrorLabel

protected Component createErrorLabel()