Package com.vaadin.flow.component.avatar

Class Avatar

  • 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<AvatarVariant>, Serializable
    @Tag("vaadin-avatar")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.6.2") @NpmPackage(value="@vaadin/avatar",version="23.6.2") @NpmPackage(value="@vaadin/vaadin-avatar",version="23.6.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/avatar/src/vaadin-avatar.js")
public class Avatar
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasSize, HasThemeVariant<AvatarVariant>
    Avatar is a graphical representation of an object or entity, for example a person or an organisation.

    Avatar has three properties: name, abbreviation and image.

    The name is shown on hover in a tooltip. When a name is set, Avatar will auto-generate and display an abbreviation of the specified name. For example, “Allison Torres” becomes “AT”, “John Smith” becomes “JS”, etc.

    The abbreviation can also be set manually. Abbreviations should be kept to a maximum of 2–3 characters.

    Avatar can be used to display images, such as user profile pictures or company logos. Abbreviations are not shown when images are used.

    Note that this component is optimized for use with Collaboration Engine — a simple way to build real-time collaboration into your app — but can also be used standalone as a regular component.

    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Avatar.AvatarI18n
      The internationalization properties for AvatarGroup.

    • Constructor Summary

      Constructors 
      Constructor Description
      Avatar()
      Creates a new empty avatar.
      Avatar​(String name)
      Creates a new avatar with the provided name.
      Avatar​(String name, String url)
      Creates a new avatar with the provided name and url.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addThemeVariants​(AvatarVariant... variants)  
      String getAbbreviation()
      Gets the abbreviation that was set for the avatar.
      Integer getColorIndex()
      Gets the color index for the avatar.
      Avatar.AvatarI18n getI18n()
      Gets the internationalization object previously set for this component.
      String getImage()
      Gets the image url that was set for the avatar.
      com.vaadin.flow.server.AbstractStreamResource getImageResource()
      Gets the image that was set for the avatar.
      String getName()
      Gets the name that was set for the avatar.
      boolean isTooltipEnabled()
      Gets the enabled state of the avatar tooltip, which is false by default.
      void removeThemeVariants​(AvatarVariant... variants)  
      void setAbbreviation​(String abbr)
      Sets the abbreviation for the avatar.
      void setColorIndex​(Integer colorIndex)
      Sets the color index for the avatar.
      void setI18n​(Avatar.AvatarI18n i18n)
      Sets the internationalization properties for this component.
      void setImage​(String url)
      Sets the image url for the avatar.
      void setImageResource​(com.vaadin.flow.server.AbstractStreamResource resource)
      Sets the image for the avatar.
      void setName​(String name)
      Sets the name for the avatar.
      void setTooltipEnabled​(boolean tooltipEnabled)
      Sets the enabled of the avatar tooltip.

      • 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

      • Avatar

        public Avatar()
        Creates a new empty avatar.

        The avatar displays the user icon in the avatar and "Anonymous" in the tooltip unless overridden by setting other properties.

      • Avatar

        public Avatar​(String name)
        Creates a new avatar with the provided name.
        Parameters:
        name - the name for the avatar
        See Also:
        setName(String)

    • Method Detail

      • getI18n

        public Avatar.AvatarI18n 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(AvatarI18n)

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

      • setI18n

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

      • getName

        public String getName()
        Gets the name that was set for the avatar.
        Returns:
        the name

      • setName

        public void setName​(String name)
        Sets the name for the avatar.

        The name is displayed in a tooltip on hover.

        Automatically deduced abbreviation is displayed in the avatar if no abbreviation or image is set.

        Parameters:
        name - the name for the avatar

      • getAbbreviation

        public String getAbbreviation()
        Gets the abbreviation that was set for the avatar.
        Returns:
        the abbreviation

      • setAbbreviation

        public void setAbbreviation​(String abbr)
        Sets the abbreviation for the avatar.

        The abbreviation will be displayed in the avatar if no image has been set.

        Parameters:
        abbr - the abbreviation

      • getImage

        public String getImage()
        Gets the image url that was set for the avatar.
        Returns:
        the image url

      • getImageResource

        public com.vaadin.flow.server.AbstractStreamResource getImageResource()
        Gets the image that was set for the avatar.
        Returns:
        the image resource value or null if the resource has not been set

      • setImageResource

        public void setImageResource​(com.vaadin.flow.server.AbstractStreamResource resource)
        Sets the image for the avatar.

        Setting the image as a resource with this method resets the image URL that was set with setImage(String)

        Parameters:
        resource - the resource value or null to remove the resource
        See Also:
        setImage(String)

      • getColorIndex

        public Integer getColorIndex()
        Gets the color index for the avatar.
        Returns:
        the color index or null if the index has not been set

      • setColorIndex

        public void setColorIndex​(Integer colorIndex)
        Sets the color index for the avatar.

        The color index defines which color will be used for the border of the avatar. Color index N applies CSS variable --vaadin-user-color-N to the border.

        Parameters:
        colorIndex - the color index or null to remove the index

      • isTooltipEnabled

        public boolean isTooltipEnabled()
        Gets the enabled state of the avatar tooltip, which is false by default.
        Returns:
        true if the tooltip is shown on hover or focus, false otherwise

      • setTooltipEnabled

        public void setTooltipEnabled​(boolean tooltipEnabled)
        Sets the enabled of the avatar tooltip.
        Parameters:
        tooltipEnabled - true to show the tooltip on hover or focus, false to not show it