public interface UploadField extends Component, Component.HasCaption, Component.BelongToFrame, Component.HasIcon, Component.Focusable, HasHtmlCaption, HasHtmlDescription
Modifier and Type | Interface and Description |
---|---|
static class |
UploadField.DropZone
Drop zone descriptor.
|
static class |
UploadField.FileUploadErrorEvent
Describes file upload error event.
|
static class |
UploadField.FileUploadEvent
Base class for UploadField events.
|
static class |
UploadField.FileUploadFinishEvent
Describes file upload finish event.
|
static class |
UploadField.FileUploadStartEvent
Describes file upload start event.
|
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
Modifier and Type | Method and Description |
---|---|
Subscription |
addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)
Adds file upload error listener.
|
Subscription |
addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)
Adds file upload finish listener.
|
Subscription |
addFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)
Adds file upload start listener.
|
java.lang.String |
getAccept()
Returns comma separated types of files.
|
UploadField.DropZone |
getDropZone() |
java.lang.String |
getDropZonePrompt() |
long |
getFileSizeLimit()
Returns maximum allowed file size in bytes.
|
ComponentContainer |
getPasteZone() |
java.util.Set<java.lang.String> |
getPermittedExtensions()
Return white list of file extensions.
|
void |
removeFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)
Deprecated.
Use
Subscription instead |
void |
removeFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)
Deprecated.
Use
Subscription instead |
void |
removeFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)
Deprecated.
Use
Subscription instead |
void |
setAccept(java.lang.String accept)
Sets the mask for files to filter them in the file selection dialog.
Example: |
void |
setDropZone(UploadField.DropZone dropZone)
Set drop zone reference to this upload component.
|
void |
setDropZonePrompt(java.lang.String dropZonePrompt)
Set 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 |
setPasteZone(ComponentContainer pasteZone)
Set paste zone reference to this upload component.
|
void |
setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)
Set white list of file extensions.
|
getFrame, setFrame
getIcon, setIcon, setIconFromSet
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
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
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
Subscription addFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)
listener
- a listener to add@Deprecated void removeFileUploadStartListener(java.util.function.Consumer<UploadField.FileUploadStartEvent> listener)
Subscription
insteadSubscription addFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)
listener
- a listener to add@Deprecated void removeFileUploadFinishListener(java.util.function.Consumer<UploadField.FileUploadFinishEvent> listener)
Subscription
insteadSubscription addFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)
listener
- a listener to add@Deprecated void removeFileUploadErrorListener(java.util.function.Consumer<UploadField.FileUploadErrorEvent> listener)
Subscription
insteadlong getFileSizeLimit()
void setFileSizeLimit(long fileSizeLimit)
java.lang.String getAccept()
void setAccept(java.lang.String accept)
fileUpload.setAccept(".png,.jpeg")
accept
- comma separated types of filesvoid setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)
private FileUploadField uploadField;
...
uploadField.setPermittedExtensions(Sets.newHashSet(".png", ".jpg"));
permittedExtensions
- permitted extensions.java.util.Set<java.lang.String> getPermittedExtensions()
UploadField.DropZone getDropZone()
void setDropZone(UploadField.DropZone dropZone)
dropZone
- drop zone descriptorvoid setPasteZone(ComponentContainer pasteZone)
pasteZone
- paste zone containerComponentContainer getPasteZone()
java.lang.String getDropZonePrompt()
void setDropZonePrompt(java.lang.String dropZonePrompt)
dropZonePrompt
- drop zone prompt