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

Commit

Permalink
Remove default value of offset parameter from view methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
jodator committed Oct 4, 2018
1 parent 7999456 commit a740dbd
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion src/view/documentselection.js
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ export default class DocumentSelection {
* @protected
* @fires change
* @param {module:engine/view/item~Item|module:engine/view/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/view/item~Item view item}.
*/
_setFocus( itemOrPosition, offset ) {
Expand Down
2 changes: 1 addition & 1 deletion src/view/downcastwriter.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ export default class DowncastWriter {
* The location can be specified in the same form as {@link module:engine/view/position~Position.createAt} parameters.
*
* @param {module:engine/view/item~Item|module:engine/view/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/view/item~Item view item}.
*/
setSelectionFocus( itemOrPosition, offset ) {
Expand Down
8 changes: 5 additions & 3 deletions src/view/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ export default class Position {
* * {@link module:engine/view/position~Position.createFromPosition}.
*
* @param {module:engine/view/item~Item|module:engine/model/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/view/item~Item view item}.
*/
static createAt( itemOrPosition, offset ) {
Expand All @@ -304,8 +304,10 @@ export default class Position {
return this.createBefore( node );
} else if ( offset == 'after' ) {
return this.createAfter( node );
} else if ( !offset ) {
offset = 0;
} else if ( offset !== 0 && !offset ) {
throw new CKEditorError(
'view-position-createAt-required-second-parameter: ' +
'Position.createAt requires the second parameter offset.' );
}

return new Position( node, offset );
Expand Down
2 changes: 1 addition & 1 deletion src/view/range.js
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ export default class Range {
* or on the given {@link module:engine/view/item~Item item}.
*
* @param {module:engine/view/item~Item|module:engine/view/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/view/item~Item view item}.
*/
static createCollapsedAt( itemOrPosition, offset ) {
Expand Down
2 changes: 1 addition & 1 deletion src/view/selection.js
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ export default class Selection {
*
* @fires change
* @param {module:engine/view/item~Item|module:engine/view/position~Position} itemOrPosition
* @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
* @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
* first parameter is a {@link module:engine/view/item~Item view item}.
*/
setFocus( itemOrPosition, offset ) {
Expand Down
6 changes: 3 additions & 3 deletions tests/view/downcastwriter/writer.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ describe( 'DowncastWriter', () => {

describe( 'setSelection()', () => {
it( 'should set document view selection', () => {
const position = ViewPosition.createAt( root );
const position = ViewPosition.createAt( root, 0 );
writer.setSelection( position );

const ranges = Array.from( doc.selection.getRanges() );
Expand All @@ -33,7 +33,7 @@ describe( 'DowncastWriter', () => {
} );

it( 'should be able to set fake selection', () => {
const position = ViewPosition.createAt( root );
const position = ViewPosition.createAt( root, 0 );
writer.setSelection( position, { fake: true, label: 'foo' } );

expect( doc.selection.isFake ).to.be.true;
Expand All @@ -43,7 +43,7 @@ describe( 'DowncastWriter', () => {

describe( 'setSelectionFocus()', () => {
it( 'should use selection._setFocus method internally', () => {
const position = ViewPosition.createAt( root );
const position = ViewPosition.createAt( root, 0 );
writer.setSelection( position );

const spy = sinon.spy( writer.document.selection, '_setFocus' );
Expand Down
2 changes: 1 addition & 1 deletion tests/view/position.js
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ describe( 'Position', () => {
} );

it( 'for two positions in the same element returns the element', () => {
const startMaecenasPosition = Position.createAt( liOl2 );
const startMaecenasPosition = Position.createAt( liOl2, 0 );
const beforeTellusPosition = new Position( liOl2, 18 );

test( startMaecenasPosition, beforeTellusPosition, liOl2 );
Expand Down
2 changes: 1 addition & 1 deletion tests/view/range.js
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ describe( 'Range', () => {
describe( 'createCollapsedAt()', () => {
it( 'should return new collapsed range at the given item position', () => {
const item = new Element( 'p', null, new Text( 'foo' ) );
const range = Range.createCollapsedAt( item );
const range = Range.createCollapsedAt( item, 0 );

expect( range.start.parent ).to.equal( item );
expect( range.start.offset ).to.equal( 0 );
Expand Down
4 changes: 2 additions & 2 deletions tests/view/view/view.js
Original file line number Diff line number Diff line change
Expand Up @@ -478,8 +478,8 @@ describe( 'view', () => {

return element;
} );
writer.insert( ViewPosition.createAt( p ), ui );
writer.insert( ViewPosition.createAt( viewRoot ), p );
writer.insert( ViewPosition.createAt( p, 0 ), ui );
writer.insert( ViewPosition.createAt( viewRoot, 0 ), p );
} );

expect( renderingCalled ).to.be.true;
Expand Down

0 comments on commit a740dbd

Please sign in to comment.