Visit Mozilla.org

XUL:richlistbox

Un article de MDC.

« Accueil de la référence XUL    [ Exemples | Attributs | Propriétés | Méthodes | Sujets liés ]

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, listbox.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

[modifier] 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.

[modifier] Attributs

Hérités de XUL element
align, allowevents, allownegativeassertions, class, coalesceduplicatearcs, collapsed, container, containment, context, contextmenu, datasources, dir, empty, equalsize, flags, flex, height, hidden, id, insertafter, insertbefore, left, maxheight, maxwidth, menu, minheight, minwidth, mousethrough, observes, ordinal, orient, pack, persist, popup, position, preference-editable, querytype, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

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.

XUL:Attributs:disableKeyNavigation

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.


XUL:Attributs:rows

seltype Nouveau dans Firefox 3
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.)



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..

[modifier] Propriétés

Héritées de XUL element
align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width

Héritées de DOM element
attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

XUL:Propriétés:accessibleType XUL:Propriétés:listbox.currentIndex XUL:Propriétés:currentItem

disabled
Type : booléen
Obtient et définit la valeur de l'attribut disabled.

XUL:Propriétés:disableKeyNavigation XUL:Propriétés:itemCount XUL:Propriétés:selectedCount XUL:Propriétés:selectedIndex XUL:Propriétés:selectedItem XUL:Propriétés:selectedItems

selType Nouveau dans Firefox 3
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.

[modifier] Méthodes

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

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

XUL:Méthodes:addItemToSelection XUL:Méthodes:appendItem XUL:Méthodes:clearSelection XUL:Méthodes:ensureElementIsVisible XUL:Méthodes:ensureIndexIsVisible XUL:Méthodes:getIndexOfFirstVisibleRow XUL:Méthodes:getIndexOfItem XUL:Méthodes:getItemAtIndex XUL:Méthodes:getNumberOfVisibleRows XUL:Méthodes:getRowCount XUL:Méthodes:getSelectedItem XUL:Méthodes:insertItemAt XUL:Méthodes:invertSelection XUL:Méthodes:moveByOffset XUL:Méthodes:removeItemAt XUL:Méthodes:removeItemFromSelection XUL:Méthodes:scrollToIndex

selectAll()
Type retourné : aucune valeur retourné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 retourné : aucune valeur retourné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 retourné : aucune valeur retournée
Sélectionne tous les éléments compris entre les deux éléments donnés en argument, incluant 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 retourné : aucune valeur retourné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 retourné : aucune valeur retourné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.

[modifier] Sujets liés

Interfaces
nsIAccessibleProvider, nsIDOMXULMultiSelectControlElement