DOM:range
Un article de MDC.
Sommaire |
[modifier] Introduction
L'objet Range (gamme) représente un fragment de document qui peut contenir des nœuds et des parties de nœuds texte dans un document donné.
Une gamme peut être crée en utilisant la méthode createRange de l'objet document. Les objets range peuvent également être récupérés en utilisant la méthode getRangeAt de l'objet selection.
[modifier] Propriétés
- collapsed
- Renvoie un booléen indiquant si le point de départ et le point final de la gamme sont confondus.
- commonAncestorContainer
- Renvoie le nœud le plus profond qui contient à la fois les nœuds
startContaineretendContainer. - endContainer
- Renvoie le nœud dans lequel la gamme se termine.
- endOffset
- Renvoie un nombre représentant l'endroit où la gamme se termine dans
endContainer. - startContainer
- Renvoie le nœud dans lequel la gamme débute.
- startOffset
- Renvoie un nombre représentant l'endroit où la gamme débute dans
startContainer.
[modifier] Méthodes
[modifier] Méthodes de positionnement
Ces méthodes permettent de définir le début et la fin d'une gamme.
- setStart
- Définit le point de départ d'une gamme.
- setEnd
- Définit le point final d'une gamme.
- setStartBefore
- Définit le point de départ d'une gamme relativement à un autre nœud.
- setStartAfter
- Définit le point de départ d'une gamme relativement à un autre nœud.
- setEndBefore
- Définit le point final d'une gamme relativement à un autre nœud.
- setEndAfter
- Définit le point final d'une gamme relativement à un autre nœud.
- selectNode
- Le contenu de la gamme devient le nœud et son contenu.
- selectNodeContents
- le contenu de la gamme devient le contenu du nœud.
- collapse
- Replie la gamme sur l'un de ses points frontières.
[modifier] Méthodes de modification
Ces méthodes recupèrent les nœuds d'une gamme et modifient le contenu d'une gamme.
- cloneContents
- Renvoie un fragment de document où sont copiés les nœuds d'une gamme.
- deleteContents
- Supprime du document le contenu d'une gamme.
- extractContents
- Déplace le contenu d'une gamme, de l'arbre du document vers un fragment de document.
- insertNode
- Insère un nœud au début d'une gamme.
- surroundContents
- Déplace le contenu d'une gamme dans un nouveau nœud.
[modifier] Autres méthodes
- compareBoundaryPoints
- Compare les points frontières de deux gammes.
- cloneRange
- Renvoie un objet
Rangeavec des points frontières identiques à ceux de la gamme clonée. - detach
- Supprime la gamme afin d'améliorer la performance.
- toString
- Renvoie le texte de la gamme.
[modifier] Les méthodes Gecko
Cette section décrit les méthodes de range qui sont particulières à Mozilla et ne font pas partie des spécifications DOM W3C.
- compareNode Obsolète
- Renvoie une constante qui indique si le nœud est avant, après, dans ou englobe la gamme.
- comparePoint
- Renvoie -1, 0, ou 1, indiquant si le point se trouve avant, après, ou dans la gamme.
- createContextualFragment
- Renvoie un fragment de document créé à partir d'un morceau de code donné.
- intersectsNode Obsolète
- Renvoie un booléen indiquant si un nœud donné a une intersection avec la gamme.
- isPointInRange
- Renvoie un booléen indiquant si le point donné est dans la gamme.