Package com.storedobject.ui.util

Class DocumentViewer

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.vaadin.AbstractResourcedComponent

com.storedobject.vaadin.PDFViewer

com.storedobject.ui.util.DocumentViewer

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

public class DocumentViewer
extends PDFViewer

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentViewer(Runnable listener)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.Component	getViewerComponent()	Get the viewer component.
void	setDocument(ContentProducer contentProducer)	Set the document to be viewed.
void	setDocument(Id streamDataId)	Set the document to be viewed.
void	setDocument(StreamData streamData)	Set the document to be viewed.
void	setExtraButtons(com.vaadin.flow.component.Component... extraButtons)	Set extra buttons to be added to the view.
void	setOnViewClose(Runnable onViewClose)	Set a runnable to be executed when the view is closed.
void	setSource(String fileURL)	Set the file to view.
void	setWindowMode(boolean windowMode)	Set the window mode.
void	view(String caption)	View the document.
static void	view(String caption, MediaFile mediaFile, boolean windowMode)	View a media file.
static void	view(String caption, MediaFile mediaFile, boolean windowMode, com.vaadin.flow.component.Component[] extraButtons)	View a media file.
static void	view(String caption, MediaFile mediaFile, boolean windowMode, Runnable onViewClose, com.vaadin.flow.component.Component[] extraButtons)	View a media file.

Methods inherited from class com.storedobject.vaadin.PDFViewer

getURIAttributeName, init

Methods inherited from class com.storedobject.vaadin.AbstractResourcedComponent

clear, onAttach, onDetach, setSource, setURI

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

DocumentViewer

public DocumentViewer(Runnable listener)

Constructor.

Parameters:

listener - Listener to be notified when the source is set.

Method Details

view

public static void view(String caption,
 MediaFile mediaFile,
 boolean windowMode)

View a media file.

Parameters:

caption - Caption.

mediaFile - Media file.

windowMode - Whether to open in a window or not.

view

public static void view(String caption,
 MediaFile mediaFile,
 boolean windowMode,
 com.vaadin.flow.component.Component[] extraButtons)

View a media file.

Parameters:

caption - Caption.

mediaFile - Media file.

windowMode - Whether to open in a window or not.

extraButtons - Extra buttons to be added to the view.

view

public static void view(String caption,
 MediaFile mediaFile,
 boolean windowMode,
 Runnable onViewClose,
 com.vaadin.flow.component.Component[] extraButtons)

View a media file.

Parameters:

caption - Caption.

mediaFile - Media file.

windowMode - Whether to open in a window or not.

onViewClose - Runnable to be executed when the view is closed.

extraButtons - Extra buttons to be added to the view.

setSource

public void setSource(String fileURL)

Description copied from class: AbstractResourcedComponent

Set the file to view.

Overrides:

setSource in class AbstractResourcedComponent

Parameters:

fileURL - URL of the file to view

setWindowMode

public void setWindowMode(boolean windowMode)

Set the window mode.

Parameters:

windowMode - True for window mode.

setExtraButtons

public void setExtraButtons(com.vaadin.flow.component.Component... extraButtons)

Set extra buttons to be added to the view.

Parameters:

extraButtons - Extra buttons.

setOnViewClose

public void setOnViewClose(Runnable onViewClose)

Set a runnable to be executed when the view is closed.

Parameters:

onViewClose - Runnable.

setDocument

public void setDocument(Id streamDataId)

Set the document to be viewed.

Parameters:

streamDataId - ID of the stream data.

setDocument

public void setDocument(StreamData streamData)

Set the document to be viewed.

Parameters:

streamData - Stream data.

view

public void view(String caption)

View the document.

Parameters:

caption - Caption.

setDocument

public void setDocument(ContentProducer contentProducer)

Set the document to be viewed.

Parameters:

contentProducer - Content producer.

getViewerComponent

public com.vaadin.flow.component.Component getViewerComponent()

Get the viewer component.

Returns:

Viewer component.