We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.upload.
Class GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>>
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.upload.GeneratedVaadinUploadFile<R>
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasStyle,Serializable@Tag("vaadin-upload-file") @NpmPackage(value="@vaadin/polymer-legacy-adapter", version="23.1.15") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/upload/src/vaadin-upload-file.js") public abstract class GeneratedVaadinUploadFile<R extends GeneratedVaadinUploadFile<R>> extends Component implements HasStyleDescription copied from corresponding location in WebComponent:
<vaadin-upload-file>element represents a file in the file list of<vaadin-upload>.Styling
The following shadow DOM parts are available for styling:
Part name Description rowFile container infoContainer for file status icon, file name, status and error messages done-iconFile done status icon warning-iconFile warning status icon metaContainer for file name, status and error messages nameFile name errorError message, shown when error happens statusStatus message commandsContainer for file command icons start-buttonStart file upload button retry-buttonRetry file upload button clear-buttonClear file button progressProgress bar The following state attributes are available for styling:
Attribute Description Part name errorAn error has happened during uploading :hostindeterminateUploading is in progress, but the progress value is unknown :hostuploadingUploading is in progress :hostcompleteUploading has finished successfully :hostSee ThemableMixin ? how to apply styles for shadow parts
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGeneratedVaadinUploadFile.FileAbortEvent<R extends GeneratedVaadinUploadFile<R>>static classGeneratedVaadinUploadFile.FileRemoveEvent<R extends GeneratedVaadinUploadFile<R>>static classGeneratedVaadinUploadFile.FileRetryEvent<R extends GeneratedVaadinUploadFile<R>>static classGeneratedVaadinUploadFile.FileStartEvent<R extends GeneratedVaadinUploadFile<R>>
-
Constructor Summary
Constructors Constructor Description GeneratedVaadinUploadFile()
-
Method Summary
All Methods Modifier and Type Method Description protected RegistrationaddFileAbortListener(ComponentEventListener<GeneratedVaadinUploadFile.FileAbortEvent<R>> listener)Adds a listener for
file-abortevents fired by the webcomponent.protected RegistrationaddFileRemoveListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRemoveEvent<R>> listener)Adds a listener for
file-removeevents fired by the webcomponent.protected RegistrationaddFileRetryListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRetryEvent<R>> listener)Adds a listener for
file-retryevents fired by the webcomponent.protected RegistrationaddFileStartListener(ComponentEventListener<GeneratedVaadinUploadFile.FileStartEvent<R>> listener)Adds a listener for
file-startevents fired by the webcomponent.protected elemental.json.JsonObjectgetFileJsonObject()This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
protected voidsetFile(elemental.json.JsonObject file)-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
-
-
-
Method Detail
-
getFileJsonObject
protected elemental.json.JsonObject getFileJsonObject()This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.
Returns:
the
fileproperty from the webcomponent
-
setFile
protected void setFile(elemental.json.JsonObject file)Parameters:
file- the JsonObject value to set
-
addFileAbortListener
protected Registration addFileAbortListener(ComponentEventListener<GeneratedVaadinUploadFile.FileAbortEvent<R>> listener)Adds a listener for
file-abortevents fired by the webcomponent.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
addFileRemoveListener
protected Registration addFileRemoveListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRemoveEvent<R>> listener)Adds a listener for
file-removeevents fired by the webcomponent.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
addFileRetryListener
protected Registration addFileRetryListener(ComponentEventListener<GeneratedVaadinUploadFile.FileRetryEvent<R>> listener)Adds a listener for
file-retryevents fired by the webcomponent.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
addFileStartListener
protected Registration addFileStartListener(ComponentEventListener<GeneratedVaadinUploadFile.FileStartEvent<R>> listener)Adds a listener for
file-startevents fired by the webcomponent.Parameters:
listener- the listenerReturns:
a
Registrationfor removing the event listener
-
-