Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | 1x 14x 1x 1x 1x 1x 4x 1x 11x 1x 15x 15x 15x 1x 14x 14x 14x 14x 14x 18x 16x 16x 2x 2x 2x 14x 18x 18x 4x 14x 14x 1x 4x 4x 4x 4x 4x 4x 2x 2x 2x 1x 1x 2x 1x 14x 14x 14x 14x 14x 14x 14x 14x 2x 2x 2x 14x 7x 7x 14x 14x 11x 11x 11x 18x 18x 5x 3x 1x 1x 1x 3x 2x 2x 3x 1x | /*!
* VisualEditor UserInterface IndentationAction class.
*
* @copyright See AUTHORS.txt
*/
/**
* Indentation action.
*
* @class
* @extends ve.ui.Action
*
* @constructor
* @param {ve.ui.Surface} surface Surface to act on
* @param {string} [source]
*/
ve.ui.IndentationAction = function VeUiIndentationAction() {
// Parent constructor
ve.ui.IndentationAction.super.apply( this, arguments );
};
/* Inheritance */
OO.inheritClass( ve.ui.IndentationAction, ve.ui.Action );
/* Static Properties */
ve.ui.IndentationAction.static.name = 'indentation';
ve.ui.IndentationAction.static.methods = [ 'increase', 'decrease' ];
/* Methods */
/**
* Indent content.
*
* @return {boolean} Indentation increase occurred
*/
ve.ui.IndentationAction.prototype.increase = function () {
return this.changeIndentation( 1 );
};
/**
* Unindent content.
*
* @return {boolean} Indentation decrease occurred
*/
ve.ui.IndentationAction.prototype.decrease = function () {
return this.changeIndentation( -1 );
};
/**
* Change indentation of content.
*
* @param {number} indent Indentation change, 1 or -1
* @return {boolean} Indentation decrease occurred
*/
ve.ui.IndentationAction.prototype.changeIndentation = function ( indent ) {
const surfaceModel = this.surface.getModel(),
selection = surfaceModel.getSelection();
if ( !( selection instanceof ve.dm.LinearSelection ) ) {
return false;
}
const documentModel = surfaceModel.getDocument();
const groups = documentModel.getCoveredSiblingGroups( selection.getRange() );
const fragments = [];
let changed = false;
// Build fragments from groups (we need their ranges since the nodes will be rebuilt on change)
groups.forEach( ( group ) => {
if ( group.grandparent && group.grandparent.getType() === 'list' ) {
fragments.push( surfaceModel.getLinearFragment( group.parent.getRange(), true ) );
changed = true;
} else Eif ( group.parent && group.parent.getType() === 'list' ) {
// In a slug, the node will be the listItem.
fragments.push( surfaceModel.getLinearFragment( group.nodes[ 0 ].getRange(), true ) );
changed = true;
}
} );
// Process each fragment (their ranges are automatically adjusted on change)
fragments.forEach( ( fragment ) => {
const listItem = documentModel.getBranchNodeFromOffset( fragment.getSelection().getRange().start );
if ( indent > 0 ) {
this.indentListItem( listItem );
} else {
this.unindentListItem( listItem );
}
} );
return changed;
};
/**
* Indent a list item.
*
* @param {ve.dm.ListItemNode} listItem List item to indent
* @throws {Error} listItem must be a ve.dm.ListItemNode
*/
ve.ui.IndentationAction.prototype.indentListItem = function ( listItem ) {
// This check should never fail
/* istanbul ignore next */
if ( !( listItem instanceof ve.dm.ListItemNode ) ) {
throw new Error( 'listItem must be a ve.dm.ListItemNode' );
}
/*
* Indenting a list item is done as follows:
*
* 1. Wrap the listItem in a list and a listItem (<li> --> <li><ul><li>)
* 2. Merge this wrapped listItem into the previous listItem if present
* (<li>Previous</li><li><ul><li>This --> <li>Previous<ul><li>This)
* 3. If this results in the wrapped list being preceded by another list,
* merge those lists.
*/
const listType = listItem.getParent().getAttribute( 'style' );
const listItemRange = listItem.getOuterRange();
// CAREFUL: after initializing the variables above, we cannot use the model tree!
// The first transaction will cause rebuilds so the nodes we have references to now
// will be detached and useless after the first transaction. Instead, inspect
// documentModel.data to find out things about the current structure.
const surfaceModel = this.surface.getModel();
// (1) Wrap the listItem in a list and a listItem
surfaceModel.getLinearFragment( listItemRange, true )
.wrapNodes( [ { type: 'listItem' }, { type: 'list', attributes: { style: listType } } ] );
const documentModel = surfaceModel.getDocument();
// (2) Merge the listItem into the previous listItem (if there is one)
if (
documentModel.data.getData( listItemRange.start ).type === 'listItem' &&
documentModel.data.getData( listItemRange.start - 1 ).type === '/listItem'
) {
let mergeStart = listItemRange.start - 1;
let mergeEnd = listItemRange.start + 1;
// (3) If this results in adjacent lists, merge those too
if (
documentModel.data.getData( mergeEnd ).type === 'list' &&
documentModel.data.getData( mergeStart - 1 ).type === '/list'
) {
mergeStart--;
mergeEnd++;
}
surfaceModel.getLinearFragment( new ve.Range( mergeStart, mergeEnd ), true ).removeContent();
}
// TODO If this listItem has a child list, split&unwrap it
};
/**
* Unindent a list item.
*
* TODO: Refactor functionality into {ve.dm.SurfaceFragment}.
*
* @param {ve.dm.ListItemNode} listItem List item to unindent
* @throws {Error} listItem must be a ve.dm.ListItemNode
*/
ve.ui.IndentationAction.prototype.unindentListItem = function ( listItem ) {
// This check should never fail
/* istanbul ignore next */
if ( !( listItem instanceof ve.dm.ListItemNode ) ) {
throw new Error( 'listItem must be a ve.dm.ListItemNode' );
}
let tx;
const surfaceModel = this.surface.getModel();
const documentModel = surfaceModel.getDocument();
const fragment = surfaceModel.getLinearFragment( listItem.getOuterRange(), true );
const list = listItem.getParent();
const listElement = list.getClonedElement();
const grandParentType = list.getParent().getType();
let listItemRange = listItem.getOuterRange();
/*
* Outdenting a list item is done as follows:
* 1. Split the parent list to isolate the listItem in its own list
* 1a. Split the list before the listItem if it's not the first child
* 1b. Split the list after the listItem if it's not the last child
* 2. If this isolated list's parent is not a listItem, unwrap the listItem and the isolated list, and stop.
* 3. Split the parent listItem to isolate the list in its own listItem
* 3a. Split the listItem before the list if it's not the first child
* 3b. Split the listItem after the list if it's not the last child
* 4. Unwrap the now-isolated listItem and the isolated list
*/
// TODO: Child list handling, gotta figure that out.
// CAREFUL: after initializing the variables above, we cannot use the model tree!
// The first transaction will cause rebuilds so the nodes we have references to now
// will be detached and useless after the first transaction. Instead, inspect
// documentModel.data to find out things about the current structure.
// (1) Split the listItem into a separate list
if ( documentModel.data.getData( listItemRange.start - 1 ).type !== 'list' ) {
// (1a) listItem is not the first child, split the list before listItem
tx = ve.dm.TransactionBuilder.static.newFromInsertion( documentModel, listItemRange.start,
[ { type: '/list' }, listElement ]
);
surfaceModel.change( tx );
// tx.translateRange( listItemRange ) doesn't do what we want
listItemRange = listItemRange.translate( 2 );
}
if ( documentModel.data.getData( listItemRange.end ).type !== '/list' ) {
// (1b) listItem is not the last child, split the list after listItem
tx = ve.dm.TransactionBuilder.static.newFromInsertion( documentModel, listItemRange.end,
[ { type: '/list' }, listElement ]
);
surfaceModel.change( tx );
// listItemRange is not affected by this transaction
}
let splitListRange = new ve.Range( listItemRange.start - 1, listItemRange.end + 1 );
if ( grandParentType !== 'listItem' ) {
// The user is trying to unindent a list item that's not nested
// (2) Unwrap both the list and the listItem, dumping the listItem's contents
// into the list's parent
surfaceModel.getLinearFragment( new ve.Range( listItemRange.start + 1, listItemRange.end - 1 ), true )
.unwrapNodes( 2 );
// Ensure paragraphs are not generated paragraphs now that they are not in a list
const children = fragment.getSiblingNodes();
for ( let i = 0, length = children.length; i < length; i++ ) {
const child = children[ i ].node;
if ( child.type === 'paragraph' && ve.getProp( child.element, 'internal', 'generated' ) ) {
surfaceModel.getLinearFragment( child.getOuterRange(), true ).convertNodes( 'paragraph', child.getAttributes(), {} );
}
}
} else {
// (3) Split the list away from parentListItem into its own listItem
// TODO factor common split logic somehow?
if ( documentModel.data.getData( splitListRange.start - 1 ).type !== 'listItem' ) {
// (3a) Split parentListItem before list
tx = ve.dm.TransactionBuilder.static.newFromInsertion( documentModel, splitListRange.start,
[ { type: '/listItem' }, { type: 'listItem' } ]
);
surfaceModel.change( tx );
// tx.translateRange( splitListRange ) doesn't do what we want
splitListRange = splitListRange.translate( 2 );
}
if ( documentModel.data.getData( splitListRange.end ).type !== '/listItem' ) {
// (3b) Split parentListItem after list
tx = ve.dm.TransactionBuilder.static.newFromInsertion( documentModel, splitListRange.end,
[ { type: '/listItem' }, { type: 'listItem' } ]
);
surfaceModel.change( tx );
// splitListRange is not affected by this transaction
}
// (4) Unwrap the list and its containing listItem
surfaceModel.getLinearFragment( new ve.Range( splitListRange.start + 1, splitListRange.end - 1 ), true )
.unwrapNodes( 2 );
}
};
/* Registration */
ve.ui.actionFactory.register( ve.ui.IndentationAction );
|