class sap.f.AvatarGroupItem

Control sample: sap.f.AvatarGroupItem
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/f/AvatarGroupItem
Application Component: CA-UI5-CTR

Represents a single avatar item displayed in the sap.f.AvatarGroup control.

Overview

The AvatarGroupItem control allows you to define additional properties that are applied when rendering each AvatarGroupItem instance in the sap.f.AvatarGroup control.


Constructor

Constructor for a new AvatarGroupItem.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.f.AvatarGroupItem(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
fallbackIcon string

Defines the fallback icon displayed in case of wrong image src and no initials set.

Notes:

  • If not set, a default fallback icon is displayed.
  • Accepted values are only icons from the SAP icon font.

Visibility: public
initials string

Defines the displayed initials.

Visibility: public
src sap.ui.core.URI

Determines the path to the desired image or icon.

Visibility: public

Methods Overview

Method Description
sap.f.AvatarGroupItem.extend

Creates a new subclass of class sap.f.AvatarGroupItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

getAvatarColor

Returns the color of the avatar.

getFallbackIcon

Gets current value of property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src and no initials set.

Notes:

  • If not set, a default fallback icon is displayed.
  • Accepted values are only icons from the SAP icon font.

getInitials

Gets current value of property initials.

Defines the displayed initials.

sap.f.AvatarGroupItem.getMetadata

Returns a metadata object for class sap.f.AvatarGroupItem.

getSrc

Gets current value of property src.

Determines the path to the desired image or icon.

setFallbackIcon

Sets a new value for property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src and no initials set.

Notes:

  • If not set, a default fallback icon is displayed.
  • Accepted values are only icons from the SAP icon font.

When called with a value of null or undefined, the default value of the property will be restored.

setInitials

Sets a new value for property initials.

Defines the displayed initials.

When called with a value of null or undefined, the default value of the property will be restored.

setSrc

Sets a new value for property src.

Determines the path to the desired image or icon.

When called with a value of null or undefined, the default value of the property will be restored.

sap.f.AvatarGroupItem.extend

Creates a new subclass of class sap.f.AvatarGroupItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getAvatarColor

Returns the color of the avatar.

getFallbackIcon

Gets current value of property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src and no initials set.

Notes:

getInitials

Gets current value of property initials.

Defines the displayed initials.

sap.f.AvatarGroupItem.getMetadata

Returns a metadata object for class sap.f.AvatarGroupItem.

getSrc

Gets current value of property src.

Determines the path to the desired image or icon.

setFallbackIcon

Sets a new value for property fallbackIcon.

Defines the fallback icon displayed in case of wrong image src and no initials set.

Notes:

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sFallbackIcon string

New value for property fallbackIcon

setInitials

Sets a new value for property initials.

Defines the displayed initials.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sInitials string

New value for property initials

setSrc

Sets a new value for property src.

Determines the path to the desired image or icon.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sSrc sap.ui.core.URI

New value for property src