Package com.vaadin.collaborationengine
Class SystemUserInfo
- java.lang.Object
-
- com.vaadin.collaborationengine.UserInfo
-
- com.vaadin.collaborationengine.SystemUserInfo
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SystemUserInfo
getInstance()
Gets the unique instance of system user info.void
setAbbreviation(String abbreviation)
Sets the user's abbreviation.void
setColorIndex(int colorIndex)
Sets the user's color index.void
setImage(String imageUrl)
Sets the url of the user's image.void
setName(String name)
Sets the user's name.-
Methods inherited from class com.vaadin.collaborationengine.UserInfo
equals, getAbbreviation, getColorIndex, getId, getImage, getName, hashCode
-
-
-
-
Method Detail
-
getInstance
public static SystemUserInfo getInstance()
Gets the unique instance of system user info.- Returns:
- the system user info instance, not
null
- Since:
- 1.0
-
setName
public void setName(String name)
Description copied from class:UserInfo
Sets the user's name.
-
setAbbreviation
public void setAbbreviation(String abbreviation)
Description copied from class:UserInfo
Sets the user's abbreviation.- Overrides:
setAbbreviation
in classUserInfo
- Parameters:
abbreviation
- the abbreviation to set
-
setImage
public void setImage(String imageUrl)
Description copied from class:UserInfo
Sets the url of the user's image.If this user info is given to a
CollaborationAvatarGroup
, the image URL is used to load the user's avatar. Alternatively, the user images can be loaded from a backend to the avatar group withCollaborationAvatarGroup.setImageProvider(ImageProvider)
.
-
setColorIndex
public void setColorIndex(int colorIndex)
Description copied from class:UserInfo
Sets the user's color index.Setting it to -1 (which is the default value) indicates that the user color can be automatically assigned by Collaboration Engine.
- Overrides:
setColorIndex
in classUserInfo
- Parameters:
colorIndex
- the color index to set- See Also:
UserInfo.getColorIndex()
-
-