info.magnolia.ui

Class AlertBuilder

java.lang.Object

info.magnolia.ui.AlertBuilder

public class AlertBuilder
extends Object

The AlertBuilder assists in opening alerts and confirm-dialogs in Magnolia.

Usage starts from either of the following static methods:

• confirmDialog(String, Runnable)
• or alert(String)

After that, body, callbacks, level and button captions may be configured through fluent builder-style methods.

Finally, the AlertBuilder has two terminal operations, both returning a standard Vaadin Window component, ready to use.

• build() returns the Window but does not open it;
• buildAndOpen() returns the Window and opens it in the current UI

Example:

 AlertBuilder.confirmDialog("Say hi?")
         .withLevel(Notification.Type.HUMANIZED_MESSAGE)
         .withBody("Do you want to say hello?")
         .withOkButtonCaption("You bet")
         .withDeclineButtonCaption("No way")
         .withConfirmationHandler(() -> sayHello(name))
         .buildAndOpen();
 

Method Summary

Modifier and Type	Method and Description
static AlertBuilder	alert(String title)
com.vaadin.ui.Window	build()
com.vaadin.ui.Window	buildAndOpen()
static AlertBuilder	confirmDialog(String title)
static AlertBuilder	confirmDialog(String title, Runnable confirmationHandler)
AlertBuilder	withBody(String body)
AlertBuilder	withConfirmationHandler(Runnable confirmationHandler)
AlertBuilder	withConfirmButtonCaption(String confirmButtonCaption)
AlertBuilder	withContent(com.vaadin.ui.Component content)
AlertBuilder	withDeclineButtonCaption(String declineButtonCaption)
AlertBuilder	withLevel(com.vaadin.ui.Notification.Type level)
AlertBuilder	withOkButtonCaption(String okButtonCaption)
AlertBuilder	withTitle(String title)

Methods inherited from class java.lang.Object

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

Method Detail

confirmDialog

public static AlertBuilder confirmDialog(String title)

confirmDialog

public static AlertBuilder confirmDialog(String title,
                                         Runnable confirmationHandler)

alert

public static AlertBuilder alert(String title)

withTitle

public AlertBuilder withTitle(String title)

withBody

public AlertBuilder withBody(String body)

withContent

public AlertBuilder withContent(com.vaadin.ui.Component content)

withLevel

public AlertBuilder withLevel(com.vaadin.ui.Notification.Type level)

withConfirmButtonCaption

public AlertBuilder withConfirmButtonCaption(String confirmButtonCaption)

withOkButtonCaption

public AlertBuilder withOkButtonCaption(String okButtonCaption)

withDeclineButtonCaption

public AlertBuilder withDeclineButtonCaption(String declineButtonCaption)

withConfirmationHandler

public AlertBuilder withConfirmationHandler(Runnable confirmationHandler)

build

public com.vaadin.ui.Window build()

buildAndOpen

public com.vaadin.ui.Window buildAndOpen()