com.haulmont.cuba.gui.components

Interface FileUploadField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field, UploadField

All Known Implementing Classes:

DesktopFileUploadField, WebFileUploadField

public interface FileUploadField
extends UploadField, Field, Component.Focusable, Component.Buffered

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileUploadField.AfterValueClearEvent
static interface	FileUploadField.AfterValueClearListener Callback interface which is invoked by the FileUploadField after value has been cleared using clear button.
static class	FileUploadField.BeforeValueClearEvent
static interface	FileUploadField.BeforeValueClearListener Callback interface which is invoked by the FileUploadField before value clearing when user use clear button.
static interface	FileUploadField.FileContentProvider
static class	FileUploadField.FileStoragePutMode Defines when FileDescriptor will be committed.
static class	FileUploadField.FileUploadSucceedEvent
static interface	FileUploadField.FileUploadSucceedListener
static interface	FileUploadField.Listener Deprecated. Use UploadField.FileUploadStartListener, UploadField.FileUploadFinishListener, UploadField.FileUploadErrorListener
static class	FileUploadField.ListenerAdapter Deprecated. Use UploadField.FileUploadStartListener, UploadField.FileUploadFinishListener, UploadField.FileUploadErrorListener

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

UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadErrorListener, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadFinishListener, UploadField.FileUploadStartEvent, UploadField.FileUploadStartListener

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

Field.Validator

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.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, 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

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addAfterValueClearListener(FileUploadField.AfterValueClearListener listener)
void	addBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)
void	addFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)
void	addListener(FileUploadField.Listener listener) Deprecated.
byte[]	getBytes() Deprecated. Please use getFileId() method and FileUploading.
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonDescription()
java.lang.String	getClearButtonIcon()
FileUploadField.FileContentProvider	getContentProvider()
java.io.InputStream	getFileContent()
FileDescriptor	getFileDescriptor()
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(FileUploadField.AfterValueClearListener listener)
void	removeBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)
void	removeFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)
void	removeListener(FileUploadField.Listener listener) Deprecated.
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(FileUploadField.FileContentProvider 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, getPermittedExtensions, removeFileUploadErrorListener, removeFileUploadFinishListener, removeFileUploadStartListener, setAccept, setDropZone, setDropZonePrompt, setFileSizeLimit, setPermittedExtensions

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

getTabIndex, isFocusable, setFocusable, setTabIndex

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

addValidator, 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.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

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

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

isValid, isValidateOnCommit, validate

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

getIcon, setIcon

Methods inherited from interface com.haulmont.cuba.gui.components.Component.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

FileDescriptor getFileDescriptor()

getBytes

byte[] getBytes()

Deprecated. Please use getFileId() method and FileUploading.

Get content bytes for uploaded file.

Returns:

Bytes for uploaded file.

addListener

@Deprecated
void addListener(FileUploadField.Listener listener)

Deprecated.

removeListener

@Deprecated
void removeListener(FileUploadField.Listener listener)

Deprecated.

addFileUploadSucceedListener

void addFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)

removeFileUploadSucceedListener

void removeFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)

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

void addBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)

removeBeforeValueClearListener

void removeBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)

addAfterValueClearListener

void addAfterValueClearListener(FileUploadField.AfterValueClearListener listener)

removeAfterValueClearListener

void removeAfterValueClearListener(FileUploadField.AfterValueClearListener listener)

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

setContentProvider

void setContentProvider(FileUploadField.FileContentProvider 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

FileUploadField.FileContentProvider getContentProvider()

Returns:

FileContentProvider which can be used to read data from field