Index (Chat Assistant Add-on 5.2.0-SNAPSHOT API)

A B C D E F G I L M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addComponentRefreshedListener(String, String, Serializable...) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Runs the given JavaScript once per component instance, using a flag on the element to avoid registering duplicate client-side listeners across refreshes.
addFabThemeVariants(FabVariant...) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Adds the given theme variants to the FAB.
addModeChangedListener(ComponentEventListener<ChatAssistant.ModeChangedEvent>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Adds a listener that is notified whenever the component switches between ChatAssistantMode.MOBILE and ChatAssistantMode.DESKTOP mode.
addScreenSizeListener(Integer, Integer, ComponentEventListener<ChatAssistant.ScreenSizeEvent>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Adds a listener that is notified when the chat window's own size crosses the given threshold.

B

BOTTOM_LEFT - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition
BOTTOM_RIGHT - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition

C

ChatAssistant<T extends Message> - Class in com.flowingcode.vaadin.addons.chatassistant: Component that allows to create a floating chat button that will open a chat window that can be used to provide a chat assistant feature.
ChatAssistant() - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Creates a ChatAssistant with no messages, using the defaults for every setting.
ChatAssistant(boolean) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Creates a ChatAssistant with no messages, using the defaults for every other setting.
ChatAssistant(List<T>, boolean) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Creates a ChatAssistant with the given initial messages, using the defaults for every other setting.
ChatAssistant.ChatAssistantBuilder<T extends Message> - Class in com.flowingcode.vaadin.addons.chatassistant: Seeds the builder defaults for the flags whose real default is not false.
ChatAssistant.ModeChangedEvent - Class in com.flowingcode.vaadin.addons.chatassistant: Event fired when the chat assistant switches between mobile and desktop mode.
ChatAssistant.ScreenSizeDirection - Enum Class in com.flowingcode.vaadin.addons.chatassistant: Direction in which the chat window crossed a configured threshold.
ChatAssistant.ScreenSizeEvent - Class in com.flowingcode.vaadin.addons.chatassistant: Event fired when the chat window's size crosses a width and/or height threshold registered through ChatAssistant.addScreenSizeListener(Integer, Integer, ComponentEventListener).
ChatAssistantBuilder() - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ChatAssistantBuilder
ChatAssistantMode - Enum Class in com.flowingcode.vaadin.addons.chatassistant.model: The display mode of the chat assistant: ChatAssistantMode.MOBILE opens the chat window as a full-screen dialog, while ChatAssistantMode.DESKTOP opens it as an anchored popover.
ChatMessage<T extends Message> - Class in com.flowingcode.vaadin.addons.chatassistant: Component that wraps the vaadin-message web component and builds it based on a Message.
ChatMessage(T) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatMessage: Creates a new ChatMessage based on the supplied message without markdown support.
ChatMessage(T, boolean) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatMessage: Creates a new ChatMessage based on the supplied message.
chatWindow - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
clearWhoIsTyping() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Clears the text shown over the message input to indicate that someone is typing.
close() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Closes the chat window.
com.flowingcode.vaadin.addons.chatassistant - package com.flowingcode.vaadin.addons.chatassistant
com.flowingcode.vaadin.addons.chatassistant.model - package com.flowingcode.vaadin.addons.chatassistant.model
container - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant

D

DECREASED - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeDirection: The chat window shrank below the threshold (it is now under it).
DEFAULT_DRAG_SENSITIVITY - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DEFAULT_FAB_ICON_SIZE - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DEFAULT_FAB_MARGIN - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DEFAULT_FAB_SIZE - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DEFAULT_MAX_RESIZER_SIZE - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DEFAULT_RESIZER_SIZE - Static variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
DESKTOP - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.ChatAssistantMode

E

ERROR - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Applies the error (red) color to the FAB.

F

fab - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
fabIcon - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
FabPosition - Enum Class in com.flowingcode.vaadin.addons.chatassistant.model: The corner of the viewport where the floating action button is initially placed.
FabVariant - Enum Class in com.flowingcode.vaadin.addons.chatassistant.model: Theme variants supported by the chat assistant floating action button (FAB).
fabWrapper - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant

G

getAuraClass() - Method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Returns the Aura accent CSS class for this variant, or null if it renders from its Lumo token alone.
getButtonVariant() - Method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Returns the Vaadin button variant that carries this variant's color.
getDirection() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeEvent: Convenience view of ChatAssistant.ScreenSizeEvent.isAboveThreshold() as a direction.
getFabPosition() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the FAB's configured corner.
getFabPositionMemory() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns how long the FAB keeps a dragged position after the user leaves the page.
getFooterComponent() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the current component configured as the footer of the chat window.
getHeaderComponent() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the current component configured as the header of the chat window.
getHeightThreshold() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeEvent: The configured height threshold in pixels, or null if height was not tracked.
getMessage() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatMessage: Returns the underlying message.
getMobileBreakpoint() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the maximum screen width, in pixels, below which mobile mode is activated automatically.
getMode() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the current display mode.
getMode() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ModeChangedEvent: Returns the mode the component switched to.
getUnreadMessages() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the number of unread messages displayed in the chat assistant.
getWhoIsTyping() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns the current text shown over the message input to indicate that someone is typing.
getWidthThreshold() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeEvent: The configured width threshold in pixels, or null if width was not tracked.

I

INCREASED - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeDirection: The chat window grew to or past the threshold (it is now at or above it).
initializeChatWindow() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
initializeContent(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
initializeFooter() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
initializeHeader() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
isAboveThreshold() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeEvent: Returns true when the chat window is now at or above the threshold (it increased past it), false when it is now below (it decreased under it).
isFabAnchoredToViewport() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns true if the FAB is anchored to the viewport, false if positioned within its container.
isFabMovable() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns whether the FAB is currently movable.
isMinimized() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Deprecated.
use ChatAssistant.isOpened() instead
isMobileMode() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns true if the component is currently in ChatAssistantMode.MOBILE mode.
isMobileModeSwitchingEnabled() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns whether automatic switching between mobile and desktop mode is enabled.
isOpened() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns true if the chat window is opened, false otherwise.
isResizeIndicatorsVisible() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns true if the resize direction indicators are visible, false otherwise.
isSizeVariant() - Method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Returns whether this is a size variant (FabVariant.SMALL or FabVariant.LARGE), which resizes the FAB.
isWindowResizable() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Returns whether the chat window is resizable.

L

LARGE - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Renders the FAB at the large predefined diameter.
LUMO_CONTRAST - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Applies the contrast color to the FAB.

M

Message - Class in com.flowingcode.vaadin.addons.chatassistant.model: Class that represents a chat message
Message() - Constructor for class com.flowingcode.vaadin.addons.chatassistant.model.Message
MOBILE - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.ChatAssistantMode
ModeChangedEvent(ChatAssistant<?>, boolean, ChatAssistantMode) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ModeChangedEvent

O

onAttach(AttachEvent) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
onClick() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Toggles the chat window's opened state.
onDetach(DetachEvent) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
onMobileModeChange(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Receives mobile mode changes from the client when the viewport crosses the breakpoint.
onScreenSizeChange(int, boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Receives chat-window size threshold crossings from the client and dispatches to the matching listener.
open() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Opens the chat window.
overlay - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant

P

PRIMARY - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Applies the primary color to the FAB.

R

refreshContent() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
removeFabThemeVariants(FabVariant...) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Removes the given theme variants from the FAB.
resetFabPosition() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Moves the FAB back to its configured corner.

S

ScreenSizeEvent(ChatAssistant<?>, boolean, Integer, Integer, boolean) - Constructor for class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeEvent
scrollToEnd() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Scrolls to the last element of the list.
scrollToIndex(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Scrolls to the given position.
scrollToStart() - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Scrolls to the first element.
sendMessage(T) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sends a message programmatically to the component.
setAvatarProvider(SerializableSupplier<Avatar>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Deprecated, for removal: This API element is subject to removal in a future version.
use ChatAssistant.setFabIcon(Component) instead
setDataProvider(DataProvider<T, ?>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
setFabAnchoredToViewport(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets whether the FAB is anchored to the viewport.
setFabIcon(Component) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the icon for the floating action button.
setFabIcon(Component, int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the icon for the floating action button with a custom size.
setFabMovable(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets whether the FAB is movable.
setFabPosition(FabPosition) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Moves the FAB to the given corner.
setFabPositionMemory(Duration) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Makes the FAB keep the position the user dragged it to across page loads, as long as the user comes back within the given time after leaving the page.
setFooterComponent(Component) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Allows changing the footer of the chat window.
setHeaderComponent(Component) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Allows changing the header of the chat window.
setMessage(T) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatMessage: Updates the component by setting the current underlying message.
setMessagesRenderer(Renderer<T>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Allows changing the renderer used to display messages in the chat window.
setMinimized(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Deprecated.
use ChatAssistant.setOpened(boolean) instead
setMobileMode(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the mobile mode programmatically.
setMobileModeSwitchingEnabled(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Enables or disables automatic switching between mobile and desktop mode based on the configured breakpoint.
setMode(ChatAssistantMode) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the display mode programmatically.
setMode(ChatAssistantMode, boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Applies the given mode, reconciling the active surface and open state, and fires a ChatAssistant.ModeChangedEvent when the mode actually changes.
setOpened(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the opened state of the chat window.
setResizeIndicatorsVisible(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets whether a small arrowhead is shown on each resize handle, pointing in that handle's resize direction, to hint where the chat window can be dragged.
setSubmitListener(ComponentEventListener<MessageInput.SubmitEvent>) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the SubmitListener that will be notified when the user submits a message on the underlying messageInput.
setUnreadBadgeColors(String, String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the background and text color of the unread badge.
setUnreadMessages(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the number of unread messages shown on the FAB badge.
setWhoIsTyping(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Uses the provided string as the text shown over the message input to indicate that someone is typing.
setWindowHeight(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window's initial height.
setWindowHeight(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window's initial height.
setWindowMaxHeight(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window maximum height, the upper bound enforced while resizing.
setWindowMaxHeight(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window maximum height, the upper bound enforced while resizing.
setWindowMaxWidth(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window maximum width, the upper bound enforced while resizing.
setWindowMaxWidth(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window maximum width, the upper bound enforced while resizing.
setWindowMinHeight(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window minimum height, the lower bound enforced while resizing.
setWindowMinHeight(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window minimum height, the lower bound enforced while resizing.
setWindowMinWidth(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window minimum width, the lower bound enforced while resizing.
setWindowMinWidth(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window minimum width, the lower bound enforced while resizing.
setWindowResizable(boolean) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets whether the chat window is resizable.
setWindowWidth(int) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window's initial width.
setWindowWidth(String) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Sets the chat window's initial width.
SMALL - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Renders the FAB at the small predefined diameter.
SUCCESS - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Applies the success (green) color to the FAB.

T

TOP_LEFT - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition
TOP_RIGHT - Enum constant in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition

U

unreadBadge - Variable in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant
updateMessage(T) - Method in class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant: Updates a previously entered message.

V

valueOf(String) - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeDirection: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.ChatAssistantMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.ChatAssistant.ScreenSizeDirection: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.ChatAssistantMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabPosition: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.flowingcode.vaadin.addons.chatassistant.model.FabVariant: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G I L M O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form