Package com.vaadin.flow.server.webcomponent

Class WebComponentBinding<C extends Component>

java.lang.Object

com.vaadin.flow.server.webcomponent.WebComponentBinding<C>

Type Parameters:

C - type of the exported component

All Implemented Interfaces:

Serializable

public final class WebComponentBinding<C extends Component>
extends Object
implements Serializable

Represents a single instance of a exported web component instance embedded onto a host page. Contains a unique Component instance and property value hosts tied to the specific web component instance. Facilitates property updates from the client to the component.

Since:

2.0

Author:

Vaadin Ltd.

See Also:

• to create WebComponentBindings
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebComponentBinding(C component)	Constructs a new WebComponentBinding.

Method Summary

Modifier and Type	Method	Description
void	bindProperty(PropertyConfigurationImpl<C,? extends Serializable> propertyConfiguration, boolean overrideDefault)	Adds a property to this web component binding based on the propertyConfiguration.
void	bindProperty(PropertyConfigurationImpl<C,? extends Serializable> propertyConfiguration, boolean overrideDefault, tools.jackson.databind.JsonNode startingValue)	Adds a property to this web component binding based on the propertyConfiguration.
C	getComponent()	Retrieves the bound Component instance.
Class<? extends Serializable>	getPropertyType(String propertyName)	Retrieve the type of a property's value.
boolean	hasProperty(String propertyName)	Does the component binding have a property identified by given name.
void	updatePropertiesToComponent()	Calls the bound change handlers defined via PropertyConfiguration.onChange(SerializableBiConsumer) for each bound property with the current value of the property.
void	updateProperty(String propertyName, Serializable value)	Updates a property bound to the component.
void	updateProperty(String propertyName, tools.jackson.databind.node.BaseJsonNode jsonValue)	Updates a property bound to the component.

Methods inherited from class java.lang.Object

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

Constructor Details

WebComponentBinding

public WebComponentBinding(C component)

Constructs a new WebComponentBinding. The bound Component is given via component parameter. The web component properties are bound by calling bindProperty(PropertyConfigurationImpl, boolean, JsonNode);

Parameters:

component - component which exposes properties as web component. Not null

Throws:

NullPointerException - if component is null

Method Details

updateProperty

public void updateProperty(String propertyName,
 Serializable value)

Updates a property bound to the component. If the property has an attached listener, the value is also delivered to the listener. If the value is null, the property is set to its default value (which could be null).

Parameters:

propertyName - name of the property, not null

value - new value to set for the property

Throws:

NullPointerException - if propertyName is null

IllegalArgumentException - if no bound property can be found for propertyName

updateProperty

public void updateProperty(String propertyName,
 tools.jackson.databind.node.BaseJsonNode jsonValue)

Updates a property bound to the component. Converts the jsonValue into the correct type if able and then calls updateProperty(String, java.io.Serializable).

Parameters:

propertyName - name of the property, not null

jsonValue - new value to set for the property

Throws:

NullPointerException - if propertyName is null

IllegalArgumentException - if no bound property can be found for propertyName

IllegalArgumentException - if the jsonValue cannot be converted to the type of the property identified by propertyName.

getComponent

public C getComponent()

Retrieves the bound Component instance.

Returns:

component instance

getPropertyType

public Class<? extends Serializable> getPropertyType(String propertyName)

Retrieve the type of a property's value.

Parameters:

propertyName - name of the property

Returns:

property type

hasProperty

public boolean hasProperty(String propertyName)

Does the component binding have a property identified by given name.

Parameters:

propertyName - name of the property

Returns:

has property

updatePropertiesToComponent

public void updatePropertiesToComponent()

Calls the bound change handlers defined via PropertyConfiguration.onChange(SerializableBiConsumer) for each bound property with the current value of the property.

bindProperty

public void bindProperty(PropertyConfigurationImpl<C,? extends Serializable> propertyConfiguration,
 boolean overrideDefault)

Adds a property to this web component binding based on the propertyConfiguration. If a property with an existing name is bound, the previous binding is removed. Starting value for the property is set to null.

Parameters:

propertyConfiguration - property configuration, not null

overrideDefault - set to true if the property should be initialized with null instead of default value found in PropertyData

Throws:

NullPointerException - if propertyConfiguration is null

bindProperty

public void bindProperty(PropertyConfigurationImpl<C,? extends Serializable> propertyConfiguration,
 boolean overrideDefault,
 tools.jackson.databind.JsonNode startingValue)

Adds a property to this web component binding based on the propertyConfiguration. If a property with an existing name is bound, the previous binding is removed.

Parameters:

propertyConfiguration - property configuration, not null

overrideDefault - set to true if the property should be initialized with startingValue instead of default value found in PropertyData

startingValue - starting value for the property. Can be null. overrideDefault must be true for this value to have any effect

Throws:

NullPointerException - if propertyConfiguration is null