Cet élément est utilisé pour créer une liste d'éléments, de manière semblable à une listbox
, mais est conçu pour être utilisé lorsque les éléments ne contiennent pas du simple contenu texte.
Note : Dans les versions de Firefox antérieures à Firefox 3, les
richlistbox
supportaient uniquement les sélections simples. Firefox 3 y permet les sélections multiples.- Attributs
- disabled, disableKeyNavigation, preference, rows, seltype, suppressonselect, tabindex, value
- Propriétés
- accessibleType, currentIndex, currentItem, disabled, disableKeyNavigation, itemCount, selectedCount, selectedIndex, selectedItem, selectedItems, selType, suppressOnSelect, tabIndex, value
- Méthodes
- addItemToSelection, appendItem, clearSelection, ensureElementIsVisible, ensureIndexIsVisible, getIndexOfFirstVisibleRow, getIndexOfItem, getItemAtIndex, getNumberofVisibleRows, getRowCount, getSelectedItem, insertItemAt, invertSelection, moveByOffset, removeItemAt, removeItemFromSelection, scrollToIndex, selectAll, selectItem, selectItemRange, timedSelect, toggleItemSelection
Exemples
<richlistbox> <richlistitem> <description>Une description XUL !</description> </richlistitem> <richlistitem> <button label="Un bouton XUL"/> </richlistitem> </richlistbox>
L'élément richlistbox
contient plusieurs éléments richlistitem
, qui peuvent contenir tout type de contenu. On peut cliquer sur n'importe quel élément richlistitem
et utiliser le clavier pour déplacer la sélection.
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ènementcommand
ne se déclenchera pas.
<!-- 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'unprefwindow
. 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 danslistbox
.)multiple
: Plusieurs lignes peuvent être sélectionnées à la fois. (Valeur par défaut danstree
.)
<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 esttrue
, l'évènementselect
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.
-
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.
-
suppressOnSelect
- Type : booléen
-
Obtient et définit la valeur de l'attribut
suppressonselect
.
Méthodes
-
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'argumenttimeout
. 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.