com.haulmont.cuba.gui.components

Interface UploadField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Focusable, Component.HasCaption, Component.HasIcon

All Known Subinterfaces:

FileMultiUploadField, FileUploadField

public interface UploadField
extends Component, Component.HasCaption, Component.BelongToFrame, Component.HasIcon, Component.Focusable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UploadField.DropZone Drop zone descriptor.
static class	UploadField.FileUploadErrorEvent
static interface	UploadField.FileUploadErrorListener
static class	UploadField.FileUploadEvent
static class	UploadField.FileUploadFinishEvent
static interface	UploadField.FileUploadFinishListener
static class	UploadField.FileUploadStartEvent
static interface	UploadField.FileUploadStartListener

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addFileUploadErrorListener(UploadField.FileUploadErrorListener listener)
void	addFileUploadFinishListener(UploadField.FileUploadFinishListener listener)
void	addFileUploadStartListener(UploadField.FileUploadStartListener 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.
Component.Container	getPasteZone()
java.util.Set<java.lang.String>	getPermittedExtensions() Return white list of file extensions.
void	removeFileUploadErrorListener(UploadField.FileUploadErrorListener listener)
void	removeFileUploadFinishListener(UploadField.FileUploadFinishListener listener)
void	removeFileUploadStartListener(UploadField.FileUploadStartListener listener)
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(Component.Container pasteZone) Set paste zone reference to this upload component.
void	setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions) Set white list of file extensions.

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

getCaption, getDescription, setCaption, setDescription

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

getFrame, setFrame

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

getIcon, setIcon, setIconFromSet

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

getTabIndex, isFocusable, setFocusable, setTabIndex

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Method Detail

addFileUploadStartListener

void addFileUploadStartListener(UploadField.FileUploadStartListener listener)

removeFileUploadStartListener

void removeFileUploadStartListener(UploadField.FileUploadStartListener listener)

addFileUploadFinishListener

void addFileUploadFinishListener(UploadField.FileUploadFinishListener listener)

removeFileUploadFinishListener

void removeFileUploadFinishListener(UploadField.FileUploadFinishListener listener)

addFileUploadErrorListener

void addFileUploadErrorListener(UploadField.FileUploadErrorListener listener)

removeFileUploadErrorListener

void removeFileUploadErrorListener(UploadField.FileUploadErrorListener listener)

getFileSizeLimit

long getFileSizeLimit()

Returns maximum allowed file size in bytes.

setFileSizeLimit

void setFileSizeLimit(long fileSizeLimit)

Sets maximum allowed file size in bytes. Default value is 0. In this case component uses system value.

getAccept

java.lang.String getAccept()

Returns comma separated types of files.

Returns:

comma separated types of files

setAccept

void setAccept(java.lang.String accept)

Sets the mask for files to filter them in the file selection dialog.
Example:

 fileUpload.setAccept(".png,.jpeg")

Parameters:

accept - comma separated types of files

setPermittedExtensions

void setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)

Set white list of file extensions. Each extension should start with dot symbol, e.g. ".png".

    private FileUploadField uploadField;
    ...
    uploadField.setPermittedExtensions(Sets.newHashSet(".png", ".jpg"));
 

Parameters:

permittedExtensions - permitted extensions.

getPermittedExtensions

java.util.Set<java.lang.String> getPermittedExtensions()

Return white list of file extensions.

Returns:

set of file extensions.

getDropZone

UploadField.DropZone getDropZone()

Returns:

current drop zone

setDropZone

void setDropZone(UploadField.DropZone dropZone)

Set drop zone reference to this upload component. Files can be dropped to component of the drop zone to be uploaded by this upload component.

Parameters:

dropZone - drop zone descriptor

setPasteZone

void setPasteZone(Component.Container pasteZone)

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

Parameters:

pasteZone - paste zone container

getPasteZone

Component.Container getPasteZone()

Returns:

current paste zone container

getDropZonePrompt

java.lang.String getDropZonePrompt()

Returns:

current drop zone prompt

setDropZonePrompt

void setDropZonePrompt(java.lang.String dropZonePrompt)

Set drop zone prompt that will be shown on drag over window with file.

Parameters:

dropZonePrompt - drop zone prompt