Package com.storedobject.vaadin

Class WrappedView

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.WrappedView

All Implemented Interfaces:

ClickHandler, ExecutableView, 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

public class WrappedView
extends View

A View that is wrapped in an ExecutableView. The ExecutableView's ExecutableView.getView(boolean) can return such a wrapped view. However, any Component may be used inside, and it is not necessary to use anything that really implements ExecutableView.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
WrappedView(com.vaadin.flow.component.Component executableView)	Constructor.
WrappedView(com.vaadin.flow.component.Component executableView, String caption)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	abort()	Abort this view.
void	clean()	Close resources if any that are left opened.
void	clearAlerts()	Clear all alters owned by this view.
void	close()	Close this view.
ApplicationMenuItem	createMenuItem(Runnable menuAction)	Create the menu item for this view.
String	getMenuIconName()	Get the name of the icon to be displayed in the menu when this view is active (running).
boolean	isCloseable()	Check if this view is closeable or not.
boolean	isHomeView()	Check if this view is a "Home View" or not.
void	returnedFrom(View parent)	This method is invoked whenever this view is automatically selected because its parent was closed.

Methods inherited from class com.storedobject.vaadin.View

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

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

clicked, error, getView, log, log, message, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

WrappedView

public WrappedView(com.vaadin.flow.component.Component executableView)

Constructor.

Parameters:

executableView - The ExecutableView component. (It can be a normal Component too).

WrappedView

public WrappedView(com.vaadin.flow.component.Component executableView,
 String caption)

Constructor.

Parameters:

executableView - The ExecutableView component. (It can be a normal Component too).

caption - Caption for the view.

Method Details

isCloseable

public boolean isCloseable()

Description copied from interface: ExecutableView

Check if this view is closeable or not. If closeable, a "closeable" menu item will be created by ExecutableView.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

public boolean isHomeView()

Description copied from interface: ExecutableView

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.

returnedFrom

public void returnedFrom(View parent)

Description copied from interface: ExecutableView

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

Parameters:

parent - Parent view that was closed

close

public void close()

Description copied from class: View

Close this view.

Specified by:

close in interface ExecutableView

Overrides:

close in class View

abort

public void abort()

Description copied from class: View

Abort this view. Default implementation sets an "abort flag" and closes the view.

Specified by:

abort in interface ExecutableView

Overrides:

abort in class View

clean

public void clean()

Description copied from class: View

Close resources if any that are left opened. This method is invoked when the view is removed from the Application. The default implementation does nothing.

Specified by:

clean in interface ExecutableView

Overrides:

clean in class View

getMenuIconName

public String getMenuIconName()

Description copied from interface: ExecutableView

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().

createMenuItem

public ApplicationMenuItem createMenuItem(Runnable menuAction)

Description copied from interface: ExecutableView

Create the menu item for this view. This will be invoked by ExecutableView.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.

clearAlerts

public void clearAlerts()

Description copied from interface: ExecutableView

Clear all alters owned by this view.