akasha

Class DOMTokenList

java.lang.Object

akasha.DOMTokenList

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="DOMTokenList")
public class DOMTokenList
extends java.lang.Object

The DOMTokenList interface represents a set of space-separated tokens. Such a set is returned by Element.classList, HTMLLinkElement.relList, HTMLAnchorElement.relList, HTMLAreaElement.relList, HTMLIframeElement.sandbox, or HTMLOutputElement.htmlFor. It is indexed beginning with 0 as with JavaScript Array objects. DOMTokenList is always case-sensitive.

See Also:

DOMTokenList - MDN, DOMTokenList - DOM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DOMTokenList.Entry
static interface	DOMTokenList.ForEachCallback
static interface	DOMTokenList.ForEachCallback2
static interface	DOMTokenList.ForEachCallback3

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	value The value property of the DOMTokenList interface is a stringifier that returns the value of the list as a DOMString, or clears and sets the list to the given value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DOMTokenList()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String... tokens) The add() method of the DOMTokenList interface adds the given token to the list.
boolean	contains(java.lang.String token) The contains() method of the DOMTokenList interface returns a Boolean — true if the underlying list contains the given token, otherwise false.
JsIterator<DOMTokenList.Entry>	entries() The DOMTokenList.entries() method returns an iterator allowing you to go through all key/value pairs contained in this object.
void	forEach(DOMTokenList.ForEachCallback callback) The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.
void	forEach(DOMTokenList.ForEachCallback2 callback) The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.
void	forEach(DOMTokenList.ForEachCallback3 callback) The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.
java.lang.String	item(int index) The item() method of the DOMTokenList interface returns an item in the list by its index.
JsIterator<java.lang.Double>	keys() The keys() method of the DOMTokenList interface returns an iterator allowing to go through all keys contained in this object.
int	length() The length read-only property of the DOMTokenList interface is an integer representing the number of objects stored in the object.
void	remove(java.lang.String... tokens) The remove() method of the DOMTokenList interface removes the specified tokens from the list.
boolean	replace(java.lang.String token, java.lang.String newToken) The replace() method of the DOMTokenList interface replaces an existing token with a new token.
boolean	supports(java.lang.String token) The supports() method of the DOMTokenList interface returns true if a given token is in the associated attribute's supported tokens.
boolean	toggle(java.lang.String token) The toggle() method of the DOMTokenList interface removes a given token from the list and returns false.
boolean	toggle(java.lang.String token, boolean force) The toggle() method of the DOMTokenList interface removes a given token from the list and returns false.
JsIterator<java.lang.String>	values() The values() method of the DOMTokenList interface returns an iterator allowing developers to go through all values contained in the DOMTokenList.

Methods inherited from class java.lang.Object

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

Field Detail

value

@Nonnull
public java.lang.String value

The value property of the DOMTokenList interface is a stringifier that returns the value of the list as a DOMString, or clears and sets the list to the given value.

See Also:

DOMTokenList.value - MDN, value - DOM

Constructor Detail

DOMTokenList

protected DOMTokenList()

Method Detail

length

@JsProperty(name="length")
public int length()

The length read-only property of the DOMTokenList interface is an integer representing the number of objects stored in the object.

See Also:

DOMTokenList.length - MDN, length - DOM

add

public void add(@Nonnull
                java.lang.String... tokens)

The add() method of the DOMTokenList interface adds the given token to the list.

See Also:

DOMTokenList.add - MDN, add() - DOM

contains

public boolean contains(@Nonnull
                        java.lang.String token)

The contains() method of the DOMTokenList interface returns a Boolean — true if the underlying list contains the given token, otherwise false.

See Also:

DOMTokenList.contains - MDN, contains() - DOM

remove

public void remove(@Nonnull
                   java.lang.String... tokens)

The remove() method of the DOMTokenList interface removes the specified tokens from the list.

See Also:

DOMTokenList.remove - MDN, remove() - DOM

replace

public boolean replace(@Nonnull
                       java.lang.String token,
                       @Nonnull
                       java.lang.String newToken)

The replace() method of the DOMTokenList interface replaces an existing token with a new token. If the first token doesn't exist, replace() returns false immediately, without adding the new token to the token list.

See Also:

DOMTokenList.replace - MDN, replace() - DOM

supports

public boolean supports(@Nonnull
                        java.lang.String token)

The supports() method of the DOMTokenList interface returns true if a given token is in the associated attribute's supported tokens. This method is intended to support feature detection.

See Also:

DOMTokenList.supports - MDN, Credential Management Level 1

toggle

public boolean toggle(@Nonnull
                      java.lang.String token,
                      boolean force)

The toggle() method of the DOMTokenList interface removes a given token from the list and returns false. If token doesn't exist it's added and the function returns true.

See Also:

DOMTokenList.toggle - MDN, toggle() - DOM

toggle

public boolean toggle(@Nonnull
                      java.lang.String token)

The toggle() method of the DOMTokenList interface removes a given token from the list and returns false. If token doesn't exist it's added and the function returns true.

See Also:

DOMTokenList.toggle - MDN, toggle() - DOM

item

@Nullable
public java.lang.String item(int index)

The item() method of the DOMTokenList interface returns an item in the list by its index.

See Also:

DOMTokenList.item - MDN, item() - DOM

keys

@Nonnull
public JsIterator<java.lang.Double> keys()

The keys() method of the DOMTokenList interface returns an iterator allowing to go through all keys contained in this object. The keys are of type unsigned integer.

See Also:

DOMTokenList.keys - MDN, keys() (as iterable<Node>) - DOM

values

@Nonnull
public JsIterator<java.lang.String> values()

The values() method of the DOMTokenList interface returns an iterator allowing developers to go through all values contained in the DOMTokenList. The individual values are DOMString objects.

See Also:

DOMTokenList.values - MDN, values() (as iterable<Node>) - DOM

entries

@Nonnull
public JsIterator<DOMTokenList.Entry> entries()

The DOMTokenList.entries() method returns an iterator allowing you to go through all key/value pairs contained in this object. The values are DOMString objects, each representing a single token.

See Also:

DOMTokenList.entries - MDN, entries() (as iterable<Node>) - DOM

forEach

public void forEach(@Nonnull
                    DOMTokenList.ForEachCallback callback)

The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.

See Also:

DOMTokenList.forEach - MDN, forEach() (as iterable<Node>) - DOM

forEach

public void forEach(@Nonnull
                    DOMTokenList.ForEachCallback2 callback)

The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.

See Also:

DOMTokenList.forEach - MDN, forEach() (as iterable<Node>) - DOM

forEach

public void forEach(@Nonnull
                    DOMTokenList.ForEachCallback3 callback)

The forEach() method of the DOMTokenList interface calls the callback given in parameter once for each value pair in the list, in insertion order.

See Also:

DOMTokenList.forEach - MDN, forEach() (as iterable<Node>) - DOM