pl.fhframework.model.forms.messages

Class Messages

java.lang.Object

pl.fhframework.model.forms.messages.Messages

All Implemented Interfaces:

pl.fhframework.core.messages.IMessages

@Component
public class Messages
extends Object
implements pl.fhframework.core.messages.IMessages

Class containing helper methods which creates dialogs. Dialogs can be used as informative or can be provided with actions. Examples:

 
 public class MagicPU extends IUseCase<...> {

 @Autowired private Messages messages;

 public void doMagic() {
 ...
 messages.showMessage(getUserSession(), "Urgent infomation", Messages.Severity.INFO);
 ...
 messages.showActionMessage(getUserSession(), "Title", "Message", Messages.Severity.INFO,
 ActionButton.get(
 "Info",
 ()-> messages.showMessage(getUserSession(), "Success", "Info pressed", Messages.Severity.SUCCESS))
 }
 }
 
 

Created by krzysztof.kobylarek on 2016-10-20.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Messages.Builder
static class	Messages.Severity Severity status os message
static class	Messages.TextMessage Helper class used to facilitate creation of messages

Constructor Summary

Constructors

Constructor and Description
Messages()

Method Summary

Modifier and Type	Method and Description
static Messages.Builder	builder(pl.fhframework.UserSession userSession)
static void	close(pl.fhframework.events.ViewEvent viewEvent) Action to close message dialog
void	init()
static pl.fhframework.core.messages.MessagePopup	showActionMessage(pl.fhframework.UserSession session, String title, Messages.TextMessage textMessage, Messages.Severity severity, ActionButton... actions) Helper method Shows message dialog and creates button provided with actions triggered when button is pressed
static pl.fhframework.core.messages.MessagePopup	showActionMessage(pl.fhframework.UserSession session, String title, String message, Messages.Severity severity, ActionButton... actions) Helper method Shows message dialog and creates button provided with actions triggered when button is pressed
pl.fhframework.core.messages.MessagePopup	showConfirmation(pl.fhframework.UserSession session, String message, pl.fhframework.core.messages.Action action) Helper method Shows simple message with default title
pl.fhframework.core.messages.MessagePopup	showConfirmation(pl.fhframework.UserSession session, String title, String message, pl.fhframework.core.messages.Action action) Helper method Shows simple message with default title
pl.fhframework.core.messages.MessagePopup	showError(pl.fhframework.UserSession session, String message, pl.fhframework.core.messages.Action action) Helper method
pl.fhframework.core.messages.MessagePopup	showError(pl.fhframework.UserSession session, String title, String message, pl.fhframework.core.messages.Action action) Helper method
static pl.fhframework.core.messages.MessagePopup	showErrorMessage(pl.fhframework.UserSession session, String message, Throwable error) Helper method
protected static pl.fhframework.core.messages.MessagePopup	showErrorMessage(pl.fhframework.UserSession session, String message, Throwable error, boolean noOverflow) Helper method
static pl.fhframework.core.messages.MessagePopup	showErrorMessageNoOverflow(pl.fhframework.UserSession session, String message, Throwable error) Helper method
pl.fhframework.core.messages.MessagePopup	showInfo(pl.fhframework.UserSession session, String message, pl.fhframework.core.messages.Action action) Helper method Shows simple message with default title
pl.fhframework.core.messages.MessagePopup	showInfo(pl.fhframework.UserSession session, String title, String message, pl.fhframework.core.messages.Action action) Helper method Shows simple message with default title
static pl.fhframework.core.messages.MessagePopup	showInfoMessage(pl.fhframework.UserSession session, String message) Helper method Shows simple message with default title
protected static pl.fhframework.core.messages.MessagePopup	showInfoMessage(pl.fhframework.UserSession session, String message, boolean noOverflow) Helper method Shows simple message with default title
static pl.fhframework.core.messages.MessagePopup	showInfoMessageNoOverflow(pl.fhframework.UserSession session, String message) Helper method Shows simple message with default title
static void	showMessage(Messages.Builder builder) Shows message represented by message builder.
static pl.fhframework.core.messages.MessagePopup	showMessage(pl.fhframework.UserSession session, String dialogTitle, String message, Messages.Severity severity) Helper method Shows dialog with one close button
protected static pl.fhframework.core.messages.MessagePopup	showMessage(pl.fhframework.UserSession session, String dialogTitle, String message, Messages.Severity severity, boolean noOverflow) Helper method Shows dialog with one close button
static pl.fhframework.core.messages.MessagePopup	showMessageNoOverflow(pl.fhframework.UserSession session, String dialogTitle, String message, Messages.Severity severity) Helper method Shows dialog with one close button

Methods inherited from class java.lang.Object

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

Constructor Detail

Messages

public Messages()

Method Detail

init

@PostConstruct
public void init()

showInfoMessage

public static pl.fhframework.core.messages.MessagePopup showInfoMessage(pl.fhframework.UserSession session,
                                                                        String message)

Helper method Shows simple message with default title

Parameters:

session - user session

message - actual message

showInfoMessageNoOverflow

public static pl.fhframework.core.messages.MessagePopup showInfoMessageNoOverflow(pl.fhframework.UserSession session,
                                                                                  String message)

Helper method Shows simple message with default title

Parameters:

session - user session

message - actual message

showInfoMessage

protected static pl.fhframework.core.messages.MessagePopup showInfoMessage(pl.fhframework.UserSession session,
                                                                           String message,
                                                                           boolean noOverflow)

Helper method Shows simple message with default title

Parameters:

session - user session

message - actual message

showActionMessage

public static pl.fhframework.core.messages.MessagePopup showActionMessage(pl.fhframework.UserSession session,
                                                                          String title,
                                                                          Messages.TextMessage textMessage,
                                                                          Messages.Severity severity,
                                                                          ActionButton... actions)

Helper method Shows message dialog and creates button provided with actions triggered when button is pressed

Parameters:

session - user session

title - message dialog title

textMessage - actual message, instance of TextMessage

severity - severity of message

actions - actions to be triggered when button is pressed

showActionMessage

public static pl.fhframework.core.messages.MessagePopup showActionMessage(pl.fhframework.UserSession session,
                                                                          String title,
                                                                          String message,
                                                                          Messages.Severity severity,
                                                                          ActionButton... actions)

Helper method Shows message dialog and creates button provided with actions triggered when button is pressed

Parameters:

session - user session

title - message dialog title

message - actual message

severity - severity of message

actions - actions to be triggered when button is pressed

showMessage

public static pl.fhframework.core.messages.MessagePopup showMessage(pl.fhframework.UserSession session,
                                                                    String dialogTitle,
                                                                    String message,
                                                                    Messages.Severity severity)

Helper method Shows dialog with one close button

Parameters:

session - user session

dialogTitle - message dialog title

message - actual message

severity - severity of message

showMessageNoOverflow

public static pl.fhframework.core.messages.MessagePopup showMessageNoOverflow(pl.fhframework.UserSession session,
                                                                              String dialogTitle,
                                                                              String message,
                                                                              Messages.Severity severity)

Helper method Shows dialog with one close button

Parameters:

session - user session

dialogTitle - message dialog title

message - actual message

severity - severity of message

showMessage

protected static pl.fhframework.core.messages.MessagePopup showMessage(pl.fhframework.UserSession session,
                                                                       String dialogTitle,
                                                                       String message,
                                                                       Messages.Severity severity,
                                                                       boolean noOverflow)

Helper method Shows dialog with one close button

Parameters:

session - user session

dialogTitle - message dialog title

message - actual message

severity - severity of message

showErrorMessage

public static pl.fhframework.core.messages.MessagePopup showErrorMessage(pl.fhframework.UserSession session,
                                                                         String message,
                                                                         Throwable error)

Helper method

Parameters:

session -

message -

error -

showErrorMessageNoOverflow

public static pl.fhframework.core.messages.MessagePopup showErrorMessageNoOverflow(pl.fhframework.UserSession session,
                                                                                   String message,
                                                                                   Throwable error)

Helper method

Parameters:

session -

message -

error -

showErrorMessage

protected static pl.fhframework.core.messages.MessagePopup showErrorMessage(pl.fhframework.UserSession session,
                                                                            String message,
                                                                            Throwable error,
                                                                            boolean noOverflow)

Helper method

Parameters:

session -

message -

error -

showInfo

public pl.fhframework.core.messages.MessagePopup showInfo(pl.fhframework.UserSession session,
                                                          String message,
                                                          pl.fhframework.core.messages.Action action)

Helper method Shows simple message with default title

Specified by:

showInfo in interface pl.fhframework.core.messages.IMessages

Parameters:

session - user session

message - actual message

showInfo

public pl.fhframework.core.messages.MessagePopup showInfo(pl.fhframework.UserSession session,
                                                          String title,
                                                          String message,
                                                          pl.fhframework.core.messages.Action action)

Helper method Shows simple message with default title

Specified by:

showInfo in interface pl.fhframework.core.messages.IMessages

Parameters:

session - user session

message - actual message

showConfirmation

public pl.fhframework.core.messages.MessagePopup showConfirmation(pl.fhframework.UserSession session,
                                                                  String message,
                                                                  pl.fhframework.core.messages.Action action)

Helper method Shows simple message with default title

Specified by:

showConfirmation in interface pl.fhframework.core.messages.IMessages

Parameters:

session - user session

message - actual message

showConfirmation

public pl.fhframework.core.messages.MessagePopup showConfirmation(pl.fhframework.UserSession session,
                                                                  String title,
                                                                  String message,
                                                                  pl.fhframework.core.messages.Action action)

Helper method Shows simple message with default title

Specified by:

showConfirmation in interface pl.fhframework.core.messages.IMessages

Parameters:

session - user session

message - actual message

showError

public pl.fhframework.core.messages.MessagePopup showError(pl.fhframework.UserSession session,
                                                           String message,
                                                           pl.fhframework.core.messages.Action action)

Helper method

Specified by:

showError in interface pl.fhframework.core.messages.IMessages

Parameters:

session -

message -

showError

public pl.fhframework.core.messages.MessagePopup showError(pl.fhframework.UserSession session,
                                                           String title,
                                                           String message,
                                                           pl.fhframework.core.messages.Action action)

Helper method

Specified by:

showError in interface pl.fhframework.core.messages.IMessages

Parameters:

session -

message -

showMessage

public static void showMessage(Messages.Builder builder)

Shows message represented by message builder.

Parameters:

builder - Message builder filled with message data and action. Created to provide more flexibility than helper methods

close

public static void close(pl.fhframework.events.ViewEvent viewEvent)

Action to close message dialog

Parameters:

viewEvent -

builder

public static Messages.Builder builder(pl.fhframework.UserSession userSession)