Package com.storedobject.vaadin

Class ActionForm

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<Object>

com.storedobject.vaadin.DataForm

com.storedobject.vaadin.ActionForm

All Implemented Interfaces:

ClickHandler, ExecutableView, HasContainer, ValueChangeHandler, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.HasValue.ValueChangeListener, Serializable, Runnable, EventListener

Direct Known Subclasses:

InformationMessage

public class ActionForm
extends DataForm

Action form is used to execute some action if the user confirms it by pressing a "Yes" button.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.vaadin.AbstractDataForm

AbstractDataForm.FieldError

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Field Summary

Fields inherited from class com.storedobject.vaadin.DataForm

buttonPanel, cancel, ok

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
ActionForm(com.vaadin.flow.component.Component message, Runnable action)	Constructor.
ActionForm(com.vaadin.flow.component.Component message, Runnable actionYes, Runnable actionNo)	Constructor.
ActionForm(com.vaadin.flow.component.Component message, Runnable actionYes, Runnable actionNo, String labelYes, String labelNo)	Constructor.
ActionForm(com.vaadin.flow.component.Component message, Runnable action, String labelYes, String labelNo)	Constructor.
ActionForm(String message)	Constructor without any action (can be set later).
ActionForm(String caption, com.vaadin.flow.component.Component message, Runnable action)	Constructor.
ActionForm(String caption, com.vaadin.flow.component.Component message, Runnable actionYes, Runnable actionNo)	Constructor.
ActionForm(String caption, com.vaadin.flow.component.Component message, Runnable actionYes, Runnable actionNo, String labelYes, String labelNo)	Constructor.
ActionForm(String caption, com.vaadin.flow.component.Component message, Runnable action, String labelYes, String labelNo)	Constructor.
ActionForm(String message, Runnable action)	Constructor.
ActionForm(String message, Runnable actionYes, Runnable actionNo)	Constructor.
ActionForm(String message, Runnable actionYes, Runnable actionNo, String labelYes, String labelNo)	Constructor.
ActionForm(String message, Runnable action, String labelYes, String labelNo)	Constructor.
ActionForm(String caption, String message, Runnable action)	Constructor.
ActionForm(String caption, String message, Runnable actionYes, Runnable actionNo)	Constructor.
ActionForm(String caption, String message, Runnable actionYes, Runnable actionNo, String labelYes, String labelNo)	Constructor.
ActionForm(String caption, String message, Runnable action, String labelYes, String labelNo)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	buildFields()	This is where the fields are built.
protected final void	cancel()	Action defined for "No" button (if any) is invoked here.
protected com.vaadin.flow.component.HasComponents	createFieldContainer()	A Div container is created.
protected void	execute(View parent, boolean doNotLock)	Overridden to implement "preconfirm" check.
static void	execute(com.vaadin.flow.component.Component message, Runnable action)	Execute an action if the user confirms it.
static void	execute(String message, Runnable action)	Execute an action if the user confirms it.
Runnable	getCancelAction()	Get the cancel action.
Runnable	getConfirmAction()	Get the confirm action.
protected String	getDefaultCaption()	Get the default caption.
protected String	getDefaultNoLabel()	Get the default "No" label.
protected String	getDefaultYesLabel()	Get the default "Yes" label.
protected final boolean	process()	Action defined for "Yes" button is invoked here.
void	setCancelAction(Runnable actionNo)	Set the cancel action.
void	setConfirmAction(Runnable actionYes)	Set the confirm action.
void	setPreconfirm(BooleanSupplier preconfirm)	Set a "preconfirm" check.

Methods inherited from class com.storedobject.vaadin.DataForm

buildButtons, clicked, getMaximumContentHeight, getMaximumContentWidth, getMinimumContentHeight, getMinimumContentWidth, initUI, setButtonsAtTop, setCloseable, setWindowMode, sizeSet, skipFirstFocus, validateData

Methods inherited from class com.storedobject.vaadin.AbstractDataForm

add, addConstructedListener, addField, addField, addIncludeFieldChecker, addValidator, addValidator, attachField, clean, clearAlerts, clearError, clearErrors, clearFields, commit, connect, connect, connect, createButtonLayout, createField, createField, createLayout, detachField, fieldAttached, fieldDetached, fireFormConstructed, formConstructed, getColumns, getColumnSpan, getContainer, getContent, getData, getErrorDisplay, getField, getFieldLabel, getFieldLabel, getFieldName, getFieldNames, getForm, getLabel, isFieldEditable, isFieldEditable, isFieldVisible, isFieldVisible, isReadOnly, load, markError, newLine, remove, removeAll, removeField, removeField, removeField, setColumns, setColumnSpan, setErrorDisplay, setFieldContainerProvider, setFieldCustomizer, setFieldEditable, setFieldEditable, setFieldHidden, setFieldHidden, setFieldLabel, setFieldLabel, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldVisible, setFieldVisible, setFieldVisible, setFieldVisible, setIncludeFieldChecker, setReadOnly, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, streamFieldNamesCreated, streamFieldsCreated

Methods inherited from class com.storedobject.vaadin.View

