Package com.storedobject.vaadin

Class AbstractResourcedComponent

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.vaadin.AbstractResourcedComponent

All Implemented Interfaces:

HasSize, ResourcedComponent, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable

Direct Known Subclasses:

PDFViewer

public abstract class AbstractResourcedComponent
extends com.vaadin.flow.component.Component
implements ResourcedComponent, HasSize

Abstract "resourced component" that knows how to register/unregister the resource during attach/detach events. By default, it will set he "display" style to "flex" and size to "full". Inherited classes may override this if required.

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractResourcedComponent()	Default constructor.
AbstractResourcedComponent(com.vaadin.flow.server.AbstractStreamResource streamResource)	Constructor with a stream resource to view.
AbstractResourcedComponent(String fileURI)	Constructor with file to view.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the current content.
protected abstract String	getURIAttributeName()	Get the name of the URI attribute.
protected void	init()	This will be invoked by the constructor for initial set up.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
void	setSource(com.vaadin.flow.server.AbstractStreamResource streamResource)	Set the file to view from a StreamResource.
void	setSource(String fileURL)	Set the file to view.
protected void	setURI(String url)	Set the URI attribute for the source.

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.storedobject.vaadin.HasSize

setHeight, setWidth

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

AbstractResourcedComponent

public AbstractResourcedComponent()

Default constructor.

AbstractResourcedComponent

public AbstractResourcedComponent(String fileURI)

Constructor with file to view.

Parameters:

fileURI - URI of the file to view

AbstractResourcedComponent

public AbstractResourcedComponent(com.vaadin.flow.server.AbstractStreamResource streamResource)

Constructor with a stream resource to view.

Parameters:

streamResource - Stream resource

Method Details

init

protected void init()

This will be invoked by the constructor for initial set up. The default implementation sets the "display" style to "flex" and size to "full". I also sets a unique "id" attribute.

setSource

public void setSource(String fileURL)

Set the file to view.

Parameters:

fileURL - URL of the file to view

getURIAttributeName

protected abstract String getURIAttributeName()

Get the name of the URI attribute. The default value returned is "src".

Returns:

URI attribute name.

setURI

protected void setURI(String url)

Set the URI attribute for the source.

Parameters:

url - URL

setSource

public void setSource(com.vaadin.flow.server.AbstractStreamResource streamResource)

Set the file to view from a StreamResource.

Specified by:

setSource in interface ResourcedComponent

Parameters:

streamResource - Stream source

clear

public void clear()

Clear the current content.

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

onDetach

protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)

Overrides:

onDetach in class com.vaadin.flow.component.Component