Package com.storedobject.vaadin

Class UploadField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>

com.vaadin.flow.component.customfield.CustomField<Integer>

com.storedobject.vaadin.CustomField<Integer>

com.storedobject.vaadin.UploadField

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<Integer>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>, Serializable

@CssImport(value="./so/upload/styles.css",
           themeFor="vaadin-upload-file")
public class UploadField
extends CustomField<Integer>

A class to process uploaded content. The content will be available to the "processor" as an InputStream. The content must be read completely from the stream by the processor's BiConsumer because the stream is automatically closed after invoking this method.

This component is a HasValue and the value returned is the number of files successfully uploaded.

The default maximum file size is set to 10,000,000 bytes, but it can be changed via the Upload.setMaxFileSize(int) method and the Upload component can be obtained via the getUploadComponent() method.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
UploadField()	Constructor.
UploadField(String label)	Constructor.
UploadField(String label, BiConsumer<InputStream,String> processor)	Constructor.
UploadField(BiConsumer<InputStream,String> processor)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Integer	generateModelValue()
String	getFileName()	Get the name of the file that is being processed.
final int	getMaxFiles()	Get the number of files allowed to upload.
com.vaadin.flow.component.upload.Upload	getUploadComponent()	Get the Upload component internally used.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	process(InputStream data, String mimeType)	This is where the real processing happens.
void	setDescription(String description)	Set the description to show.
void	setMaxFiles(int fileCount)	Set the number of files that are allowed to upload.
protected void	setPresentationValue(Integer integer)
void	setReadOnly(boolean readOnly)
void	setValue(Integer value)
void	showDescription(boolean show)	Whether to show the description or not.

Methods inherited from class com.storedobject.vaadin.CustomField

addField, addField, focus

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, remove, removeThemeVariants, setLabel, updateValue

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, valueEquals

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, onDetach, 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.BlurNotifier

addBlurListener

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

addDetachListener

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

addFocusShortcut, blur, getTabIndex, setTabIndex

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

addFocusListener

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

getElement

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

isEnabled, setEnabled

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

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

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

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

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

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

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

setManualValidation

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Constructor Details

UploadField

public UploadField()

Constructor.

UploadField

public UploadField(String label)

Constructor.

Parameters:

label - Label

UploadField

public UploadField(BiConsumer<InputStream,String> processor)

Constructor.

Parameters:

processor - Processor to process the content (Parameters: content, mime type)

UploadField

public UploadField(String label,
 BiConsumer<InputStream,String> processor)

Constructor.

Parameters:

label - Label

processor - Processor to process the content (Parameters: content, mime type)

Method Details

getUploadComponent

public com.vaadin.flow.component.upload.Upload getUploadComponent()

Get the Upload component internally used. Any customization of this component is possible.

Returns:

Upload component

onAttach

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

Overrides:

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

setValue

public void setValue(Integer value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>,Integer>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Integer>,Integer>

showDescription

public void showDescription(boolean show)

Whether to show the description or not.

Parameters:

show - True/false.

setDescription

public void setDescription(String description)

Set the description to show.

Parameters:

description - Description to show.

generateModelValue

protected Integer generateModelValue()

Specified by:

generateModelValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

setPresentationValue

protected void setPresentationValue(Integer integer)

Specified by:

setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<Integer>

process

public void process(InputStream data,
 String mimeType)

This is where the real processing happens. This method is invoked to process the uploaded content, and by default, it asks the "processor" to process it. However, this can be overridden.

Parameters:

data - Uploaded content

mimeType - Mime type of the content

getFileName

public String getFileName()

Get the name of the file that is being processed. This could be called from within the "processor" if required.

Returns:

File name

setMaxFiles

public void setMaxFiles(int fileCount)

Set the number of files that are allowed to upload.

Parameters:

fileCount - Number of files

getMaxFiles

public final int getMaxFiles()

Get the number of files allowed to upload.

Returns:

Number of files.

setReadOnly

public void setReadOnly(boolean readOnly)