io.jmix.ui.component.impl

Class AbstractSingleFileUploadField<R>

java.lang.Object

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

io.jmix.ui.component.impl.AbstractValueComponent<T,P,V>

io.jmix.ui.component.impl.AbstractField<JmixFileUploadField,java.lang.String,R>

io.jmix.ui.component.impl.AbstractSingleFileUploadField<R>

All Implemented Interfaces:

AttachNotifier, Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasValueSource<R>, Field<R>, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValidator<R>, HasValue<R>, Requirable, SingleFileUploadField, UploadField, Validatable, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

AbstractFileStorageUploadField, FileUploadFieldImpl

public abstract class AbstractSingleFileUploadField<R>
extends AbstractField<JmixFileUploadField,java.lang.String,R>
implements SingleFileUploadField, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractSingleFileUploadField.JmixSingleFileUploadField

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

SingleFileUploadField.AfterValueClearEvent, SingleFileUploadField.BeforeValueClearEvent, SingleFileUploadField.FileUploadSucceedEvent

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.HasValue

HasValue.ValueChangeEvent<V>

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 java.util.function.Supplier<java.io.InputStream>	contentProvider
protected Downloader	downloader
protected UploadField.DropZone	dropZone
protected java.lang.String	dropZonePrompt
protected java.lang.String	fileName
protected long	fileSizeLimit
protected io.jmix.core.Messages	messages
protected ComponentContainer	pasteZone
protected java.util.Set<java.lang.String>	permittedExtensions

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

editable, parentEditableChangeListener, validators, VALIDATORS_LIST_INITIAL_CAPACITY

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

internalValue, uiTestIdsSupport, valueBinding

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.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractSingleFileUploadField()

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	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	addFileUploadSucceedListener(java.util.function.Consumer<SingleFileUploadField.FileUploadSucceedEvent> listener) Adds file upload succeed listener.
void	afterPropertiesSet()
protected void	clearButtonClicked(com.vaadin.ui.Button.ClickEvent clickEvent)
void	commit() Updates all changes since the previous commit to the data source.
protected JmixFileUploadField	createComponent()
void	discard() Discards all changes since last commit.
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	fireFileUploadSucceed(java.lang.String fileName, long contentLength)
void	focus() Sets focus to this component
java.lang.String	getAccept() Returns comma separated types of files.
protected long	getActualFileSizeLimit()
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonDescription()
java.lang.String	getClearButtonIcon()
java.util.function.Supplier<java.io.InputStream>	getContentProvider()
UploadField.DropZone	getDropZone()
java.lang.String	getDropZonePrompt()
java.lang.String	getFileName()
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.lang.String	getUploadButtonCaption()
java.lang.String	getUploadButtonDescription()
java.lang.String	getUploadButtonIcon()
protected void	initComponent()
protected void	internalValueChanged(java.lang.Object newValue)
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isShowClearButton()
boolean	isShowFileName()
protected void	onFileExtensionNotAllowed(JmixFileUpload.FileExtensionNotAllowedEvent e)
protected abstract void	onFileNameClick(com.vaadin.ui.Button.ClickEvent e)
protected void	onFileSizeLimitExceeded(JmixFileUpload.FileSizeLimitExceededEvent e)
protected void	onUploadFailed(JmixFileUpload.FailedEvent event)
protected void	onUploadFinished(JmixFileUpload.FinishedEvent event)
protected void	onUploadStarted(JmixFileUpload.StartedEvent event)
protected void	onUploadSucceeded(JmixFileUpload.SucceededEvent event)
protected abstract java.io.OutputStream	receiveUpload(java.lang.String fileName, java.lang.String MIMEType)
void	setAccept(java.lang.String accept) Sets the mask for files to filter them in the file selection dialog.
void	setBuffered(boolean buffered) Sets the buffered mode.
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	setComponentProperties(UiComponentProperties componentProperties)
void	setContentProvider(java.util.function.Supplier<java.io.InputStream> contentProvider) Set content provider which contains file data.
void	setDownloader(Downloader downloader)
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	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	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	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
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 class io.jmix.ui.component.impl.AbstractField

addValidator, attachValueChangeListener, getDatatypeConversionErrorMsg, getErrorMessage, getRequiredMessage, getValidators, isEditable, isRequired, isValid, removeValidator, setEditable, setEditableToComponent, setParent, setRequired, setRequiredMessage, setupComponentErrorProvider, triggerValidators, validate

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

