Package com.storedobject.vaadin

Class DataForm

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<Object>

com.storedobject.vaadin.DataForm

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:

ActionForm

public abstract class DataForm
extends AbstractDataForm<Object>

This class is used to accept some quick data from the users. It has an "Ok" and a "Cancel" button. By default, is is displayed as a Dialog box.

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

Modifier and Type	Field	Description
protected com.vaadin.flow.component.HasComponents	buttonPanel	Button panel where buttons are added.
protected Button	cancel	The Cancel button.
protected Button	ok	The Ok button.

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
DataForm(String caption)	Constructor.
DataForm(String caption, boolean windowMode)	Constructor.
DataForm(String caption, boolean windowMode, boolean centered)	Constructor.
DataForm(String caption, String labelOK, String labelCancel)	Constructor.
DataForm(String caption, String labelOK, String labelCancel, boolean windowMode)	Constructor.
DataForm(String caption, String labelOK, String labelCancel, boolean windowMode, boolean centered)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	buildButtons()	Build the buttons.
protected void	buildFields()	This is where the fields are built.
protected void	cancel()	This method is invoked if the "Cancel" button is pressed.
void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
int	getMaximumContentHeight()	Get the maximum "content height" (Percentage value of the view port height.
int	getMaximumContentWidth()	Get the maximum "content width" (Percentage value of the view port width).
int	getMinimumContentHeight()	Get the minimum "content height" (Percentage value of the view port height.
int	getMinimumContentWidth()	Get the minimum "content width" (Percentage value of the view port width).
protected final void	initUI()	This method is invoked when the view wants to determine its "content" to be displayed and nothing exists at that moment.
protected abstract boolean	process()	This method is invoked if the "Ok" button is pressed and there is no error raised by validateData() method.
void	setButtonsAtTop(boolean buttonsAtTop)	Button panel is normally shown at the bottom.
void	setCloseable(boolean closeable)	Set the closeability.
void	setWindowMode(boolean windowOn)	Set the "window mode".
protected void	sizeSet()	This method is invoked once when the size of the content is set.
boolean	skipFirstFocus(com.vaadin.flow.component.Focusable<?> skipFocus)	Check if this component to be skipped while traversing the component tree to find the first focusable component or not.
protected void	validateData()	Validate data.

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, createFieldContainer, 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, setRequired, streamFieldNamesCreated, streamFieldsCreated

Methods inherited from class com.storedobject.vaadin.View

abort, aborted, addClosedListener, addOpenedListener, close, createCloseableView, createWindow, decorateComponent, execute, 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

Field Details

ok

protected Button ok

The Ok button.

cancel

protected Button cancel

The Cancel button.

buttonPanel

protected com.vaadin.flow.component.HasComponents buttonPanel

Button panel where buttons are added.

Constructor Details

DataForm

public DataForm(String caption)

Constructor.

Parameters:

caption - Caption

DataForm

public DataForm(String caption,
 boolean windowMode)

Constructor.

Parameters:

caption - Caption

windowMode - True if the view to be displayed as a window/dialog

DataForm

public DataForm(String caption,
 boolean windowMode,
 boolean centered)

Constructor.

Parameters:

caption - Caption

windowMode - True if the view to be displayed as a window/dialog

centered - Whether the components to be centered in the content area or not. Useful only when the "window mode" is off.

DataForm

public DataForm(String caption,
 String labelOK,
 String labelCancel)

Constructor.

Parameters:

caption - Caption

labelOK - "Ok" label

labelCancel - "Cancel" label

DataForm

public DataForm(String caption,
 String labelOK,
 String labelCancel,
 boolean windowMode)

Constructor.

Parameters:

caption - Caption

labelOK - "Ok" label

labelCancel - "Cancel" label

windowMode - True if the view to be displayed as a window/dialog

DataForm

public DataForm(String caption,
 String labelOK,
 String labelCancel,
 boolean windowMode,
 boolean centered)

Constructor.

Parameters:

caption - Caption

labelOK - "Ok" label

labelCancel - "Cancel" label

windowMode - True if the view to be displayed as a window/dialog

centered - Whether the components to be centered in the content area or not. Useful only when the "window mode" is off.

Method Details

initUI

protected final void initUI()

Description copied from class: View

This method is invoked when the view wants to determine its "content" to be displayed and nothing exists at that moment. View.setComponent(Component) may be called from within this method.

Overrides:

initUI in class View

sizeSet

protected void sizeSet()

This method is invoked once when the size of the content is set. You can do further change if any.

getMinimumContentWidth

public int getMinimumContentWidth()

Get the minimum "content width" (Percentage value of the view port width). Value should be between 10 and 80. This value is used only in "window mode" or "centered" mode.

Returns:

Percentage value of the view port width. Default is 10%.

getMaximumContentWidth

public int getMaximumContentWidth()

Get the maximum "content width" (Percentage value of the view port width). Value should be between 10 and 90. This value is used only in "window mode" or "centered" mode.

Returns:

Percentage value of the view port width. Default is 80%.

getMinimumContentHeight

public int getMinimumContentHeight()

Get the minimum "content height" (Percentage value of the view port height. Value should be between 10 and 80.) This value is used only in "window mode" or "centered" mode.

Returns:

Percentage value of the view port height. Default is 10%.

getMaximumContentHeight

public int getMaximumContentHeight()

Get the maximum "content height" (Percentage value of the view port height. Value should be between 10 and 90.) This value is used only in "window mode" or "centered" mode.

Returns:

Percentage value of the view port height. Default is 80%.

setWindowMode

public void setWindowMode(boolean windowOn)

Description copied from class: View

Set the "window mode". Content of the view will be wrapped in a Dialog for "window mode".

Overrides:

setWindowMode in class View

Parameters:

windowOn - Window mode

skipFirstFocus

public boolean skipFirstFocus(com.vaadin.flow.component.Focusable<?> skipFocus)

Description copied from class: View

Check if this component to be skipped while traversing the component tree to find the first focusable component or not.

Overrides:

skipFirstFocus in class View

Parameters:

skipFocus - The focusable component

Returns:

False if it should not be skipped (Default implementation returns false).

buildFields

protected void buildFields()

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.

buildButtons

protected void buildButtons()

Build the buttons. Button "Ok" and "Cancel" are already created. This method add those to the buttonPanel. You can add additional custom buttons and components to the buttonPanel.

cancel

protected void cancel()

This method is invoked if the "Cancel" button is pressed. Default action closes the "data entry screen".

process

protected abstract boolean process()

This method is invoked if the "Ok" button is pressed and there is no error raised by validateData() method. This method has to return true in order to close the "data entry screen".

Returns:

True or false.

clicked

public void clicked(com.vaadin.flow.component.Component c)

Description copied from interface: ExecutableView

Default implementation, does nothing.

Parameters:

c - Component

setButtonsAtTop

public void setButtonsAtTop(boolean buttonsAtTop)

Button panel is normally shown at the bottom. This method makes it appear at the top.

Parameters:

buttonsAtTop - Whether the button panel should be shown at the top or not

validateData

protected void validateData()
                     throws Exception

Validate data. This method is invoked when the "Ok" button is pressed. process() will be invoked only if this method did not raise any exception.

Throws:

Exception - Exception raised will be displayed as a warning message.

setCloseable

public void setCloseable(boolean closeable)

Set the closeability. This will have effect only in window-mode and the Window was created by the DataForm itself. If you create the Window in an overridden View.createWindow(Component) method, you should control the closeability of that yourself.

Parameters:

closeable - True/false.