Package com.vaadin.flow.component.avatar

Class AvatarGroupLocator

java.lang.Object

com.vaadin.browserless.locator.Locator<AvatarGroup,AvatarGroupLocator>

com.vaadin.flow.component.avatar.AvatarGroupLocator

All Implemented Interfaces:

Clickable<AvatarGroup>, HasThemeFilter<AvatarGroup,AvatarGroupLocator>

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

Generated locator for AvatarGroup, derived from AvatarGroupTester. 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
AvatarGroupLocator()
AvatarGroupLocator(AvatarGroup component)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
String	getActiveUsersLabel()	Gets the accessible label of the group, that is, the invalid reference one or invalid reference many active users phrase with {count} replaced by the total number of items.
AvatarGroup	getComponent()	Gets the component being tested.
List<AvatarGroup.AvatarGroupItem>	getItems()	Gets all items of the group, whether or not they are shown as individual avatars.
String	getOverflowAbbreviation()	Gets the abbreviation shown on the overflow avatar, such as "+3".
List<AvatarGroup.AvatarGroupItem>	getOverflowItems()	Gets the items that do not fit AvatarGroup.getMaxItemsVisible() and are grouped behind the overflow avatar.
List<AvatarGroup.AvatarGroupItem>	getVisibleItems()	Gets the items that are shown as individual avatars.

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

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, 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

AvatarGroupLocator

public AvatarGroupLocator()

AvatarGroupLocator

public AvatarGroupLocator(AvatarGroup component)

Method Details

getComponent

public AvatarGroup getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<AvatarGroup>

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

getItems

public List<AvatarGroup.AvatarGroupItem> getItems()

Gets all items of the group, whether or not they are shown as individual avatars. Javadoc copied from AvatarGroupTester.getItems().

Returns:

the items of the group

Throws:

IllegalStateException - if the group is not visible to the user

getVisibleItems

public List<AvatarGroup.AvatarGroupItem> getVisibleItems()

Gets the items that are shown as individual avatars. Javadoc copied from AvatarGroupTester.getVisibleItems().

Returns:

the items shown as individual avatars

Throws:

IllegalStateException - if the group is not visible to the user

getOverflowItems

public List<AvatarGroup.AvatarGroupItem> getOverflowItems()

Gets the items that do not fit AvatarGroup.getMaxItemsVisible() and are grouped behind the overflow avatar. Javadoc copied from AvatarGroupTester.getOverflowItems().

Returns:

the overflowing items, empty if nothing overflows

Throws:

IllegalStateException - if the group is not visible to the user

getOverflowAbbreviation

public String getOverflowAbbreviation()

Gets the abbreviation shown on the overflow avatar, such as "+3". Javadoc copied from AvatarGroupTester.getOverflowAbbreviation().

Returns:

the overflow abbreviation, or null if no items overflow and the overflow avatar is not shown

Throws:

IllegalStateException - if the group is not visible to the user

getActiveUsersLabel

public String getActiveUsersLabel()

Gets the accessible label of the group, that is, the

invalid reference

one

or

invalid reference

many

active users phrase with {count} replaced by the total number of items. Javadoc copied from AvatarGroupTester.getActiveUsersLabel().

Returns:

the accessible label, or null if no matching translation has been set on the component

Throws:

IllegalStateException - if the group is not visible to the user