org.dominokit.domino.ui.upload

Class FileItem

java.lang.Object

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

org.dominokit.domino.ui.upload.FileItem

All Implemented Interfaces:

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

public class FileItem
extends BaseDominoElement<elemental2.dom.HTMLDivElement,FileItem>

A component representing the upload file

See Also:

BaseDominoElement, FileUpload

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileItem.BeforeUploadHandler A handler to be called before uploading the file
static interface	FileItem.CancelHandler A handler to be called when the upload request is canceled
static interface	FileItem.ErrorHandler A handler to be called when the upload request fails
static interface	FileItem.ProgressHandler A handler which provides the upload progress
static interface	FileItem.RemoveFileHandler A handler to be called when the file is removed
static interface	FileItem.SuccessUploadHandler A handler to be called when the file is successfully uploaded

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
FileItem(elemental2.dom.File file, UploadOptions options)

Method Summary

Modifier and Type	Method and Description
FileItem	addBeforeUploadHandler(FileItem.BeforeUploadHandler beforeUploadHandler) Adds a handler to be called before uploading the file
FileItem	addCancelHandler(FileItem.CancelHandler cancelHandler) Adds a handler to be called when uploading the file is canceled
FileItem	addErrorHandler(FileItem.ErrorHandler errorHandler) Adds a handler to be called when an error happens while uploading the file
FileItem	addProgressHandler(FileItem.ProgressHandler progressHandler) Adds a handler to be called when file is uploading providing the progress
FileItem	addRemoveHandler(FileItem.RemoveFileHandler removeHandler) Adds a handler to be called when removing the file
FileItem	addSuccessUploadHandler(FileItem.SuccessUploadHandler successUploadHandler) Adds a handler to be called when the file is uploaded successfully
FileItem	cancel() Cancels the upload request
static FileItem	create(elemental2.dom.File file, UploadOptions options)
elemental2.dom.HTMLDivElement	element()
List<FileItem.BeforeUploadHandler>	getBeforeUploadHandlers()
List<FileItem.CancelHandler>	getCancelHandlers()
DominoElement<elemental2.dom.HTMLElement>	getCancelIcon()
DominoElement<elemental2.dom.HTMLElement>	getDeleteIcon()
List<FileItem.ErrorHandler>	getErrorHandlers()
elemental2.dom.File	getFile()
FileImage	getFileImage()
String	getFileName()
DominoElement<elemental2.dom.HTMLHeadingElement>	getFileNameTitleContainer()
DominoElement<elemental2.dom.HTMLParagraphElement>	getFileSizeParagraph()
DominoElement<elemental2.dom.HTMLDivElement>	getFooterContainer()
DominoElement<elemental2.dom.HTMLElement>	getMessageContainer()
ProgressBar	getProgressBar()
DominoElement<elemental2.dom.HTMLDivElement>	getProgressElement()
List<FileItem.ProgressHandler>	getProgressHandlers()
List<FileItem.RemoveFileHandler>	getRemoveHandlers()
List<FileItem.SuccessUploadHandler>	getSuccessUploadHandlers()
void	invalidate(String message) Invalidates the file preview with an error message
boolean	isCanceled()
boolean	isExceedsMaxFile()
boolean	isImage()
boolean	isRemoved()
boolean	isUploaded()
String	readableFileSize()
FileItem	remove() removes the element from the DOM tree
FileItem	setErrorUploadMessage(String errorMessage) Sets the message to be shown when uploading file fails
void	setFileName(String fileName) Sets the file name
FileItem	setSizeTitle(String sizeTitle) The title of the file size
FileItem	setSuccessUploadMessage(String successMessage) Sets the message to be shown when the file is uploaded
FileItem	setUrl(String url) Sets the url of the server
void	upload() Uploads the file
void	upload(UploadRequestSender requestSender) Uploads the file

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, 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, 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

FileItem

public FileItem(elemental2.dom.File file,
                UploadOptions options)

Method Detail

create

public static FileItem create(elemental2.dom.File file,
                              UploadOptions options)

Parameters:

file - the File

options - the UploadOptions

Returns:

new instance

isImage

public boolean isImage()

Returns:

true if the uploaded file is image

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,FileItem>

Returns:

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

getFile

public elemental2.dom.File getFile()

Returns:

the File

setSizeTitle

public FileItem setSizeTitle(String sizeTitle)

The title of the file size

Parameters:

sizeTitle - the title

Returns:

same instance

readableFileSize

public String readableFileSize()

Returns:

the size of the file in a readable format

addRemoveHandler

public FileItem addRemoveHandler(FileItem.RemoveFileHandler removeHandler)

Adds a handler to be called when removing the file

Parameters:

removeHandler - A FileItem.RemoveFileHandler

