Package com.vaadin.flow.component.upload

Class UploadButtonLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<UploadButton,UploadButtonLocator>

com.vaadin.flow.component.upload.UploadButtonLocator

All Implemented Interfaces:

Clickable<UploadButton>, HasAriaLabelFilter<UploadButton,UploadButtonLocator>, HasTextFilter<UploadButton,UploadButtonLocator>, HasThemeFilter<UploadButton,UploadButtonLocator>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class UploadButtonLocator
extends Locator<UploadButton,UploadButtonLocator>
implements Clickable<UploadButton>, HasTextFilter<UploadButton,UploadButtonLocator>, HasAriaLabelFilter<UploadButton,UploadButtonLocator>, HasThemeFilter<UploadButton,UploadButtonLocator>

Generated locator for UploadButton, derived from UploadButtonTester. 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
UploadButtonLocator()
UploadButtonLocator(UploadButton component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
void	ensureUploaded()	Checks that the last upload through the UploadManager the button is linked to delivered every one of its files, and fails otherwise.
void	ensureUploadFailed()	Checks that at least one file of the last upload through the UploadManager the button is linked to failed or was rejected, and fails otherwise.
UploadButton	getComponent()	Gets the component being tested.
List<UploadTester.FileStatus>	getLastUploadStatus()	Returns what happened to each file the user last selected, dropped or started through the UploadManager the button is linked to, in the order the files were given.
void	upload(File file)	Simulates the user picking the given file in the file dialog.
void	upload(String fileName, String contentType, byte[] contents)	Simulates the user picking a file with the given name, content type and contents in the file dialog.
void	uploadAborted(File file)	Simulates the user picking the given file in the file dialog and then aborting its upload.
void	uploadAborted(String fileName, String contentType)	Simulates the user picking a file with the given name and content type in the file dialog and then aborting its upload.
void	uploadAll(File... files)	Simulates the user picking several files at once in the file dialog.
void	uploadAll(Collection<File> files)	Simulates the user picking several files at once in the file dialog.
void	uploadFailed(File file)	Simulates the user picking the given file in the file dialog and its upload then failing.
void	uploadFailed(String fileName, String contentType)	Simulates the user picking a file with the given name and content type in the file dialog and its upload then failing.

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

withAriaLabel, withAriaLabelContaining

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

withText, withTextContaining

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

withoutTheme, withoutTheme, withTheme, withTheme

Constructor Details

UploadButtonLocator

public UploadButtonLocator()

UploadButtonLocator

public UploadButtonLocator(UploadButton component)

Method Details

getComponent

public UploadButton getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<UploadButton>

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

upload

public void upload(File file)

Simulates the user picking the given file in the file dialog.

The content type is detected from the file name. Javadoc copied from UploadButtonTester.upload(java.io.File).

Parameters:

file - the file to upload

upload

public void upload(String fileName,
 String contentType,
 byte[] contents)

Simulates the user picking a file with the given name, content type and contents in the file dialog. Javadoc copied from UploadButtonTester.upload(java.lang.String,java.lang.String,byte[]).

Parameters:

fileName - name of the file to upload

contentType - content type of the file to upload

contents - file contents as an array of bytes

uploadAll

public void uploadAll(File... files)

Simulates the user picking several files at once in the file dialog.

The content types are detected from the file names. Javadoc copied from UploadButtonTester.uploadAll(java.io.File[]).

Parameters:

files - the files to upload

uploadAll

public void uploadAll(Collection<File> files)

Simulates the user picking several files at once in the file dialog.

The content types are detected from the file names. Javadoc copied from UploadButtonTester.uploadAll(java.util.Collection).

Parameters:

files - the files to upload

uploadAborted

public void uploadAborted(File file)

Simulates the user picking the given file in the file dialog and then aborting its upload.

As in the browser, the aborted file is dropped from the file list and a UploadManager.FileRemovedEvent is fired, freeing a slot when UploadManager.setMaxFiles(int) is in use.

The file is added and its transfer started in one go, whether or not auto upload is turned off. The content type is detected from the file name, and the file is not read. Javadoc copied from UploadButtonTester.uploadAborted(java.io.File).

Parameters:

file - the file to upload

Throws:

IllegalStateException - if the component is not usable

uploadAborted

public void uploadAborted(String fileName,
 String contentType)

Simulates the user picking a file with the given name and content type in the file dialog and then aborting its upload.

As in the browser, the aborted file is dropped from the file list and a UploadManager.FileRemovedEvent is fired, freeing a slot when UploadManager.setMaxFiles(int) is in use.

The file is added and its transfer started in one go, whether or not auto upload is turned off. Javadoc copied from UploadButtonTester.uploadAborted(java.lang.String,java.lang.String).

Parameters:

fileName - name of the file to upload

contentType - content type of the file to upload

Throws:

IllegalStateException - if the component is not usable

uploadFailed

public void uploadFailed(File file)

Simulates the user picking the given file in the file dialog and its upload then failing.

As in the browser, a file whose upload failed stays in the file list.

The file is added and its transfer started in one go, whether or not auto upload is turned off. The content type is detected from the file name, and the file is not read. Javadoc copied from UploadButtonTester.uploadFailed(java.io.File).

Parameters:

file - the file to upload

Throws:

IllegalStateException - if the component is not usable

uploadFailed

public void uploadFailed(String fileName,
 String contentType)

Simulates the user picking a file with the given name and content type in the file dialog and its upload then failing.

As in the browser, a file whose upload failed stays in the file list.

The file is added and its transfer started in one go, whether or not auto upload is turned off. Javadoc copied from UploadButtonTester.uploadFailed(java.lang.String,java.lang.String).

Parameters:

fileName - name of the file to upload

contentType - content type of the file to upload

Throws:

IllegalStateException - if the component is not usable

getLastUploadStatus

public List<UploadTester.FileStatus> getLastUploadStatus()

Returns what happened to each file the user last selected, dropped or started through the UploadManager the button is linked to, in the order the files were given.

Files are reported as UploadTester.UploadStatus.UPLOADED once the upload handler has consumed them, as UploadTester.UploadStatus.REJECTED when the manager or Flow's server-side accepted type validation refused them, as UploadTester.UploadStatus.FAILED when the handler threw, and as UploadTester.UploadStatus.PENDING while they wait in the file list for auto upload being turned off. The error message of a file the manager refused is the client-side error code: tooManyFiles, fileIsTooBig or incorrectFileType. Javadoc copied from UploadButtonTester.getLastUploadStatus().

Returns:

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

ensureUploaded

public void ensureUploaded()

Checks that the last upload through the UploadManager the button is linked to delivered every one of its files, and fails otherwise. Javadoc copied from UploadButtonTester.ensureUploaded().

Throws:

IllegalStateException - if no upload has been simulated, or if any file of the last upload was not uploaded

See Also:

• getLastUploadStatus()

ensureUploadFailed

public void ensureUploadFailed()

Checks that at least one file of the last upload through the UploadManager the button is linked to failed or was rejected, and fails otherwise.

Counterpart of ensureUploaded() for a test about the failure case, such as an upload handler that throws or a file the manager refuses. Use getLastUploadStatus() to check which file failed and why.

A file left UploadTester.UploadStatus.PENDING does not count as failed: it was neither delivered nor refused, such as a file waiting because auto upload is turned off. Javadoc copied from UploadButtonTester.ensureUploadFailed().

Throws:

IllegalStateException - if no upload has been simulated, or if no file of the last upload failed or was rejected

See Also:

• getLastUploadStatus()