DOM:selection
Un article de MDC.
Sommaire |
[modifier] Résumé
La classe de l'objet retourné par window.getSelection() et d'autres méthodes.
[modifier] Description
Un objet selection représente les plages sélectionnées par l'utilisateur. Habituellement, il ne contient qu'une seule plage accessible comme ceci :
range = sel.getRangeAt(0);
L'appel de la méthode toString() renvoie le texte contenu dans la sélection, par exemple
selObj = window.getSelection(); window.alert(selObj);
[modifier] Glossaire
Autres mots clés utilisés dans cette section.
- anchor (ancre)
- L'« ancre » d'une sélection est son point de départ. Pour une sélection avec la souris, l'« ancre » correspond à l'endroit initialement pressé par le bouton de la souris. Quand l'utilisateur modifie la sélection à la souris ou au clavier, l'« ancre » ne change pas.
- focus (focus)
- Le « focus » d'une sélection est son point d'arrivée. Pour une sélection avec la souris, le « focus » correspond à l'endroit où le bouton de la souris est relaché. Quand l'utilisateur modifie la sélection à la souris ou au clavier, le « focus » pointe la fin de la sélection modifiée.
- range (plage)
- Une « plage » est une partie contigüe d'un document. Une « plage » peut contenir aussi bien des nœuds entiers que des portions de nœuds, comme un extrait de nœud texte. Habituellement, un utilisateur n'effectuera qu'une seule sélection à la fois, mais il lui est possible de sélectionner plusieurs « plages » (par ex. en utilisant la touche Ctrl). Une « plage » est obtenue depuis une sélection par l'objet range. Les objets
rangepeuvent également être créés via le DOM et ajoutés ou supprimés d'une sélection par programmation.
[modifier] Propriétés
- anchorNode
- Renvoie le nœud d'où la sélection commence.
- anchorOffset
- Renvoie le décalage en nombre de caractères de l'« ancre » de la sélection à l'intérieur du nœud
anchorNode. - focusNode
- Renvoie le nœud où la sélection se termine.
- focusOffset
- Renvoie le décalage en nombre de caractères du « focus » de sélection à l'intérieur de
focusNode. - isCollapsed
- Renvoie un booléen indiquant si le point de départ et d'arrivée sont à la même position.
- rangeCount
- Renvoie le nombre de « plages » dans la sélection.
[modifier] Méthodes
- getRangeAt
- Renvoie un objet range représentant une des « plages » actuellement sélectionnée.
- collapse
- Réduit la sélection courante à un simple point.
- extend
- Déplace le « focus » de la sélection à un endroit spécifié.
- collapseToStart
- Déplace le « focus » de la sélection au même point que l'« ancre ».
- collapseToEnd
- Déplace l'« ancre » de la sélection au même point que le « focus ». Le « focus » ne bouge pas.
- selectAllChildren
- Ajoute tous les enfants d'un nœud spécifié à la sélection.
- addRange
- Un objet range devant être ajouté à la sélection.
- removeRange
- Supprime une « plage » de la sélection.
- removeAllRanges
- Supprime toutes les « plages » de la sélection.
- deleteFromDocument
- Efface le contenu de la sélection du document.
- selectionLanguageChange
- toString
- Renvoie une chaîne de caractères représentant l'actuel objet
selection, i.e. le texte sélectionné. - containsNode
- Indique si un nœud donné appartient à la sélection.