Package com.vaadin.collaborationengine

Class CollaborationMessageList

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, java.io.Serializable
    public class CollaborationMessageList
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.messages.MessageList>
implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle
    Extension of the MessageList component which integrates with the CollaborationEngine. It reads the messages from a topic and renders them within the component. The list is automatically updated when new messages are available. You can use the CollaborationMessageInput component for submitting messages.
    Since:
    3.1
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CollaborationAvatarGroup.ImageProvider getImageProvider()
      Gets the currently used image provider callback.
      CollaborationMessageList.MessageConfigurator getMessageConfigurator()
      Gets the current message configurator, if any.
      void setImageProvider​(CollaborationAvatarGroup.ImageProvider imageProvider)
      Sets an image provider callback for dynamically loading avatar images for a given user.
      void setMessageConfigurator​(CollaborationMessageList.MessageConfigurator messageConfigurator)
      Sets a configurator callback for the messages.
      void setSubmitter​(CollaborationMessageSubmitter submitter)
      Sets a submitter to handle the append of messages to the list.
      void setTopic​(java.lang.String topicId)
      Sets the topic to use with this component.

      • Methods inherited from class com.vaadin.flow.component.Composite

        getChildren, getContent, getElement, initContent

      • Methods inherited from class com.vaadin.flow.component.Component

        addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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

    • Constructor Detail

      • CollaborationMessageList

        public CollaborationMessageList​(UserInfo localUser,
                                java.lang.String topicId)
        Creates a new collaboration message list component with the provided topic id.

        It renders messages received by a CollaborationMessageInput or a custom submitter component connected to this list via setSubmitter(CollaborationMessageSubmitter)

        If a null topic id is provided, the component won't display any messages, until connecting to a non-null topic with setTopic(String).

        Parameters:
        localUser - the information of the end user, not null
        topicId - the id of the topic to connect to, or null to not connect the component to any topic

      • CollaborationMessageList

        public CollaborationMessageList​(UserInfo localUser,
                                java.lang.String topicId,
                                CollaborationMessagePersister persister)
        Creates a new collaboration message list component with the provided topic id and persister of CollaborationMessage items from/to an external source (e.g. a database).

        It renders messages received by a CollaborationMessageInput or a custom submitter component connected to this list via setSubmitter(CollaborationMessageSubmitter)

        If a null topic id is provided, the component won't display any messages, until connecting to a non-null topic with setTopic(String).

        Parameters:
        localUser - the information of the end user, not null
        topicId - the id of the topic to connect to, or null to not connect the component to any topic
        persister - the persister to read/write messages to an external source

    • Method Detail

      • setTopic

        public void setTopic​(java.lang.String topicId)
        Sets the topic to use with this component. The connection to the previous topic (if any) and existing messages are removed. A connection to the new topic is opened and the list of messages in the new topic are populated to this component.

        If the topic id is null, no messages will be displayed.

        Parameters:
        topicId - the topic id to use, or null to not use any topic

      • setSubmitter

        public void setSubmitter​(CollaborationMessageSubmitter submitter)
        Sets a submitter to handle the append of messages to the list. It can be used to connect a custom input component as an alternative to the provided CollaborationMessageInput. If set to null the existing submitter will be disconnected from the list.
        Parameters:
        submitter - the submitter, or null to remove the current submitter

      • setImageProvider

        public void setImageProvider​(CollaborationAvatarGroup.ImageProvider imageProvider)
        Sets an image provider callback for dynamically loading avatar images for a given user. The image can be loaded on-demand from a database or using any other source of IO streams.

        If no image callback is defined, then the image URL defined by UserInfo.getImage() is directly passed to the browser. This means that avatar images need to be available as static files or served dynamically from a custom servlet. This is the default.

        Usage example: 

         collaborationMessageList.setImageProvider(userInfo -> {
     StreamResource streamResource = new StreamResource(
             "avatar_" + userInfo.getId(), () -> {
                 User userEntity = userRepository
                         .findById(userInfo.getId());
                 byte[] profilePicture = userEntity.getProfilePicture();
                 return new ByteArrayInputStream(profilePicture);
             });
     streamResource.setContentType("image/png");
     return streamResource;
 });
        Parameters:
        imageProvider - the image provider to use, or null to use image URLs directly from the user info object

      • setMessageConfigurator

        public void setMessageConfigurator​(CollaborationMessageList.MessageConfigurator messageConfigurator)
        Sets a configurator callback for the messages. It can be used for customizing the properties of the MessageListItem objects after the component has generated them, before sending them to the user's browser.

        Usage example: 

         messageList.setMessageConfigurator((message, user) -> {
     message.setUserName(user.getName().toUpperCase());
 });
        Parameters:
        messageConfigurator - the configurator to set, or null to remove the current configurator