Package com.vaadin.flow.dom.impl

Class ImmutableClassList

java.lang.Object

java.util.AbstractCollection<String>

java.util.AbstractSet<String>

com.vaadin.flow.dom.impl.ImmutableClassList

All Implemented Interfaces:

ClassList, Serializable, Iterable<String>, Collection<String>, Set<String>

public class ImmutableClassList
extends AbstractSet<String>
implements ClassList, Serializable

Immutable class list implementation.

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

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImmutableClassList(Collection<String> values)	Creates a new immutable class list with the given values.

Method Summary

Modifier and Type	Method	Description
boolean	add(String e)
void	bind(String name, com.vaadin.signals.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.
Iterator<String>	iterator()
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.flow.dom.ClassList

set

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, spliterator, toArray, toArray

Constructor Details

ImmutableClassList

public ImmutableClassList(Collection<String> values)

Creates a new immutable class list with the given values.

Parameters:

values - the values of the class list

Method Details

add

public boolean add(String e)

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

Overrides:

add in class AbstractCollection<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface Set<String>

Specified by:

iterator in class AbstractCollection<String>

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface Set<String>

Specified by:

size in class AbstractCollection<String>

bind

public void bind(String name,
 com.vaadin.signals.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.

Passing null as the signal removes any existing binding for the given class name. When unbinding, the current presence of the class is left unchanged.

While a binding for the given class name is active, manual calls to Set.add(Object), Set.remove(Object) or ClassList.set(String, boolean) for that name will throw a com.vaadin.flow.dom.BindingActiveException. Bindings are lifecycle-aware and only active while the owning Element is in attached state; they are deactivated while the element is in detached state.

Bulk operations that indiscriminately replace or clear the class list (for example Set.clear() or setting the class attribute via Element.setAttribute(String, String)) clear all bindings.

Text nodes do not support binding a Signal to a stylesheet class, because they do not support styling in general.

Specified by:

bind in interface ClassList

Parameters:

name - the class name to bind, not null or blank

signal - the boolean signal to bind to, or null to unbind