Index (Vaadin Flow Components Base 25.2-SNAPSHOT API)

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

A

add() - Method in class com.vaadin.flow.component.shared.internal.OverlayAutoAddController: Adds the component to the UI if it is not already attached, regardless of the current opened state of the component.
add(String) - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy
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.
ARIA_DESCRIBED_BY - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.AriaLinkMode: Links the tooltip as a description of the target using aria-describedby.
ARIA_LABELLED_BY - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.AriaLinkMode: Links the tooltip as the accessible name of the target using aria-labelledby.

B

bind(String, Signal<Boolean>) - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy
bindClearButtonVisible(Signal<Boolean>) - Method in interface com.vaadin.flow.component.shared.HasClearButton: Binds a given signal to the visibility of the clear button.
bindThemeVariant(TVariantEnum, Signal<Boolean>) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Binds the presence of the given theme variant to a Signal.
bindThemeVariants(Signal<List<TVariantEnum>>) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Binds the theme variants of this component to a Signal so that the theme list is dynamically updated to match the signal's value.
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: Deprecated.
since 24.5, use ValidationUtil.validateMaxConstraint(String, Comparable, Comparable) instead.
checkRequired(boolean, V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Deprecated.
since 24.5, use ValidationUtil.validateRequiredConstraint(String, boolean, Object, Object) instead.
checkSmallerThanMin(V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Deprecated.
since 24.5, use ValidationUtil.validateMinConstraint(String, Comparable, Comparable) instead.
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.
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

DisableOnClickController<C> - Class in com.vaadin.flow.component.shared.internal: An internal controller for handling disabling a component when it is clicked.
DisableOnClickController(C) - Constructor for class com.vaadin.flow.component.shared.internal.DisableOnClickController: Creates a new controller for the given component.
DISCARD - Enum constant in enum class com.vaadin.flow.component.shared.SelectionPreservationMode: Selection preservation mode that clears selection when DataProvider.refreshAll() is called.

E

effectBinding(Component, String, Signal<T>, SerializableConsumer<T>) - Static method in class com.vaadin.flow.component.shared.internal.SignalBindingUtil: Creates a signal effect with Signal.effect(com.vaadin.flow.component.Component, com.vaadin.flow.signals.function.EffectAction) and returns a SignalBinding that is notified with the updated signal value when the effect runs.
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.
fromPosition(String) - Static method in enum class com.vaadin.flow.component.shared.Tooltip.TooltipPosition: Gets the Tooltip.TooltipPosition for the given position string.
fromValue(String) - Static method in enum class com.vaadin.flow.component.shared.Tooltip.AriaLinkMode: Gets the Tooltip.AriaLinkMode for the given value string.

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.
getAriaLinkMode() - Method in class com.vaadin.flow.component.shared.Tooltip: Controls which ARIA attribute links the target element(s) with the tooltip content.
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 displayed for all constraint violations if it has been set with HasValidationProperties.setErrorMessage(String).
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.
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.
getValue() - Method in enum class com.vaadin.flow.component.shared.Tooltip.AriaLinkMode
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.
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> - 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,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.
isDisableOnClick() - Method in class com.vaadin.flow.component.shared.internal.DisableOnClickController: Gets whether the component is set to be disabled when clicked.
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.
iterator() - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy

M

mapBinding(Signal<T>, SerializableFunction<T, U>, SerializableFunction<Signal<U>, SignalBinding<U>>) - Static method in class com.vaadin.flow.component.shared.internal.SignalBindingUtil: Maps a signal binding from one type to another.
ModalRoot - Annotation Interface in com.vaadin.flow.component.shared.internal: The purpose of this annotation is to help Popover decide where to auto-attach itself based on the target component.

N

NONE - Enum constant in enum class com.vaadin.flow.component.shared.Tooltip.AriaLinkMode: Does not add any ARIA linking attribute to the target.

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.
onSetEnabled() - Method in class com.vaadin.flow.component.shared.internal.DisableOnClickController: Forces the client-side component's disabled property to be updated before the response is sent to the client, so that it matches the component's effective enabled state, including whether any parent is disabled.
OverlayAutoAddController<C> - Class in com.vaadin.flow.component.shared.internal: An internal controller for automatically adding a component to the UI when it's opened.
OverlayAutoAddController(C) - Constructor for class com.vaadin.flow.component.shared.internal.OverlayAutoAddController
OverlayAutoAddController(C, SerializableSupplier<ModalityMode>) - Constructor for class com.vaadin.flow.component.shared.internal.OverlayAutoAddController
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.

R

remove() - Method in class com.vaadin.flow.component.shared.internal.OverlayAutoAddController: Force remove the component from the UI in case it was auto-added.
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.
setAriaLinkMode(Tooltip.AriaLinkMode) - Method in class com.vaadin.flow.component.shared.Tooltip: Controls which ARIA attribute links the target element(s) with the tooltip content.
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.
setDisableOnClick(boolean) - Method in class com.vaadin.flow.component.shared.internal.DisableOnClickController: Sets whether the component should be disabled when clicked.
setErrorMessage(String) - Method in interface com.vaadin.flow.component.shared.HasValidationProperties: Sets a single error message to display for all constraint violations.
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.
setManualValidation(boolean) - Method in class com.vaadin.flow.component.shared.internal.ValidationController: Sets whether manual validation mode is enabled.
setMarkdown(String) - Method in class com.vaadin.flow.component.shared.Tooltip: Sets the tooltip content in Markdown format.
setOpened(boolean) - Method in class com.vaadin.flow.component.shared.Tooltip: When true, the tooltip is opened programmatically.
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.
setSkipOnNavigation(boolean) - Method in class com.vaadin.flow.component.shared.internal.OverlayAutoAddController: Sets whether to skip auto-adding when the UI navigates to a new view before the component is opened.
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: Sets the tooltip content as plain text.
setThemeVariant(TVariantEnum, boolean) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Adds or removes the given theme variant for this component.
setThemeVariants(boolean, TVariantEnum...) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Adds or removes the given theme variants for this component.
setThemeVariants(TVariantEnum...) - Method in interface com.vaadin.flow.component.shared.HasThemeVariant: Sets the theme variants of this component.
setTooltipMarkdown(String) - Method in interface com.vaadin.flow.component.shared.HasTooltip: Sets a tooltip text for the component in Markdown format.
setTooltipText(String) - Method in interface com.vaadin.flow.component.shared.HasTooltip: Sets a tooltip text for the component as plain text.
SignalBindingUtil - Class in com.vaadin.flow.component.shared.internal: Internal utility for working with signal bindings in components.
size() - Method in class com.vaadin.flow.component.shared.internal.OverlayClassListProxy
slot() - Element in annotation interface com.vaadin.flow.component.shared.internal.ModalRoot: The slot to use when attaching to the modal root.
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
throwIfBindingActive(Component, String) - Static method in class com.vaadin.flow.component.shared.internal.SignalBindingUtil: Throws a BindingActiveException if a binding of the specified type is active on the component.
Tooltip - Class in com.vaadin.flow.component.shared: A handle that can be used to configure and control tooltips.
Tooltip.AriaLinkMode - Enum Class in com.vaadin.flow.component.shared: Controls which ARIA attribute links the target element(s) with the tooltip content.
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

validate(V) - Method in class com.vaadin.flow.component.shared.internal.ValidationController: Validates the given value using the component's validator and sets the invalid and errorMessage properties based on the result.
validateMaxConstraint(String, V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satisfies the maximum value constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
validateMaxLengthConstraint(String, String, Integer) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satisfies the maximum length constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
validateMinConstraint(String, V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satisfies the minimum value constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
validateMinLengthConstraint(String, String, Integer) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satisfies the minimum length constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
validatePatternConstraint(String, String, String) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satisfies the pattern constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
validateRequiredConstraint(String, boolean, V, V) - Static method in class com.vaadin.flow.component.shared.ValidationUtil: Checks if the value satistifies the required constraint and returns a ValidationResult.ok() or ValidationResult.error() with the given error message depending on the result.
ValidationController<C,V> - Class in com.vaadin.flow.component.shared.internal: An internal controller for managing the validation state of a component.
ValidationController(C) - Constructor for class com.vaadin.flow.component.shared.internal.ValidationController
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.AriaLinkMode: 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.AriaLinkMode: 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

withAriaLinkMode(Tooltip.AriaLinkMode) - Method in class com.vaadin.flow.component.shared.Tooltip: Controls which ARIA attribute links the target element(s) with the tooltip content.
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.
withMarkdown(String) - Method in class com.vaadin.flow.component.shared.Tooltip: String used as a tooltip content in Markdown format.
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 M N O P R S T V W
All Classes and Interfaces|All Packages|Serialized Form