com.vaadin.collaborationengine.CollaborationMessageInput API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.collaborationengine.

java.lang.Object
- com.vaadin.flow.component.Component
- - com.vaadin.flow.component.Composite<MessageInput>
  - - com.vaadin.collaborationengine.CollaborationMessageInput

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, Serializable
```
public class CollaborationMessageInput
extends Composite<MessageInput>
implements HasSize, HasStyle
```
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:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`CollaborationMessageInput(CollaborationMessageList list)`	Creates a new collaboration message input component which submits messages to the provided `CollaborationMessageList`.

Method Summary

All Methods
Modifier and Type	Method	Description
`MessageInputI18n`	`getI18n()`	Gets the internationalization object previously set for this component.
`void`	`setI18n(MessageInputI18n i18n)`	Sets the internationalization properties for 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, fireEvent, from, get, getEventBus, getId, getLocale, getParent, 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
  - 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 Detail
  - 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