Package com.vaadin.flow.component.messages

Class MessageInput

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.messages.MessageInput

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasEnabled, HasSize, HasStyle, HasTooltip, Serializable

@Tag("vaadin-message-input")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.3.25") @NpmPackage(value="@vaadin/message-input",version="23.3.25") @NpmPackage(value="@vaadin/vaadin-messages",version="23.3.25")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/message-input/src/vaadin-message-input.js")
public class MessageInput
extends Component
implements HasSize, HasStyle, HasEnabled, HasTooltip

Message Input allows users to author and send messages. The component displays a text-area to input a message and a button to send it. The user can send the message with one of the following actions:

• by pressing Enter (use Shift + Enter to add a new line)
• by clicking the “send” button.

Use the MessageList component to show messages that users have sent.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageInput.SubmitEvent	The submit event which is fired by MessageInput component.

Constructor Summary

Constructors

Constructor	Description
MessageInput()	Creates a new message input component.
MessageInput(ComponentEventListener<MessageInput.SubmitEvent> listener)	Creates a new message input component with the provided listener that gets invoked when the user submits a new message.

Method Summary

Modifier and Type	Method	Description
Registration	addSubmitListener(ComponentEventListener<MessageInput.SubmitEvent> listener)	Adds a listener that is called when the user submits the value of the input field, which can be obtained with MessageInput.SubmitEvent.getValue().
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.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, 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.HasEnabled

isEnabled, setEnabled

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

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Constructor Detail

MessageInput

public MessageInput()

Creates a new message input component.

MessageInput

public MessageInput(ComponentEventListener<MessageInput.SubmitEvent> listener)

Creates a new message input component with the provided listener that gets invoked when the user submits a new message.

Parameters:

listener - the submit event listener

See Also:

addSubmitListener(ComponentEventListener)

Method Detail

addSubmitListener

public Registration addSubmitListener(ComponentEventListener<MessageInput.SubmitEvent> listener)

Adds a listener that is called when the user submits the value of the input field, which can be obtained with MessageInput.SubmitEvent.getValue().

The event is fired when clicking the Send button or pressing the Enter key.

Parameters:

listener - the listener

Returns:

registration for removal of the listener

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 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