addValueChangeListener, componentValueChanged, convertToModel, convertToPresentation, fieldValueEquals, getValue, getValueSource, setUiTestId, setUiTestIdsSupport, setValue, setValueSource, setValueToPresentation, valueBindingActivated, valueBindingConnected

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, setIcon, setIconFromSet, setId, 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.SingleFileUploadField

getFileContent

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

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

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

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

isEditableWithParent

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

isValidateOnCommit

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

addValidators

Field Detail

BYTES_IN_MEGABYTE

protected static final int BYTES_IN_MEGABYTE

See Also:

Constant Field Values

downloader

protected Downloader downloader

messages

protected io.jmix.core.Messages messages

contentProvider

protected java.util.function.Supplier<java.io.InputStream> contentProvider

componentProperties

protected UiComponentProperties componentProperties

fileSizeLimit

protected long fileSizeLimit

permittedExtensions

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

accept

protected java.lang.String accept

fileName

protected java.lang.String fileName

dropZone

protected UploadField.DropZone dropZone

pasteZone

protected ComponentContainer pasteZone

dropZonePrompt

protected java.lang.String dropZonePrompt

Constructor Detail

AbstractSingleFileUploadField

public AbstractSingleFileUploadField()

Method Detail

createComponent

protected JmixFileUploadField createComponent()

setDownloader

@Autowired
public void setDownloader(Downloader downloader)

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

initComponent

protected void initComponent()

receiveUpload

protected abstract java.io.OutputStream receiveUpload(java.lang.String fileName,
                                                      java.lang.String MIMEType)

onUploadStarted

protected void onUploadStarted(JmixFileUpload.StartedEvent event)

onUploadFinished

protected void onUploadFinished(JmixFileUpload.FinishedEvent event)

onUploadSucceeded

protected void onUploadSucceeded(JmixFileUpload.SucceededEvent event)

onUploadFailed

protected void onUploadFailed(JmixFileUpload.FailedEvent event)

onFileSizeLimitExceeded

protected void onFileSizeLimitExceeded(JmixFileUpload.FileSizeLimitExceededEvent e)

onFileExtensionNotAllowed

protected void onFileExtensionNotAllowed(JmixFileUpload.FileExtensionNotAllowedEvent e)

onFileNameClick

protected abstract void onFileNameClick(com.vaadin.ui.Button.ClickEvent e)

getFileName

@Nullable
public java.lang.String getFileName()

addFileUploadSucceedListener

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

Description copied from interface: SingleFileUploadField

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

Specified by:

addFileUploadSucceedListener in interface SingleFileUploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

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

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

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

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

getFileSizeLimit

public long getFileSizeLimit()

Description copied from interface: UploadField

Returns maximum allowed file size in bytes.

Specified by:

getFileSizeLimit in interface UploadField

getActualFileSizeLimit

protected long getActualFileSizeLimit()

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.

getFileSizeLimitString

protected java.lang.String getFileSizeLimitString()

internalValueChanged

protected void internalValueChanged(java.lang.Object newValue)

getDropZone

@Nullable
public UploadField.DropZone getDropZone()

Specified by:

getDropZone in interface UploadField

Returns:

current drop zone

getPasteZone

@Nullable
public ComponentContainer getPasteZone()

Specified by:

getPasteZone in interface UploadField

Returns:

current paste zone container

getDropZonePrompt

@Nullable
public java.lang.String getDropZonePrompt()

Specified by:

getDropZonePrompt in interface UploadField

Returns:

current drop zone prompt

clearButtonClicked

protected void clearButtonClicked(com.vaadin.ui.Button.ClickEvent clickEvent)

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)

fireFileUploadSucceed

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

setContentProvider

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

Description copied from interface: SingleFileUploadField

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 SingleFileUploadField.getFileContent() method.

Specified by:

setContentProvider in interface SingleFileUploadField

Parameters:

contentProvider - content provider

getContentProvider

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

Specified by:

getContentProvider in interface SingleFileUploadField

Returns:

FileContentProvider which can be used to read data from field

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

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

isShowFileName

public boolean isShowFileName()

Specified by:

isShowFileName in interface SingleFileUploadField

Returns:

true if name of uploaded file is shown.

setShowFileName

