org.dominokit.domino.ui.upload

Class FileUpload

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,FileUpload>

org.dominokit.domino.ui.upload.FileUpload

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,FileUpload,FileUpload>, HasChildren<FileUpload>, HasName<FileUpload>, HasWavesElement, IsCollapsible<FileUpload>, IsReadOnly<FileUpload>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class FileUpload
extends BaseDominoElement<elemental2.dom.HTMLDivElement,FileUpload>
implements HasName<FileUpload>

A component for uploading files (photos, documents or any other file type) from local storage

See Also:

BaseDominoElement, HasName

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileUpload.OnAddFileHandler A handler to be called when file is added

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
FileUpload()

Method Summary

Modifier and Type	Method and Description
FileUpload	accept(String acceptedFiles) Sets the accepted files extensions
FileUpload	appendChild(org.jboss.elemento.IsElement<?> child)
FileUpload	appendChild(elemental2.dom.Node child)
FileUpload	autoUpload() Sets that the file should be automatically uploaded when the user adds it
static FileUpload	create()
elemental2.dom.HTMLDivElement	element()
List<FileItem>	getAddedFileItems()
Optional<DropEffect>	getDropEffect()
DominoElement<elemental2.dom.HTMLDivElement>	getFilesContainer()
DominoElement<elemental2.dom.HTMLDivElement>	getFormElement()
DominoElement<elemental2.dom.HTMLInputElement>	getHiddenFileInput()
double	getMaxFileSize()
String	getName()
List<FileUpload.OnAddFileHandler>	getOnAddFileHandlers()
Row<Row_12>	getRow()
DominoElement<elemental2.dom.HTMLDivElement>	getUploadIconContainer()
DominoElement<elemental2.dom.HTMLDivElement>	getUploadMessageContainer()
String	getUrl()
boolean	isAutoUpload()
FileUpload	manualUpload() Sets that the file should be uploaded only when calling uploadFiles(FileList) or uploadAllFiles()
FileUpload	maxFileSize(double maxFileSize) Sets the maximum accepted file size
FileUpload	multipleFiles() Enables multiple files upload
FileUpload	onAddFile(FileUpload.OnAddFileHandler onAddFileHandler) Sets a handler to be called when file is added
FileUpload	setDropEffect(DropEffect dropEffect) Sets the drop effect
FileUpload	setIcon(BaseIcon<?> icon) Sets the upload icon
FileUpload	setName(String name)
FileUpload	setRequestSender(UploadRequestSender requestSender) Sets the sender of the upload request when the request is ready to be sent
FileUpload	setSingleFileErrorMessage(String errorMessage) Sets the error message when uploading file fails
void	setSuccessCodesProvider(Supplier<List<Integer>> successCodesProvider) Sets the success codes for upload files
FileUpload	setThumbOffset(int xLarge, int large, int medium, int small, int xSmall) Sets the column offset for a file preview
FileUpload	setThumbSpans(int xLarge, int large, int medium, int small, int xSmall) Sets the column span for a file preview
FileUpload	setUrl(String url) Sets the url for uploading the files to
FileUpload	singleFile() Enables uploading only a single file
void	uploadAllFiles() Sends the requests for uploading all files

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

FileUpload

public FileUpload()

Method Detail

setRequestSender

public FileUpload setRequestSender(UploadRequestSender requestSender)

Sets the sender of the upload request when the request is ready to be sent

Parameters:

requestSender - the UploadRequestSender

Returns:

same instance

uploadAllFiles

public void uploadAllFiles()

Sends the requests for uploading all files

create

public static FileUpload create()

Returns:

new instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,FileUpload>

Returns:

the HTML element of type E which is the root element of the component

appendChild

public FileUpload appendChild(elemental2.dom.Node child)

Specified by:

appendChild in interface HasChildren<FileUpload>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,FileUpload>

Parameters:

child - Node to be appended to the component

Returns:

same component

appendChild

public FileUpload appendChild(org.jboss.elemento.IsElement<?> child)

Specified by:

appendChild in interface HasChildren<FileUpload>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,FileUpload>

Parameters:

child - IsElement to be appended to the component

Returns:

same component

multipleFiles

public FileUpload multipleFiles()

Enables multiple files upload

Returns:

same instance

singleFile

public FileUpload singleFile()

