io.jmix.ui.component.impl

Class FileMultiUploadFieldImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixFileUpload>

io.jmix.ui.component.impl.FileMultiUploadFieldImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, FileMultiUploadField, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, UploadField, org.springframework.beans.factory.InitializingBean

public class FileMultiUploadFieldImpl
extends AbstractComponent<JmixFileUpload>
implements FileMultiUploadField, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.FileMultiUploadField

FileMultiUploadField.QueueUploadCompleteEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.UploadField

UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadStartEvent

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

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accept
protected static int	BYTES_IN_MEGABYTE
protected UiComponentProperties	componentProperties
protected UploadField.DropZone	dropZone
protected java.lang.String	dropZonePrompt
protected java.util.Map<java.util.UUID,java.lang.String>	files
protected long	fileSizeLimit
protected io.jmix.core.Messages	messages
protected ComponentContainer	pasteZone
protected java.util.Set<java.lang.String>	permittedExtensions
protected java.util.UUID	tempFileId
protected TemporaryStorage	temporaryStorage

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
FileMultiUploadFieldImpl()

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.
io.jmix.core.common.event.Subscription	addQueueUploadCompleteListener(java.util.function.Consumer<FileMultiUploadField.QueueUploadCompleteEvent> listener) Adds queue upload complete listener.
void	afterPropertiesSet()
void	clearUploads() Clear uploads list
protected JmixFileUpload	createComponent()
protected void	fireFileUploadError(java.lang.String fileName, long contentLength, java.lang.Exception cause)
protected void	fireFileUploadFinish(java.lang.String fileName, long contentLength)
protected void	fireFileUploadStart(java.lang.String fileName, long contentLength)
protected void	fireQueueUploadComplete()
void	focus() Sets focus to this component
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.
protected java.lang.String	getFileSizeLimitString()
ComponentContainer	getPasteZone()
java.util.Set<java.lang.String>	getPermittedExtensions() Returns white list of file extensions.
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
java.util.Map<java.util.UUID,java.lang.String>	getUploadsMap() Get uploads map
protected void	initComponent(JmixFileUpload impl)
void	setAccept(java.lang.String accept) Sets the mask for files to filter them in the file selection dialog.
void	setComponentProperties(UiComponentProperties componentProperties)
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	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setMessages(io.jmix.core.Messages messages)
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.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	setTemporaryStorage(TemporaryStorage temporaryStorage)

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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

getFrame, setFrame

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

getIcon, setIconFromSet

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

isFocusable, setFocusable

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

Field Detail

BYTES_IN_MEGABYTE

protected static final int BYTES_IN_MEGABYTE

See Also:

Constant Field Values

files

protected final java.util.Map<java.util.UUID,java.lang.String> files

fileSizeLimit

protected long fileSizeLimit

permittedExtensions

protected java.util.Set<java.lang.String> permittedExtensions

dropZone

protected UploadField.DropZone dropZone

pasteZone

protected ComponentContainer pasteZone

dropZonePrompt

protected java.lang.String dropZonePrompt

componentProperties

protected UiComponentProperties componentProperties

messages

protected io.jmix.core.Messages messages

temporaryStorage

protected TemporaryStorage temporaryStorage

tempFileId

protected java.util.UUID tempFileId

accept

protected java.lang.String accept

Constructor Detail

FileMultiUploadFieldImpl

public FileMultiUploadFieldImpl()

Method Detail

setTemporaryStorage

@Autowired
public void setTemporaryStorage(TemporaryStorage temporaryStorage)

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

setComponentProperties

@Autowired
public void setComponentProperties(UiComponentProperties componentProperties)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

createComponent

protected JmixFileUpload createComponent()

initComponent

protected void initComponent(JmixFileUpload impl)

getUploadsMap

public java.util.Map<java.util.UUID,java.lang.String> getUploadsMap()

Get uploads map

Specified by:

getUploadsMap in interface FileMultiUploadField

Returns:

Map (UUID - Id of file in Temporary storage, String - FileName )

clearUploads

public void clearUploads()

Description copied from interface: FileMultiUploadField

Clear uploads list

Specified by:

clearUploads in interface FileMultiUploadField

