org.opennms.features.vaadin.jmxconfiggenerator.ui

Class UIHelper

java.lang.Object

org.opennms.features.vaadin.jmxconfiggenerator.ui.UIHelper

public abstract class UIHelper
extends Object

This class provides several helper methods for ui stuff, e.g. creating a button. So the amount of code is reduced generally.

Author:

Markus von Rüden

Constructor Summary

Constructors

Constructor and Description
UIHelper()

Method Summary

Modifier and Type	Method and Description
static com.vaadin.ui.Button	createButton(String buttonCaption, String buttonDescription, com.vaadin.server.Resource icon, com.vaadin.ui.Button.ClickListener clickListener)
static JmxConfigGeneratorUI	getCurrent()
static String	loadContentFromFile(Class<?> clazz, String resourceName) Loads the resourceName from the classpath using the given clazz.
static void	showNotification(String message)
static void	showNotification(String title, String message, com.vaadin.ui.Notification.Type type)
static void	showNotification(String title, String message, com.vaadin.ui.Notification.Type type, int delayMsec)
static void	showValidationError(String errorMessage) Shows a validation error to the user.
static void	updateView(UiState newUiState)
static void	validateField(com.vaadin.ui.Field<?> field, boolean swallowValidationExceptions) Validates the given field and sets the component error accordingly.
static void	validateFields(Collection<com.vaadin.ui.Field<?>> fields, boolean swallowValidationExceptions)

Methods inherited from class java.lang.Object

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

Constructor Detail

UIHelper

public UIHelper()

Method Detail

createButton

public static com.vaadin.ui.Button createButton(String buttonCaption,
                                                String buttonDescription,
                                                com.vaadin.server.Resource icon,
                                                com.vaadin.ui.Button.ClickListener clickListener)

loadContentFromFile

public static String loadContentFromFile(Class<?> clazz,
                                         String resourceName)

Loads the resourceName from the classpath using the given clazz. If the resource couldn't be loaded an empty string is returned.

Parameters:

clazz - The class to use for loading the resource.

resourceName - The name of the resource to be loaded (e.g. /folder/filename.txt)

Returns:

The content of the file, each line separated by line.separator or empty string if the resource does not exist.

showValidationError

public static void showValidationError(String errorMessage)

Shows a validation error to the user.

Parameters:

errorMessage - the error message.

getCurrent

public static JmxConfigGeneratorUI getCurrent()

showNotification

public static void showNotification(String message)

showNotification

public static void showNotification(String title,
                                    String message,
                                    com.vaadin.ui.Notification.Type type)

showNotification

public static void showNotification(String title,
                                    String message,
                                    com.vaadin.ui.Notification.Type type,
                                    int delayMsec)

updateView

public static void updateView(UiState newUiState)

validateField

public static void validateField(com.vaadin.ui.Field<?> field,
                                 boolean swallowValidationExceptions)
                          throws com.vaadin.data.Validator.InvalidValueException

Validates the given field and sets the component error accordingly. Please note, that the provided field must implement Field and must be a sub class of AbstractComponent.

Parameters:

field - The field to validate (must be a sub class of AbstractComponent).

swallowValidationExceptions - Indicates if an InvalidValueException is swallowed and not propagated. If false the first occurring InvalidValueException is thrown.

Throws:

Validator.InvalidValueException - If the field is not valid (see Validator.validate(Object).

validateFields

public static void validateFields(Collection<com.vaadin.ui.Field<?>> fields,
                                  boolean swallowValidationExceptions)