Package com.vaadin.flow.component.html

Class Param

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.html.Param

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, Serializable

@Tag("param")
public class Param
extends HtmlComponent

Component representing a <param> element for <param> element.

Author:

Vaadin Ltd

See Also:

• HtmlObject
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Param()	Creates a new <param> component.
Param(String name, String value)	Creates a new <param> component with given name and value.

Method Summary

Modifier and Type	Method	Description
void	bindName(Signal<String> nameSignal)	Binds a signal's value to the "name" attribute as a one-way binding, so that the attribute is updated when the signal's value is updated.
void	bindValue(Signal<String> valueSignal)	Binds a signal's value to the "value" attribute as a one-way binding, so that the attribute is updated when the signal's value is updated.
String	getName()	Gets the "name" attribute value.
Optional<String>	getValue()	Gets the "value" attribute.
void	setName(String name)	Sets a "name" attribute value.
void	setValue(String value)	Sets a "value" attribute.

Methods inherited from class com.vaadin.flow.component.HtmlComponent

getTitle, setTitle

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

bindHeight, bindWidth, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

Param

public Param()

Creates a new <param> component.

Param

public Param(String name,
 String value)

Creates a new <param> component with given name and value.

Parameters:

name - a name attribute value

value - a value attribute value

See Also:

• setName(String)
• setValue(String)

Method Details

setValue

public void setValue(String value)

Sets a "value" attribute.

Parameters:

value - "value" attribute value

bindValue

public void bindValue(Signal<String> valueSignal)

Binds a signal's value to the "value" attribute as a one-way binding, so that the attribute is updated when the signal's value is updated.

Passing null as the signal removes any existing binding for the "value" attribute. When unbinding, the current attribute value is left unchanged.

While a binding for the "value" attribute is active, any attempt to set the attribute manually throws BindingActiveException. The same happens when trying to bind a new Signal while one is already bound.

Bindings are lifecycle-aware and only active while this component is in the attached state; they are deactivated while the component is in the detached state.

Parameters:

valueSignal - the signal to bind, not null

Throws:

BindingActiveException - thrown when there is already an existing binding

Since:

25.1

See Also:

• setValue(String)
• Element.bindAttribute(String, Signal)

setName

public void setName(String name)

Sets a "name" attribute value.

Parameters:

name - a "name" attribute value

bindName

public void bindName(Signal<String> nameSignal)

Binds a signal's value to the "name" attribute as a one-way binding, so that the attribute is updated when the signal's value is updated.

While a binding for the "name" attribute is active, any attempt to set the attribute manually throws BindingActiveException. The same happens when trying to bind a new Signal while one is already bound.

Bindings are lifecycle-aware and only active while this component is in the attached state; they are deactivated while the component is in the detached state.

Parameters:

nameSignal - the signal to bind, not null

Throws:

BindingActiveException - thrown when there is already an existing binding

Since:

25.1

See Also:

• setName(String)
• Element.bindAttribute(String, Signal)

getName

public String getName()

Gets the "name" attribute value.

Returns:

the "name" attribute value

See Also:

• setName(String)

getValue

public Optional<String> getValue()

Gets the "value" attribute.

Returns:

the "value" attribute value

See Also:

• setValue(String)