Enables uploading only a single file

Returns:

same instance

accept

public FileUpload accept(String acceptedFiles)

Sets the accepted files extensions

Parameters:

acceptedFiles - a comma separated string containing all the accepted file extensions

Returns:

same instance

maxFileSize

public FileUpload maxFileSize(double maxFileSize)

Sets the maximum accepted file size

Parameters:

maxFileSize - the maximum size of the file

Returns:

same instance

setUrl

public FileUpload setUrl(String url)

Sets the url for uploading the files to

Parameters:

url - the url of the server

Returns:

same instance

onAddFile

public FileUpload onAddFile(FileUpload.OnAddFileHandler onAddFileHandler)

Sets a handler to be called when file is added

Parameters:

onAddFileHandler - a FileUpload.OnAddFileHandler

Returns:

same instance

autoUpload

public FileUpload autoUpload()

Sets that the file should be automatically uploaded when the user adds it

Returns:

same instance

manualUpload

public FileUpload manualUpload()

Sets that the file should be uploaded only when calling uploadFiles(FileList) or uploadAllFiles()

Returns:

same instance

getRow

public Row<Row_12> getRow()

Returns:

the files container

getFormElement

public DominoElement<elemental2.dom.HTMLDivElement> getFormElement()

Returns:

The form element

getUploadMessageContainer

public DominoElement<elemental2.dom.HTMLDivElement> getUploadMessageContainer()

Returns:

the upload message container

getUploadIconContainer

public DominoElement<elemental2.dom.HTMLDivElement> getUploadIconContainer()

Returns:

the upload icon container

getHiddenFileInput

public DominoElement<elemental2.dom.HTMLInputElement> getHiddenFileInput()

Returns:

the hidden file input element

getFilesContainer

public DominoElement<elemental2.dom.HTMLDivElement> getFilesContainer()

Returns:

the files container

getAddedFileItems

public List<FileItem> getAddedFileItems()

Returns:

the added file items

getMaxFileSize

public double getMaxFileSize()

Returns:

the maximum accepted file size

getUrl

public String getUrl()

Returns:

the url for the server

getOnAddFileHandlers

public List<FileUpload.OnAddFileHandler> getOnAddFileHandlers()

Returns:

all FileUpload.OnAddFileHandler defined

isAutoUpload

public boolean isAutoUpload()

Returns:

true if auto upload is set, false otherwise

getName

public String getName()

Specified by:

getName in interface HasName<FileUpload>

Returns:

String component name

setIcon

public FileUpload setIcon(BaseIcon<?> icon)

Sets the upload icon

Parameters:

icon - a BaseIcon

Returns:

same instance

setThumbSpans

public FileUpload setThumbSpans(int xLarge,
                                int large,
                                int medium,
                                int small,
                                int xSmall)

Sets the column span for a file preview

Parameters:

xLarge - the span when the screen is X large

large - the span when the screen is Large

medium - the span when the screen is Medium

small - the span when the screen is Small

xSmall - the span when the screen is X small

Returns:

same instance

setThumbOffset

public FileUpload setThumbOffset(int xLarge,
                                 int large,
                                 int medium,
                                 int small,
                                 int xSmall)

Sets the column offset for a file preview

Parameters:

xLarge - the offset when the screen is X large

large - the offset when the screen is Large

medium - the offset when the screen is Medium

small - the offset when the screen is Small

xSmall - the offset when the screen is X small

Returns:

same instance

setSuccessCodesProvider

public void setSuccessCodesProvider(Supplier<List<Integer>> successCodesProvider)

Sets the success codes for upload files

Parameters:

successCodesProvider - a Supplier for getting the success codes

setName

public FileUpload setName(String name)

Specified by:

setName in interface HasName<FileUpload>

Parameters:

name - String component name

Returns:

same implementing class

setSingleFileErrorMessage

public FileUpload setSingleFileErrorMessage(String errorMessage)

Sets the error message when uploading file fails

Parameters:

errorMessage - the error message

Returns:

same instance

getDropEffect

public Optional<DropEffect> getDropEffect()

Returns:

the DropEffect configured

setDropEffect

public FileUpload setDropEffect(DropEffect dropEffect)

Sets the drop effect

Parameters:

dropEffect - the DropEffect

Returns:

same instance