listbox

par 2 contributeurs :

Cet élément est utilisé pour créer une liste d'éléments dont l'un ou plusieurs d'entre-eux peuvent être sélectionnés. Une listbox peut contenir plusieurs colonnes. Différentes méthodes permettent aux éléments de la liste d'êtres récupérés et modifiés.

Vous pouvez spécifier le nombre de lignes à afficher dans la liste à l'aide de l'attribut rows. Les lignes supplémentaires peuvent être consultées avec une barre de défilement. Une listbox est supposée contenir des éléments listitem. Toutes les lignes dans la listbox ont la même hauteur, qui est la hauteur du plus grand élément de la liste. Si vous désirez créer une liste dont les hauteurs de lignes sont variables, ou avec du contenu non textuel, utilisez plutôt l'élément richlistbox.

Consultez le Tutoriel XUL pour plus d'informations.

Attributs
disabled, disableKeyNavigation, preference, rows, seltype, suppressonselect, tabindex, value
Propriétés
accessibleType, currentIndex, currentItem, disabled, disableKeyNavigation, itemCount, listBoxObject, selectedCount, selectedIndex, selectedItem, selectedItems, selType, tabIndex, value
Méthodes
addItemToSelection, appendItem, clearSelection, ensureElementIsVisible, ensureIndexIsVisible, getIndexOfFirstVisibleRow, getIndexOfItem, getItemAtIndex, getNumberofVisibleRows, getRowCount, getSelectedItem, insertItemAt, invertSelection, moveByOffset, removeItemAt, removeItemFromSelection, scrollToIndex, selectAll, selectItem, selectItemRange, suppressOnSelect, timedSelect, toggleItemSelection

Exemple

Image:XUL_ref_listbox.png
 <listbox id="theList">
   <listitem label="Rubis"/>
   <listitem label="Émeraude"/>
   <listitem label="Saphir" selected="true"/>
   <listitem label="Diamant"/>
 </listbox>

Attributs

disabled
Type : booléen
Indique si l'élément est ou non désactivé. Si cette valeur est définie à true, l'élément est désactivé. Les éléments désactivés sont habituellement affichés avec leur texte grisé. Si l'élément est désactivé, il ne répond pas aux actions de l'utilisateur, il ne peut pas recevoir le focus, et l'évènement command ne se déclenchera pas.


Image:XUL_ref_attr_disabled.png
<!-- La case à cocher active/désactive le bouton -->
<checkbox label="Enable button" 
    onclick="document.getElementById('buttRemove').disabled = this.checked"/>
<button id="buttRemove" label="Remove All" disabled="true"/>
preference
Type : id d'élément
Connecte l'élément à une préférence (élément preference) correspondante. Cet attribut n'a d'effet qu'utilisé au sein d'un prefwindow. La valeur de la préférence sera mise à jour pour correspondre à la propriété value de l'élément.
rows
Type : entier
Le nombre de lignes à afficher dans l'élément. Si l'élément contient plus que ce nombre de lignes, une barre de défilement apparaitra afin que l'utilisateur puisse consulter les autres lignes. Pour obtenir le nombre réel de lignes dans l'élément, utilisez la méthode getRowCount.
seltype<magic name="\"PAGENAME\"/"></magic>
Type : une des valeurs ci-dessous
Utilisé pour indiquer si les sélections multiples sont permises.
  • single : Seule une ligne peut être sélectionnée à la fois. (Valeur par défaut dans listbox.)
  • multiple : Plusieurs lignes peuvent être sélectionnées à la fois. (Valeur par défaut dans tree.)

<magic name="\"PAGENAME\"/">Des cellules individuelles peuvent être sélectionnées.</magic><magic name="\"PAGENAME\"/"> Des lignes sont sélectionnées, cependant, l'indicateur de sélection n'est visible que sur le texte de la colonne principale.</magic>

suppressonselect
Type : booléen
Si cet attribut n'est pas spécifié, un évènement select est déclenché dès qu'un élément est sélectionné, que ce soit par l'utilisateur ou par l'appel d'une des méthodes de sélection. Si la valeur de l'attribut est true, l'évènement select n'est jamais déclenché.
tabindex
Type : entier
L'ordre de tabulation de l'élément. L'ordre de tabulation est l'ordre dans lequel le focus se déplace lorsque l'utilisateur appuie sur la touche « tab ». Les éléments dont le tabindex est plus haut se trouvent plus tard dans la séquence de tabulation.
value
Type : chaîne
Cet attribut chaîne permet d'associer une valeur de données avec un élément. Il n'est destiné à aucune utilisation particulière, mais vous pouvez y accéder avec un script pour votre usage propre..

