Package com.vaadin.flow.component

Class TextTester<T extends Text>

java.lang.Object

com.vaadin.browserless.ComponentTester<T>

com.vaadin.flow.component.TextTester<T>

Type Parameters:

T - component type

All Implemented Interfaces:

Clickable<T>

public class TextTester<T extends Text>
extends ComponentTester<T>

Tester for Text components.

Text renders as a text node rather than an HTML element, so it has no visibility or enabled state of its own (Component.isVisible() throws, and a text node cannot be disabled). Usability is therefore derived from the component being attached and from the effective visibility of its parent subtree.

Constructor Summary

Constructors

Constructor	Description
TextTester(T component)	Wrap given component for testing.

Method Summary

Modifier and Type	Method	Description
String	getText()	Gets the text of the component.
boolean	isUsable()	Validate that component can be interacted with and should be visible in the UI.
protected void	notUsableReasons(Consumer<String> collector)	Provides messages explaining why the component is actually not usable.

Methods inherited from class com.vaadin.browserless.ComponentTester

ensureComponentIsUsable, ensureComponentIsUsable, ensureVisible, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, getComponent, getField, getField, getMethod, getMethod, isUsable, notUsableReasons, roundTrip, setModal, setValueAsUser

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

Constructor Details

TextTester

public TextTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

getText

public String getText()

Gets the text of the component.

Returns:

the text, never null

Throws:

IllegalStateException - if the component is not usable

isUsable

public boolean isUsable()

Description copied from class: ComponentTester

Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override ComponentTester.notUsableReasons(Consumer) to provide additional details to the potential exception thrown by ComponentTester.ensureComponentIsUsable().

Overrides:

isUsable in class ComponentTester<T extends Text>

Returns:

true if component can be interacted with by the user

See Also:

• ComponentTester.notUsableReasons(Consumer)
• ComponentTester.ensureComponentIsUsable()

notUsableReasons

protected void notUsableReasons(Consumer<String> collector)

Description copied from class: ComponentTester

Provides messages explaining why the component is actually not usable. Subclasses overriding ComponentTester.isUsable() should also override this method to provide additional details to the potential exception throw by ComponentTester.ensureComponentIsUsable().

Overrides:

notUsableReasons in class ComponentTester<T extends Text>

See Also:

• ComponentTester.isUsable()
• ComponentTester.ensureComponentIsUsable()