Package com.vaadin.flow.dom.impl

Class ThemeListImpl

java.lang.Object

com.vaadin.flow.dom.impl.ThemeListImpl

All Implemented Interfaces:

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

public class ThemeListImpl
extends Object
implements ThemeList, Serializable

Default implementation for the ThemeList that provides a live view into the theme names of the corresponding element. Both reads and writes go through the element attribute, THEME_ATTRIBUTE_NAME, so that all instances obtained for the same element always agree on the current theme names.

Since the attribute value is space separated, a theme name cannot contain spaces. add(String) still accepts a space separated value for backwards compatibility, adding each theme name in it and logging a warning, but every other operation treats the value it is given as a single theme name, so remove("badge success") does not undo add("badge success").

The iterator returned by iterator() is the one exception to the live view: it iterates the theme names present when it was created.

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

Since:

1.0.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	THEME_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
ThemeListImpl(Element element)	Creates new theme list for element specified.

Method Summary

Modifier and Type	Method	Description
boolean	add(String themeName)	Adds the given theme name.
boolean	addAll(Collection<? extends String> themeNames)
SignalBinding<List<String>>	bind(Signal<List<String>> names)	Binds the theme names to the provided signal so that the theme list is dynamically updated to match the signal's value.
SignalBinding<Boolean>	bind(String name, Signal<Boolean> signal)	Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.
void	clear()
boolean	contains(Object themeName)
boolean	containsAll(Collection<?> themeNames)
boolean	isEmpty()
Iterator<String>	iterator()
boolean	remove(Object themeName)
boolean	removeAll(Collection<?> themeNamesToRemove)
boolean	retainAll(Collection<?> themeNamesToRetain)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class java.lang.Object

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

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

equals, hashCode, spliterator

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

set

Field Details

THEME_ATTRIBUTE_NAME

public static final String THEME_ATTRIBUTE_NAME

See Also:

• Constant Field Values

Constructor Details

ThemeListImpl

public ThemeListImpl(Element element)

Creates new theme list for element specified.

Parameters:

element - the element to reflect theme changes onto

Method Details

bind

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

Description copied from interface: ThemeList

Binds the presence of the given theme name to the provided signal so that the theme name is added when the signal value is true and removed when the value is false.

While a binding for the given theme name is active, manual calls to Set.add(Object), Set.remove(Object), ThemeList.set(String, boolean), Set.addAll(Collection), Set.retainAll(Collection) or Set.removeAll(Collection) for that name will throw a 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 theme list (for example Set.clear() or setting the theme attribute via HasTheme.setThemeName(String)) throw a BindingActiveException if any binding is active.

Specified by:

bind in interface ThemeList

Parameters:

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

signal - the boolean signal to bind to, not null

bind

public SignalBinding<List<String>> bind(Signal<List<String>> names)

Description copied from interface: ThemeList

Binds the theme names to the provided signal so that the theme list is dynamically updated to match the signal's value. Only one group binding is allowed per theme list.

The group binding coexists with static values and individual toggle bindings. Names that appear in both sources may appear as duplicates in the theme attribute.

Null or empty entries in the list and a null list value are silently ignored.

Bulk operations that indiscriminately replace or clear the theme list (for example Set.clear() or setting the theme attribute via HasTheme.setThemeName(String)) throw a BindingActiveException if any binding is active.

Specified by:

bind in interface ThemeList

Parameters:

names - the signal providing the list of theme names, not null

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>

add

public boolean add(String themeName)

Adds the given theme name.

Since the theme attribute value is space separated, a theme name cannot contain spaces. For backwards compatibility a space separated value is still accepted here and adds each theme name in it, but it logs a warning and may stop being supported in a future version, so add one theme name per call, or use HasTheme.addThemeNames(String...).

No other operation interprets a value that way: Set.contains(Object), Set.remove(Object), Set.addAll(Collection) and the bind methods all treat the value they are given as a single theme name, so remove("badge success") does not undo add("badge success").

A space separated value is split into the individual theme names, which are all added, and logs a warning. See ThemeList.add(String).

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

Specified by:

add in interface ThemeList

Parameters:

themeName - the theme name to add, not null or blank

Returns:

true if the theme list was modified, false if all the given theme names were already present

addAll

public boolean addAll(Collection<? extends String> themeNames)

Specified by:

addAll in interface Collection<String>

Specified by:

addAll in interface Set<String>

remove

public boolean remove(Object themeName)

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface Set<String>

retainAll

public boolean retainAll(Collection<?> themeNamesToRetain)

Specified by:

retainAll in interface Collection<String>

Specified by:

retainAll in interface Set<String>

removeAll

public boolean removeAll(Collection<?> themeNamesToRemove)

Specified by:

removeAll in interface Collection<String>

Specified by:

removeAll in interface Set<String>

clear

public void clear()

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface Set<String>

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface Set<String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<String>

Specified by:

isEmpty in interface Set<String>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface Set<String>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<String>

Specified by:

toArray in interface Set<String>

contains

public boolean contains(Object themeName)

Specified by:

contains in interface Collection<String>

Specified by:

contains in interface Set<String>

containsAll

public boolean containsAll(Collection<?> themeNames)

Specified by:

containsAll in interface Collection<String>

Specified by:

containsAll in interface Set<String>

toString

public String toString()

Overrides:

toString in class Object