Éléments

Cette page est en cours de traduction, son contenu peut donc être incomplet ou contenir des parties en anglais. N'hésitez pas à participer à sa traduction à partir de XBL:XBL 1.0 Reference:Elements

bindings

Cette section est testée et ajustée selon l'implémentation courante de Firefox. Veuillez ne la modifier que si le comportement réel diffère de celui qui est décrit. Veuillez ne pas le faire seulement sur base d'une autre spécification XBL.

<!ELEMENT bindings ( binding* ) >

Hiérarchie :   élément racine
Peut contenir : <binding>

L'élément bindings est l'élément racine de tout document XBL. Il doit habituellement déclarer XBL en tant qu'espace de noms par défaut (à moins qu'un préfixe d'espaces de noms XBL soit utilisé) et peut également déclarer d'autres préfixes d'espace de noms utilisés dans votre liaison.

bindings contient zéro ou plus éléments binding comme enfants. Chaque élément binding enfant définit une liaison unique pouvant être attachée à des éléments dans d'autres documents.

Un élément ne peut avoir qu'une liaison attachée (explicitement ou héritée) à un moment donné. Si plusieurs liaisons sont définies, seule la dernière de la séquence sera utilisée (comme avec toute règle CSS).

helloworld.html :

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>Hello world!</title>
<style type="text/css">
p {
 -moz-binding: url(hello.xml#default);
}
#p03 {
 -moz-binding: url(hello.xml#hello2);
}
</style>
</head>
<body>

  <p>Default content</p>
  <p>Default content</p>
  <p id="p03">Default content</p>

</body>
</html>

hello.xml :

<?xml version="1.0"?>
<bindings xmlns="http://www.mozilla.org/xbl"
 xmlns:html="http://www.w3.org/1999/xhtml">
  <binding id="default">
    <content><html:b>Hello world! </html:b><children/></content>
  </binding>
  <binding id="hello2">
    <content><html:b>Hello from my binding! </html:b><children/></content>
  </binding>
</bindings>

Vous pouvez voir le résultat en ouvrant helloworld.html dans Firefox. hello.xml doit se trouver dans le même répertoire que helloworld.html.

Suivant : <big>bindings > élément binding</big>.

Notes

  • Dans les versions stables actuelles des produits Mozilla (par exemple Firefox 2), il est impossible d'attacher des liaisons à des sous-éléments de tableaux (lignes, cellules, etc.). Il n'est possible d'attacher des liaisons qu'à l'élément table lui-même. Cela a été corrigé dans les prochaines versions des produits Mozilla. Consultez le bug 83830 pour plus d'informations et des méthodes de contournement.
  • L'encodage par défaut des documents XML (dont les fichiers XBL) est l'UTF-8. Des déclarations explicites d'encodage peuvent être présentes pour écraser celui par défaut, par exemple <?xml version="1.0" encoding="ISO-8859-1"?>.
  • L'URI dans les déclarations d'espaces de noms (namespace) est une chaîne opaque utilisée uniquement pour identifier l'espace de noms de manière unique. Il n'est pas nécessaire (et souvent ce n'est pas le cas) qu'ils pointent vers un schéma réel ou une ressource liée à l'espace de noms. Voir la spécification Namespaces in XML.
  • Outre l'espace de noms par défaut, vous pouvez déclarer un nombre illimité d'autres espaces de noms pour gérer votre contenu. Les plus utiles sont sans doute HTML/XHTML, XUL (XML User Interface Language), SVG (Scalable Vector Graphics) et XLink. Ainsi, une déclaration plus ou moins universelle d'espaces de noms dans votre élément bindings pourrait ressembler à ceci :
<bindings xmlns="http://www.mozilla.org/xbl"
 xmlns:html = "http://www.w3.org/1999/xhtml"
 xmlns:xul  = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
 xmlns:svg  = "http://www.w3.org/2000/svg"
 xmlns:xlink= "http://www.w3.org/1999/xlink">

binding

<!ENTITY % binding-content "(resources?,content?,implementation?,handlers?)">
<!ELEMENT binding %binding-content;>
<!ATTLIST binding
   id                     ID             #REQUIRED
   extends                CDATA          #IMPLIED
   display                CDATA          #IMPLIED
   inheritstyle           true           #IMPLIED
>

L'élément binding décrit une seule liaison XBL. Une liaison XBL peut ajouter du contenu anonyme, des champs, des propriétés, des méthodes et des gestionnaires d'évènements à des éléments HTML/XML.

Une seule liaison XBL peut être attachée à un élément à l'aide de feuilles de style pour par script. (Consultez le bug 83830 pour les spécificités de <table>).

CSS :

div {
 -moz-binding: url(myBinding.xml#default);
}

DOM :

elementReference.style.MozBinding = "url(myBinding.xml#default)";

Dans les deux cas qui précèdent, on utilise binding avec id="default" dans un fichier myBinding.xml.

À partir de Firefox 3, il est également possible d'utiliser une URL data: pour intégrer la liaison directement :

div {
  -moz-binding: url(data:text/xml;charset=utf-8,%3C%3Fxml%20version%3D%221.0%22%3F%3E%0A%3Cbindings%20id%3D%22xbltestBindings%22%20xmlns%3D%22http%3A//www.mozilla.org/xbl%22%3E%0A%20%20%3Cbinding%20id%3D%22xbltest%22%3E%3Ccontent%3EPASS%3C/content%3E%3C/binding%3E%0A%3C/bindings%3E%0A);
}

Comme les URL data: ne gèrent pas les identifiants de fragments, la première liaison trouvée dans le XML intégré est utilisée à la place. N'oubliez pas que la liaison doit toujours avoir un ID même si on ne la référence pas. De plus, les URL data: ne sont gérées que depuis du code chrome (autrement dit, depuis l'application ou une extension).

Note : La politique de même origine est utilisée pour les sites web ; ils peuvent seulement lier des fichiers XBL du même domaine, ou dans le chrome.

Pour des raisons de clarté, voici à quoi ressemble le XML intégré dans l'exemple qui précède :

<?xml version="1.0"?>
<bindings id="xbltestBindings" xmlns="http://www.mozilla.org/xbl">
  <binding id="xbltest"><content>PASS</content></binding>
</bindings>

La seule manière simple d'attacher des liaisons à tout ensemble d'éléments est d'utiliser des déclarations CSS. Cela permet également de rendre l'implémentation des liaisons partiellement fonctionnelle si le scripting est désactivé. Dans ce dernier cas, toutes les méthodes et tous les gestionnaires d'évènements seront bloqués, mais le contenu anonyme et les styles seront toujours utilisés. C'est pourquoi que les déclarations CSS doivent toujours être utilisées — à moins que vous deviez ajouter des liaisons en cours d'exécution à des éléments particuliers.

Un élément binding peut contenur une balise resources, une balise content, une balise implementation et une balise handlers.

  • id — L'attribut id est un identifiant unique dans le document. Pour l'élément binding, cet attribut est obligatoire, puisqu'il est utilisé pour attacher des liaisons.
  • extends — L'attribut extends est utilisé pour spécifier l'URL d'une liaison dont cette liaison hérite (consultez Héritage d'implémentations). L'URL spécifie un document de liaison particulier. La notation # doit être utilisée pour pointer vers un id particulier au sein d'un document de liaison. Notez que le contenu ne peut pas être hérité, seulement le comportement.
  • display — Cet attribut spécifie comment sera affichée la balise. En définissant cet attribut, vous pouvez donner à un élément les caractéristiques d'affichage et de positionnement d'un élément existant. Par exemple, utilisez la valeur « xul:button » pour créer un élément qui s'affichera comme un bouton. La partie précédant les deux points est un préfixe d'espace de noms, vous devrez donc égélement déclarer l'espace de noms XUL. Toutes les balises n'ont pas un type d'affichage unique. Les types d'affichage XUL suivant peuvent être utilisés : browser, button, checkbox, description, editor, grippy, iframe, image, label, menu, menuitem, menubar, progressmeter, radio, resizer, scrollbar, scrollbox, spacer, splitter, titlebar, treechildren et treecol. Vous pourriez également utiliser une série de balises HTML, MathML et SVG. L'attribut « display » ne fonctionne pas à mois que l'attribut extends soit défini, consultez le bug 119389. Dans ce cas, mettre la valeur de l'attribut display dans l'attribut extends.
  • inheritstyle — L'attribut inheritstyle indique si les règles de style du document affecteront le contenu anonyme généré par la liaison XBL. Si cet attribut est à true, les styles du document seront également appliqués au contenu anonyme généré par XBL.

 

content

<!ELEMENT content ANY>
<!ATTLIST content
   id               ID           #IMPLIED
>

Une liaison peut spécifier du nouveau contenu qui sera placé à l'intérieur de l'élément lié. Bien que ce contenu soit visible à l'écran comme s'il était directement dans le fichier, il est anonyme et est invisible du DOM normal. Pour accéder à des nœuds anonymes sur un élément XBL lié, vous pouvez utiliser les fonctions getAnonymousElementByAttribute et getAnonymousNodes. Le seul élément XBL pouvant apparaître dans la balise content est l'élément children. Les attributs de l'élément <content> dans la liaison sont définis sur l'élément lié.

  • id — L'attribut id est un identifiant unique dans le document.

children

<!ELEMENT children EMPTY>
<!ATTLIST children
   id               ID                           #IMPLIED
   includes         CDATA                        #IMPLIED
>

Spécifie l'emplacement où les éventuels enfants de l'élément lié seront placés dans le contenu généré.

Normalement, si l'élément lié a son propre contenu, le contenu anonyme n'est pas généré. Cependant, avec un élément children, il est possible de fusionner le contenu de l'élément HTML/XML avec le contenu XBL.

Si la balise children a elle-même un contenu, celui-ci deviendra le contenu par défaut. Si l'élément auquel la liaison est attachée a du contenu, le contenu par défaut sera ignoré. Si l'élément n'a aucun contenu, le contenu par défaut sera ajouté.

  • id — L'attribut id est un identifiant unique dans le document.
  • includes — L'attribut includes peut être utilisé pour indiquer que seul un certain contenu doit être placé au point d'insertion spécifié par l'élément children. Sa valeur peut être un nom de balise ou plusieurs noms séparés par des virgules. (Avec xulrunner 1.9, il faut utiliser la barre verticale '|` comme séparateur et non pas une virgule.) Un enfant ne peut être placé au point d'insertion que s'il correspond à la valeur de l'attribut includes. Seuls les enfants immédiats sont comparés au sélecteur. Par exemple, pour un fragment XML <customElement><foobar><hoge/></foobar></customElement> avec une définition de liaison <binding id="customElement"><content><xul:box><children includes="hoge"/></xul:box></content></binding> pour l'élément customElement, <xul:box/> devient vide parce que le sélecteur includes="hoge" ne correspond pas à l'élément enfant direct foobar.

implementation

<!ENTITY % implementation-content "(method|property)*">
<!ELEMENT implementation %implementation-content;>
<!ATTLIST implementation
   id               ID           #IMPLIED
   name             CDATA        #IMPLIED
   implements       CDATA        #IMPLIED
>

The implementation element describes the set of methods and properties that are attached to the bound element. Once the binding is attached, these methods and properties can be invoked directly from the bound element.

  • id — The id attribute is a document-unique identifier.
  • name — The name attribute can be used to provide a specific name for an implementation. This name can then be used to reference the implementation. For example, in JavaScript the value of this attribute represents the name of the corresponding class that is constructed for the implementation. If no name attribute is specified then the binding's document URI and id are used to uniquely reference the binding's implementation.
  • implements — The implements attribute can be used to describe the set of interfaces that are implemented by the binding. Its value is a comma-separated list of named interfaces. If supported, in strongly typed languages the bound element can be referenced not only as any of the interfaces that the element might already support (e.g., HTMLElement) but also as any of the interfaces described by this attribute. Support of this capability is optional.

constructor

The code inside the constructor is called when a binding has just been attached to an element. So full access to anonymous nodes generated by the binding is already possible. The constructor tag must be placed inside the implementation tag.

  • id — The id attribute is a document-unique identifier.
Note: Prior to Firefox 3, the constructor could be called at a time when reflow of the document layout was locked down, so that attempting to get layout information from within the constructor could return out of date information. In Firefox 3 and later, the constructor is called when reflow can take place, which results in up-to-date information being returned. See bug 398404 for details.

destructor

The code inside the destructor is called when a binding is being removed from an element. You can use this to unload resources to free memory. However the destructor is often not called when it should, see bug 230086. The destructor tag must be placed inside the implementation tag.

  • id — The id attribute is a document-unique identifier.

method

<!ENTITY % method-content "(parameter*,body?)">
<!ELEMENT method %method-content;>
<!ATTLIST method
   id               ID           #IMPLIED
   name             CDATA        #REQUIRED
   type             CDATA        #IMPLIED
>

The method element is used to describe a single method of a binding implementation.

  • id — The id attribute is a document-unique identifier.
  • name — The name attribute's value is the name given to the method when it is attached to the bound element. The method can be invoked directly from the bound element using this value.

Example

<method name="scrollTo">
  <parameter name="index"/>
  <body>
    this.setAttribute("scrollpos", index);
  </body>
</method>

parameter

<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
   id               ID           #IMPLIED
   name             CDATA        #REQUIRED
>

The parameter element is used inside a method element. It represents a single parameter of a method.

  • id — The id attribute is a document-unique identifier.
  • name — The value of the name attribute is used by script within a method's body element to reference this parameter.

body

<!ELEMENT body CDATA>
<!ATTLIST body
   id               ID           #IMPLIED
>

The body element represents the implementation of its corresponding method. Its contents are the script that is executed when the method is invoked.

  • id — The id attribute is a document-unique identifier.

field

<!ELEMENT field EMPTY>
<!ATTLIST field
   id               ID                  #IMPLIED
   name             CDATA               #REQUIRED
   readonly         (true|false)        #IMPLIED
>

A field is similar to a property, except that it should not have a getter or setter. It is useful as a simple holder for a value. The field element must have content which is code that determines the initial value of the field. The field tag must be inside the implementation tag.

  • id — The id attribute is a document-unique identifier.
  • name — The name of the field. This is the name used to refer to the field on the bound element.
  • readonly — If true, this field is read-only. If this attribute is omitted, the field will be readable and writable.
Note: In Firefox 3, fields are now evaluated the first time they're accessed instead of at binding attachment time. This shouldn't cause any problems in typical use cases, but there are cases in which this will impact the behavior of your code. See bug 372769 for details.

Here are some examples of cases in which the behavior of your code may change due to this change in Firefox 3:

  1. If you have two fields, one named A and one named B, and field A sets .B, the value of .B will depend on whether or not .A has already been accessed.
  2. If a proto is inserted into the proto chain after binding instantiation, doing so may affect field values (this wasn't the case in prior versions of Firefox).
  3. At binding attachment time, <field name="parentNode">this.parentNode</field> is undefined instead of the value of parentNode.
  4. A field no longer changes the value of a property set on the object itself (rather than a proto) before binding attachment.

property

<!ENTITY % property-content "(getter?,setter?)">
<!ELEMENT property %property-content;>
<!ATTLIST property
   id               ID                  #IMPLIED
   name             CDATA               #REQUIRED
   readonly         (true|false)        #IMPLIED
   onget            CDATA               #IMPLIED
   onset            CDATA               #IMPLIED
>

The property element represents a single property of an implementation. A property consists of a pair of getter/setter functions that can be defined using onget/onset attributes or getter/setter elements underneath the property element. Like methods, once the binding is attached, the property can be obtained directly from the bound element. The property tag must be inside the implementation tag.

  • id — The id attribute is a document-unique identifier.
  • name — The name of the property. This is the name used to refer to the property on the bound element.
  • readonly — The readonly attribute is used to designate a property as read-only. If set to true, the value of the property cannot be altered. If this attribute is omitted, the property will be readable and writable.
  • onget — The onget attribute's value is a script that executes when the value of the property is requested. If this attribute is set, any initial value contained underneath the element will be ignored. The return value of the script represents the value of the property that will be returned to the requestor. A property getter can also be specified as a child of the property element using the getter tag.
  • onset — The onset attribute's value is a script that executes when the value of the property is being altered. If this attribute is set, any initial value contained underneath the element will be ignored. Within the script, the parameter val represents the new value being assigned. A property setter can also be specified as a child of the property element using a setter tag.

getter

<!ELEMENT getter PCDATA>
<!ATTLIST getter
   id               ID                  #IMPLIED
>

The getter element contains script that gets executed when a specific property gets called. The getter tag must be inside the property tag.

  • id — The id attribute is a document-unique identifier.

setter

<!ELEMENT setter PCDATA>
<!ATTLIST setter
   id               ID                  #IMPLIED
>

The setter element contains script that gets executed when a specific property is being set. The setter tag must be inside the property tag.

  • id — The id attribute is a document-unique identifier.

handlers

<!ENTITY % handlers-content "handler*">
<!ELEMENT handlers %handlers-content;>
<!ATTLIST handlers
   id               ID                  #IMPLIED
>

The handlers element contains event handlers that can be attached to elements within the bound document. These handlers are installed when the binding is attached and removed when the binding is detached. The handlers tag must be inside the binding tag.

  • id — The id attribute is a document-unique identifier.

handler

<!ENTITY % handler-content "PCDATA">
<!ELEMENT handler %handler-content;>
<!ATTLIST handler
   id               ID                                  #IMPLIED
   event            NMREF                               #REQUIRED
   action           CDATA                               #IMPLIED
   phase            (capturing|bubbling|target)         #IMPLIED
   button           (1|2|3)                             #IMPLIED
   modifiers        CDATA                               #IMPLIED
   keycode          CDATA                               #IMPLIED
   key              CDATA                               #IMPLIED
   charcode         CDATA                               #IMPLIED
   clickcount       (1|2|3)                             #IMPLIED
   command          ID                                  #IMPLIED
   preventdefault   false|true                          #IMPLIED
>

The handler element describes a single event handler. This handler is attached to its target at the time the binding is attached and unhooked when the binding is detached from the bound element. The script inside the handler is executed when the event handler is matched. The handler tag must be inside the handlers tag.

  • id — The id attribute is a document-unique identifier.
  • event — The event attribute describes the specific event that this handler is listening for. Its value can be any legal DOM event name (including custom events created using the DocumentEvent interface of the DOM).
  • action — The action attribute contains script that is invoked when the handler fires. The type attribute on the enclosing handlers element determines the language of the script. The handler script can also be specified as a child of the handler element.
  • phase — This attribute specifies the phase of the event flow that this handler should monitor. The possible values are capturing, bubbling, and target. If a phase is specified, the handler will only be invoked during that phase of the event handling process. If no phase is specified, a default of bubbling is assumed.
  • button — The button attribute imposes a filter on the handler. It is used with mouse handlers to specify a particular button. The event handler will only be matched if the value of the button field in the DOM mouse event object matches the value of the attribute.
  • modifiers — The modifiers attribute imposes a filter on key and mouse handlers. Its value is a whitespace- or comma-separated list of modifier keys. If present in the list, then the modifier key must be set in the DOM event object in order for the handler to be matched. If the modifiers is not empty and the modifier is not present in the list, then the modifier key must not be set in the DOM event object in order for the handler to be matched.
    Supported modifiers are:
    • shift
    • alt
    • control
    • meta
    • accel — the platform's primary accelerator key. It is left up to the user agent to decide which modifier key represents the primary key. (It's the Control key on Windows and Meta on Mac.)
    • accesskey — the platform's primary shortcut mnemonic key should be used (the Alt key on Windows and Linux, has no effect on Mac).
  • keycode — The keycode attribute imposes a filter on key handlers. Its value is a key identifier for a specific keycode, e.g., vk_enter.
    [Editor's Note: A forthcoming DOM events specification will presumably outline the list of valid keycode strings.]
    If this attribute is present, then its value must match the keyCode field of the DOM key event object in order for the handler to fire.
  • charcode — The charcode attribute imposes a filter on key handlers. Its value is a single character, e.g., "z". If this attribute is present, then its value must match the charCode field of the DOM key event object in order for the handler to fire.
    [Editor's note: As DOM Events mature more attributes may be added. For example, mutation events define several new fields such as relatedTarget that could be supported in the filtering syntax.]
  • key — The key attribute has the same meaning as charcode.
  • clickcount — The clickcount attribute imposes a filter on the handler. It is used with mouse handlers to specify how many times a button has been clicked. The event handler will only be matched if the value of the clickcount field in the DOM mouse event object matches the value of the attribute.
  • command — The id of a command to invoke when the event occurs. If used in a non-chrome document, the entire handler will be ignored.
  • preventdefault — If set to true, the default action of the event is not performed. See also preventDefault method of the Event object.

resources

<!ENTITY % resources-content "(image?,stylesheet?)">
<!ELEMENT resources %resources-content;>
<!ATTLIST property
   id               ID                  #IMPLIED
>

Used for inclusion of image elements, to cache them for later use, and for inclusion of stylesheet elements. The resources tag must be used directly inside the binding tag.

  • id — The id attribute is a document-unique identifier.

stylesheet

<!ELEMENT stylesheet EMPTY>
<!ATTLIST stylesheet
   id               ID                  #IMPLIED
   src              URI                 #REQUIRED
>

The stylesheet element declares a style sheet used by the binding. The style rules in the style sheet will only be applied to the binding, not to other elements in the document. The stylesheet tag must be inside the resources tag.

  • id — The id attribute is a document-unique identifier.
  • src — The URL of the style sheet to apply to the binding content.

image

<!ELEMENT image EMPTY>
<!ATTLIST image
   id               ID                  #IMPLIED
   src              URI                 #REQUIRED
>

Declares an image resource used by the binding. The image is loaded as soon as the binding is used. You can use this to preload a number of images for later use. The image tag must be inside the resources tag.

  • id — The id attribute is a document-unique identifier.
  • src — The URL of the image to load.

Étiquettes et contributeurs liés au document

Contributeurs ayant participé à cette page : BenoitL, ttaubert, Yanmorin
Dernière mise à jour par : ttaubert,