com.haulmont.cuba.gui.components

Interface FileUploadField

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<FileDescriptor>, Field<FileDescriptor>, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasValue<FileDescriptor>, HasValueSource<FileDescriptor>, UploadField, Validatable

public interface FileUploadField
extends UploadField, Field<FileDescriptor>, Component.Focusable, Buffered

Component for uploading files from client to server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileUploadField.AfterValueClearEvent Describes after value clear event.
static class	FileUploadField.BeforeValueClearEvent Describes before value clear event.
static interface	FileUploadField.FileContentProvider Deprecated. Use Supplier of InputStream instead.
static class	FileUploadField.FileStoragePutMode Defines when FileDescriptor will be committed.
static class	FileUploadField.FileUploadSucceedEvent Describes file upload succeeded event when the uploads are successfully finished.

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

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

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

Field.Validator<T>

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

HasValue.ValueChangeEvent<V>

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

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

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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	addAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener) Adds a callback interface which is invoked by the FileUploadField after value has been cleared using clear button.
Subscription	addBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener) Sets a callback interface which is invoked by the FileUploadField before value clearing when user use clear button.
Subscription	addFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener) Adds file upload succeed listener.
byte[]	getBytes() Deprecated. Please use getFileId() method and FileUploading.
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonDescription()
java.lang.String	getClearButtonIcon()
java.util.function.Supplier<java.io.InputStream>	getContentProvider()
java.io.InputStream	getFileContent()
FileDescriptor	getFileDescriptor() Return FileDescriptor instance of uploaded file.
java.util.UUID	getFileId() Get id for uploaded file in FileUploading.
java.lang.String	getFileName()
FileUploadField.FileStoragePutMode	getMode()
java.lang.String	getUploadButtonCaption()
java.lang.String	getUploadButtonDescription()
java.lang.String	getUploadButtonIcon()
boolean	isShowClearButton()
boolean	isShowFileName()
void	removeAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener) Deprecated. Use Subscription instead
void	removeBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener) Deprecated. Use Subscription instead
void	removeFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener) Deprecated. Use Subscription instead
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	setMode(FileUploadField.FileStoragePutMode mode) Set mode which determines when FileDescriptor will be committed.
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 com.haulmont.cuba.gui.components.UploadField

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

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

addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

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

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

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

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

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.data.HasValueSource

getValueSource, setValueSource

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

isEditable, isEditableWithParent, setEditable

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

getFrame, setFrame

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

isValid, isValidateOnCommit, validate

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

getIcon, setIcon, setIconFromSet

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

commit, discard, isBuffered, isModified, setBuffered

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getFileId

java.util.UUID getFileId()

Get id for uploaded file in FileUploading.

Returns:

File Id.

getFileName

java.lang.String getFileName()

getFileDescriptor

@Nullable
FileDescriptor getFileDescriptor()

Return FileDescriptor instance of uploaded file. Can be null.

Returns:

FileDescriptor instance or null

getBytes

@Deprecated
byte[] getBytes()

Deprecated. Please use getFileId() method and FileUploading.

Get content bytes for uploaded file.

Returns:

Bytes for uploaded file.

addFileUploadSucceedListener

Subscription addFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener)

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

Parameters:

listener - a listener to add

Returns:

subscription

removeFileUploadSucceedListener

@Deprecated
void removeFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener)

Deprecated. Use Subscription instead

Parameters:

listener - a listener to remove

getFileContent

@Nullable
java.io.InputStream getFileContent()

Returns:

content of uploaded file.

setShowFileName

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

void setUploadButtonCaption(java.lang.String caption)

Setup caption of upload button.

getUploadButtonCaption

java.lang.String getUploadButtonCaption()

Returns:

upload button caption.

setUploadButtonIcon

void setUploadButtonIcon(java.lang.String icon)

Setup upload button icon.

getUploadButtonIcon

java.lang.String getUploadButtonIcon()

Returns:

upload button icon.

setUploadButtonDescription

void setUploadButtonDescription(java.lang.String description)

Setup upload button description.

getUploadButtonDescription

java.lang.String getUploadButtonDescription()

Returns:

upload button description.

setShowClearButton

void setShowClearButton(boolean showClearButton)

Enable or disable displaying name of clear button.

isShowClearButton

boolean isShowClearButton()

Returns:

true if clear button is shown.

setClearButtonCaption

void setClearButtonCaption(java.lang.String caption)

Setup clear button caption.

getClearButtonCaption

java.lang.String getClearButtonCaption()

Returns:

clear button caption.

setClearButtonIcon

void setClearButtonIcon(java.lang.String icon)

Setup clear button icon.

getClearButtonIcon

java.lang.String getClearButtonIcon()

Returns:

clear button icon.

setClearButtonDescription

void setClearButtonDescription(java.lang.String description)

Setup clear button description.

getClearButtonDescription

java.lang.String getClearButtonDescription()

Returns:

clear button description.

addBeforeValueClearListener

Subscription addBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener)

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

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

Parameters:

listener - a listener to add

See Also:

setShowClearButton(boolean)

removeBeforeValueClearListener

@Deprecated
void removeBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener)

Deprecated. Use Subscription instead

Parameters:

listener - a listener to remove

addAfterValueClearListener

Subscription addAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener)

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

Parameters:

listener - a listener to add

See Also:

setShowClearButton(boolean)

removeAfterValueClearListener

@Deprecated
void removeAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener)

Deprecated. Use Subscription instead

Parameters:

listener - a listener to remove

setMode

void setMode(FileUploadField.FileStoragePutMode mode)

Set mode which determines when FileDescriptor will be committed.

getMode

FileUploadField.FileStoragePutMode getMode()

Returns:

mode which determines when FileDescriptor will be committed.

setContentProvider

void setContentProvider(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

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

Returns:

FileContentProvider which can be used to read data from field