ve.dm.TransactionBuilder

Generate a transaction that annotates content.

Generate a transaction that changes one or more attributes.

Generate a transaction that converts elements that can contain content.

Build a transaction that inserts the contents of a document at a given offset.

This is typically used to merge changes to a document slice back into the main document. If newDoc is a document slice of doc, it's assumed that there were no changes to doc's internal list since the slice, so any differences between internal items that doc and newDoc have in common will be resolved in newDoc's favor.

Generate a transaction that inserts data at an offset.

Generate a transaction that removes data from a range.

There are three possible results from a removal:

• Remove content only
  • Occurs when the range starts and ends on elements of different type, depth or ancestry
• Remove entire elements and their content
  • Occurs when the range spans across an entire element
• Merge two elements by removing the end of one and the beginning of another
  • Occurs when the range starts and ends on elements of similar type, depth and ancestry

This function uses the following logic to decide what to actually remove:

1. Elements are only removed if range being removed covers the entire element
2. Elements can only be merged if ve.dm.Node#canBeMergedWith returns true
3. Merges take place at the highest common ancestor

Generate a transaction that replaces data in a range.

Generate a transaction that wraps, unwraps or replaces structure.

The unwrap parameters are checked against the actual model data, and an exception is thrown if the type fields don't match. This means you can omit attributes from the unwrap parameters, those are automatically picked up from the model data instead.

NOTE: This function currently does not fix invalid parent/child relationships, so it will happily convert paragraphs to listItems without wrapping them in a list if that's what you ask it to do. We'll probably fix this later but for now the caller is responsible for giving valid instructions.

Changing a paragraph to a header: Before: [ {type: 'paragraph'}, 'a', 'b', 'c', {type: '/paragraph'} ] newFromWrap( new ve.Range( 1, 4 ), [ {type: 'paragraph'} ], [ {type: 'heading', level: 1 } ] ); After: [ {type: 'heading', level: 1 }, 'a', 'b', 'c', {type: '/heading'} ]

Changing a set of paragraphs to a list: Before: [ {type: 'paragraph'}, 'a', {type: '/paragraph'}, {'type':'paragraph'}, 'b', {'type':'/paragraph'} ] newFromWrap( new ve.Range( 0, 6 ), [], [ {type: 'list' } ], [], [ {type: 'listItem', attributes: {styles: ['bullet']}} ] ); After: [ {type: 'list'}, {type: 'listItem', attributes: {styles: ['bullet']}}, {'type':'paragraph'} 'a', {type: '/paragraph'}, {type: '/listItem'}, {type: 'listItem', attributes: {styles: ['bullet']}}, {type: 'paragraph'}, 'b', {type: '/paragraph'}, {type: '/listItem'}, {type: '/list'} ]