Package com.vaadin.flow.component.trigger.internal

Class PropertyInput<T>

java.lang.Object

com.vaadin.flow.component.trigger.internal.Action.Input<T>

com.vaadin.flow.component.trigger.internal.PropertyInput<T>

Type Parameters:

T - the runtime type of the value produced

All Implemented Interfaces:

Serializable

public class PropertyInput<T>
extends Action.Input<T>

Reads a JavaScript property from a target component's root element at the moment a trigger fires.

Common targets and properties:

• TextField.value → new PropertyInput<>(textField, "value", String.class)
• Checkbox.checked → new PropertyInput<>(checkbox, "checked", Boolean.class)

For internal use only. May be renamed or removed in a future release.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PropertyInput(Component target, String propertyName, Class<T> valueType)	Creates a property input that reads the given JS property from the given target component.

Method Summary

Modifier and Type	Method	Description
protected void	appendExpression(com.vaadin.flow.component.trigger.internal.JsBuilder builder, StringBuilder out)	Appends this input's JS expression to out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PropertyInput

public PropertyInput(Component target,
 String propertyName,
 Class<T> valueType)

Creates a property input that reads the given JS property from the given target component.

Parameters:

target - the component to read from, not null

propertyName - the JS property name, not null

valueType - runtime type of the produced value, not null

Method Details

appendExpression

protected void appendExpression(com.vaadin.flow.component.trigger.internal.JsBuilder builder,
 StringBuilder out)

Description copied from class: Action.Input

Appends this input's JS expression to out. Element references must go through JsBuilder.reference(com.vaadin.flow.dom.Element).

Specified by:

appendExpression in class Action.Input<T>

Parameters:

builder - collects element parameter references, not null

out - buffer to append into, not null