Package com.vaadin.flow.component.avatar

Class AvatarGroup

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, HasThemeVariant<AvatarGroupVariant>, Serializable
    @Tag("vaadin-avatar-group")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.6.2") @NpmPackage(value="@vaadin/avatar-group",version="23.6.2") @NpmPackage(value="@vaadin/vaadin-avatar",version="23.6.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/avatar-group/src/vaadin-avatar-group.js")
public class AvatarGroup
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasSize, HasThemeVariant<AvatarGroupVariant>
    Avatar Group is used to group multiple Avatars together. It can be used, for example, to show that there are multiple users viewing the same page or for listing members of a project.

    You can specify the max number of items an Avatar Group should display. Items that overflow are grouped into a single Avatar that displays the overflow count. The name of each hidden item is shown on hover in a tooltip. Clicking the overflow item displays the overflowing avatars and names in a list.

    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(AvatarGroup.AvatarGroupItem... items)
      Adds the items to the list of displayed as avatars.
      void addThemeVariants​(AvatarGroupVariant... variants)  
      AvatarGroup.AvatarGroupI18n getI18n()
      Gets the internationalization object previously set for this component.
      List<AvatarGroup.AvatarGroupItem> getItems()
      Gets the items that were set for the avatar group in an unmodifiable list.
      Integer getMaxItemsVisible()
      Gets the maximum number of avatars to display, or null if no limit has been set.
      void remove​(AvatarGroup.AvatarGroupItem... items)
      Removes the items from the list of displayed as avatars.
      void removeThemeVariants​(AvatarGroupVariant... variants)  
      void setI18n​(AvatarGroup.AvatarGroupI18n i18n)
      Sets the internationalization properties for this component.
      void setItems​(AvatarGroup.AvatarGroupItem... items)
      Sets the items that will be displayed as avatars.
      void setItems​(Collection<AvatarGroup.AvatarGroupItem> items)
      Sets the items that will be displayed as avatars.
      void setMaxItemsVisible​(Integer max)
      Sets the the maximum number of avatars to display.

      • Methods inherited from class com.vaadin.flow.component.Component

        addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible

      • 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.HasSize

        getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

      • Methods inherited from interface com.vaadin.flow.component.HasStyle

        addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

      • Methods inherited from interface com.vaadin.flow.component.HasTheme

        addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    • Constructor Detail

      • AvatarGroup

        public AvatarGroup()
        Creates an empty avatar group component.

      • AvatarGroup

        public AvatarGroup​(Collection<AvatarGroup.AvatarGroupItem> items)
        Creates an avatar group with the provided items to be displayed as avatars.
        Parameters:
        items - the items to be displayed

      • AvatarGroup

        public AvatarGroup​(AvatarGroup.AvatarGroupItem... items)
        Creates an avatar group with the provided items to be displayed as avatars.
        Parameters:
        items - the items to be displayed

    • Method Detail

      • setItems

        public void setItems​(AvatarGroup.AvatarGroupItem... items)
        Sets the items that will be displayed as avatars.
        Parameters:
        items - the items to set

      • add

        public void add​(AvatarGroup.AvatarGroupItem... items)
        Adds the items to the list of displayed as avatars.
        Parameters:
        items - the items to add

      • remove

        public void remove​(AvatarGroup.AvatarGroupItem... items)
        Removes the items from the list of displayed as avatars.
        Parameters:
        items - the items to remove

      • getItems

        public List<AvatarGroup.AvatarGroupItem> getItems()
        Gets the items that were set for the avatar group in an unmodifiable list.
        Returns:
        list of items

      • getI18n

        public AvatarGroup.AvatarGroupI18n getI18n()
        Gets the internationalization object previously set for this component.

        Note: updating the object content that is gotten from this method will not update the lang on the component if not set back using setI18n(AvatarGroupI18n)

        Returns:
        the i18n object. It will be null, If the i18n properties weren't set.

      • setI18n

        public void setI18n​(AvatarGroup.AvatarGroupI18n i18n)
        Sets the internationalization properties for this component.
        Parameters:
        i18n - the internationalized properties, not null

      • setMaxItemsVisible

        public void setMaxItemsVisible​(Integer max)
        Sets the the maximum number of avatars to display.

        By default, all the avatars are displayed. When max is set, the overflowing avatars are grouped into one avatar.

        Parameters:
        max - the maximum number of avatars, or null to remove the limit

      • getMaxItemsVisible

        public Integer getMaxItemsVisible()
        Gets the maximum number of avatars to display, or null if no limit has been set.
        Returns:
        the max number of avatars
        See Also:
        setMaxItemsVisible(Integer)