public void setShowFileName(boolean showFileName)

Description copied from interface: SingleFileUploadField

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

Specified by:

setShowFileName in interface SingleFileUploadField

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.

setShowClearButton

public void setShowClearButton(boolean showClearButton)

Description copied from interface: SingleFileUploadField

Enable or disable displaying name of clear button.

Specified by:

setShowClearButton in interface SingleFileUploadField

isShowClearButton

public boolean isShowClearButton()

Specified by:

isShowClearButton in interface SingleFileUploadField

Returns:

true if clear button is shown.

setClearButtonCaption

public void setClearButtonCaption(@Nullable
                                  java.lang.String caption)

Description copied from interface: SingleFileUploadField

Setup clear button caption.

Specified by:

setClearButtonCaption in interface SingleFileUploadField

getClearButtonCaption

@Nullable
public java.lang.String getClearButtonCaption()

Specified by:

getClearButtonCaption in interface SingleFileUploadField

Returns:

clear button caption.

setClearButtonIcon

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

Description copied from interface: SingleFileUploadField

Setup clear button icon.

Specified by:

setClearButtonIcon in interface SingleFileUploadField

getClearButtonIcon

@Nullable
public java.lang.String getClearButtonIcon()

Specified by:

getClearButtonIcon in interface SingleFileUploadField

Returns:

clear button icon.

setClearButtonDescription

public void setClearButtonDescription(java.lang.String description)

Description copied from interface: SingleFileUploadField

Setup clear button description.

Specified by:

setClearButtonDescription in interface SingleFileUploadField

getClearButtonDescription

public java.lang.String getClearButtonDescription()

Specified by:

getClearButtonDescription in interface SingleFileUploadField

Returns:

clear button description.

addBeforeValueClearListener

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

Description copied from interface: SingleFileUploadField

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().

Specified by:

addBeforeValueClearListener in interface SingleFileUploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

See Also:

SingleFileUploadField.setShowClearButton(boolean)

addAfterValueClearListener

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

Description copied from interface: SingleFileUploadField

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

Specified by:

addAfterValueClearListener in interface SingleFileUploadField

Parameters:

listener - a listener to add

Returns:

a registration object for removing an event listener

See Also:

SingleFileUploadField.setShowClearButton(boolean)

setUploadButtonCaption

public void setUploadButtonCaption(@Nullable
                                   java.lang.String caption)

Description copied from interface: SingleFileUploadField

Setup caption of upload button.

Specified by:

setUploadButtonCaption in interface SingleFileUploadField

getUploadButtonCaption

@Nullable
public java.lang.String getUploadButtonCaption()

Specified by:

getUploadButtonCaption in interface SingleFileUploadField

Returns:

upload button caption.

setUploadButtonIcon

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

Description copied from interface: SingleFileUploadField

Setup upload button icon.

Specified by:

setUploadButtonIcon in interface SingleFileUploadField

getUploadButtonIcon

@Nullable
public java.lang.String getUploadButtonIcon()

Specified by:

getUploadButtonIcon in interface SingleFileUploadField

Returns:

upload button icon.

setUploadButtonDescription

public void setUploadButtonDescription(@Nullable
                                       java.lang.String description)

Description copied from interface: SingleFileUploadField

Setup upload button description.

Specified by:

setUploadButtonDescription in interface SingleFileUploadField

getUploadButtonDescription

@Nullable
public java.lang.String getUploadButtonDescription()

Specified by:

getUploadButtonDescription in interface SingleFileUploadField

Returns:

upload button description.

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

commit

public void commit()

Description copied from interface: Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Buffered

Overrides:

commit in class AbstractValueComponent<JmixFileUploadField,java.lang.String,R>

discard

public void discard()

Description copied from interface: Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Buffered

Overrides:

discard in class AbstractValueComponent<JmixFileUploadField,java.lang.String,R>

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Buffered

Overrides:

isBuffered in class AbstractValueComponent<JmixFileUploadField,java.lang.String,R>

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Buffered.commit() is called. Calling Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Buffered.commit() and Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Buffered

Overrides:

setBuffered in class AbstractValueComponent<JmixFileUploadField,java.lang.String,R>

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Buffered

Overrides:

isModified in class AbstractValueComponent<JmixFileUploadField,java.lang.String,R>

Returns:

true if the value in the object has been modified since the last data source update, false if not.