Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Other: Rename writer.setMarker() to writer.addMarker().
Browse files Browse the repository at this point in the history
  • Loading branch information
@jodator
jodator committed Apr 4, 2018
1 parent 87f54d8 commit 7d00bb6
Show file tree
Hide file tree
Showing 13 changed files with 98 additions and 98 deletions.
4 changes: 2 additions & 2 deletions src/model/delta/markerdelta.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import Delta from './delta';
import DeltaFactory from './deltafactory';

/**
* To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#setMarker Batch#setMarker}
* and {@link module:engine/model/writer~Writer#removeMarker Batch#removeMarker} methods use the `MarkerDelta` class which inherits
* To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#addMarker Writer#addMarker}
* and {@link module:engine/model/writer~Writer#removeMarker Writer#removeMarker} methods use the `MarkerDelta` class which inherits
* from the `Delta` class and may overwrite some methods.
*
* @extends module:engine/model/delta/delta~Delta
Expand Down
8 changes: 4 additions & 4 deletions src/model/markercollection.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
* {@link module:engine/model/markercollection~MarkerCollection#event:update} event.
*
* To create, change or remove makers use {@link module:engine/model/writer~Writer model writers'} methods:
* {@link module:engine/model/writer~Writer#setMarker} or {@link module:engine/model/writer~Writer#removeMarker}. Since
* {@link module:engine/model/writer~Writer#addMarker} or {@link module:engine/model/writer~Writer#removeMarker}. Since
* the writer is the only proper way to change the data model it is not possible to change markers directly using this
* collection. All markers created by the writer will be automatically added to this collection.
*
Expand Down Expand Up @@ -275,11 +275,11 @@ mix( MarkerCollection, EmitterMixin );
* Therefore, they are handled in the undo stack and synchronized between clients if the collaboration plugin is enabled.
* This type of markers is useful for solutions like spell checking or comments.
*
* Both type of them should be added / updated by {@link module:engine/model/writer~Writer#setMarker}
* Both type of them should be added / updated by {@link module:engine/model/writer~Writer#addMarker}
* and removed by {@link module:engine/model/writer~Writer#removeMarker} methods.
*
* model.change( ( writer ) => {
* const marker = writer.setMarker( name, { range, usingOperation: true } );
* const marker = writer.addMarker( name, { range, usingOperation: true } );
*
* // ...
*
Expand Down Expand Up @@ -343,7 +343,7 @@ class Marker {
/**
* Returns value of flag indicates if the marker is managed using operations or not.
* See {@link ~Marker marker class description} to learn more about marker types.
* See {@link module:engine/model/writer~Writer#setMarker}.
* See {@link module:engine/model/writer~Writer#addMarker}.
*
* @returns {Boolean}
*/
Expand Down
20 changes: 10 additions & 10 deletions src/model/writer.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ export default class Writer {
markerRange.end._getCombined( rangeRootPosition, position )
);

this.setMarker( markerName, { range, usingOperation: true } );
this.addMarker( markerName, { range, usingOperation: true } );
}
}
}
Expand Down Expand Up @@ -792,11 +792,11 @@ export default class Writer {
*
* Create marker directly base on marker's name:
*
* setMarker( markerName, { range, usingOperation: false } );
* addMarker( markerName, { range, usingOperation: false } );
*
* Create marker using operation:
*
* setMarker( markerName, { range, usingOperation: true } );
* addMarker( markerName, { range, usingOperation: true } );
*
* Note: For efficiency reasons, it's best to create and keep as little markers as possible.
*
Expand All @@ -808,17 +808,17 @@ export default class Writer {
* @param {module:engine/model/range~Range} options.range Marker range.
* @returns {module:engine/model/markercollection~Marker} Marker that was set.
*/
setMarker( name, options ) {
addMarker( name, options ) {
this._assertWriterUsedCorrectly();

if ( !options || typeof options.usingOperation != 'boolean' ) {
/**
* The options.usingOperations parameter is required when adding a new marker.
*
* @error writer-setMarker-no-usingOperations
* @error writer-addMarker-no-usingOperations
*/
throw new CKEditorError(
'writer-setMarker-no-usingOperations: The options.usingOperations parameter is required when adding a new marker.'
'writer-addMarker-no-usingOperations: The options.usingOperations parameter is required when adding a new marker.'
);
}

Expand All @@ -829,18 +829,18 @@ export default class Writer {
/**
* Marker with provided name already exists.
*
* @error writer-setMarker-marker-exists
* @error writer-addMarker-marker-exists
*/
throw new CKEditorError( 'writer-setMarker-marker-exists: Marker with provided name already exists.' );
throw new CKEditorError( 'writer-addMarker-marker-exists: Marker with provided name already exists.' );
}

if ( !range ) {
/**
* Range parameter is required when adding a new marker.
*
* @error writer-setMarker-no-range
* @error writer-addMarker-no-range
*/
throw new CKEditorError( 'writer-setMarker-no-range: Range parameter is required when adding a new marker.' );
throw new CKEditorError( 'writer-addMarker-no-range: Range parameter is required when adding a new marker.' );
}

if ( !usingOperation ) {
Expand Down
6 changes: 3 additions & 3 deletions tests/controller/datacontroller.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ describe( 'DataController', () => {
model.change( writer => {
writer.insert( modelElement, modelRoot, 0 );
const range = Range.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 );
writer.setMarker( 'marker:a', { range, usingOperation: true } );
writer.addMarker( 'marker:a', { range, usingOperation: true } );
} );

const viewDocumentFragment = data.toView( modelElement );
Expand All @@ -432,8 +432,8 @@ describe( 'DataController', () => {
const rangeA = Range.createFromParentsAndOffsets( modelP1, 1, modelP1, 3 );
const rangeB = Range.createFromParentsAndOffsets( modelP2, 0, modelP2, 2 );

writer.setMarker( 'marker:a', { range: rangeA, usingOperation: true } );
writer.setMarker( 'marker:b', { range: rangeB, usingOperation: true } );
writer.addMarker( 'marker:a', { range: rangeA, usingOperation: true } );
writer.addMarker( 'marker:b', { range: rangeB, usingOperation: true } );
} );

const viewDocumentFragment = data.toView( modelP1 );
Expand Down
14 changes: 7 additions & 7 deletions tests/controller/editingcontroller.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

expect( getViewData( editing.view, { withoutSelection: true } ) )
Expand All @@ -246,7 +246,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

model.change( writer => {
Expand All @@ -261,7 +261,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) );
Expand All @@ -278,7 +278,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
writer.insertText( 'xyz', new ModelPosition( modelRoot, [ 1, 0 ] ) );
} );

Expand All @@ -290,7 +290,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

model.change( writer => {
Expand All @@ -308,7 +308,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

model.change( writer => {
Expand All @@ -326,7 +326,7 @@ describe( 'EditingController', () => {
const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) );

model.change( writer => {
writer.setMarker( 'marker', { range, usingOperation: false } );
writer.addMarker( 'marker', { range, usingOperation: false } );
} );

model.change( writer => {
Expand Down
Loading

0 comments on commit 7d00bb6

Please sign in to comment.