Uses of Interface
com.vaadin.flow.signals.Signal

Packages that use Signal

Package	Description
com.vaadin.flow.component
com.vaadin.flow.component.geolocation
com.vaadin.flow.component.internal
com.vaadin.flow.component.page
com.vaadin.flow.dom
com.vaadin.flow.dom.impl
com.vaadin.flow.internal.nodefeature
com.vaadin.flow.signals
com.vaadin.flow.signals.impl
com.vaadin.flow.signals.local
com.vaadin.flow.signals.operations
com.vaadin.flow.signals.shared

Uses of Signal in com.vaadin.flow.component

Methods in com.vaadin.flow.component with type parameters of type Signal

Modifier and Type	Method	Description
default <T, S extends Signal<T>> void	HasComponents.bindChildren(Signal<List<S>> list, SerializableFunction<S,Component> childFactory)	Binds a list Signal to this component using a child component factory.

Methods in com.vaadin.flow.component that return Signal

Modifier and Type	Method	Description
Signal<Component.Size>	Component.sizeSignal()	Returns a signal that tracks the current size of this component as observed by the browser's ResizeObserver API.

Methods in com.vaadin.flow.component with parameters of type Signal

Modifier and Type	Method	Description
void	SignalPropertySupport.bind(Signal<T> signal)	Binds a Signal's value to this property support and keeps the value synchronized with the signal value while the component is in attached state.
default <T, S extends Signal<T>> void	HasComponents.bindChildren(Signal<List<S>> list, SerializableFunction<S,Component> childFactory)	Binds a list Signal to this component using a child component factory.
default void	HasEnabled.bindEnabled(Signal<Boolean> enabledSignal)	Binds a Signal's value to the enabled state of this component and keeps the state synchronized with the signal value while the element is in attached state.
default void	HasValidation.bindErrorMessage(Signal<String> signal)	Binds the component's error message to the provided signal so that the error message is kept in sync with the signal's current value.
default void	HasSize.bindHeight(Signal<String> heightSignal)	Binds a Signal's value to the height of this component and keeps the height synchronized with the signal value while the component is in attached state.
default void	HasHelper.bindHelperText(Signal<String> helperTextSignal)	Binds a signal's value to the component's helper text so that the helper text is updated when the signal's value is updated.
void	Html.bindHtmlContent(Signal<String> htmlSignal)	Binds a Signal's value to this component's HTML content (outer HTML) and keeps the content synchronized with the signal value while the component is attached.
default void	HasValidation.bindInvalid(Signal<Boolean> signal)	Binds the component's invalid state to the provided signal so that the invalid flag is kept in sync with the signal's current value.
default void	HasPlaceholder.bindPlaceholder(Signal<String> placeholderSignal)	Binds a signal's value to the component's placeholder so that the placeholder is updated when the signal's value is updated.
default void	HasValue.bindReadOnly(Signal<Boolean> readOnlySignal)	Binds a Signal's value to the read-only state of this component and keeps the state synchronized with the signal value while the component is in attached state.
default void	HasValueAndElement.bindReadOnly(Signal<Boolean> readOnlySignal)
default void	HasValue.bindRequiredIndicatorVisible(Signal<Boolean> requiredSignal)	Binds a Signal's value to the required indicator visible state of this component and keeps the state synchronized with the signal value while the component is in attached state.
default void	HasValueAndElement.bindRequiredIndicatorVisible(Signal<Boolean> requiredSignal)
default void	HasText.bindText(Signal<String> textSignal)	Binds a Signal's value to the text content of this component and keeps the text content synchronized with the signal value while the element is in attached state.
default void	HasTheme.bindThemeName(String name, Signal<Boolean> signal)	Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.
void	AbstractCompositeField.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)
void	AbstractField.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)
default void	HasValue.bindValue(Signal<V> valueSignal, SerializableConsumer<V> writeCallback)	Binds a Signal's value to the value state of this component and keeps the state synchronized with the signal value while the element is in attached state.
void	Component.bindVisible(Signal<Boolean> visibleSignal)	Binds a Signal's value to the visible property of this component and keeps property synchronized with the signal value while the component is in attached state.
default void	HasSize.bindWidth(Signal<String> widthSignal)	Binds a Signal's value to the width of this component and keeps the width synchronized with the signal value while the component is in attached state.

Constructors in com.vaadin.flow.component with parameters of type Signal

Modifier	Constructor	Description
	Html(Signal<String> htmlSignal)	Creates an instance based on the given HTML fragment signal.

Uses of Signal in com.vaadin.flow.component.geolocation

Methods in com.vaadin.flow.component.geolocation that return Signal

