com.whitestein.lsps.vaadin

Interface LspsFormConnector

All Superinterfaces:

Serializable

public interface LspsFormConnector
extends Serializable

Interface for a connector between an LSPS form and an application view. This interface defines services which should be provided by the application to the LSPS form. Hence the application should provide implementation of this interface to the LspsContextHolder so that the LSPS forms can make use of those services in runtime.

Author:

mhi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LspsFormConnector.ProcessingResult Bean representing the result of the last form processing.
static class	LspsFormConnector.ValidationErrors Contains validation errors.

Method Summary

Modifier and Type	Method and Description
void	handleError(Throwable t) This method is called when an exception is thrown during form processing.
void	navigate(RecordHolder navigation, boolean closeForm) Opens the requested application page, replacing the given component.
void	onProcessingEnd(LspsFormConnector.ProcessingResult status) Called at the end of each form processing invocation.
void	setContent(com.vaadin.ui.Component content) Updates the form content.
void	setTitle(String title) Updates the title of the form.
void	showNotification(com.vaadin.ui.Notification notif) Displays a notification for this form.

Method Detail

setContent

void setContent(com.vaadin.ui.Component content)

Updates the form content. Invoked whenever the form content should be replaced. Content may be null, e.g. when rendering of the screen has failed.

Parameters:

content -

setTitle

void setTitle(String title)

Updates the title of the form.

Parameters:

title -

navigate

void navigate(RecordHolder navigation,
              boolean closeForm)

Opens the requested application page, replacing the given component. This method is invoked after the form is submitted or cancelled or if a listener requests a page to be shown (e.g. when ui::NavigationAction is used). Note that ui::NavigationLink is rendered as a plain link by default and does not call this method (see LspsUrlFactory instead). If the navigation definition is null, default view should be shown. If closeForm is true, the current form is not valid anymore and it should be closed.

Parameters:

navigation - navigation definition, may be null

closeForm - true if this form should be closed

onProcessingEnd

void onProcessingEnd(LspsFormConnector.ProcessingResult status)

Called at the end of each form processing invocation.

Parameters:

status -

showNotification

void showNotification(com.vaadin.ui.Notification notif)

Displays a notification for this form.

Parameters:

notif -

handleError

void handleError(Throwable t)

This method is called when an exception is thrown during form processing.

Parameters:

t -