We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.avatar.
Class Avatar
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.avatar.Avatar
-
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, HasTheme, Serializable
@Tag(value="vaadin-avatar") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="22.1.0") @NpmPackage(value="@vaadin/avatar",version="22.1.0") @NpmPackage(value="@vaadin/vaadin-avatar",version="22.1.0") @JsModule(value="@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule(value="@vaadin/avatar/src/vaadin-avatar.js") public class Avatar extends Component implements HasStyle, HasSize, HasThemeServer-side component for the
vaadin-avatarelement.Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classAvatar.AvatarI18nThe internationalization properties for
AvatarGroup.
-
Constructor Summary
Constructors Constructor and 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 Modifier and Type Method and Description voidaddThemeVariants(AvatarVariant... variants)Adds theme variants to the avatar component.
StringgetAbbreviation()Gets the abbreviation that was set for the avatar.
IntegergetColorIndex()Gets the color index for the avatar.
Avatar.AvatarI18ngetI18n()Gets the internationalization object previously set for this component.
StringgetImage()Gets the image url that was set for the avatar.
AbstractStreamResourcegetImageResource()Gets the image that was set for the avatar.
StringgetName()Gets the name that was set for the avatar.
voidremoveThemeVariants(AvatarVariant... variants)Removes theme variants from the avatar component.
voidsetAbbreviation(String abbr)Sets the abbreviation for the avatar.
voidsetColorIndex(Integer colorIndex)Sets the color index for the avatar.
voidsetI18n(Avatar.AvatarI18n i18n)Sets the internationalization properties for this component.
voidsetImage(String url)Sets the image url for the avatar.
voidsetImageResource(AbstractStreamResource resource)Sets the image for the avatar.
voidsetName(String name)Sets the name for the avatar.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
Methods inherited from interface com.vaadin.flow.component.HasSize
getCssSize, 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.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
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 avatarSee Also:
-
-
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, notnull
-
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 AbstractStreamResource getImageResource()Gets the image that was set for the avatar.
Returns:
the image resource value or
nullif the resource has not been set
-
setImage
public void setImage(String url)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 urlSee Also:
-
setImageResource
public void setImageResource(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 ornullto remove the resourceSee Also:
-
getColorIndex
public Integer getColorIndex()Gets the color index for the avatar.
Returns:
the color index or
nullif 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-Nto the border.Parameters:
colorIndex- the color index ornullto remove the index
-
addThemeVariants
public void addThemeVariants(AvatarVariant... variants)Adds theme variants to the avatar component.
Parameters:
variants- theme variants to add
-
removeThemeVariants
public void removeThemeVariants(AvatarVariant... variants)Removes theme variants from the avatar component.
Parameters:
variants- theme variants to remove
-
-