public interface FileUploadField extends UploadField, Field<FileDescriptor>, Component.Focusable, Buffered
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.
|
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 |
---|---|
com.haulmont.bali.events.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. |
com.haulmont.bali.events.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. |
com.haulmont.bali.events.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.
|
addFileUploadErrorListener, addFileUploadFinishListener, addFileUploadStartListener, getAccept, getDropZone, getDropZonePrompt, getFileSizeLimit, getPasteZone, getPermittedExtensions, removeFileUploadErrorListener, removeFileUploadFinishListener, removeFileUploadStartListener, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPasteZone, setPermittedExtensions
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
addValidator, 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
getValueSource, setValueSource
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
isDescriptionAsHtml, setDescriptionAsHtml
commit, discard, isBuffered, isModified, setBuffered
static final java.lang.String NAME
java.util.UUID getFileId()
FileUploading
.java.lang.String getFileName()
@Nullable FileDescriptor getFileDescriptor()
@Deprecated byte[] getBytes()
getFileId()
method and FileUploading
.com.haulmont.bali.events.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(java.lang.String caption)
java.lang.String getUploadButtonCaption()
void setUploadButtonIcon(java.lang.String icon)
java.lang.String getUploadButtonIcon()
void setUploadButtonDescription(java.lang.String description)
java.lang.String getUploadButtonDescription()
void setShowClearButton(boolean showClearButton)
boolean isShowClearButton()
void setClearButtonCaption(java.lang.String caption)
java.lang.String getClearButtonCaption()
void setClearButtonIcon(java.lang.String icon)
java.lang.String getClearButtonIcon()
void setClearButtonDescription(java.lang.String description)
java.lang.String getClearButtonDescription()
com.haulmont.bali.events.Subscription addBeforeValueClearListener(java.util.function.Consumer<FileUploadField.BeforeValueClearEvent> listener)
FileUploadField
before value
clearing when user use 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 removecom.haulmont.bali.events.Subscription 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()