com.haulmont.cuba.gui.components

Interface UploadField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasHtmlCaption, HasHtmlDescription

All Known Subinterfaces:

FileMultiUploadField, FileUploadField

public interface UploadField
extends Component, Component.HasCaption, Component.BelongToFrame, Component.HasIcon, Component.Focusable, HasHtmlCaption, HasHtmlDescription

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UploadField.DropZone Drop zone descriptor.
static class	UploadField.FileUploadErrorEvent Describes file upload error event.
static class	UploadField.FileUploadEvent Base class for UploadField events.
static class	UploadField.FileUploadFinishEvent Describes file upload finish event.
static class	UploadField.FileUploadStartEvent Describes file upload start event.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener) Adds file upload error listener.
Subscription	addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener) Adds file upload finish listener.
Subscription	addFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener) Adds file upload start listener.
java.lang.String	getAccept() Returns comma separated types of files.
UploadField.DropZone	getDropZone()
java.lang.String	getDropZonePrompt()
long	getFileSizeLimit() Returns maximum allowed file size in bytes.
ComponentContainer	getPasteZone()
java.util.Set<java.lang.String>	getPermittedExtensions() Return white list of file extensions.
void	removeFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener) Deprecated. Use Subscription instead
void	removeFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener) Deprecated. Use Subscription instead
void	removeFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener) Deprecated. Use Subscription instead
void	setAccept(java.lang.String accept) Sets the mask for files to filter them in the file selection dialog. Example:
void	setDropZone(UploadField.DropZone dropZone) Set drop zone reference to this upload component.
void	setDropZonePrompt(java.lang.String dropZonePrompt) Set drop zone prompt that will be shown on drag over window with file.
void	setFileSizeLimit(long fileSizeLimit) Sets maximum allowed file size in bytes.
void	setPasteZone(ComponentContainer pasteZone) Set paste zone reference to this upload component.
void	setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions) Set white list of file extensions.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Method Detail

addFileUploadStartListener

Subscription addFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)

Adds file upload start listener. It is invoked when start uploading the file.

Parameters:

listener - a listener to add

Returns:

subscription

removeFileUploadStartListener

@Deprecated
void removeFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)

Deprecated. Use Subscription instead

addFileUploadFinishListener

Subscription addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)

Adds file upload finish listener. It is invoked when file is uploaded.

Parameters:

listener - a listener to add

Returns:

subscription

removeFileUploadFinishListener

@Deprecated
void removeFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)

Deprecated. Use Subscription instead

addFileUploadErrorListener

Subscription addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)

Adds file upload error listener. It is invoked when the uploads are finished, but unsuccessful.

Parameters:

listener - a listener to add

Returns:

subscription

removeFileUploadErrorListener

@Deprecated
void removeFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)

Deprecated. Use Subscription instead

getFileSizeLimit

long getFileSizeLimit()

Returns maximum allowed file size in bytes.

setFileSizeLimit

void setFileSizeLimit(long fileSizeLimit)

Sets maximum allowed file size in bytes. Default value is 0. In this case component uses system value.

getAccept

java.lang.String getAccept()

Returns comma separated types of files.

Returns:

comma separated types of files

setAccept

void setAccept(java.lang.String accept)

Sets the mask for files to filter them in the file selection dialog.
Example:

 fileUpload.setAccept(".png,.jpeg")

Parameters:

accept - comma separated types of files

setPermittedExtensions

void setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)

Set white list of file extensions. Each extension should start with dot symbol, e.g. ".png".

    private FileUploadField uploadField;
    ...
    uploadField.setPermittedExtensions(Sets.newHashSet(".png", ".jpg"));
 

Parameters:

permittedExtensions - permitted extensions.

getPermittedExtensions

java.util.Set<java.lang.String> getPermittedExtensions()

Return white list of file extensions.

Returns:

set of file extensions.

getDropZone

UploadField.DropZone getDropZone()

Returns:

current drop zone

setDropZone

void setDropZone(UploadField.DropZone dropZone)

Set drop zone reference to this upload component. Files can be dropped to component of the drop zone to be uploaded by this upload component.

Parameters:

dropZone - drop zone descriptor

setPasteZone

void setPasteZone(ComponentContainer pasteZone)

Set paste zone reference to this upload component. PasteZone handles paste shortcut when a text input field in the container is focused.
It is supported by Chromium-based browsers.

Parameters:

pasteZone - paste zone container

getPasteZone

ComponentContainer getPasteZone()

Returns:

current paste zone container

getDropZonePrompt

java.lang.String getDropZonePrompt()

Returns:

current drop zone prompt

setDropZonePrompt

void setDropZonePrompt(java.lang.String dropZonePrompt)

Set drop zone prompt that will be shown on drag over window with file.

Parameters:

dropZonePrompt - drop zone prompt