Package com.storedobject.vaadin

Class Viewer

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.Viewer

All Implemented Interfaces:

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

Direct Known Subclasses:

HTMLView

public class Viewer
extends View
implements CloseableView

A helper View class that is used to view a single component.

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
Viewer(com.vaadin.flow.component.Component component, String caption, boolean windowMode)	Constructor.
Viewer(String caption)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Window	createWindow(com.vaadin.flow.component.Component component)	Create the "window" to show the content.
protected WindowDecorator	createWindowDecorator()	Create the "window decorator" to decorate the content window.
void	decorateComponent()	Decorate the component to remove the default padding.
protected int	getViewHeight()	Get the height of the view (as a percentage).
protected int	getViewWidth()	Get the width of the view (as a percentage).

Methods inherited from class com.storedobject.vaadin.View

abort, aborted, addClosedListener, addOpenedListener, clean, close, createCloseableView, 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

clearAlerts, clicked, 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

Viewer

public Viewer(String caption)

Constructor.

Parameters:

caption - Caption.

Viewer

public Viewer(com.vaadin.flow.component.Component component,
 String caption,
 boolean windowMode)

Constructor.

Parameters:

component - Component to set.

caption - Caption.

windowMode - Whether to shown as a pop-window or not.

Method Details

createWindow

protected Window createWindow(com.vaadin.flow.component.Component component)

Create the "window" to show the content. This is invoked to obtain the Window component only if the View has to appear as a popped-up window. The window will have a size of 80vw X 80vh by default unless the methods getViewWidth() and getViewHeight() are overridden.

Overrides:

createWindow in class View

Parameters:

component - Component containing the actual content to display.

Returns:

A window containing the content that is passed.

createWindowDecorator

protected WindowDecorator createWindowDecorator()

Create the "window decorator" to decorate the content window. This is invoked while creating the Window component only if the View has to appear as a popped-up window.

Returns:

A window decorator. It typically creates a decorator via new WindowDecorator(this).

getViewWidth

protected int getViewWidth()

Get the width of the view (as a percentage). Default is 80.

Returns:

Percentage width of the view.

getViewHeight

protected int getViewHeight()

Get the height of the view (as a percentage). Default is 80.

Returns:

Percentage height of the view.

decorateComponent

public void decorateComponent()

Decorate the component to remove the default padding.

Overrides:

decorateComponent in class View