feat: make ErrorWindow internationalizable

Close #16

Author: Michael Knigge

src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindow.java

@@ -48,10 +48,6 @@ public class ErrorWindow extends Dialog {
 
 	private static final Logger logger = LoggerFactory.getLogger(ErrorWindow.class);
 
-	private static final String DEFAULT_CAPTION = "<h3 style='margin-top:0px;text-align:center'>An error has occurred</h3>";
-
-	private static final String DEFAULT_ERROR_LABEL_MESSAGE = "Please contact the system administrator for more information.";
-
 	private VerticalLayout exceptionTraceLayout;
 
 	private final Throwable cause;
@@ -62,32 +58,50 @@ public class ErrorWindow extends Dialog {
 
 	private boolean productionMode;
 
+	private ErrorWindowI18n i18n;
+
 	public ErrorWindow(final Throwable cause) {
-		this(cause, null, isProductionMode());
+		this(cause, null, isProductionMode(), ErrorWindowI18n.createDefault());
+	}
+
+	public ErrorWindow(final Throwable cause, final ErrorWindowI18n i18n) {
+		this(cause, null, isProductionMode(), i18n);
 	}
 
 	public ErrorWindow(final Throwable cause, final String errorMessage) {
-		this(cause, errorMessage, isProductionMode());
+		this(cause, errorMessage, isProductionMode(), ErrorWindowI18n.createDefault());
+	}
+
+	public ErrorWindow(final Throwable cause, final String errorMessage, final ErrorWindowI18n i18n) {
+		this(cause, errorMessage, isProductionMode(), i18n);
 	}
 
 	public ErrorWindow(final Throwable cause, final String errorMessage, boolean productionMode) {
+		this(cause, errorMessage, productionMode, ErrorWindowI18n.createDefault());
+	}
+	public ErrorWindow(final Throwable cause, final String errorMessage, boolean productionMode, final ErrorWindowI18n i18n) {
 		super();
 
 		uuid = UUID.randomUUID().toString();
 		this.cause = cause;
 		this.errorMessage = errorMessage;
 		this.productionMode = productionMode;
+		this.i18n = i18n;
 		initWindow();
 	}
 
 	public ErrorWindow(ErrorDetails errorDetails) {
-		this(errorDetails.getThrowable(), errorDetails.getCause());
+		this(errorDetails, ErrorWindowI18n.createDefault());
 	}
 
 	public ErrorWindow(ErrorDetails errorDetails, boolean productionMode) {
 		this(errorDetails.getThrowable(), errorDetails.getCause(), productionMode);
 	}
 
+	public ErrorWindow(ErrorDetails errorDetails, final ErrorWindowI18n i18n) {
+		this(errorDetails.getThrowable(), errorDetails.getCause(), i18n);
+	}
+
 	private static boolean isProductionMode() {
 		return ErrorManager.getErrorWindowFactory().isProductionMode();
 	}
@@ -110,7 +124,7 @@ private VerticalLayout createMainLayout() {
 		mainLayout.setPadding(false);
 		mainLayout.setMargin(false);
 
-		final Html title = new Html(DEFAULT_CAPTION);
+		final Html title = new Html(String.format("<h3 style='margin-top:0px;text-align:center'>%s</h3>", i18n.getCaption()));
 		title.getElement().getStyle().set("width", "100%");
 		mainLayout.add(title);
 
@@ -129,7 +143,7 @@ private VerticalLayout createMainLayout() {
 			mainLayout.add(createExceptionTraceLayout());
 		}
 
-		final Button closeButton = new Button("Close", event -> close());
+		final Button closeButton = new Button(i18n.getClose(), event -> close());
 		buttonsLayout.add(closeButton);
 		mainLayout.add(buttonsLayout);
 		mainLayout.setHorizontalComponentAlignment(Alignment.END, buttonsLayout);
@@ -138,7 +152,7 @@ private VerticalLayout createMainLayout() {
 	}
 
 	private Button createDetailsButtonLayout() {
-		final Button errorDetailsButton = new Button("Show error detail", event -> {
+		final Button errorDetailsButton = new Button(i18n.getDetails(), event -> {
 			boolean visible = !exceptionTraceLayout.isVisible();
 			exceptionTraceLayout.setVisible(visible);
 			if(visible) {
@@ -175,9 +189,9 @@ protected TextArea createStackTraceArea() {
 	}
 
 	protected Html createErrorLabel() {
-		String label = errorMessage == null ? DEFAULT_ERROR_LABEL_MESSAGE : errorMessage;
+		String label = errorMessage == null ? i18n.getDefaultErrorMessage() : errorMessage;
 		if (productionMode) {
-			label = label.concat(String.format("<br />Please report the following code to system administrator:<h4><p><center>%s<center/></p></h4>", uuid));
+			label = label.concat(String.format("<br />%s<h4><p><center>%s<center/></p></h4>", i18n.getInstructions(), uuid));
 		}
 		final Html errorLabel = new Html("<span>" + label + "</span>");
 		errorLabel.getElement().getStyle().set("width", "100%");

src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindowI18n.java

@@ -0,0 +1,122 @@
+/*-
+ * #%L
+ * Error Window Add-on Project
+ * %%
+ * Copyright (C) 2018 - 2020 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.errorwindow;
+
+/**
+ * Internationalization object for customizing the component UI texts.
+ * An instance with the default messages can be obtained using {@link ErrorWindowI18n#createDefault()}
+ *
+ * @author [email protected]
+ *
+ */
+public class ErrorWindowI18n {
+
+	private String caption;
+	private String instructions;
+	private String close;
+	private String details;
+	private String defaultErrorMessage;
+
+	private ErrorWindowI18n() {
+		this.caption = "An error has occurred";
+		this.instructions = "Please report the following code to your system administrator";
+		this.close = "Close";
+		this.details = "Show error details";
+		this.defaultErrorMessage = "Please contact the system administrator for more information.";
+	}
+
+	/**
+	 * @return a new instance with the default messages
+	 */
+	public static ErrorWindowI18n createDefault() {
+		return new ErrorWindowI18n();
+	}
+
+	/**
+	 * Sets the caption of the error window.
+	 */
+	public void setCaption(final String caption) {
+		this.caption = caption;
+	}
+
+	/**
+	 * @return returns the caption of the error window.
+	 */
+	public String getCaption() {
+		return this.caption;
+	}
+
+	/**
+	 * Sets the instructions for the user if the UUID is displayed in production mode.
+	 */
+	public void setInstructions(final String instructions) {
+		this.instructions = instructions;
+	}
+
+	/**
+	 * @return returns the instructions for the user if the UUID is displayed in production mode.
+	 */
+	public String getInstructions() {
+		return this.instructions;
+	}
+
+	/**
+	 * Sets the text of the "Close"-Button.
+	 */
+	public void setClose(final String close) {
+		this.close = close;
+	}
+
+	/**
+	 * @return returns the text of the "Close"-Button.
+	 */
+	public String getClose() {
+		return this.close;
+	}
+
+	/**
+	 * Sets the text of the "Details"-Button.
+	 */
+	public void setDetails(final String details) {
+		this.details = details;
+	}
+
+	/**
+	 * @return returns the text of the "Details"-Button.
+	 */
+	public String getDetails() {
+		return this.details;
+	}
+
+	/**
+	 * Sets the default error message shown if the message passed to the error window is <code>null</code>.
+	 */
+	public void setDefaultErrorMessage(final String defaultErrorMessage) {
+		this.defaultErrorMessage = defaultErrorMessage;
+	}
+
+	/**
+	 * @return returns the default error message shown if the message passed to the error window is <code>null</code>.
+	 */
+	public String getDefaultErrorMessage() {
+		return this.defaultErrorMessage;
+	}
+
+}

src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java

@@ -49,14 +49,29 @@ public ErrorwindowDemo() {
 			}
 		});
 
+		Button throwErrorWithCustomMessageAndCustomTexts = new Button("Throw Error with custom message (custom labels)", ev -> {
+			try {
+				Integer.parseInt("asdf");
+			} catch (NumberFormatException e) {
+				ErrorWindowI18n i18n = ErrorWindowI18n.createDefault();
+				i18n.setCaption("Uh oh... that's embarrassing");
+				i18n.setInstructions("Please pass this unique error identifier to your administrator");
+				i18n.setClose("Ok");
+				i18n.setDetails("Show me technical details");
+				i18n.setDefaultErrorMessage("Something really strange happened");
+				ErrorWindow w = new ErrorWindow(e, "CUSTOM ERROR MESSAGE", i18n);
+				w.open();
+			}
+		});
+
 		Checkbox productionModeCb = new Checkbox("Production Mode");
 		productionModeCb.addValueChangeListener(e -> {
 			System.setProperty("productionMode", "" + productionModeCb.getValue().toString());
 			Notification.show("Currently production mode is: " + System.getProperty("productionMode"));
 		});
 
 		setSizeFull();
-		add(productionModeCb, errorButton, throwErrorWithoutErrorHandler, throwErrorWithCustomMessage);
+		add(productionModeCb, errorButton, throwErrorWithoutErrorHandler, throwErrorWithCustomMessageAndCustomTexts, throwErrorWithCustomMessage);
 	}
 
 }