abort, aborted, addClosedListener, addOpenedListener, close, createCloseableView, createWindow, decorateComponent, execute, execute, executing, focus, focus, focusAny, getApplication, getCaption, getComponent, getCreatedBy, getEmbeddedView, getMenuItem, getMenuItem, getView, invoke, isFullScreen, isScrollable, isWindowMode, select, setCaption, setComponent, setCreatedBy, setDefaultPadding, setEmbeddedView, setFirstFocus, setFullScreen, setScrollable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface com.storedobject.vaadin.ExecutableView

createMenuItem, error, getMenuIconName, getView, isCloseable, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

ActionForm

public ActionForm(String message)

Constructor without any action (can be set later).

Parameters:

message - Message to be shown

ActionForm

public ActionForm(String message,
 Runnable action)

Constructor.

Parameters:

message - Message to be shown

action - Action when "Yes" button is pressed

ActionForm

public ActionForm(com.vaadin.flow.component.Component message,
 Runnable action)

Constructor.

Parameters:

message - Message to be shown

action - Action when "Yes" button is pressed

ActionForm

public ActionForm(String message,
 Runnable action,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

message - Message to be shown

action - Action when "Yes" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(com.vaadin.flow.component.Component message,
 Runnable action,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

message - Message to be shown

action - Action when "Yes" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(String message,
 Runnable actionYes,
 Runnable actionNo)

Constructor.

Parameters:

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

ActionForm

public ActionForm(com.vaadin.flow.component.Component message,
 Runnable actionYes,
 Runnable actionNo)

Constructor.

Parameters:

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

ActionForm

public ActionForm(String message,
 Runnable actionYes,
 Runnable actionNo,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(com.vaadin.flow.component.Component message,
 Runnable actionYes,
 Runnable actionNo,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(String caption,
 String message,
 Runnable action)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

action - Action when "Yes" button is pressed

ActionForm

public ActionForm(String caption,
 com.vaadin.flow.component.Component message,
 Runnable action)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

action - Action when "Yes" button is pressed

ActionForm

public ActionForm(String caption,
 String message,
 Runnable action,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

action - Action when "Yes" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(String caption,
 com.vaadin.flow.component.Component message,
 Runnable action,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

action - Action when "Yes" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(String caption,
 String message,
 Runnable actionYes,
 Runnable actionNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

ActionForm

public ActionForm(String caption,
 com.vaadin.flow.component.Component message,
 Runnable actionYes,
 Runnable actionNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

ActionForm

public ActionForm(String caption,
 String message,
 Runnable actionYes,
 Runnable actionNo,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

ActionForm

public ActionForm(String caption,
 com.vaadin.flow.component.Component message,
 Runnable actionYes,
 Runnable actionNo,
 String labelYes,
 String labelNo)

Constructor.

Parameters:

caption - Caption to be displayed

message - Message to be shown

actionYes - Action when "Yes" button is pressed

actionNo - Action when "No" button is pressed

labelYes - Label for "Yes" button

labelNo - Label for "No" button

Method Details

getDefaultYesLabel

protected String getDefaultYesLabel()

Get the default "Yes" label.

Returns:

The default label for the "Yes" button.

getDefaultNoLabel

protected String getDefaultNoLabel()

Get the default "No" label.

Returns:

The default label for the "No" button.

getDefaultCaption

protected String getDefaultCaption()

Get the default caption.

Returns:

The default caption.

createFieldContainer

protected com.vaadin.flow.component.HasComponents createFieldContainer()

A Div container is created.

Overrides:

createFieldContainer in class AbstractDataForm<Object>

Returns:

Div container.

buildFields

protected void buildFields()

Description copied from class: DataForm

This is where the fields are built. Typically, we create the fields and add it using AbstractDataForm.addField(HasValue...) or AbstractDataForm.addField(String, HasValue) methods.

Overrides:

buildFields in class DataForm

getConfirmAction

public Runnable getConfirmAction()

Get the confirm action.

Returns:

Confirm action.

setConfirmAction

public void setConfirmAction(Runnable actionYes)

Set the confirm action.

Parameters:

actionYes - Action from "Yes" button is pressed

getCancelAction

public Runnable getCancelAction()

Get the cancel action.

Returns:

Cancel action.

setCancelAction

public void setCancelAction(Runnable actionNo)

Set the cancel action.

Parameters:

actionNo - Action from "No" button is pressed

cancel

protected final void cancel()

Action defined for "No" button (if any) is invoked here.

Overrides:

cancel in class DataForm

process

protected final boolean process()

Action defined for "Yes" button is invoked here.

Specified by:

process in class DataForm

Returns:

True or false.

setPreconfirm

public void setPreconfirm(BooleanSupplier preconfirm)

Set a "preconfirm" check. If this is set, confirm box is displayed only if the "preconfirm" returns true (BooleanSupplier.getAsBoolean()).

Parameters:

preconfirm - Preconfirm

execute

protected void execute(View parent,
 boolean doNotLock)

Overridden to implement "preconfirm" check.

Overrides:

execute in class View

Parameters:

parent - Parent view to lock

doNotLock - True if parent should not be locked

See Also:

• setPreconfirm(BooleanSupplier)

execute

public static void execute(String message,
 Runnable action)

Execute an action if the user confirms it.

Parameters:

message - Message to be shown

action - Action to be executed

execute

public static void execute(com.vaadin.flow.component.Component message,
 Runnable action)

Execute an action if the user confirms it.

Parameters:

message - Message to be shown

action - Action to be executed