DOMTokenList#
Wstęp#
Interfejs DOMTokenList stanowi definicję Web IDL dla obiektów reprezentujących zestawy w węzłach elementowych. Obiekty typu DOMTokenList są potocznie nazywane zestawami słów DOM # i skojarzone zostały z kilkoma podstawowymi zagadnieniami.
Cały interfejs DOMTokenList pojawia się dopiero w specyfikacji DOM4 i jest wykorzystywany jedynie przez obiekty zwracane przez właściwość Element.classList. Dzięki niemu manipulowanie poszczególnymi klasami w elementach jest znacznie wygodniejsze i szybsze, niż wykorzystanie w tym celu właściwości Element.className (operującej jedynie na tekście). Inne specyfikacje mogą wykorzystywać zestawy przy definiowaniu właściwości dla bardziej skonkretyzowanych elementów (np. HTML5).
Obiekty typu DOMTokenList są zawsze czułe na wielkość znaków, nawet jeśli słowa w skojarzonym uporządkowanym zestawem słów mogą być traktowane bez uwzględniania wielkości znaków.
Interfejs DOMTokenList nie dziedziczy z żadnego innego interfejsu w ogólnym ujęciu DOM, chociaż w środowisku JS obiekty implementujące ten interfejs będą dziedziczyły z prototypu najwyższego rzędu. Zachowanie takie jest czymś normalnym w przypadku języka ECMAScript.
Zestaw słów DOM można uzyskać za pomocą właściwości zawartych w poniższej tabeli:
Właściwości DOMTokenList#
| Nazwa | Opis |
|---|---|
DOMTokenList.length | Zwraca liczbę słów z uporządkowanego zestawu słów. |
DOMTokenList.value | Zwraca lub ustawia w postaci łańcucha znakowego wartość skojarzonego atrybutu. |
Metody DOMTokenList#
| Nazwa | Opis |
|---|---|
DOMTokenList.add() | Dodaje przekazane słowa do uporządkowanego zestawu słów. |
DOMTokenList.contains() | Zwraca wartość true jeśli przekazane słowo znajduje się w uporządkowanym zestawie słów, w przeciwnym razie wartość false. |
DOMTokenList.item() | Zwraca słowo o określonym indeksie z uporządkowanego zestawu słów. |
DOMTokenList.remove() | Usuwa przekazane słowa z uporządkowanego zestawu słów. |
DOMTokenList.replace() | Zastępuje przekazane słowo nowym słowem w uporządkowanym zestawie słów. |
DOMTokenList.supports() | Zwraca wartość true jeśli przekazane słowo znajduje się w obsługiwanych słowach, w przeciwnym razie wartość false. |
DOMTokenList.toggle() | Przełącza (dodaje/kasuje) przekazane słowo w uporządkowanym zestawie słów i zwraca wartość true jeśli słowo to znajduje się w uporządkowanym zestawie słów, w przeciwnym razie wartość false. |
Inne DOMTokenList#
| Nazwa | Opis |
|---|---|
stringifier | Określa reguły zamiany uporządkowanego zestawu słów na łańcuch znakowy. |
Składnia Web IDL#
interface DOMTokenList # { readonly attribute unsigned long length; getter DOMString? item(unsigned long index); boolean contains(DOMString token); void add(DOMString... tokens); void remove(DOMString... tokens); boolean toggle(DOMString token, optional boolean force); void replace(DOMString token, DOMString newToken); boolean supports(DOMString token); attribute DOMString value; stringifier; };