public interface FileUploadField extends UploadField, Field<FileDescriptor>, Component.Focusable, Buffered
Modifier and Type | Interface and Description |
---|---|
static class |
FileUploadField.AfterValueClearEvent
Event sent after value is cleared.
|
static class |
FileUploadField.BeforeValueClearEvent
Event sent before value clearing when the user clicks the clear button.
|
static interface |
FileUploadField.FileContentProvider
Deprecated.
Use
Supplier of InputStream instead. |
static class |
FileUploadField.FileStoragePutMode
Defines when FileDescriptor is committed.
|
static class |
FileUploadField.FileUploadSucceedEvent
Describes file upload succeeded event when the uploads are successfully finished.
|
UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadStartEvent
Field.Validator<T>
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
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 the user clicks the clear button. |
Subscription |
addFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener)
Adds file upload succeed listener.
|
byte[] |
getBytes()
Get content of the uploaded file.
|
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 of the 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.
|
addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, getAccept, getDropZone, getDropZonePrompt, getFileSizeLimit, getPasteZone, getPermittedExtensions, removeFileUploadErrorListener, removeFileUploadFinishListener, removeFileUploadStartListener, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPasteZone, setPermittedExtensions
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage
getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue
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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition
getValueSource, setValueSource
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
commit, discard, isBuffered, isModified, setBuffered
static final java.lang.String NAME
java.util.UUID getFileId()
FileUploading
.java.lang.String getFileName()
@Nullable FileDescriptor getFileDescriptor()
byte[] getBytes()
Consider using FileUploadingAPI.getFile(UUID)
and passing getFileId()
to it.
Subscription addFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener)
listener
- a listener to add@Deprecated void removeFileUploadSucceedListener(java.util.function.Consumer<FileUploadField.FileUploadSucceedEvent> listener)
Subscription
insteadlistener
- a listener to remove@Nullable java.io.InputStream getFileContent()
void setShowFileName(boolean showFileName)
boolean isShowFileName()
void setUploadButtonCaption(@Nullable java.lang.String caption)
@Nullable java.lang.String getUploadButtonCaption()
void setUploadButtonIcon(@Nullable java.lang.String icon)
@Nullable java.lang.String getUploadButtonIcon()
void setUploadButtonDescription(@Nullable java.lang.String description)
@Nullable java.lang.String getUploadButtonDescription()
void setShowClearButton(boolean showClearButton)
boolean isShowClearButton()
void setClearButtonCaption(@Nullable java.lang.String caption)
@Nullable java.lang.String getClearButtonCaption()
void setClearButtonIcon(@Nullable java.lang.String icon)
@Nullable java.lang.String getClearButtonIcon()
void setClearButtonDescription(@Nullable java.lang.String description)
@Nullable java.lang.String getClearButtonDescription()
Subscription addBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener)
FileUploadField
before value
clearing when the user clicks the clear button.
Listener can prevent value clearing using FileUploadField.BeforeValueClearEvent.preventClearAction()
.
listener
- a listener to addsetShowClearButton(boolean)
@Deprecated void removeBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener)
Subscription
insteadlistener
- a listener to removeSubscription addAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener)
FileUploadField
after value
has been cleared using clear button.listener
- a listener to addsetShowClearButton(boolean)
@Deprecated void removeAfterValueClearListener(java.util.function.Consumer<FileUploadField.AfterValueClearEvent> listener)
Subscription
insteadlistener
- a listener to removevoid setMode(FileUploadField.FileStoragePutMode mode)
FileDescriptor
will be committed.FileUploadField.FileStoragePutMode getMode()
FileDescriptor
will be committed.void setContentProvider(java.util.function.Supplier<java.io.InputStream> contentProvider)
Passed content provider will be used for downloading by clicking the link with file name
or as source for getFileContent()
method.
contentProvider
- content providerjava.util.function.Supplier<java.io.InputStream> getContentProvider()