should be the outermost attribute element (inside table)', () => {
editor.conversion.for( 'downcast' ).attributeToElement( { model: 'bold', view: 'b' } );
setModelData( model,
'' +
'<$text bold="true">foo bar baz$text> ' +
'
'
);
const paragraph = model.document.getRoot().getChild( 0 ).getChild( 0 ).getChild( 0 ).getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 0 ), writer.createPositionAt( paragraph, 'end' ) ),
usingOperation: true,
affectsData: true
} );
} );
assertEqualMarkup( editor.getData(),
' '
);
assertEqualMarkup( getViewData( editor.editing.view, { withoutSelection: true } ),
'' +
'
' +
'' +
' '
);
} );
} );
describe( 'flattening exception markers', () => {
it( 'should fix non-flat marker range (start is higher in tree)', () => {
setModelData( model, '' );
const tableCell = model.document.getRoot().getNodeByPath( [ 0, 0, 0 ] );
const paragraph = model.document.getRoot().getNodeByPath( [ 0, 0, 0, 0 ] );
model.change( writer => {
writer.addMarker( `restrictedEditingException:${ 1 }`, {
range: writer.createRange(
writer.createPositionAt( paragraph, 0 ),
writer.createPositionAt( tableCell, 'end' )
),
usingOperation: true,
affectsData: true
} );
} );
const marker = model.markers.get( 'restrictedEditingException:1' );
expect( marker.getStart().parent ).to.equal( marker.getEnd().parent );
expect( marker.getStart().path ).to.deep.equal( [ 0, 0, 0, 0, 0 ] );
expect( marker.getEnd().path ).to.deep.equal( [ 0, 0, 0, 0, 11 ] );
} );
it( 'should fix non-flat marker range (end is higher in tree)', () => {
setModelData( model, '' );
const tableCell = model.document.getRoot().getNodeByPath( [ 0, 0, 0 ] );
const paragraph = model.document.getRoot().getNodeByPath( [ 0, 0, 0, 0 ] );
model.change( writer => {
writer.addMarker( `restrictedEditingException:${ 1 }`, {
range: writer.createRange(
writer.createPositionAt( tableCell, 0 ),
writer.createPositionAt( paragraph, 'end' )
),
usingOperation: true,
affectsData: true
} );
} );
const marker = model.markers.get( 'restrictedEditingException:1' );
expect( marker.getStart().parent ).to.equal( marker.getEnd().parent );
expect( marker.getStart().path ).to.deep.equal( [ 0, 0, 0, 0, 0 ] );
expect( marker.getEnd().path ).to.deep.equal( [ 0, 0, 0, 0, 11 ] );
} );
} );
} );
describe( 'editing behavior', () => {
beforeEach( async () => {
editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
model = editor.model;
} );
afterEach( () => {
return editor.destroy();
} );
it( 'should keep markers in the view when editable region is edited', () => {
setModelData( model,
'foo bar baz ' +
'xxx y[]yy zzz '
);
const firstParagraph = model.document.getRoot().getChild( 0 );
const secondParagraph = model.document.getRoot().getChild( 1 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
writer.addMarker( 'restrictedEditingException:2', {
range: writer.createRange(
writer.createPositionAt( secondParagraph, 4 ),
writer.createPositionAt( secondParagraph, 7 )
),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
model.insertContent( writer.createText( 'R', model.document.selection.getAttributes() ) );
} );
expect( editor.getData() ).to.equal(
'foo bar baz
' +
'xxx yRyy zzz
' );
expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal(
'foo bar baz
' +
'xxx yRyy zzz
' );
} );
it( 'should block user typing outside exception markers', () => {
setModelData( model, 'foo []bar baz ' );
editor.execute( 'input', { text: 'X' } );
assertEqualMarkup( getModelData( model ), 'foo []bar baz ' );
} );
it( 'should not block user typing inside exception marker', () => {
setModelData( model, '[]foo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.setSelection( firstParagraph, 5 );
} );
editor.execute( 'input', { text: 'X' } );
assertEqualMarkup( getModelData( model ), 'foo bX[]ar baz ' );
} );
it( 'should extend maker when typing on the marker boundary (end)', () => {
setModelData( model, 'foo bar[] baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
editor.execute( 'input', { text: 'X' } );
assertEqualMarkup( getModelData( model ), 'foo barX[] baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 8 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
it( 'should extend marker when typing on the marker boundary (start)', () => {
setModelData( model, 'foo []bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
editor.execute( 'input', { text: 'X' } );
assertEqualMarkup( getModelData( model ), 'foo X[]bar baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 8 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
it( 'should extend marker when typing on the marker boundary (collapsed marker)', () => {
setModelData( model, '[]foo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.setSelection( writer.createPositionAt( firstParagraph, 4 ) );
} );
editor.execute( 'input', { text: 'X' } );
assertEqualMarkup( getModelData( model ), 'foo X[]bar baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 5 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
it( 'should retain marker on non-typing change at the marker boundary (start)', () => {
setModelData( model, 'foo bar[] baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
model.change( writer => {
editor.execute( 'delete', {
selection: writer.createSelection( writer.createRange(
writer.createPositionAt( firstParagraph, 4 ),
writer.createPositionAt( firstParagraph, 6 )
) )
} );
editor.execute( 'input', {
text: 'XX',
range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ) )
} );
} );
assertEqualMarkup( getModelData( model ), 'foo XX[]r baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 7 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
it( 'should retain marker on non-typing change at marker boundary (end)', () => {
setModelData( model, 'foo bar[] baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
model.change( writer => {
editor.execute( 'delete', {
selection: writer.createSelection( writer.createRange(
writer.createPositionAt( firstParagraph, 5 ),
writer.createPositionAt( firstParagraph, 7 )
) )
} );
editor.execute( 'input', {
text: 'XX',
range: writer.createRange( writer.createPositionAt( firstParagraph, 5 ) )
} );
} );
assertEqualMarkup( getModelData( model ), 'foo bXX[] baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 7 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
it( 'should not move collapsed marker to $graveyard', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange(
writer.createPositionAt( firstParagraph, 4 ),
writer.createPositionAt( firstParagraph, 5 )
),
usingOperation: true,
affectsData: true
} );
} );
editor.execute( 'delete' );
assertEqualMarkup( getModelData( model ), 'foo []ar baz ' );
const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
const expectedRange = model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 4 )
);
expect( markerRange.isEqual( expectedRange ) ).to.be.true;
} );
} );
describe( 'enforcing restrictions on deleteContent', () => {
beforeEach( async () => {
editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
model = editor.model;
} );
afterEach( async () => {
await editor.destroy();
} );
it( 'should not allow to delete content outside restricted area', () => {
setModelData( model, '[]foo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 3, 9, firstParagraph );
model.change( writer => {
writer.setSelection( firstParagraph, 2 );
} );
model.deleteContent( model.document.selection );
assertEqualMarkup( getModelData( model ), 'fo[]o bar baz ' );
} );
it( 'should trim deleted content to a exception marker (focus in marker)', () => {
setModelData( model, '[]foofoo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 3, 9, firstParagraph );
model.change( writer => {
const selection = writer.createSelection( writer.createRange(
writer.createPositionAt( firstParagraph, 0 ),
writer.createPositionAt( firstParagraph, 6 )
) );
model.deleteContent( selection );
} );
assertEqualMarkup( getModelData( model ), '[]foo bar baz ' );
} );
it( 'should trim deleted content to a exception marker (anchor in marker)', () => {
setModelData( model, '[]foo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
model.change( writer => {
const selection = writer.createSelection( writer.createRange(
writer.createPositionAt( firstParagraph, 5 ),
writer.createPositionAt( firstParagraph, 8 )
) );
model.deleteContent( selection );
} );
assertEqualMarkup( getModelData( model ), '[]foo b baz ' );
} );
it( 'should trim deleted content to a exception marker and alter the selection argument (delete command integration)', () => {
setModelData( model, '[]foofoo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 3, 9, firstParagraph );
model.change( writer => {
writer.setSelection( firstParagraph, 6 );
} );
editor.execute( 'delete', { unit: 'word' } );
assertEqualMarkup( getModelData( model ), 'foo[] bar baz ' );
} );
it( 'should work with document selection', () => {
setModelData( model, 'f[oo bar] baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 2, 'end', firstParagraph );
model.change( () => {
model.deleteContent( model.document.selection );
} );
assertEqualMarkup( getModelData( model, { withoutSelection: true } ), 'fo baz ' );
} );
} );
describe( 'enforcing restrictions on input command', () => {
let firstParagraph;
beforeEach( async () => {
editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
model = editor.model;
setModelData( model, '[]foo bar baz ' );
firstParagraph = model.document.getRoot().getChild( 0 );
} );
afterEach( async () => {
await editor.destroy();
} );
it( 'should prevent changing text before exception marker', () => {
addExceptionMarker( 4, 7, firstParagraph );
model.change( writer => {
writer.setSelection( firstParagraph, 5 );
} );
// Simulate native spell-check action.
editor.execute( 'input', {
text: 'xxxxxxx',
range: model.createRange(
model.createPositionAt( firstParagraph, 0 ),
model.createPositionAt( firstParagraph, 7 )
)
} );
assertEqualMarkup( getModelData( model ), 'foo b[]ar baz ' );
} );
it( 'should prevent changing text before exception marker (native spell-check simulation)', () => {
addExceptionMarker( 4, 7, firstParagraph );
model.change( writer => {
writer.setSelection( firstParagraph, 5 );
} );
// Simulate native spell-check action.
editor.execute( 'input', {
text: 'xxxxxxx',
range: model.createRange(
model.createPositionAt( firstParagraph, 4 ),
model.createPositionAt( firstParagraph, 9 )
)
} );
assertEqualMarkup( getModelData( model ), 'foo b[]ar baz ' );
} );
it( 'should prevent changing text before (change crossing different markers)', () => {
addExceptionMarker( 0, 4, firstParagraph );
addExceptionMarker( 7, 9, firstParagraph, 2 );
model.change( writer => {
writer.setSelection( firstParagraph, 2 );
} );
// Simulate native spell-check action.
editor.execute( 'input', {
text: 'xxxxxxx',
range: model.createRange(
model.createPositionAt( firstParagraph, 2 ),
model.createPositionAt( firstParagraph, 8 )
)
} );
assertEqualMarkup( getModelData( model ), 'fo[]o bar baz ' );
} );
it( 'should allow changing text inside single marker', () => {
addExceptionMarker( 0, 9, firstParagraph );
model.change( writer => {
writer.setSelection( firstParagraph, 2 );
} );
// Simulate native spell-check action.
editor.execute( 'input', {
text: 'xxxxxxx',
range: model.createRange(
model.createPositionAt( firstParagraph, 2 ),
model.createPositionAt( firstParagraph, 8 )
)
} );
assertEqualMarkup( getModelData( model ), 'foxxxxxxx[]baz ' );
} );
} );
describe( 'clipboard', () => {
let viewDoc;
beforeEach( async () => {
editor = await VirtualTestEditor.create( {
plugins: [ Paragraph, BoldEditing, ItalicEditing, StrikethroughEditing, BlockQuoteEditing, LinkEditing, Typing, Clipboard,
RestrictedEditingModeEditing
]
} );
model = editor.model;
viewDoc = editor.editing.view.document;
} );
afterEach( async () => {
await editor.destroy();
} );
describe( 'cut', () => {
it( 'should be blocked outside exception markers', () => {
setModelData( model, 'foo []bar baz ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'cut'
} );
sinon.assert.notCalled( spy );
assertEqualMarkup( getModelData( model ), 'foo []bar baz ' );
} );
it( 'should cut selected content inside exception marker (selection inside marker)', () => {
setModelData( model, 'foo b[a]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'cut'
} );
assertEqualMarkup( getModelData( model ), 'foo b[]r baz ' );
} );
it( 'should cut selected content inside exception marker (selection touching marker start)', () => {
setModelData( model, 'foo [ba]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'cut'
} );
assertEqualMarkup( getModelData( model ), 'foo []r baz ' );
} );
it( 'should cut selected content inside exception marker (selection touching marker end)', () => {
setModelData( model, 'foo b[ar] baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'cut'
} );
assertEqualMarkup( getModelData( model ), 'foo b[] baz ' );
} );
} );
describe( 'copy', () => {
it( 'should not be blocked outside exception markers', () => {
setModelData( model, 'foo []bar baz ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'copy'
} );
sinon.assert.calledOnce( spy );
assertEqualMarkup( getModelData( model ), 'foo []bar baz ' );
} );
it( 'should not be blocked inside exception marker', () => {
setModelData( model, '[]foo bar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
const spy = sinon.spy();
viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange(
writer.createPositionAt( firstParagraph, 4 ),
writer.createPositionAt( firstParagraph, 7 )
),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.setSelection( firstParagraph, 5 );
} );
viewDoc.fire( 'clipboardOutput', {
content: {
isEmpty: true
},
method: 'copy'
} );
sinon.assert.calledOnce( spy );
assertEqualMarkup( getModelData( model ), 'foo b[]ar baz ' );
} );
} );
describe( 'paste', () => {
beforeEach( () => {
// Required when testing without DOM using VirtualTestEditor - Clipboard feature scrolls after paste event.
sinon.stub( editor.editing.view, 'scrollToTheSelection' );
} );
it( 'should be blocked outside exception markers (collapsed selection)', () => {
setModelData( model, 'foo []bar baz ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardInput', {
dataTransfer: {
getData: sinon.spy()
}
} );
sinon.assert.notCalled( spy );
assertEqualMarkup( getModelData( model ), 'foo []bar baz ' );
} );
it( 'should be blocked outside exception markers (non-collapsed selection)', () => {
setModelData( model, '[foo bar baz] ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardInput', {
dataTransfer: {
getData: sinon.spy()
}
} );
sinon.assert.notCalled( spy );
assertEqualMarkup( getModelData( model ), '[foo bar baz] ' );
} );
it( 'should be blocked outside exception markers (non-collapsed selection, starts inside exception marker)', () => {
setModelData( model, 'foo b[ar baz] ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardInput', {
dataTransfer: {
getData: sinon.spy()
}
} );
sinon.assert.notCalled( spy );
assertEqualMarkup( getModelData( model ), 'foo b[ar baz] ' );
} );
it( 'should be blocked outside exception markers (non-collapsed selection, ends inside exception marker)', () => {
setModelData( model, '[foo ba]r baz ' );
const spy = sinon.spy();
viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
viewDoc.fire( 'clipboardInput', {
dataTransfer: {
getData: sinon.spy()
}
} );
sinon.assert.notCalled( spy );
assertEqualMarkup( getModelData( model ), '[foo ba]r baz ' );
} );
describe( 'collapsed selection', () => {
it( 'should paste text inside exception marker', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo bXXX[]ar baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 10 ] );
} );
it( 'should paste allowed text attributes inside exception marker', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( {
'text/html': 'XXX
',
'text/plain': 'XXX'
} )
} );
assertEqualMarkup( getModelData( model ),
'foo b<$text bold="true" italic="true" linkHref="foo">XXX$text>' +
// The link attribute is removed from selection after pasting.
// See https://github.com/ckeditor/ckeditor5/issues/6053.
'<$text bold="true" italic="true">[]$text>ar baz '
);
assertMarkerRangePaths( [ 0, 4 ], [ 0, 10 ] );
} );
it( 'should not allow to paste disallowed text attributes inside exception marker', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo bXXX[]ar baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 10 ] );
} );
it( 'should filter out disallowed attributes from other text attributes when pasting inside exception marker', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup(
getModelData( model ),
'foo b<$text bold="true" italic="true">XXX[]$text>ar baz '
);
assertMarkerRangePaths( [ 0, 4 ], [ 0, 10 ] );
} );
it( 'should not allow pasting block elements other then paragraph', () => {
setModelData( model, 'foo b[]ar baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo bXXX[]ar baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 10 ] );
} );
} );
describe( 'non-collapsed selection', () => {
it( 'should paste text inside exception marker', () => {
setModelData( model, 'foo b[a]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo bXXX[]r baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 9 ] );
} );
it( 'should paste allowed text attributes inside exception marker', () => {
setModelData( model, 'foo b[a]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo b<$text bold="true">XXX[]$text>r baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 9 ] );
} );
it( 'should not allow to paste disallowed text attributes inside exception marker', () => {
setModelData( model, 'foo b[a]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup( getModelData( model ), 'foo bXXX[]r baz ' );
assertMarkerRangePaths( [ 0, 4 ], [ 0, 9 ] );
} );
it( 'should filter out disallowed attributes from other text attributes when pasting inside exception marker', () => {
setModelData( model, 'foo b[a]r baz ' );
const firstParagraph = model.document.getRoot().getChild( 0 );
addExceptionMarker( 4, 7, firstParagraph );
viewDoc.fire( 'clipboardInput', {
dataTransfer: createDataTransfer( { 'text/html': 'XXX
', 'text/plain': 'XXX' } )
} );
assertEqualMarkup(
getModelData( model ),
'foo b<$text bold="true" italic="true">XXX[]$text>r baz '
);
assertMarkerRangePaths( [ 0, 4 ], [ 0, 9 ] );
} );
} );
} );
} );
describe( 'exception highlighting', () => {
let view;
beforeEach( async () => {
editor = await VirtualTestEditor.create( {
plugins: [ Paragraph, RestrictedEditingModeEditing, BoldEditing ]
} );
model = editor.model;
view = editor.editing.view;
} );
afterEach( () => {
return editor.destroy();
} );
it( 'should convert the highlight to a proper view classes', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
expect( getViewData( view ) ).to.equal(
'foo b{a}r baz
'
);
} );
it( 'should remove classes when selection is moved away from an exception', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
expect( getViewData( view ) ).to.equal(
'foo b{a}r baz
'
);
model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 0 ) );
expect( getViewData( view ) ).to.equal(
'{}foo bar baz
'
);
} );
it( 'should work correctly when selection is moved inside an exception', () => {
setModelData( model, '[]foo bar baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// []foo <$marker>bar$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
expect( getViewData( view ) ).to.equal(
'{}foo bar baz
'
);
model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 6 ) );
expect( getViewData( view ) ).to.equal(
'foo ba{}r baz
'
);
} );
describe( 'editing downcast conversion integration', () => {
it( 'works for the #insert event', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.insertText( 'FOO', { linkHref: 'url' }, model.document.selection.getFirstPosition() );
} );
expect( getViewData( view ) ).to.equal(
'foo bFOO{a}r baz
'
);
} );
it( 'works for the #remove event', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.remove( writer.createRange(
writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 ),
writer.createPositionAt( model.document.getRoot().getChild( 0 ), 6 )
) );
} );
expect( getViewData( view ) ).to.equal(
'foo b{}r baz
'
);
} );
it( 'works for the #attribute event', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.setAttribute( 'bold', true, writer.createRange(
model.document.selection.getFirstPosition().getShiftedBy( -1 ),
model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
);
} );
expect( getViewData( view ) ).to.equal(
'foo ' +
'' +
'b{a ' +
'}r ' +
' baz
'
);
} );
it( 'works for the #selection event', () => {
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
writer.setSelection( writer.createRange(
model.document.selection.getFirstPosition().getShiftedBy( -1 ),
model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
);
} );
expect( getViewData( view ) ).to.equal(
'foo {ba}r baz
'
);
} );
it( 'works for the addMarker and removeMarker events', () => {
editor.conversion.for( 'editingDowncast' ).markerToHighlight( { model: 'fooMarker', view: {} } );
setModelData( model, 'foo b[a]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo <$marker>b[a]r$marker> baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
model.change( writer => {
const range = writer.createRange(
writer.createPositionAt( model.document.getRoot().getChild( 0 ), 0 ),
writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 )
);
writer.addMarker( 'fooMarker', { range, usingOperation: true } );
} );
expect( getViewData( view ) ).to.equal(
'' +
'foo ' +
'' +
'b {a}r' +
' ' +
' baz
'
);
model.change( writer => writer.removeMarker( 'fooMarker' ) );
expect( getViewData( view ) ).to.equal(
'foo b{a}r baz
'
);
} );
} );
} );
describe( 'exception cycling with the keyboard', () => {
let view, domEvtDataStub;
beforeEach( async () => {
editor = await VirtualTestEditor.create( {
plugins: [ Paragraph, RestrictedEditingModeEditing, BoldEditing ]
} );
model = editor.model;
view = editor.editing.view;
domEvtDataStub = {
keyCode: getCode( 'Tab' ),
preventDefault: sinon.spy(),
stopPropagation: sinon.spy()
};
sinon.spy( editor, 'execute' );
} );
afterEach( () => {
return editor.destroy();
} );
it( 'should move to the closest next exception on tab key', () => {
setModelData( model, '[]foo bar baz qux ' );
const paragraph = model.document.getRoot().getChild( 0 );
// []foo bar baz qux
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
// []foo bar baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:2', {
range: writer.createRange( writer.createPositionAt( paragraph, 8 ), writer.createPositionAt( paragraph, 11 ) ),
usingOperation: true,
affectsData: true
} );
} );
view.document.fire( 'keydown', domEvtDataStub );
sinon.assert.calledOnce( editor.execute );
sinon.assert.calledWithExactly( editor.execute, 'goToNextRestrictedEditingException' );
sinon.assert.calledOnce( domEvtDataStub.preventDefault );
sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
} );
it( 'should let the focus go outside the editor on tab key when in the last exception', () => {
setModelData( model, 'foo qux[] ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo qux[]
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 0 ), writer.createPositionAt( paragraph, 3 ) ),
usingOperation: true,
affectsData: true
} );
} );
view.document.fire( 'keydown', domEvtDataStub );
sinon.assert.notCalled( editor.execute );
sinon.assert.notCalled( domEvtDataStub.preventDefault );
sinon.assert.notCalled( domEvtDataStub.stopPropagation );
} );
it( 'should move to the closest previous exception on shift+tab key', () => {
setModelData( model, 'foo bar baz qux[] ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo bar baz qux[]
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
// foo bar baz
model.change( writer => {
writer.addMarker( 'restrictedEditingException:2', {
range: writer.createRange( writer.createPositionAt( paragraph, 8 ), writer.createPositionAt( paragraph, 11 ) ),
usingOperation: true,
affectsData: true
} );
} );
domEvtDataStub.keyCode += getCode( 'Shift' );
view.document.fire( 'keydown', domEvtDataStub );
sinon.assert.calledOnce( editor.execute );
sinon.assert.calledWithExactly( editor.execute, 'goToPreviousRestrictedEditingException' );
sinon.assert.calledOnce( domEvtDataStub.preventDefault );
sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
} );
it( 'should let the focus go outside the editor on shift+tab when in the first exception', () => {
setModelData( model, '[]foo qux ' );
const paragraph = model.document.getRoot().getChild( 0 );
// []foo qux
model.change( writer => {
writer.addMarker( 'restrictedEditingException:1', {
range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
usingOperation: true,
affectsData: true
} );
} );
domEvtDataStub.keyCode += getCode( 'Shift' );
view.document.fire( 'keydown', domEvtDataStub );
sinon.assert.notCalled( editor.execute );
sinon.assert.notCalled( domEvtDataStub.preventDefault );
sinon.assert.notCalled( domEvtDataStub.stopPropagation );
} );
} );
describe( 'custom keydown behaviour', () => {
let view, evtData;
beforeEach( async () => {
editor = await VirtualTestEditor.create( {
plugins: [ Paragraph, RestrictedEditingModeEditing, BoldEditing ]
} );
model = editor.model;
view = editor.editing.view;
} );
afterEach( () => {
return editor.destroy();
} );
describe( 'Ctrl+A handler', () => {
beforeEach( async () => {
evtData = {
keyCode: getCode( 'A' ),
ctrlKey: true,
preventDefault: sinon.spy(),
stopPropagation: sinon.spy()
};
} );
describe( 'collapsed selection', () => {
it( 'should select text only within an exception when selection is inside an exception', () => {
setModelData( model, 'foo ba[]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo ba[]r baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
it( 'should select text only within an exception when selection is at the begining of an exception', () => {
setModelData( model, 'foo []bar baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo []bar baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
it( 'should select text only within an exception when selection is at the end of an exception', () => {
setModelData( model, 'foo bar[] baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo bar[] baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
it( 'should not change the selection if the caret is not inside an exception', () => {
setModelData( model, 'foo ba[]r baz ' );
// no markers
// foo ba[]r baz
view.document.fire( 'keydown', evtData );
sinon.assert.notCalled( evtData.preventDefault );
sinon.assert.notCalled( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo ba[]r baz ' );
} );
it( 'should not extend the selection outside an exception when press Ctrl+A second time', () => {
setModelData( model, 'foo b[]ar baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo b[]ar baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
view.document.fire( 'keydown', evtData );
sinon.assert.calledTwice( evtData.preventDefault );
sinon.assert.calledTwice( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
} );
describe( 'non-collapsed selection', () => {
it( 'should select text within an exception when a whole selection range is inside an exception', () => {
setModelData( model, 'fo[o ba]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// fo[o ba]r baz
addExceptionMarker( 0, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( '[foo bar] baz ' );
} );
it( 'should select text within an exception when end of selection range is equal exception end', () => {
setModelData( model, 'foo b[ar] baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo b[ar] baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
it( 'should select text within an exception when start of selection range is equal exception start', () => {
setModelData( model, 'foo [ba]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo [ba]r baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.calledOnce( evtData.preventDefault );
sinon.assert.calledOnce( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
it( 'should not select text within an exception when a part of the selection range is outside an exception', () => {
setModelData( model, 'fo[o ba]r baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// fo[o ba]r baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
sinon.assert.notCalled( evtData.preventDefault );
sinon.assert.notCalled( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'fo[o ba]r baz ' );
} );
it( 'should not extend the selection outside an exception when press Ctrl+A second time', () => {
setModelData( model, 'foo [bar] baz ' );
const paragraph = model.document.getRoot().getChild( 0 );
// foo [bar] baz
addExceptionMarker( 4, 7, paragraph );
view.document.fire( 'keydown', evtData );
view.document.fire( 'keydown', evtData );
sinon.assert.calledTwice( evtData.preventDefault );
sinon.assert.calledTwice( evtData.stopPropagation );
expect( getModelData( model ) ).to.equal( 'foo [bar] baz ' );
} );
} );
} );
} );
// Helper method that creates an exception marker inside given parent.
// Marker range is set to given position offsets (start, end).
function addExceptionMarker( startOffset, endOffset = startOffset, parent, id = 1 ) {
model.change( writer => {
writer.addMarker( `restrictedEditingException:${ id }`, {
range: writer.createRange(
writer.createPositionAt( parent, startOffset ),
writer.createPositionAt( parent, endOffset )
),
usingOperation: true,
affectsData: true
} );
} );
}
function createDataTransfer( data ) {
return {
getData( type ) {
return data[ type ];
}
};
}
function assertMarkerRangePaths( startPath, endPath, markerId = 1 ) {
const marker = model.markers.get( `restrictedEditingException:${ markerId }` );
expect( marker.getStart().path ).to.deep.equal( startPath );
expect( marker.getEnd().path ).to.deep.equal( endPath );
}
} );