Package com.vaadin.collaborationengine

Class CollaborationMessageInput

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.Composite<MessageInput>
com.vaadin.collaborationengine.CollaborationMessageInput
All Implemented Interfaces:
AttachNotifier, BlurNotifier<CollaborationMessageInput>, DetachNotifier, Focusable<CollaborationMessageInput>, FocusNotifier<CollaborationMessageInput>, HasElement, HasEnabled, HasSize, HasStyle, HasTooltip, Serializable
public class CollaborationMessageInput extends Composite<MessageInput> implements Focusable<CollaborationMessageInput>, HasSize, HasStyle, HasEnabled, HasTooltip
Extension of the MessageInput component which integrates with the CollaborationMessageList. The user can type a message and submit it. The messages will be displayed in any CollaborationMessageList that is connected to the same topic as the list passed as the argument of this component constructor. The text area and button will be disabled while the connection to the topic is not active or the topic is set to null (see CollaborationMessageList.setTopic(String)).
Since:
3.1
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • CollaborationMessageInput

      public CollaborationMessageInput(CollaborationMessageList list)
      Creates a new collaboration message input component which submits messages to the provided CollaborationMessageList.
      Parameters:
      list - the list which will display the submitted messages, not null

  • Method Details

    • getI18n

      public MessageInputI18n getI18n()
      Gets the internationalization object previously set for this component.

      Note: updating the object content returned by this method will not update the component if not set back using MessageInput.setI18n(MessageInputI18n).

      Returns:
      the i18n object, or null if one has not been set with setI18n(MessageInputI18n)

    • setI18n

      public void setI18n(MessageInputI18n i18n)
      Sets the internationalization properties for this component. It enabled you to customize and translate the language used in the message input.

      Note: updating the object properties after setting the i18n will not update the component. To make the changes effective, you need to set the updated object again.

      Parameters:
      i18n - the i18n object, not null

    • setTooltipText

      public Tooltip setTooltipText(String text)
      Sets a tooltip text for the component.
      Specified by:
      setTooltipText in interface HasTooltip
      Parameters:
      text - The tooltip text
      Returns:
      the tooltip handle

    • getTooltip

      public Tooltip getTooltip()
      Gets the tooltip handle of the component.
      Specified by:
      getTooltip in interface HasTooltip
      Returns:
      the tooltip handle