Package com.vaadin.flow.component.upload

Class UploadFileListLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<UploadFileList,UploadFileListLocator>

com.vaadin.flow.component.upload.UploadFileListLocator

All Implemented Interfaces:

Clickable<UploadFileList>, HasThemeFilter<UploadFileList,UploadFileListLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class UploadFileListLocator
extends Locator<UploadFileList,UploadFileListLocator>
implements Clickable<UploadFileList>, HasThemeFilter<UploadFileList,UploadFileListLocator>

Generated locator for UploadFileList, derived from UploadFileListTester. Filter steps are inherited from Locator; action methods delegate to a fresh tester around the resolved component, so behavioral changes belong on the tester, not here.

Constructor Summary

Constructors

Constructor	Description
UploadFileListLocator()
UploadFileListLocator(UploadFileList component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
UploadFileList	getComponent()	Gets the component being tested.
List<UploadTester.FileStatus>	getFiles()	Gets the files the file list shows, in the order the browser shows them: the most recently added file first.
List<UploadTester.FileStatus>	getLastUploadStatus()	Returns what happened to each file the user last picked with an UploadButton, dropped on an UploadDropZone or started from this list, in the order the files were given.
void	removeFile(int index)	Simulates the user clicking the remove button of the file at the given position of the list, which reaches one entry when several share a name.
void	removeFile(File file)	Simulates the user clicking the remove button of a file in the list.
void	removeFile(String fileName)	Simulates the user clicking the remove button of a file in the list.
void	startUpload(int index)	Simulates the user clicking the start button of the file at the given position of the list, which waits because auto upload is turned off, uploading it.
void	startUpload(File file)	Simulates the user clicking the start button of a file that waits in the list because auto upload is turned off, uploading it.
void	startUpload(String fileName)	Simulates the user clicking the start button of a file that waits in the list because auto upload is turned off, uploading it.

Methods inherited from class com.vaadin.browserless.locator.Locator

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, withCondition, withCondition, withId, withinSlot, withoutAttribute, withoutAttribute, withoutClassName, withTestId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.browserless.Clickable

click, click, click, middleClick, middleClick, rightClick, rightClick

Methods inherited from interface com.vaadin.browserless.locator.HasThemeFilter

withoutTheme, withoutTheme, withTheme, withTheme

Constructor Details

UploadFileListLocator

public UploadFileListLocator()

UploadFileListLocator

public UploadFileListLocator(UploadFileList component)

Method Details

getComponent

public UploadFileList getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<UploadFileList>

Returns:

the component under test

ensureComponentIsUsable

public void ensureComponentIsUsable()

Description copied from interface: Clickable

Ensures the component is in a usable state before interaction.

Specified by:

ensureComponentIsUsable in interface Clickable<UploadFileList>

getFiles

public List<UploadTester.FileStatus> getFiles()

Gets the files the file list shows, in the order the browser shows them: the most recently added file first.

A file is UploadTester.UploadStatus.UPLOADED once the upload handler has consumed it, UploadTester.UploadStatus.FAILED or UploadTester.UploadStatus.REJECTED when its transfer failed or the server refused it, and UploadTester.UploadStatus.PENDING while it waits to be started because auto upload is turned off. Javadoc copied from UploadFileListTester.getFiles().

Returns:

the files in the file list, or an empty list if the file list is not linked to an upload manager

getLastUploadStatus

public List<UploadTester.FileStatus> getLastUploadStatus()

Returns what happened to each file the user last picked with an UploadButton, dropped on an UploadDropZone or started from this list, in the order the files were given.

A file is UploadTester.UploadStatus.UPLOADED once the upload handler has consumed it, UploadTester.UploadStatus.FAILED when the handler threw, and UploadTester.UploadStatus.PENDING while it waits for startUpload(String) because auto upload is turned off.

Unlike getFiles(), this also reports the files the manager refused, which never enter the list: they are UploadTester.UploadStatus.REJECTED with the client-side error code as the error message: tooManyFiles, fileIsTooBig or incorrectFileType. A file Flow's server-side accepted type validation refused is REJECTED as well. Javadoc copied from UploadFileListTester.getLastUploadStatus().

Returns:

the outcome of the last upload, one entry per file, or an empty list if nothing has been uploaded yet or the file list is not linked to a manager

removeFile

public void removeFile(String fileName)

Simulates the user clicking the remove button of a file in the list.

A UploadManager.FileRemovedEvent is fired and the file stops counting towards UploadManager.setMaxFiles(int).

When several entries have the given name, the most recently added one is removed. Javadoc copied from UploadFileListTester.removeFile(java.lang.String).

Parameters:

fileName - name of the file to remove, as given when it was uploaded

Throws:

IllegalArgumentException - if the file is not in the file list

IllegalStateException - if the component is not usable

removeFile

public void removeFile(File file)

Simulates the user clicking the remove button of a file in the list.

A UploadManager.FileRemovedEvent is fired and the file stops counting towards UploadManager.setMaxFiles(int).

When several entries have the name of the given file, the most recently added one is removed. Javadoc copied from UploadFileListTester.removeFile(java.io.File).

Parameters:

file - the file to remove

Throws:

IllegalArgumentException - if the file is not in the file list

IllegalStateException - if the component is not usable

removeFile

public void removeFile(int index)

Simulates the user clicking the remove button of the file at the given position of the list, which reaches one entry when several share a name.

A UploadManager.FileRemovedEvent is fired and the file stops counting towards UploadManager.setMaxFiles(int). Javadoc copied from UploadFileListTester.removeFile(int).

Parameters:

index - the position of the file in the list, in the order getFiles() returns them: the most recently added file first

Throws:

IllegalArgumentException - if there is no file at the position

IllegalStateException - if the component is not usable

startUpload

public void startUpload(String fileName)

Simulates the user clicking the start button of a file that waits in the list because auto upload is turned off, uploading it.

When several waiting entries have the given name, the most recently added one is started. Javadoc copied from UploadFileListTester.startUpload(java.lang.String).

Parameters:

fileName - name of the file to start, as given when it was added

startUpload

public void startUpload(File file)

Simulates the user clicking the start button of a file that waits in the list because auto upload is turned off, uploading it.

When several waiting entries have the name of the given file, the most recently added one is started. Javadoc copied from UploadFileListTester.startUpload(java.io.File).

Parameters:

file - the file to start

startUpload

public void startUpload(int index)

Simulates the user clicking the start button of the file at the given position of the list, which waits because auto upload is turned off, uploading it. This reaches one entry when several share a name. Javadoc copied from UploadFileListTester.startUpload(int).

Parameters:

index - the position of the file in the list, in the order getFiles() returns them: the most recently added file first