Index (Vaadin Flow Components Base 24.4.6 API)

A B C D E F G H I O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

add(String) - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy
addClientValidatedEventListener(ComponentEventListener<HasClientValidation.ClientValidatedEvent>) - Method in interface com.vaadin.flow.component.shared.HasClientValidation: Adds a listener for the validated event fired by the web component whenever it is validated on the client-side.
addThemeVariants(TVariantEnum...) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Adds theme variants to the component.
addToSlot(HasElement, String, Component...) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Adds components to the specified slot in the parent component.
addToSlot(HasElement, String, Element...) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Adds elements to the specified slot in the parent component.

B

BOTTOM - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
BOTTOM_END - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
BOTTOM_START - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition

C

checkGreaterThanMax(V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value being set to the component is greater than the max value defined
checkRequired(boolean, V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks the required validation constraint
checkSmallerThanMin(V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value being set to the component is smaller than the max value defined
clearSlot(HasElement, String) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Removes every child element of the parent that are in the specified slot.
ClientValidatedEvent(Component, boolean) - Constructor for class com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent: Creates a new event using the given source.
ClientValidatedEvent(Component, boolean, boolean) - Constructor for class com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent: Creates a new event using the given source.
ClientValidationUtil - Class in com.vaadin.flow.component.shared: A utility class that allows preventing the web component from setting itself to valid as a result of client-side validation.
com.vaadin.flow.component.shared - package com.vaadin.flow.component.shared
com.vaadin.flow.component.shared.internal - package com.vaadin.flow.component.shared.internal

D

DISCARD - Enum constant in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Selection preservation mode that clears selection when DataProvider.refreshAll() is called.

E

END - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
END_BOTTOM - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
END_TOP - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition

F

forComponent(Component) - Static method in class com.vaadin.flow.component.shared.Tooltip: Creates a tooltip to the given Component if one hasn't already been created.

G

getAllowedCharPattern() - Method in interface com.vaadin.flow.component.shared.HasAllowedCharPattern: A regular expression that is used on the client-side to determine which characters the user is allowed to type into the field.
getChildInSlot(HasElement, String) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Gets the first child component of the parent that is in the specified slot.
getElementsInSlot(HasElement, String) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Gets all the child elements of the parent that are in the specified slot.
getErrorMessage() - Method in interface com.vaadin.flow.component.shared.HasValidationProperties: Gets the error message to show to the when the component is invalid.
getFocusDelay() - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on keyboard focus, when not in manual mode.
getHideDelay() - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is closed on losing hover, when not in manual mode.
getHoverDelay() - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on hover, when not in manual mode.
getOverlayClassName() - Method in interface com.vaadin.flow.component.shared.HasOverlayClassName: A space-delimited list of CSS class names to set on the overlay element.
getPosition() - Method in class com.vaadin.flow.component.shared.Tooltip: Position of the tooltip with respect to its target.
getPosition() - Method in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
getPrefixComponent() - Method in interface com.vaadin.flow.component.shared.HasPrefix: Gets the component in the prefix slot of this field.
getSelectionPreservationMode() - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Gets the selection preservation mode.
getSuffixComponent() - Method in interface com.vaadin.flow.component.shared.HasSuffix: Gets the component in the suffix slot of this field.
getText() - Method in class com.vaadin.flow.component.shared.Tooltip: String used as a tooltip content.
getTooltip() - Method in interface com.vaadin.flow.component.shared.HasTooltip: Gets the tooltip handle of the component.
getVariantName() - Method in interface com.vaadin.flow.component.shared.ThemeVariant

H

handleDataChange(DataChangeEvent<T>) - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Handles data change based on the current selection preservation mode.
HasAllowedCharPattern - Interface in com.vaadin.flow.component.shared: Mixin interface for field components that support setting allowed char pattern to prevent user from entering invalid characters when typing or pasting text.
HasAutoOpen - Interface in com.vaadin.flow.component.shared: Mixin interface for field components that support setting auto open to control whether the overlay should open on input click or not.
HasClearButton - Interface in com.vaadin.flow.component.shared: Mixin interface for components that support a clear button.
HasClientValidation - Interface in com.vaadin.flow.component.shared: Mixin interface for subscribing to the client-side `validated` event from a component.
HasClientValidation.ClientValidatedEvent - Class in com.vaadin.flow.component.shared: An event fired by the web component whenever it is validated on the client-side.
HasOverlayClassName - Interface in com.vaadin.flow.component.shared: Mixin interface for components that have an internal overlay and support setting CSS class names on it for styling.
HasPrefix - Interface in com.vaadin.flow.component.shared: Mixin interface for components that have a prefix slot.
HasSuffix - Interface in com.vaadin.flow.component.shared: Mixin interface for components that have a suffix slot.
HasThemeVariant<TVariantEnum extends ThemeVariant> - Interface in com.vaadin.flow.component.shared: Mixin interface that allows adding and removing typed theme variants to / from a component
HasTooltip - Interface in com.vaadin.flow.component.shared: Mixin interface for components that have special handling for tooltips on the Web Component level.
HasValidationProperties - Interface in com.vaadin.flow.component.shared: Mixin interface for components that provide properties for setting invalid state and error message string to show when invalid.

I

InputField<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<V>,V> - Interface in com.vaadin.flow.component.shared: A common interface for input fields that can be used to iterate over a collection of fields and set common properties.
isAutoOpen() - Method in interface com.vaadin.flow.component.shared.HasAutoOpen: Gets whether dropdown will open automatically or not.
isClearButtonVisible() - Method in interface com.vaadin.flow.component.shared.HasClearButton: Gets the visibility of the button which clears the field, which is false by default.
isInvalid() - Method in interface com.vaadin.flow.component.shared.HasValidationProperties: Gets whether the component is currently in invalid state.
isManual() - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is controlled programmatically instead of reacting to focus and mouse events.
isOpened() - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is opened programmatically.
isValid() - Method in class com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent: Returns true if the client-side validation succeeded and false otherwise.
iterator() - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy

O

onDiscard(DataChangeEvent<T>) - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Clears selection when DataProvider.refreshAll() is called.
onPreserveAll(DataChangeEvent<T>) - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Preserves all selected items when DataProvider.refreshAll() is called.
onPreserveExisting(DataChangeEvent<T>) - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Preserves the selected items that still exist after DataProvider.refreshAll() is called.
OverlayClassListProxy - Class in com.vaadin.flow.component.shared.internal: Internal class that provides shared functionality for setting CSS class names to overlay only components that support HasStyle, such as Dialog.
OverlayClassListProxy(HasStyle) - Constructor for class com.vaadin.flow.component.shared.internal.OverlayClassListProxy

P

PRESERVE_ALL - Enum constant in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Selection preservation mode that preserves all selected items when DataProvider.refreshAll() is called.
PRESERVE_EXISTING - Enum constant in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Selection preservation mode that only preserves the selected items that still exist after DataProvider.refreshAll() is called.
preventWebComponentFromModifyingInvalidState(C) - Static method in class com.vaadin.flow.component.shared.ClientValidationUtil

R

removeThemeVariants(TVariantEnum...) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Removes theme variants from the component.

S

SelectionPreservationHandler<T> - Class in com.vaadin.flow.component.shared: Abstract class that handles selection when DataProvider.refreshAll() is called.
SelectionPreservationHandler(SelectionPreservationMode) - Constructor for class com.vaadin.flow.component.shared.SelectionPreservationHandler: Constructor taking in the initial selection preservation mode.
SelectionPreservationMode - Enum Class in com.vaadin.flow.component.shared: Represents selection preservation mode.
setAllowedCharPattern(String) - Method in interface com.vaadin.flow.component.shared.HasAllowedCharPattern: Sets a regular expression that is used on the client-side to determine which characters the user is allowed to type into the field.
setAutoOpen(boolean) - Method in interface com.vaadin.flow.component.shared.HasAutoOpen: Enables or disables the dropdown opening automatically.
setClearButtonVisible(boolean) - Method in interface com.vaadin.flow.component.shared.HasClearButton: Sets the visibility of the button which clears the field.
setDefaultFocusDelay(int) - Static method in class com.vaadin.flow.component.shared.TooltipConfiguration: Sets the default focus delay to be used by all tooltip instances (running in the same JVM), except for those that have focus delay configured using property.
setDefaultHideDelay(int) - Static method in class com.vaadin.flow.component.shared.TooltipConfiguration: Sets the default hide delay to be used by all tooltip instances (running in the same JVM), except for those that have hide delay configured using property.
setDefaultHoverDelay(int) - Static method in class com.vaadin.flow.component.shared.TooltipConfiguration: Sets the default hover delay to be used by all tooltip instances (running in the same JVM), except for those that have hover delay configured using property.
setErrorMessage(String) - Method in interface com.vaadin.flow.component.shared.HasValidationProperties: Sets the error message to show to the user when the component is invalid.
setFocusDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on keyboard focus, when not in manual mode.
setHideDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is closed on losing hover, when not in manual mode.
setHoverDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on hover, when not in manual mode.
setInvalid(boolean) - Method in interface com.vaadin.flow.component.shared.HasValidationProperties: Sets the invalid state of the component.
setManual(boolean) - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is controlled programmatically instead of reacting to focus and mouse events.
setOpened(boolean) - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is opened programmatically.
setOverlayClassName(String) - Method in interface com.vaadin.flow.component.shared.HasOverlayClassName: Sets a space-delimited list of CSS class names to set on the overlay element.
setPosition(Tooltip.TooltipPosition) - Method in class com.vaadin.flow.component.shared.Tooltip: Position of the tooltip with respect to its target.
setPrefixComponent(Component) - Method in interface com.vaadin.flow.component.shared.HasPrefix: Adds the given component into this field before the content, replacing any existing prefix component.
setSelectionPreservationMode(SelectionPreservationMode) - Method in class com.vaadin.flow.component.shared.SelectionPreservationHandler: Sets the selection preservation mode.
setSlot(HasElement, String, Component...) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Clears the specific slot in the parent component and adds components to it.
setSlot(HasElement, String, Element...) - Static method in class com.vaadin.flow.component.shared.SlotUtils: Clears the specific slot in the parent component and adds elements to it.
setSuffixComponent(Component) - Method in interface com.vaadin.flow.component.shared.HasSuffix: Adds the given component into this field after the content, replacing any existing suffix component.
setText(String) - Method in class com.vaadin.flow.component.shared.Tooltip: String used as a tooltip content.
setTooltipText(String) - Method in interface com.vaadin.flow.component.shared.HasTooltip: Sets a tooltip text for the component.
size() - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy
SlotUtils - Class in com.vaadin.flow.component.shared: Util methods for handling child elements inside slots.
SlotUtils() - Constructor for class com.vaadin.flow.component.shared.SlotUtils
START - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
START_BOTTOM - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
START_TOP - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition

T

ThemeVariant - Interface in com.vaadin.flow.component.shared: Base definition for a typed theme variant enum of a component
Tooltip - Class in com.vaadin.flow.component.shared: A handle that can be used to configure and control tooltips.
Tooltip.TooltipPosition - Enum Class in com.vaadin.flow.component.shared: Tooltip position in relation to the target element.
TooltipConfiguration - Class in com.vaadin.flow.component.shared: A configuration class for a tooltips default behavior.
TooltipConfiguration() - Constructor for class com.vaadin.flow.component.shared.TooltipConfiguration
TOP - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
TOP_END - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition
TOP_START - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition

V

ValidationUtil - Class in com.vaadin.flow.component.shared: Util methods for component validation
valueOf(String) - Static method in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition: Returns an array containing the constants of this enum class, in the order they are declared.

W

withFocusDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on keyboard focus, when not in manual mode.
withHideDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is closed on losing hover, when not in manual mode.
withHoverDelay(int) - Method in class com.vaadin.flow.component.shared.Tooltip: The delay in milliseconds before the tooltip is opened on hover, when not in manual mode.
withManual(boolean) - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is controlled programmatically instead of reacting to focus and mouse events.
withPosition(Tooltip.TooltipPosition) - Method in class com.vaadin.flow.component.shared.Tooltip: Position of the tooltip with respect to its target.
withText(String) - Method in class com.vaadin.flow.component.shared.Tooltip: String used as a tooltip content.

A B C D E F G H I O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form