Package com.vaadin.flow.component.shared.internal

Class OverlayClassListProxy

java.lang.Object

java.util.AbstractCollection<String>

java.util.AbstractSet<String>

com.vaadin.flow.component.shared.internal.OverlayClassListProxy

All Implemented Interfaces:

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

public class OverlayClassListProxy
extends AbstractSet<String>
implements ClassList

Internal class that provides shared functionality for setting CSS class names to overlay only components that support HasStyle, such as Dialog. Not intended to be used publicly.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OverlayClassListProxy(HasStyle hasStyle)

Method Summary

Modifier and Type	Method	Description
boolean	add(String s)
SignalBinding<Boolean>	bind(String className, Signal<Boolean> signal)	Binds the presence of the given class name to the provided signal.
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

bind, 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

OverlayClassListProxy

public OverlayClassListProxy(HasStyle hasStyle)

Method Details

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>

add

public boolean add(String s)

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

Overrides:

add in class AbstractCollection<String>

bind

public SignalBinding<Boolean> bind(String className,
 Signal<Boolean> signal)

Description copied from interface: ClassList

Binds the presence of the given class name to the provided signal. The class name is immediately added or removed based on the current signal value when the binding is created. The class is added when the signal value is true and removed when the value is false.

After the initial application, the binding is kept synchronized with any subsequent signal value changes while the owning Element is in attached state. 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 BindingActiveException. When the element is in detached state, signal value changes have no effect.

Bulk operations that indiscriminately replace or clear the class list (for example Set.clear() or setting the class attribute via Element.setAttribute(String, String)) throw a BindingActiveException if any binding is active.

Specified by:

bind in interface ClassList

Parameters:

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

signal - the boolean signal to bind to, not null