Răsfoiți Sursa

Simplified change event in treeView.Selection.

Szymon Kupś 9 ani în urmă
părinte
comite
ba35d34878

+ 13 - 13
packages/ckeditor5-engine/src/treeview/selection.js

@@ -110,13 +110,13 @@ export default class Selection {
 	 * Throws {@link utils.CKEditorError CKEditorError} `view-selection-range-intersects` if added range intersects
 	 * with ranges already stored in Selection instance.
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 * @param {engine.treeView.Range} range
 	 */
 	addRange( range, isBackward ) {
 		this._pushRange( range );
 		this._lastRangeBackward = !!isBackward;
-		this.fire( 'change:range' );
+		this.fire( 'change' );
 	}
 
 	/**
@@ -209,7 +209,7 @@ export default class Selection {
 	/**
 	 * Removes range at given index.
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 * @param {Number} index
 	 * @returns {engine.treeView.Range|null} Returns removed range or `null` if there is no range under given index.
 	 */
@@ -217,7 +217,7 @@ export default class Selection {
 		const removed = this._ranges.splice( index, 1 );
 
 		if ( removed.length ) {
-			this.fire( 'change:range' );
+			this.fire( 'change' );
 
 			return removed[ 0 ];
 		}
@@ -228,12 +228,12 @@ export default class Selection {
 	/**
 	 * Removes all ranges that were added to the selection.
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 */
 	removeAllRanges() {
 		if ( this._ranges.length ) {
 			this._ranges = [];
-			this.fire( 'change:range' );
+			this.fire( 'change' );
 		}
 	}
 
@@ -243,7 +243,7 @@ export default class Selection {
 	 * {@link engine.treeView.Selection#focus focus}. Accepts a flag describing in which way the selection is made
 	 * (see {@link engine.treeView.Selection#addRange addRange}).
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 * @param {Array.<engine.treeView.Range>} newRanges Array of ranges to set.
 	 * @param {Boolean} [isLastBackward] Flag describing if last added range was selected forward - from start to end
 	 * (`false`) or backward - from end to start (`true`). Defaults to `false`.
@@ -256,7 +256,7 @@ export default class Selection {
 		}
 
 		this._lastRangeBackward = !!isLastBackward;
-		this.fire( 'change:range' );
+		this.fire( 'change' );
 	}
 
 	/**
@@ -264,14 +264,14 @@ export default class Selection {
 	 * All ranges will be removed beside one collapsed range. Nothing will be changed if there are no ranges stored
 	 * inside selection.
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 */
 	collapseToStart() {
 		const startPosition = this.getFirstPosition();
 
 		if ( startPosition !== null ) {
 			this.setRanges( [ new Range( startPosition, startPosition ) ] );
-			this.fire( 'change:range' );
+			this.fire( 'change' );
 		}
 	}
 
@@ -280,14 +280,14 @@ export default class Selection {
 	 * All ranges will be removed beside one collapsed range. Nothing will be changed if there are no ranges stored
 	 * inside selection.
 	 *
-	 * @fires engine.treeView.Selection#change:range
+	 * @fires engine.treeView.Selection#change
 	 */
 	collapseToEnd() {
 		const endPosition = this.getLastPosition();
 
 		if ( endPosition !== null ) {
 			this.setRanges( [ new Range( endPosition, endPosition ) ] );
-			this.fire( 'change:range' );
+			this.fire( 'change' );
 		}
 	}
 
@@ -326,5 +326,5 @@ utils.mix( Selection, EmitterMixin );
 /**
  * Fired whenever selection ranges are changed through {@link engine.treeView.Selection Selection API}.
  *
- * @event engine.treeView.Selection#change:range
+ * @event engine.treeView.Selection#change
  */

+ 6 - 6
packages/ckeditor5-engine/tests/treeview/selection.js

@@ -119,7 +119,7 @@ describe( 'Selection', () => {
 		} );
 
 		it( 'should fire change event', ( done ) => {
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.getRangeAt( 0 ).isEqual( range1 ) ).to.be.true;
 				done();
 			} );
@@ -259,7 +259,7 @@ describe( 'Selection', () => {
 		it( 'should fire change event', ( done ) => {
 			selection.addRange( range1 );
 
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.rangeCount ).to.equal( 0 );
 				done();
 			} );
@@ -273,7 +273,7 @@ describe( 'Selection', () => {
 			selection.addRange( range1 );
 			selection.addRange( range2 );
 
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.rangeCount ).to.equal( 0 );
 				done();
 			} );
@@ -294,7 +294,7 @@ describe( 'Selection', () => {
 		it( 'should add ranges and fire change event', ( done ) => {
 			selection.addRange( range1 );
 
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.rangeCount ).to.equal( 2 );
 				expect( selection.getRangeAt( 0 ).isEqual( range2 ) ).to.be.true;
 				expect( selection.getRangeAt( 0 ) ).is.not.equal( range2 );
@@ -310,7 +310,7 @@ describe( 'Selection', () => {
 	describe( 'collapseToStart', () => {
 		it( 'should collapse to start position and fire change event', ( done ) => {
 			selection.setRanges( [ range1, range2, range3 ] );
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.rangeCount ).to.equal( 1 );
 				expect( selection.isCollapsed ).to.be.true;
 				expect( selection.getRangeAt( 0 ).start.isEqual( range2.start ) ).to.be.true;
@@ -333,7 +333,7 @@ describe( 'Selection', () => {
 	describe( 'collapseToEnd', () => {
 		it( 'should collapse to end position and fire change event', ( done ) => {
 			selection.setRanges( [ range1, range2, range3 ] );
-			selection.once( 'change:range', () => {
+			selection.once( 'change', () => {
 				expect( selection.rangeCount ).to.equal( 1 );
 				expect( selection.isCollapsed ).to.be.true;
 				expect( selection.getRangeAt( 0 ).end.isEqual( range3.end ) ).to.be.true;