A binding can specify an anonymous content template using the
content element. This template describes a content tree that will be generated around the bound element during binding attachment. An element declared in a bound document using a single tag can then be constructed out of multiple child elements, and this implementation is hidden from the bound document.
For example, the HTML file upload control appears in most browsers as a composite widget consisting of a text field and a button. A sample XBL binding for the file widget might look as follows:
<binding id="fileupload"> <content> <html:input type="text"/> <html:input type="button"/> </content> </binding>
Because this content is not visible to its parent element, it is said to be
Scoping and Access Using the DOM
When a binding is attached and certain conditions are met, the children of the binding's
content element are cloned. Elements and attributes in the XBL namespace are never cloned. For content generated underneath the bound element, the topmost nodes'
parentNode pointers are set to the bound element. When anonymous content elements are built above the bound element, the topmost elements'
parentNode pointers are set to the bound element's
parentNode. All anonymous nodes'
ownerDocument pointers are set to the bound document at the time of generation.
In effect the anonymous content exists in its own insulated pocket within the document. Using
parentNode, anonymous content nodes can refer to their explicit parents, but explicit parents have no knowledge of their anonymous children. The anonymous content is not accessible via the
childNodes list for the bound element, nor is it accessible using
nextSibling to iterate over the children of the bound element. The anonymous content is accessible only through special methods like
Anonymous content introduces the concept of scope to nodes within a document. Because anonymous content elements can also have bindings attached that generate their own anonymous content, this scoping can be taken to an arbitrary level of nesting.
Explicit content is said to be at the document-level scope. Anonymous content nodes are in their own binding-level scopes. Binding scopes are determined by the bound element that contains the binding responsible for the generation of the anonymous nodes.
The scope of an element can be determined using the
getBindingParent method on the
DocumentXBL interface. See section 3 for more information. This method returns the bound element in the enclosing scope that is responsible for the anonymous node. If invoked on an element at the document-level scope, it returns null.
DOM methods that can be invoked on elements (e.g.,
getElementsByTagName) will only see nodes that are in the same scope. Methods invoked on the document (e.g.,
getElementById) only see nodes that are at the document-level scope.
Rules for Generation
Whenever bindings are attached to an element, anonymous content will potentially be generated or destroyed. When a new binding is attached, the bindings in its explicit 'inherits' chain are checked to see if any have anonymous content templates. The most derived binding in the chain with a template is the one used to determine if anonymous content should be generated.
Anonymous content is only generated from a template if there are insertion points defined within the template for all the explicit content found underneath the bound element at the time the check for generation is made. If the binding specifies no insertion points for explicit content, then anonymous content will only be constructed if the bound element has no explicit children.
Assuming that all explicit children have valid insertion points, the anonymous content is generated underneath the bound element. The binding responsible for the generation is referred to as the primary generating binding. Whenever the primary generating binding changes on a bound element, all anonymous nodes in the scope of the bound element are destroyed.
contentgeneratedevent is not implemented yet; see bug 223411.
Whenever content is built from a binding's template, a
contentgenerated event fires. A binding can specify a
contentgenerated handler that contains script to be executed after the binding has generated content.
Content generation handlers fire whenever the primary generating binding changes and it is determined that the binding should generate content around the bound element. The handlers for a binding chain always fire from the base binding down to the most derived binding. No handlers fire until the content from all bindings in the chain has been generated.
Whenever the primary generating binding changes (either to another binding or to nothing at all), and if anonymous content is already currently in place around the bound element, that content is destroyed. Prior to the destruction of the content, a
contentdestroyed event is fired.
The handlers execute from the most derived binding up to the base binding in the chain. All handlers fire before any content is actually destroyed. At the time the handlers fire, the primary generating binding has not yet changed.
Attributes on anonymous content elements can be tied to attributes on the bound element. Whenever the attribute is set or removed on the bound element, the corresponding attribute on the anonymous content is also set or removed. On any anonymous content element in a template, an
inherits attribute can be used to specify a comma-separated list of attributes that should be inherited. Attributes with namespaces can be defined using a namespace prefix and the attribute name separate by a colon.
For example, on the HTML file upload control, the anonymous textfield can be set up to automatically inherit the
value attribute from the bound element.
<xbl:binding id="fileUploadControl"> <xbl:content> <html:input type="text" xbl:inherits="value"/> <html:input type="button" value="Browse..."/> </xbl:content> </xbl:binding>
Each entry in the
inherits list can either simply list an attribute (such as
value in the example above), or it can specify an =-separated pair consisting of the attribute on the anonymous content that should be tied to the attribute on the bound element. The anonymous content attribute is listed first.
The special value
xbl:text can be used in an = separated pair, where the prefix defined is the XBL namespace. When specified on the left-hand side of the pair it indicates that the attribute on the right-hand side should be stored as text nodes underneath the anonymous element. When used on the right-hand side, it indicates that any raw text nodes that are explicit children of the bound element should be coalesced and the resulting value should be stored as the attribute on the left-hand side.
xbl:text value cannot occur by itself in the list. It may be used only in an = separated pair.
Note that the
inherits attribute is never cloned when content is generated from a template.
<children> and <element>
XBL bindings can interleave anonymous content between bound elements and their explicit children. They do so using XBL
children tags and the XBL
element tag. Any number of
children tags may be used in a binding's anonymous content template. The location at which a
children tag occurs is called an insertion point.
There are two types of insertion points: explicit and inherited. Explicit insertion points specify locations at which the explicit children of a bound element are inserted. Explicit insertion points are only used if they are found on the primary generating binding. Explicit insertion points on other bindings are ignored.
Inherited insertion points are used to place the anonymous content generated by the next binding in the chain that contributes anonymous content. That binding can define inherited insertion points for its base binding as well. This pattern continues all the way up the binding chain.
XPath selectors specified using the
includes attribute determine which insertion point a given child should be placed under. If no attribute is specified, an insertion point is considered generic and will match on all content.
The insertion point used for a given piece of content is the first encountered with a selector whose node set matches the element when doing a depth-first walk of the content template.
element tag specifies the position of the bound element relative to its generated anonymous content. Only one
element tag can occur in an anonymous content template. Any
element tags encountered on bindings other than the primary generating binding are ignored. If the bound element is repositioned such that it occurs underneath anonymous content that it generates, then all of the root anonymous elements generated by the primary binding are placed at the insertion point that would have been used for the bound element in the altered tree.
children elements are never cloned when content is generated from a template.
Handling DOM Changes
Insertion points continue to be used as elements are inserted or removed from the DOM. Whenever an element is inserted or appended, all insertion points are checked following all the same rules that applied when first placing explicit children during anonymous content generation. If no insertion point is found for the newly-inserted child, then the binding is no longer a fit for the bound element, and all anonymous content will be destroyed.
Whenever an element is removed, it simply disappears from its insertion point along with all anonymous content that was generated by the element.
It is possible to manipulate the anonymous content contained underneath a bound element using standard DOM APIs. If anonymous content that contains an insertion point is removed, then any explicit children found underneath the insertion point are relocated to any other insertion points that match. Again, if all the children cannot be relocated, then the anonymous content is destroyed.
[Editor's Note: Should there be an API for retrieving insertion points, fordynamically creating new insertion points, or for removing insertion points? Perhaps on ElementXBL?]
Event Flow and Targeting
Flow and Targeting Across Scopes
DOM events can fire on anonymous targets just as they can on explicit targets. As long as the event flows within the same scope, it is no different from the behavior outlined in the DOM Level 2 Events specification.
Events flow through the final transformed content model after all elements have been repositioned through the usage of
Whenever events flow from an anonymous element in a bound element's scope to the bound element itself, one of two actions occurs. Either the event is retargeted so that the bound element becomes the target, or the event is stopped and flow proceeds to the next phase. Whenever an event is retargeted, the
target field of the event is set to the bound element. The original anonymous content responsible for the event can be obtained from a new field of the event object:
The action taken (retarget vs. stop) is specific to the event type. In general, UI events are retargeted and mutation events are stopped. Exceptions to the rule are noted below.
Focus and Blur Events
When a focus or blur event crosses a scope boundary, the bound element is checked to see if it is focusable, i.e., if the user agent would normally fire a focus or blur event on the element. If the bound element is focusable, then the event is retargeted. If not, then the event is stopped. If anonymous content underneath a focusable bound element blurs and anonymous content also underneath the bound element takes focus, then the blur and focus events are both stopped. As far as the bound element is concerned, it retains focus throughout the two events.
Anonymous content can receive focus when the user tabs through the document. The same rules apply. If the anonymous content is focusable, it can be tabbed into, but if the bound element is not focusable, the event will be stopped before it reaches the bound element.
In HTML4 the
tabindex attribute can be used to specify the tab order for focusable elements. This attribute can be specified on anonymous content. Each scope has a unique tab order. The tabindex values used in one scope are ignored by other scopes.
As an example, consider the HTML file upload control. It is a focusable element that in turn is made up of two focusable anonymous elements: a textfield and a button. Tab indices can be specified on the textfield and the button to dictate the order in which the components of the file control should be accessed when tabbing.
When the user tabs such that the file control should become focused, the user agent determines if any anonymous content should also become focused, using the tab order specified by the anonymous content elements. It then generates a focus event on the textfield inside the file control. As this event flows across scopes, it is retargeted to be a focus event on the file control itself.
Focus events should also be stopped if the bound element is already focused. For example, if the user has already focused the textfield within an HTML file upload control, then the file upload control is now also focused. If the user then focuses the button inside the file upload control, the focus event generated for the button is stopped before it reaches the file control, since the file control is already focused.
Because content in multiple scopes can be focused, the CSS
:focus pseudo-element is hierarchical. Style rules can be written with the assumption that they will match (in the above example) both the file control and the element focused inside the file control. In other words, an arbitrary chain of elements can be in the
:focus state at the same time.
Mouseover and Mouseout Events
Mouseover and mouseout events are retargeted if the mouse genuinely enters or exits the bound element (in addition to entering or exiting some anonymous content). If, however, the user has simply moved the mouse from one anonymous element to another, without entering or exiting the bound element itself, then the event is stopped.
For example, if the user enters the HTML file upload control from the left, a mouseover event is generated for the anonymous textfield. Because this event also constitutes a mouseover of the file control itself, the event is retargeted when it flows across scopes. If the user then moves the mouse from the textfield to the button, a mouseout is generated for the textfield, followed by a mouseover of the button.
Since neither of these events constitutes a mouseover or mouseout of the file control itself, the events are not allowed to flow to the file control. If the user continues moving to the right and leaves the button, then the mouseout generated will be retargeted, since the file control will also have been exited.
Anonymous Content and CSS
Selectors and Scopes
Bindings can interleave anonymous elements between the bound element and its explicit children. See Insertion Points for more information. In this situation, a new tree emerges that is different from the explicit content node tree. In addition to having a single explicit parent (the bound element) the explicit children also have an arbitrary set of anonymous parents (created by bindings when child insertion points or
element tags were used). Child, descendant and sibling selectors will match on any path of anonymous and explicit elements.
As far as CSS is concerned, anonymous content nodes are children (or descendants) of the bound element, they are ancestors of explicit content, and they are siblings of the explicit content. Style rules using the child, descendant or sibling selectors transparently cross binding scopes and operate on the altered and original content models.
The final modified content tree determines how CSS properties (e.g., fonts and colors) are inherited. An element either ends up underneath its explicit parent (just as in the content model), or it ends up being nested through a series of insertion points. When nested, it inherits from the innermost anonymous parent.
A binding file can load stylesheets using the
stylesheet element. By default these stylesheets apply to the bound element and to all anonymous content generated by all bindings attached to the bound element. These sheets have the same origin as the sheet with the rule responsible for the binding. Stylesheets loaded by bindings that are attached using the DOM are treated as author-level sheets.
[Editor's Note: Binding inheritance complicatesthis cascade, since an author-level DOM binding could inherit from a user-level binding. If both load sheets, what level do those sheets belong to in the cascade?]
Sheets are always walked from the innermost scope to the outermost scope. With this ordering a binding that defines a widget can define a default look for the widget that can then be easily overridden by a client of the widget. For multiple bindings attached to the same element, the sheets are walked from the base binding down to the most derived binding.
Bindings can fine-tune the control of the stylesheet scoping with
inheritstyle attribute, it indicates whether or not author sheets defined at outer scopes affect the anonymous content generated by the binding. For the primary generating binding only, this attribute is checked to see if any author sheets at outer levels of scoping should be applied to the anonymous content generated by the bindings attached to the bound element. If this attribute is set, the rules specified in any author sheets at outer scopes are not walked. By default, stylesheets specified in bindings files are applied only to the bound element and to anonymous content generated by bindings attached to the element.
User agent sheets and user sheets are always applied to all scopes.