Modifier and Type	Method	Description
Signal<GeolocationState>	Geolocation.state()	Returns a signal holding the current tracking state.

Uses of Signal in com.vaadin.flow.component.internal

Methods in com.vaadin.flow.component.internal with parameters of type Signal

Modifier and Type	Method	Description
void	AbstractFieldSupport.bindValue(Signal<T> valueSignal, SerializableConsumer<T> writeCallback)	Binds a Signal's value to the value state of the field and keeps the state synchronized with the signal value while the element is in attached state.

Uses of Signal in com.vaadin.flow.component.page

Methods in com.vaadin.flow.component.page that return Signal

Modifier and Type	Method	Description
Signal<PageVisibility>	Page.pageVisibilitySignal()	Returns a signal that tracks the current page visibility state.
Signal<ScreenOrientationData>	Page.screenOrientationSignal()	Returns a signal that tracks the current screen orientation.
Signal<WindowSize>	Page.windowSizeSignal()	Returns a signal that tracks the current browser window size.

Uses of Signal in com.vaadin.flow.dom

Methods in com.vaadin.flow.dom with type parameters of type Signal

Modifier and Type	Method	Description
static <T, S extends Signal<T>> Registration	ElementEffect.bindChildren(Element parentElement, Signal<List<S>> list, SerializableFunction<S,Element> childFactory)	Binds a list signal containing child signals to a parent component using a child component factory.

Methods in com.vaadin.flow.dom with parameters of type Signal

Modifier and Type	Method	Description
default void	ClassList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given class name to the provided signal so that the class is added when the signal value is true and removed when the value is false.
static <T> Registration	ElementEffect.bind(Element owner, Signal<T> signal, SerializableBiConsumer<Element,T> setter)	Binds a signal's value to a given owner element in a way defined in setter function and creates a Signal effect function executing the setter whenever the signal value changes.
default Style	Style.bind(String name, Signal<String> signal)	Binds the given style property to the provided string signal and keeps the style property value synchronized with the signal.
default void	ThemeList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.
void	Element.bindAttribute(String attribute, Signal<String> signal)	Binds a Signal's value to a given attribute and keeps the attribute value synchronized with the signal value while the element is in attached state.
void	ElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)	Binds the given signal to the given attribute.
static <T, S extends Signal<T>> Registration	ElementEffect.bindChildren(Element parentElement, Signal<List<S>> list, SerializableFunction<S,Element> childFactory)	Binds a list signal containing child signals to a parent component using a child component factory.
void	Element.bindEnabled(Signal<Boolean> enabledSignal)	Binds a Signal's value to the enabled state of this element and keeps the state synchronized with the signal value while the element is in attached state.
<T> void	Element.bindProperty(String name, Signal<T> signal, SerializableConsumer<T> writeCallback)	Binds a Signal's value to the given property and keeps the property value synchronized with the signal value while the element is in attached state.
void	ElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)	Binds the given signal to the given property.
void	Element.bindText(Signal<String> signal)	Binds a Signal's value to the text content of this element and keeps the text content synchronized with the signal value while the element is in attached state.
void	Element.bindVisible(Signal<Boolean> visibleSignal)	Binds a Signal's value to the visible property of this element and keeps property synchronized with the signal value while the element is in attached state.
void	ElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)	Binds the given signal to the visible property.

Uses of Signal in com.vaadin.flow.dom.impl

Methods in com.vaadin.flow.dom.impl with parameters of type Signal

Modifier and Type	Method	Description
Style	BasicElementStyle.bind(String name, Signal<String> signal)
void	ImmutableClassList.bind(String name, Signal<Boolean> signal)	Binds the presence of the given class name to the provided signal so that the class is added when the signal value is true and removed when the value is false.
Style	ImmutableEmptyStyle.bind(String name, Signal<String> signal)	Binds the given style property to the provided string signal and keeps the style property value synchronized with the signal.
void	ThemeListImpl.bind(String name, Signal<Boolean> signal)
void	AbstractTextElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
void	BasicElementStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
void	ShadowRootStateProvider.bindAttributeSignal(Element owner, String attribute, Signal<String> signal)
void	AbstractTextElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
void	BasicElementStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
void	ShadowRootStateProvider.bindPropertySignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)
void	AbstractTextElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)
void	BasicElementStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)
void	ShadowRootStateProvider.bindVisibleSignal(Element owner, Signal<Boolean> signal)

Uses of Signal in com.vaadin.flow.internal.nodefeature

Methods in com.vaadin.flow.internal.nodefeature that return Signal

