io.jmix.ui.component

Interface SingleFileUploadField

All Superinterfaces:

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

All Known Subinterfaces:

FileStorageUploadField, FileUploadField

All Known Implementing Classes:

AbstractFileStorageUploadField, AbstractSingleFileUploadField, FileStorageUploadFieldImpl, FileUploadFieldImpl

public interface SingleFileUploadField
extends UploadField, Component.Focusable, Buffered

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SingleFileUploadField.AfterValueClearEvent Describes after value clear event.
static class	SingleFileUploadField.BeforeValueClearEvent Describes before value clear event.
static class	SingleFileUploadField.FileUploadSucceedEvent Describes file upload succeeded event when the uploads are successfully finished.

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

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	addAfterValueClearListener(java.util.function.Consumer<SingleFileUploadField.AfterValueClearEvent> listener) Adds a callback interface which is invoked by the SingleFileUploadField after value has been cleared using clear button.
io.jmix.core.common.event.Subscription	addBeforeValueClearListener(java.util.function.Consumer<SingleFileUploadField.BeforeValueClearEvent> listener) Sets a callback interface which is invoked by the SingleFileUploadField before value clearing when user use clear button.
io.jmix.core.common.event.Subscription	addFileUploadSucceedListener(java.util.function.Consumer<SingleFileUploadField.FileUploadSucceedEvent> listener) Adds file upload succeed listener.
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonDescription()
java.lang.String	getClearButtonIcon()
java.util.function.Supplier<java.io.InputStream>	getContentProvider()
java.io.InputStream	getFileContent()
java.lang.String	getUploadButtonCaption()
java.lang.String	getUploadButtonDescription()
java.lang.String	getUploadButtonIcon()
boolean	isShowClearButton()
boolean	isShowFileName()
void	setClearButtonCaption(java.lang.String caption) Setup clear button caption.
void	setClearButtonDescription(java.lang.String description) Setup clear button description.
void	setClearButtonIcon(java.lang.String icon) Setup clear button icon.
void	setContentProvider(java.util.function.Supplier<java.io.InputStream> contentProvider) Set content provider which contains file data.
void	setShowClearButton(boolean showClearButton) Enable or disable displaying name of clear button.
void	setShowFileName(boolean showFileName) Enable or disable displaying name of uploaded file next to upload button.
void	setUploadButtonCaption(java.lang.String caption) Setup caption of upload button.
void	setUploadButtonDescription(java.lang.String description) Setup upload button description.
void	setUploadButtonIcon(java.lang.String icon) Setup upload button icon.

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

addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, getAccept, getDropZone, getDropZonePrompt, getFileSizeLimit, getPasteZone, getPermittedExtensions, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPasteZone, setPermittedExtensions

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

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

commit, discard, isBuffered, isModified, setBuffered

Method Detail

getFileContent

@Nullable
java.io.InputStream getFileContent()

Returns:

content of uploaded file.

setShowFileName

@StudioProperty(defaultValue="false")
void setShowFileName(boolean showFileName)

Enable or disable displaying name of uploaded file next to upload button.

isShowFileName

boolean isShowFileName()

Returns:

true if name of uploaded file is shown.

setUploadButtonCaption

@StudioProperty(type=LOCALIZED_STRING)
void setUploadButtonCaption(@Nullable
                                                                   java.lang.String caption)

Setup caption of upload button.

getUploadButtonCaption

@Nullable
java.lang.String getUploadButtonCaption()

Returns:

upload button caption.

setUploadButtonIcon

@StudioProperty(type=ICON_ID)
void setUploadButtonIcon(@Nullable
                                                       java.lang.String icon)

Setup upload button icon.

getUploadButtonIcon

@Nullable
java.lang.String getUploadButtonIcon()

Returns:

upload button icon.

setUploadButtonDescription

@StudioProperty(type=LOCALIZED_STRING)
void setUploadButtonDescription(@Nullable
                                                                       java.lang.String description)

Setup upload button description.

getUploadButtonDescription

@Nullable
java.lang.String getUploadButtonDescription()

Returns:

upload button description.

setShowClearButton

@StudioProperty(defaultValue="false")
void setShowClearButton(boolean showClearButton)

Enable or disable displaying name of clear button.

isShowClearButton

boolean isShowClearButton()

Returns:

true if clear button is shown.

setClearButtonCaption

@StudioProperty(type=LOCALIZED_STRING)
void setClearButtonCaption(@Nullable
                                                                  java.lang.String caption)

Setup clear button caption.

getClearButtonCaption

@Nullable
java.lang.String getClearButtonCaption()

Returns:

clear button caption.

setClearButtonIcon

@StudioProperty(type=ICON_ID)
void setClearButtonIcon(@Nullable
                                                      java.lang.String icon)

Setup clear button icon.

getClearButtonIcon

@Nullable
java.lang.String getClearButtonIcon()

Returns:

clear button icon.

setClearButtonDescription

@StudioProperty(type=LOCALIZED_STRING)
void setClearButtonDescription(java.lang.String description)

Setup clear button description.

getClearButtonDescription

java.lang.String getClearButtonDescription()

Returns:

clear button description.

addFileUploadSucceedListener

io.jmix.core.common.event.Subscription addFileUploadSucceedListener(java.util.function.Consumer<SingleFileUploadField.FileUploadSucceedEvent> listener)

Adds file upload succeed listener. It is invoked when the uploads are successfully finished.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

addBeforeValueClearListener

io.jmix.core.common.event.Subscription addBeforeValueClearListener(java.util.function.Consumer<SingleFileUploadField.BeforeValueClearEvent> listener)

Sets a callback interface which is invoked by the SingleFileUploadField before value clearing when user use clear button.

Listener can prevent value clearing using SingleFileUploadField.BeforeValueClearEvent.preventClearAction().

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

See Also:

setShowClearButton(boolean)

addAfterValueClearListener

io.jmix.core.common.event.Subscription addAfterValueClearListener(java.util.function.Consumer<SingleFileUploadField.AfterValueClearEvent> listener)

Adds a callback interface which is invoked by the SingleFileUploadField after value has been cleared using clear button.

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

See Also:

setShowClearButton(boolean)

setContentProvider

void setContentProvider(@Nullable
                        java.util.function.Supplier<java.io.InputStream> contentProvider)

Set content provider which contains file data.

Passed content provider will be used for downloading by clicking the link with file name or as source for getFileContent() method.

Parameters:

contentProvider - content provider

getContentProvider

@Nullable
java.util.function.Supplier<java.io.InputStream> getContentProvider()

Returns:

FileContentProvider which can be used to read data from field