io.jmix.ui.component

Interface UploadField

All Superinterfaces:

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

All Known Subinterfaces:

FileMultiUploadField, FileStorageUploadField, FileUploadField, SingleFileUploadField

All Known Implementing Classes:

AbstractFileStorageUploadField, AbstractSingleFileUploadField, FileMultiUploadFieldImpl, FileStorageUploadFieldImpl, FileUploadFieldImpl

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

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 io.jmix.ui.component.Component

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

Field Summary

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener) Adds file upload error listener.
io.jmix.core.common.event.Subscription	addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener) Adds file upload finish listener.
io.jmix.core.common.event.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() Returns white list of file extensions.
void	setAccept(java.lang.String accept) Sets the mask for files to filter them in the file selection dialog.
void	setDropZone(UploadField.DropZone dropZone) Sets drop zone reference to this upload component.
void	setDropZonePrompt(java.lang.String dropZonePrompt) Sets 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) Sets paste zone reference to this upload component.
void	setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions) Sets white list of file extensions.

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Method Detail

addFileUploadStartListener

io.jmix.core.common.event.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:

a registration object for removing an event listener

addFileUploadFinishListener

io.jmix.core.common.event.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:

a registration object for removing an event listener

addFileUploadErrorListener

io.jmix.core.common.event.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:

a registration object for removing an event listener

getFileSizeLimit

long getFileSizeLimit()

Returns maximum allowed file size in bytes.

setFileSizeLimit

@StudioProperty
void setFileSizeLimit(long fileSizeLimit)

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

getAccept

@Nullable
java.lang.String getAccept()

Returns comma separated types of files.

Returns:

comma separated types of files

setAccept

@StudioProperty(type=STRING)
void setAccept(@Nullable
                                            java.lang.String accept)

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

    uploadField.setAccept(".png,.jpeg");
 

Parameters:

accept - comma separated types of files

setPermittedExtensions

@StudioProperty(type=STRING)
void setPermittedExtensions(@Nullable
                                                         java.util.Set<java.lang.String> permittedExtensions)

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

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

Parameters:

permittedExtensions - permitted extensions.

getPermittedExtensions

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

Returns white list of file extensions.

Returns:

set of file extensions.

getDropZone

@Nullable
UploadField.DropZone getDropZone()

Returns:

current drop zone

setDropZone

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.component.BoxLayout")
void setDropZone(@Nullable
                                                                                                               UploadField.DropZone dropZone)

Sets 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

@StudioProperty(type=COMPONENT_REF,
                options="io.jmix.ui.component.ComponentContainer")
void setPasteZone(@Nullable
                                                                                                                         ComponentContainer pasteZone)

Sets 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

@Nullable
ComponentContainer getPasteZone()

Returns:

current paste zone container

getDropZonePrompt

@Nullable
java.lang.String getDropZonePrompt()

Returns:

current drop zone prompt

setDropZonePrompt

@StudioProperty(type=LOCALIZED_STRING)
void setDropZonePrompt(@Nullable
                                                              java.lang.String dropZonePrompt)

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

Parameters:

dropZonePrompt - drop zone prompt