Package com.storedobject.vaadin

Interface ExecutableView

All Superinterfaces:

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

All Known Subinterfaces:

HasColumns<T>

All Known Implementing Classes:

AbstractDataEditor, AbstractDataForm, ActionForm, Dashboard, DataEditor, DataForm, DataGrid, DataTreeGrid, ImageView, InformationMessage, ListGrid, MultiSelectGrid, SelectGrid, View, Viewer, ViewGrid, WrappedView

public interface ExecutableView
extends Runnable, ClickHandler, ValueChangeHandler

An interface used by "displayable" classes such as View.

Author:

Syam

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default void	abort()	Abort this.
default void	clean()	Clean this up by closing resources if any.
default void	clearAlerts()	Clear all alters owned by this view.
default void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
default void	close()	Close this.
default ApplicationMenuItem	createMenuItem(Runnable menuAction)	Create the menu item for this view.
default void	error(Object message)	Show an error message.
default void	execute()	Execute this by displaying it in a View.
default void	execute(View lock)	Execute the associated view by locking another view (the locked view will not be selectable until this view is closed).
default <A extends Application> A	getApplication()	Get the current Application.
default String	getCaption()	Get the caption for this view.
default String	getMenuIconName()	Get the name of the icon to be displayed in the menu when this view is active (running).
default ApplicationMenuItem	getMenuItem(Runnable menuAction)	Get the menu item for this view.
default View	getView()	Get the currently active View.
View	getView(boolean create)	Get the View.
default void	invoke(View parent)	Execute the associated view and set its parent too.
default boolean	isCloseable()	Check if this view is closeable or not.
default boolean	isFullScreen()	Check if this view is a full-screen view or not.
default boolean	isHomeView()	Check if this view is a "Home View" or not.
default void	log(Object anything)	Log something.
default void	log(Object anything, Throwable error)	Log something along with an exception.
default void	message(Object message)	Show a message.
default void	returnedFrom(View parent)	This method is invoked whenever this view is automatically selected because its parent was closed.
default void	run()	Default implementation is to invoke execute().
default void	setCaption(String caption)	Set the caption
default void	setClickable(com.vaadin.flow.component.HasValue<?,?> field)	This method has the same effect of trackValueChange(HasValue).
default void	speak(String sentence)	Speak out the given sentence if the ApplicationLayout is supporting it (The default layout ApplicationFrame supports it).
default void	trackValueChange(com.vaadin.flow.component.HasValue<?,?> field)	Track value changes of a field HasValue.
default void	tray(Object message)	Show a warning message n the "tray area" of the application.
default void	valueChanged(ChangedValues changedValues)	This default implementation invokes the clicked(Component) with the changed field as the parameter.
default void	warning(Object message)	Show a warning message.

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Method Details

warning

default void warning(Object message)

Show a warning message. Default implementation is to invoke Application.warning(Object).

Parameters:

message - Warning

tray

default void tray(Object message)

Show a warning message n the "tray area" of the application. Default implementation is to invoke Application.tray(Object).

Parameters:

message - Message to show in the tray.

message

default void message(Object message)

Show a message. Default implementation is to invoke Application.message(Object).

Parameters:

message - Message

error

default void error(Object message)

Show an error message. Default implementation is to invoke Application.error(Object).

Parameters:

message - Error

clearAlerts

default void clearAlerts()

Clear all alters owned by this view.

getView

default View getView()

Get the currently active View. It could be null.

Returns:

Currently active view.

getView

View getView(boolean create)

Get the View. Create it if it doesn't exist.

Parameters:

create - Whether to create or not.

Returns:

View.

run

default void run()

Default implementation is to invoke execute().

Specified by:

run in interface Runnable

execute

default void execute()

Execute this by displaying it in a View.

execute

default void execute(View lock)

Execute the associated view by locking another view (the locked view will not be selectable until this view is closed). The locked view acts as its "parent" and it will automatically get selected when this view closes.

Parameters:

lock - View to be locked.

invoke

default void invoke(View parent)

Execute the associated view and set its parent too. (In this case, parent view is not locked). The parent view is automatically selected when this view closes.

Parameters:

parent - Parent view to be set

close

default void close()

Close this.

