Package com.vaadin.flow.dom

Interface ClassList

All Superinterfaces:
Collection<String>, Iterable<String>, Serializable, Set<String>
All Known Implementing Classes:
ImmutableClassList, OverlayClassListProxy
public interface ClassList extends Set<String>, Serializable
Representation of the class names for an Element.
Since:
1.0
Author:
Vaadin Ltd

  • Method Details

    • set

      default boolean set(String className, boolean set)
      Sets or removes the given class name, based on the set parameter.
      Parameters:
      className - the class name to set or remove
      set - true to set the class name, false to remove it
      Returns:
      true if the class list was modified (class name added or removed), false otherwise

    • bind

      default SignalBinding<Boolean> bind(String name, Signal<Boolean> signal)
      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 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.

      Parameters:
      name - the class name to bind, not null or blank
      signal - the boolean signal to bind to, not null
      Throws:
      BindingActiveException - thrown when there is already an existing binding
      Since:
      25.0

    • bind

      default SignalBinding<List<String>> bind(Signal<List<String>> names)
      Binds the class names to the provided signal. The class list is immediately updated to match the current signal value when the binding is created, and is kept synchronized with any subsequent signal value changes while the element is attached. Only one group binding is allowed per class list.

      The group binding coexists with static values and individual toggle bindings. Names that appear in both sources are deduplicated by the underlying classList (Set behavior).

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

      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.

      Parameters:
      names - the signal providing the list of class names, not null
      Throws:
      BindingActiveException - thrown when there is already an existing group binding
      Since:
      25.1