addQueueUploadCompleteListener

public io.jmix.core.common.event.Subscription addQueueUploadCompleteListener(java.util.function.Consumer<FileMultiUploadField.QueueUploadCompleteEvent> listener)

Description copied from interface: FileMultiUploadField

Adds queue upload complete listener. It is invoked when all selected files are uploaded to the temporary storage.

Specified by:

addQueueUploadCompleteListener in interface FileMultiUploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

setIcon

public void setIcon(@Nullable
                    java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

Overrides:

setIcon in class AbstractComponent<JmixFileUpload>

getAccept

@Nullable
public java.lang.String getAccept()

Description copied from interface: UploadField

Returns comma separated types of files.

Specified by:

getAccept in interface UploadField

Returns:

comma separated types of files

setAccept

public void setAccept(@Nullable
                      java.lang.String accept)

Description copied from interface: UploadField

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

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

Specified by:

setAccept in interface UploadField

Parameters:

accept - comma separated types of files

getDropZone

@Nullable
public UploadField.DropZone getDropZone()

Specified by:

getDropZone in interface UploadField

Returns:

current drop zone

setDropZone

public void setDropZone(@Nullable
                        UploadField.DropZone dropZone)

Description copied from interface: UploadField

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.

Specified by:

setDropZone in interface UploadField

Parameters:

dropZone - drop zone descriptor

getPasteZone

@Nullable
public ComponentContainer getPasteZone()

Specified by:

getPasteZone in interface UploadField

Returns:

current paste zone container

setPasteZone

public void setPasteZone(@Nullable
                         ComponentContainer pasteZone)

Description copied from interface: UploadField

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.

Specified by:

setPasteZone in interface UploadField

Parameters:

pasteZone - paste zone container

getDropZonePrompt

@Nullable
public java.lang.String getDropZonePrompt()

Specified by:

getDropZonePrompt in interface UploadField

Returns:

current drop zone prompt

setDropZonePrompt

public void setDropZonePrompt(@Nullable
                              java.lang.String dropZonePrompt)

Description copied from interface: UploadField

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

Specified by:

setDropZonePrompt in interface UploadField

Parameters:

dropZonePrompt - drop zone prompt

fireFileUploadStart

protected void fireFileUploadStart(java.lang.String fileName,
                                   long contentLength)

fireFileUploadFinish

protected void fireFileUploadFinish(java.lang.String fileName,
                                    long contentLength)

fireFileUploadError

protected void fireFileUploadError(java.lang.String fileName,
                                   long contentLength,
                                   java.lang.Exception cause)

fireQueueUploadComplete

protected void fireQueueUploadComplete()

getFileSizeLimit

public long getFileSizeLimit()

Description copied from interface: UploadField

Returns maximum allowed file size in bytes.

Specified by:

getFileSizeLimit in interface UploadField

setFileSizeLimit

public void setFileSizeLimit(long fileSizeLimit)

Description copied from interface: UploadField

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

Specified by:

setFileSizeLimit in interface UploadField

getPermittedExtensions

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

Description copied from interface: UploadField

Returns white list of file extensions.

Specified by:

getPermittedExtensions in interface UploadField

Returns:

set of file extensions.

setPermittedExtensions

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

Description copied from interface: UploadField

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

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

Specified by:

setPermittedExtensions in interface UploadField

Parameters:

permittedExtensions - permitted extensions.

focus

public void focus()

Description copied from interface: Component.Focusable

Sets focus to this component

Specified by:

focus in interface Component.Focusable

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

getFileSizeLimitString

protected java.lang.String getFileSizeLimitString()

addFileUploadStartListener

public io.jmix.core.common.event.Subscription addFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)

Description copied from interface: UploadField

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

Specified by:

addFileUploadStartListener in interface UploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addFileUploadFinishListener

public io.jmix.core.common.event.Subscription addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)

Description copied from interface: UploadField

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

Specified by:

addFileUploadFinishListener in interface UploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addFileUploadErrorListener

public io.jmix.core.common.event.Subscription addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)

Description copied from interface: UploadField

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

Specified by:

addFileUploadErrorListener in interface UploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener