Class Avatar
- All Implemented Interfaces:
AttachNotifier
,DetachNotifier
,HasElement
,HasSize
,HasStyle
,HasTheme
,HasThemeVariant<AvatarVariant>
,Serializable
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
The internationalization properties forAvatarGroup
. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the abbreviation that was set for the avatar.Gets the color index for the avatar.getI18n()
Gets the internationalization object previously set for this component.getImage()
Gets the image url that was set for the avatar.Gets the image that was set for the avatar.getName()
Gets the name that was set for the avatar.boolean
Gets the enabled state of the avatar tooltip, which isfalse
by default.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
Sets the image url for the avatar.void
setImageResource
(AbstractStreamResource resource) Sets the image for the avatar.void
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, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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
Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant
addThemeVariants, removeThemeVariants
-
Constructor Details
-
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
Creates a new avatar with the provided name.- Parameters:
name
- the name for the avatar- See Also:
-
Avatar
Creates a new avatar with the provided name and url.- Parameters:
name
- the name for the avatarurl
- the image url- See Also:
-
-
Method Details
-
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
Sets the internationalization properties for this component.- Parameters:
i18n
- the internationalized properties, notnull
-
getName
Gets the name that was set for the avatar.- Returns:
- the name
-
setName
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
Gets the abbreviation that was set for the avatar.- Returns:
- the abbreviation
-
setAbbreviation
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
Gets the image url that was set for the avatar.- Returns:
- the image url
-
getImageResource
Gets the image that was set for the avatar.- Returns:
- the image resource value or
null
if the resource has not been set
-
setImage
Sets the image url for the avatar.The image will be displayed in the avatar even if abbreviation or name is set.
Setting the image with this method resets the image resource provided with
setImageResource(AbstractStreamResource)
- Parameters:
url
- the image url- See Also:
-
setImageResource
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 ornull
to remove the resource- See Also:
-
getColorIndex
Gets the color index for the avatar.- Returns:
- the color index or
null
if the index has not been set
-
setColorIndex
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 ornull
to remove the index
-
isTooltipEnabled
public boolean isTooltipEnabled()Gets the enabled state of the avatar tooltip, which isfalse
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
-