Modifier and Type	Method	Description
<T> Signal<T>	SignalBindingFeature.getSignal(String key)	Gets the signal bound to the given key.
Signal<?>	NodeMap.SignalBinding.signal()	Returns the value of the signal record component.

Methods in com.vaadin.flow.internal.nodefeature with parameters of type Signal

Modifier and Type	Method	Description
void	AbstractPropertyMap.bindSignal(Element owner, String name, Signal<?> signal, SerializableConsumer<?> writeCallback)	Binds the given signal to the given property with a write callback.
void	ElementAttributeMap.bindSignal(Element owner, String attribute, Signal<String> signal)	Binds the given signal to the given attribute.
protected <T> void	NodeMap.bindSignal(Element owner, String key, Signal<T> signal, SerializableBiConsumer<Element,T> setter, SerializableConsumer<?> writeCallback)	Binds a signal to a given key using a setter function and stores the writeCallback in SignalBindingFeature.
void	ElementData.bindVisibleSignal(Element owner, Signal<Boolean> signal)	Binds the given signal to the visible property.
void	SignalBindingFeature.setBinding(String key, Registration registration, Signal<?> signal)	Sets a binding for the given key.
void	SignalBindingFeature.setBinding(String key, Registration registration, Signal<?> signal, SerializableConsumer<?> writeCallback)	Sets a binding for the given key with a write callback.
void	TextBindingFeature.setBinding(Registration registration, Signal<String> textSignal)

Constructors in com.vaadin.flow.internal.nodefeature with parameters of type Signal

Modifier	Constructor	Description
	SignalBinding(Signal<?> signal, Registration registration, Serializable value, SerializableConsumer<?> writeCallback)	Creates an instance of a SignalBinding record class.

Uses of Signal in com.vaadin.flow.signals

Methods in com.vaadin.flow.signals that return Signal

Modifier and Type	Method	Description
static <T> Signal<T>	Signal.computed(SignalComputation<T> computation)	Creates a new computed signal with the given computation callback.
default <C> Signal<C>	Signal.map(SignalMapper<T,C> mapper)	Creates a simple computed signal based on a mapper function that is passed the value of this signal.
static Signal<Boolean>	Signal.not(Signal<Boolean> signal)	Crates a new computed signal containing the negation of the provided boolean-valued signal.

Methods in com.vaadin.flow.signals with parameters of type Signal

Modifier and Type	Method	Description
static Signal<Boolean>	Signal.not(Signal<Boolean> signal)	Crates a new computed signal containing the negation of the provided boolean-valued signal.

Uses of Signal in com.vaadin.flow.signals.impl

Classes in com.vaadin.flow.signals.impl that implement Signal

Modifier and Type	Class	Description
class	ComputedSignal<T>	A signal with a value that is computed based on the value of other signals.

Uses of Signal in com.vaadin.flow.signals.local

Classes in com.vaadin.flow.signals.local that implement Signal

Modifier and Type	Class	Description
class	AbstractLocalSignal<T>	Base class for local signals providing shared listener notification, usage tracking, and value access logic.
class	ListSignal<T>	A local list signal that holds a list of writable signals, enabling per-entry reactivity.
class	ValueSignal<T>	A local writable signal that holds a reference to an object.

Methods in com.vaadin.flow.signals.local that return Signal

Modifier and Type	Method	Description
Signal<T>	ValueSignal.asReadonly()	Wraps this signal to not accept changes.

Uses of Signal in com.vaadin.flow.signals.operations

Classes in com.vaadin.flow.signals.operations with type parameters of type Signal

Modifier and Type	Class	Description
class	InsertOperation<T extends Signal<?>>	An operation that inserts a new child signal into a list or map.
final record	PutIfAbsentResult<S extends Signal<?>>	The result of a put-if-absent operation.

Uses of Signal in com.vaadin.flow.signals.shared

Classes in com.vaadin.flow.signals.shared that implement Signal

Modifier and Type	Class	Description
class	AbstractSignal<T>	Base type for full-featured signals that are backed by a transactional signal tree.
class	SharedListSignal<T>	A signal containing a list of values.
class	SharedMapSignal<T>	A signal containing a map of values with string keys.
class	SharedNodeSignal	A signal representing a node in a tree structure.
class	SharedNumberSignal	A signal containing a numeric value.
class	SharedValueSignal<T>	A signal containing a value.

Methods in com.vaadin.flow.signals.shared that return Signal

Modifier and Type	Method	Description
<C> Signal<C>	SharedNumberSignal.mapIntValue(SerializableIntFunction<C> mapper)	Creates a computed signal based on an integer mapper function that is passed the value of this signal.