Package 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("vaadin-avatar")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.0.11") @NpmPackage(value="@vaadin/avatar",version="23.0.11") @NpmPackage(value="@vaadin/vaadin-avatar",version="23.0.11")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/avatar/src/vaadin-avatar.js")
public class Avatar
extends Component
implements HasStyle, HasSize, HasTheme

Server-side component for the vaadin-avatar element.

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

Modifier and Type	Method	Description
void	addThemeVariants(AvatarVariant... variants)	Adds theme variants to the avatar component.
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.
AbstractStreamResource	getImageResource()	Gets the image that was set for the avatar.
String	getName()	Gets the name that was set for the avatar.
void	removeThemeVariants(AvatarVariant... variants)	Removes theme variants from the avatar component.
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(AbstractStreamResource resource)	Sets the image for the avatar.
void	setName(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.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)

Avatar

public Avatar(String name,
              String url)

Creates a new avatar with the provided name and url.

Parameters:

name - the name for the avatar

url - the image url

See Also:

setName(String), setImage(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 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

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 url

See Also:

setImageResource(AbstractStreamResource)

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

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