abstract ve.dm.Model

Describe a single attribute change in the model

Describe attribute changes in the model

Extra RDFa types that the element is allowed to have.

Compare two attribute strings and return an HTML diff

Get hash object of a linear model data element.

Array of RDFa types that this model should be a match candidate for.

Check if this element is of the same type as another element for the purposes of diffing.

Static function to convert a DOM element or set of sibling DOM elements to a linear model element for this model type.

This function is only called if this model "won" the matching for the first DOM element, so domElements[0] will match this model's matching rule. There is usually only one DOM node in domElements[]. Multiple elements will only be passed if this model supports about groups. If there are multiple nodes, the nodes are all adjacent siblings in the same about group (i.e. they are grouped together because they have the same value for the about attribute).

The converter has some state variables that can be obtained by this function:

• if converter.isExpectingContent() returns true, the converter expects a content element
• if converter.isInWrapper() returns true, the returned element will be put in a wrapper paragraph generated by the converter (this is only relevant if isExpectingContent() is true)
• converter.canCloseWrapper() returns true if the current wrapper paragraph can be closed, and false if it can't be closed or if there is no active wrapper

This function is allowed to return a content element when context indicates that a non-content element is expected or vice versa. If that happens, the converter deals with it in the following way:

• if a non-content element is expected but a content element is returned:
  • open a wrapper paragraph
  • put the returned element in the wrapper
• if a content element is expected but a non-content element is returned:
  • if we are in a wrapper paragraph:
    • if we can close the wrapper:
      • close the wrapper
      • insert the returned element right after the end of the wrapper
    • if we can't close the wrapper:
      • alienate the element
  • if we aren't in a wrapper paragraph:
    • alienate the element

For these purposes, annotations are considered content. Meta-items can occur anywhere, so if a meta-element is returned no special action is taken. Note that "alienate" always means an alien node (ve.dm.AlienNode) will be generated, never an alien meta-item (ve.dm.AlienMetaItem), regardless of whether the subclass attempting the conversion is a node or a meta-item.

The returned linear model element must have a type property set to a registered model name (usually the model's own .static.name, but that's not required). It may optionally have an attributes property set to an object with key-value pairs. Any other properties are not allowed.

This function may return a single linear model element, or an array of balanced linear model data. If this function needs to recursively convert a DOM node (e.g. a child of one of the DOM elements passed in), it can call converter.getDataFromDomSubtree( domElement ). Note that if an array is returned, the converter will not descend into the DOM node's children; the model will be assumed to have handled those children.

Static function to convert a linear model data element for this model type back to one or more DOM elements.

If this model is a node with handlesOwnChildren set to true, dataElement will be an array of the linear model data of this node and all of its children, rather than a single element. In this case, this function may want to recursively convert linear model data to DOM, which can be done with ve.dm.Converter#getDomSubtreeFromData.

NOTE: If this function returns multiple DOM elements, the DOM elements produced by the children of this model (if it's a node and has children) will be attached to the first DOM element in the array. For annotations, only the first element is used, and any additional elements are ignored.

Utility function for wrapping text in a tag, equivalent to $( '<tag>' ).text( text )