Returns:

same instance

addErrorHandler

public FileItem addErrorHandler(FileItem.ErrorHandler errorHandler)

Adds a handler to be called when an error happens while uploading the file

Parameters:

errorHandler - A FileItem.ErrorHandler

Returns:

same instance

addProgressHandler

public FileItem addProgressHandler(FileItem.ProgressHandler progressHandler)

Adds a handler to be called when file is uploading providing the progress

Parameters:

progressHandler - A FileItem.ProgressHandler

Returns:

same instance

addBeforeUploadHandler

public FileItem addBeforeUploadHandler(FileItem.BeforeUploadHandler beforeUploadHandler)

Adds a handler to be called before uploading the file

Parameters:

beforeUploadHandler\ - A FileItem.BeforeUploadHandler

Returns:

same instance

addSuccessUploadHandler

public FileItem addSuccessUploadHandler(FileItem.SuccessUploadHandler successUploadHandler)

Adds a handler to be called when the file is uploaded successfully

Parameters:

successUploadHandler - A FileItem.SuccessUploadHandler

Returns:

same instance

addCancelHandler

public FileItem addCancelHandler(FileItem.CancelHandler cancelHandler)

Adds a handler to be called when uploading the file is canceled

Parameters:

cancelHandler - A FileItem.CancelHandler

Returns:

same instance

upload

public void upload()

Uploads the file

upload

public void upload(UploadRequestSender requestSender)

Uploads the file

Parameters:

requestSender - a UploadRequestSender to use for sending the request

isExceedsMaxFile

public boolean isExceedsMaxFile()

invalidate

public void invalidate(String message)

Invalidates the file preview with an error message

Parameters:

message - the error message

remove

public FileItem remove()

removes the element from the DOM tree

Overrides:

remove in class BaseDominoElement<elemental2.dom.HTMLDivElement,FileItem>

Returns:

same component

setUrl

public FileItem setUrl(String url)

Sets the url of the server

Parameters:

url - the server url

Returns:

same instance

getFileName

public String getFileName()

Returns:

the file name

setFileName

public void setFileName(String fileName)

Sets the file name

Parameters:

fileName - the new file name

getFileImage

public FileImage getFileImage()

Returns:

the FileImage element

getFileSizeParagraph

public DominoElement<elemental2.dom.HTMLParagraphElement> getFileSizeParagraph()

Returns:

the file size element

getFileNameTitleContainer

public DominoElement<elemental2.dom.HTMLHeadingElement> getFileNameTitleContainer()

Returns:

the file name container

getFooterContainer

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

Returns:

the footer container

getDeleteIcon

public DominoElement<elemental2.dom.HTMLElement> getDeleteIcon()

Returns:

the delete icon

getMessageContainer

public DominoElement<elemental2.dom.HTMLElement> getMessageContainer()

Returns:

the message container

getProgressElement

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

Returns:

the progress element

getProgressBar

public ProgressBar getProgressBar()

Returns:

the ProgressBar

getRemoveHandlers

public List<FileItem.RemoveFileHandler> getRemoveHandlers()

Returns:

all the FileItem.RemoveFileHandler

getErrorHandlers

public List<FileItem.ErrorHandler> getErrorHandlers()

Returns:

all the FileItem.ErrorHandler

getProgressHandlers

public List<FileItem.ProgressHandler> getProgressHandlers()

Returns:

all the FileItem.ProgressHandler

getBeforeUploadHandlers

public List<FileItem.BeforeUploadHandler> getBeforeUploadHandlers()

Returns:

all the FileItem.BeforeUploadHandler

getSuccessUploadHandlers

public List<FileItem.SuccessUploadHandler> getSuccessUploadHandlers()

Returns:

all the FileItem.SuccessUploadHandler

setSuccessUploadMessage

public FileItem setSuccessUploadMessage(String successMessage)

Sets the message to be shown when the file is uploaded

Parameters:

successMessage - the message

Returns:

same instance

setErrorUploadMessage

public FileItem setErrorUploadMessage(String errorMessage)

Sets the message to be shown when uploading file fails

Parameters:

errorMessage - the message

Returns:

same instance

cancel

public FileItem cancel()

Cancels the upload request

Returns:

same instance

getCancelIcon

public DominoElement<elemental2.dom.HTMLElement> getCancelIcon()

Returns:

the cancel icon

getCancelHandlers

public List<FileItem.CancelHandler> getCancelHandlers()

Returns:

all the FileItem.CancelHandler

isCanceled

public boolean isCanceled()

Returns:

true if the upload request is canceled

isRemoved

public boolean isRemoved()

Returns:

true if the file is removed

isUploaded

public boolean isUploaded()

Returns:

true if the file is uploaded