Propriétés

accessibleType
Type : entier
Une valeur indiquant le type d'objet d'accessibilité pour l'élément.
currentItem
Type : élément listitem
Renvoie le dernier élément sélectionné dans la liste de sélection, ce qui n'est utile que dans une liste à sélection multiple.
disabled
Type : booléen
Obtient et définit la valeur de l'attribut disabled.
listBoxObject
Type : nsIListBoxObject
L'objet nsIListBoxObject derrière la liste de sélection. Cette propriété est en lecture seule. La plupart des fonctionnalités de la liste de sélection sont déjà disponibles directement dans l'élément listbox, il sera donc rarement nécessaire d'utiliser cet objet de boîte directement.
selectedIndex
Type : entier
Renvoie l'indice de l'élément actuellement sélectionné. Un élément peut être sélectionné en assignant son indice à cette propriété. En lui assignant -1, tous les éléments seront désélectionnés.
selectedItem
Type : élément
Conserve l'élément actuellement sélectionné. Si aucun élément n'est sélectionné, sa valeur sera null. Vous pouvez sélectionner un élément en définissant cette valeur. Un évènement select sera envoyé à cet élément lorsqu'il est sélectionné en modifiant cette propriété, la propriété selectedIndex, ou par l'utilisateur.
selType<magic name="\"PAGENAME\"/"></magic>
Type : chaîne de caractères
Obtient et définit la valeur de l'attribut seltype.

suppressOnSelect
Type : booléen
Obtient et définit la valeur de l'attribut suppressonselect.
tabIndex
Type : entier
Obtient et définit la valeur de l'attribut tabindex.
value
Type : chaîne
Obtient et définit la valeur de l'attribut value.

Méthodes

Héritées de XUL element
blur, click, doCommand, focus, getElementsByAttribute getElementsByAttributeNS

Héritées de DOM element
addEventListener(), appendChild(), dispatchEvent(), getAttribute(), getAttributeNode(), getAttributeNodeNS(), getAttributeNS(), getElementsByTagName(), getElementsByTagNameNS(), hasAttribute(), hasAttributeNS(), hasAttributes(), hasChildNodes(), insertBefore(), isSupported(), normalize(), removeAttribute(), removeAttributeNode(), removeAttributeNS(), removeChild(), removeEventListener(), replaceChild(), setAttribute(), setAttributeNode(), setAttributeNodeNS(), setAttributeNS()

getRowCount()
Type de retour : entier
Renvoie le nombre total de lignes dans l'élément, quel que soit le nombre de lignes affichées.
selectAll()
Type de retour : aucune valeur renvoyée
Sélectionne tous les éléments. Un évènement de sélection est envoyé après l'exécution de la sélection.
selectItem( item )
Type de retour : aucune valeur renvoyée
Désélectionne tous les éléments actuellement sélectionnés, puis sélectionne l'élément donné en argument. Un évènement de sélection est envoyé après l'exécution de la sélection.
selectItemRange( startItem, endItem)
Type de retour : aucune valeur renvoyée
Sélectionne tous les éléments compris entre les deux éléments donnés en paramètre, y compris les éléments de début et de fin. Tous les autres éléments sont désélectionnés. Cette méthode n'a aucun effet sur les listes en mono-sélection. Un évènement de sélection est envoyé après l'exécution de la sélection.
timedSelect( item, timeout )
Type de retour : aucune valeur renvoyée
Sélectionne un élément spécifié par l'argument item après un nombre de millisecondes définit par l'argument timeout. Tous les autres éléments sont désélectionnés.
toggleItemSelection( item )
Type de retour : aucune valeur renvoyée
Modifie l'état de sélection de l'élément spécifié. S'il est sélectionné, il devient désélectionné. S'il est désélectionné, il devient sélectionné. Les autres éléments de la liste ne sont pas affectés et ils conservent leur état de sélection.

Sujets liés

Éléments
listcell, listcol, listcols, listhead, listheader, listitem
Interfaces
nsIAccessibleProvider, nsIDOMXULMultiSelectControlElement

Étiquettes et contributeurs liés au document

Étiquettes : 
Contributeurs à cette page : lmorchard, BenoitL
Dernière mise à jour par : lmorchard,