abort

default void abort()

Abort this.

clean

default void clean()

Clean this up by closing resources if any.

getCaption

default String getCaption()

Get the caption for this view.

Returns:

Caption.

setCaption

default void setCaption(String caption)

Set the caption

Parameters:

caption - Caption

trackValueChange

default void trackValueChange(com.vaadin.flow.component.HasValue<?,?> field)

Track value changes of a field HasValue. Whenever a value is changed, ValueChangeHandler.valueChanged(HasValue.ValueChangeEvent) method is invoked (and that in turn, will invoke valueChanged(ChangedValues) because that is the default implementation).

Parameters:

field - Field to be tracked.

setClickable

default void setClickable(com.vaadin.flow.component.HasValue<?,?> field)

This method has the same effect of trackValueChange(HasValue). If a field is made "clickable", its value will be tracked and valueChanged(ChangedValues) whenever its value is changed.

Parameters:

field - Field to be tracked.

See Also:

• trackValueChange(HasValue)

getApplication

default <A extends Application> A getApplication()

Get the current Application.

Type Parameters:

A - Application type

Returns:

Current Application.

returnedFrom

default void returnedFrom(View parent)

This method is invoked whenever this view is automatically selected because its parent was closed.

Parameters:

parent - Parent view that was closed

valueChanged

default void valueChanged(ChangedValues changedValues)

This default implementation invokes the clicked(Component) with the changed field as the parameter. However, nothing happens if the field is not a component.

Specified by:

valueChanged in interface ValueChangeHandler

Parameters:

changedValues - Change information (field and it value changes) wrapped into ChangedValues.

clicked

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

Default implementation, does nothing.

Specified by:

clicked in interface ClickHandler

Parameters:

c - Component

log

default void log(Object anything)

Log something. Default implementation invokes Application.log(Object).

Parameters:

anything - Message to log, it could be a Throwable

log

default void log(Object anything,
 Throwable error)

Log something along with an exception. Default implementation invokes Application.log(Object, Throwable).

Parameters:

anything - Message to log, it could be a Throwable

error - Error to be printed

getMenuItem

default ApplicationMenuItem getMenuItem(Runnable menuAction)

Get the menu item for this view. This is the menu item displayed by the Application when the view is activated. By default, this invokes createMenuItem(Runnable) to create the menu item.

Parameters:

menuAction - Action for the menu item to be created

Returns:

Menu item.

createMenuItem

default ApplicationMenuItem createMenuItem(Runnable menuAction)

Create the menu item for this view. This will be invoked by getMenuItem(Runnable). By default, this invokes ApplicationEnvironment.createMenuItem(ExecutableView, String, Runnable) to create the menu item.

Parameters:

menuAction - Action for the menu item to be created

Returns:

Menu item.

getMenuIconName

default String getMenuIconName()

Get the name of the icon to be displayed in the menu when this view is active (running).

Returns:

Default implementation takes this value from ApplicationEnvironment.getActiveMenuIconName().

isCloseable

default boolean isCloseable()

Check if this view is closeable or not. If closeable, a "closeable" menu item will be created by getMenuItem(Runnable). This is checked only once when the "menu item" is created.

Returns:

True if closeable. By default, a view is closeable if it implements CloseableView or its internal component (View.getComponent()) implements CloseableView.

isHomeView

default boolean isHomeView()

Check if this view is a "Home View" or not. A "Home View" will not show any menu when it gets executed. Typically, views that show background images or some sort of dashboards can be defined as "Home Views" so that they will always appear on the content portion of the Application.

Returns:

True if this view is a "Home View". By default, if a view implements HomeView or its internal component (View.getComponent()) implements HomeView, this method return true.

isFullScreen

default boolean isFullScreen()

Check if this view is a full-screen view or not. A full-screen view takes up the whole screen.

Returns:

True if closeable. By default, a view takes up full-screen if it implements FullScreen or its internal component (View.getComponent()) implements FullScreen.

speak

default void speak(String sentence)

Speak out the given sentence if the ApplicationLayout is supporting it (The default layout ApplicationFrame supports it). Please note that the speaker must have been switched on before calling this (See SpeakerButton).

Parameters:

sentence - Sentence to speak out.