JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
/*!
|
2013-01-15 23:38:49 +00:00
|
|
|
* VisualEditor ContentEditable Document class.
|
2012-07-19 21:25:16 +00:00
|
|
|
*
|
2013-02-19 23:37:34 +00:00
|
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
2012-07-19 00:11:26 +00:00
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
*/
|
|
|
|
|
2012-05-03 20:21:13 +00:00
|
|
|
/**
|
|
|
|
* ContentEditable document.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-03 20:21:13 +00:00
|
|
|
* @class
|
JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
* @extends ve.Document
|
ve.Element refactor
Objectives:
* Move ve.ui.Element to ve.Element
* Make CE nodes inherit from ve.Element
Changes:
ve.ui.Element.js, ve.Element.js
* Move and rename
* Move ve.ui.get$$ to ve.Element.static.get$$
* Add static getDocument and getWindow methods
* Add instance getElementDocument and getElementWindow methods
* Add getTagName method, which by default reads the static tagName property, but when overridden can return a tag name based on other factors
*.php
* Updated file link
ve.ce.*Annotation.js, ve.ce.*Node.js, ve.ce.View.js, ve.ce.Document
* Added config options pass through
* Replaced passing elements through constructor with defining static tag names
* Added getTagName overrides where needed that derive tag name from model
* Refactore dom wrapper methods, now consistently using getTagName
ve.ce.Surface.js
* Removed static initialization (not needed)
ve.dm.Model.js, ve.ui.Window.js
* Added missing docs
ve.ui.GroupElement.js, ve.ui.Layout.js, ve.ui.Widget.js,
* Updated class name for elements
ve.ui.Frame.js, ve.ui.LookupInputWidget.js
* Updated location of get$$
ve.ui.js
* Move get$$ to ve.Element
ve.js
* Add auto-init of static properties to mixinClass
Change-Id: I39ae14966456903728e4d9e53f806ddce9ca2b70
2013-05-13 20:52:59 +00:00
|
|
|
*
|
2012-05-03 20:21:13 +00:00
|
|
|
* @constructor
|
2012-09-17 13:30:50 +00:00
|
|
|
* @param {ve.dm.Document} model Model to observe
|
The Great ve.ui.Surface refactor of 2013
Prologue:
Farewell ve.Editor my good chap… Oh, hey there HTML frames - I didn't
see you there! In a world where iframes are outlaws, and symbols like
document and window are global, there were more than a few assumptions
about which document or window was being used. But fear not - for this
commit (probably) tracks them all down, leaving a trail of
iframe-compatible awesomeness in its wake. With the great ve.ui.Surface
now able to be used inside of iframes, let the reference editing
commence. But there, lurking in the darkness is a DM issue so fierce it
may take Roan and/or Ed up to 3 whole hours to sort it out.
Note to Roan and/or Ed:
Editing references seems to work fine, but when saving the page there
are "no changes" which is a reasonable indication to the contrary.
Objectives:
* Make it possible to have multiple surfaces be instantiated, get along
nicely, and be embedded inside of iframes if needed.
* Make reference content editable within a dialog
Approach:
* Move what's left of ve.Editor to ve.ui.Surface and essentially
obliterate all use of it
* Make even more stuff inherit from ve.Element (long live this.$$)
* Use the correct document or window anywhere it was being assumed to be
the top level one
* Resolve stacking order issues by removing the excessive use of z-index
and introducing global and local overlay elements for each editor
* Add a surface to the reference dialog, load up the reference contents
and save them back on apply
* Actually destroy what we create in ce and ui surfaces
* Add recursive frame offset calculation method to ve.Element
* Moved ve.ce.Surface's getSelectionRect method to the prototype
Bonus:
* Move ve.ce.DocumentNode.css contents to ve.ce.Node.css (not sure why it
was separate in the first place, but I'm likely the one to blame)
* Fix blatant lies in documentation
* Whitespace cleanup here and there
* Get rid of ve.ui.Window overlays - not used or needed
Change-Id: Iede83e7d24f7cb249b6ba3dc45d770445b862e08
2013-05-20 22:45:50 +00:00
|
|
|
* @param {ve.ce.Surface} surface Surface document is part of
|
2012-05-03 20:21:13 +00:00
|
|
|
*/
|
2012-09-06 23:15:55 +00:00
|
|
|
ve.ce.Document = function VeCeDocument( model, surface ) {
|
Object management: Object create/inherit/clone utilities
* For the most common case:
- replace ve.extendClass with ve.inheritClass (chose slightly
different names to detect usage of the old/new one, and I
like 'inherit' better).
- move it up to below the constructor, see doc block for why.
* Cases where more than 2 arguments were passed to
ve.extendClass are handled differently depending on the case.
In case of a longer inheritance tree, the other arguments
could be omitted (like in "ve.ce.FooBar, ve.FooBar,
ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
because ve.ce.FooBar inherits from ve.Bar).
In the case of where it previously had two mixins with
ve.extendClass(), either one becomes inheritClass and one
a mixin, both to mixinClass().
No visible changes should come from this commit as the
instances still all have the same visible properties in the
end. No more or less than before.
* Misc.:
- Be consistent in calling parent constructors in the
same order as the inheritance.
- Add missing @extends and @param documentation.
- Replace invalid {Integer} type hint with {Number}.
- Consistent doc comments order:
@class, @abstract, @constructor, @extends, @params.
- Fix indentation errors
A fairly common mistake was a superfluous space before the
identifier on the assignment line directly below the
documentation comment.
$ ack "^ [^*]" --js modules/ve
- Typo "Inhertiance" -> "Inheritance".
- Replacing the other confusing comment "Inheritance" (inside
the constructor) with "Parent constructor".
- Add missing @abstract for ve.ui.Tool.
- Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
- Add function names to all @constructor functions. Now that we
have inheritance it is important and useful to have these
functions not be anonymous.
Example of debug shot: http://cl.ly/image/1j3c160w3D45
Makes the difference between
< documentNode;
> ve_dm_DocumentNode
...
: ve_dm_BranchNode
...
: ve_dm_Node
...
: ve_dm_Node
...
: Object
...
without names (current situation):
< documentNode;
> Object
...
: Object
...
: Object
...
: Object
...
: Object
...
though before this commit, it really looks like this
(flattened since ve.extendClass really did a mixin):
< documentNode;
> Object
...
...
...
Pattern in Sublime (case-sensitive) to find nameless
constructor functions:
"^ve\..*\.([A-Z])([^\.]+) = function \("
Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
|
|
|
// Parent constructor
|
2012-06-14 04:46:29 +00:00
|
|
|
ve.Document.call( this, new ve.ce.DocumentNode( model.getDocumentNode(), surface ) );
|
2012-05-10 04:11:09 +00:00
|
|
|
|
2012-05-03 20:21:13 +00:00
|
|
|
// Properties
|
2012-05-10 04:11:09 +00:00
|
|
|
this.model = model;
|
2012-05-03 20:21:13 +00:00
|
|
|
};
|
2012-05-10 04:11:09 +00:00
|
|
|
|
Object management: Object create/inherit/clone utilities
* For the most common case:
- replace ve.extendClass with ve.inheritClass (chose slightly
different names to detect usage of the old/new one, and I
like 'inherit' better).
- move it up to below the constructor, see doc block for why.
* Cases where more than 2 arguments were passed to
ve.extendClass are handled differently depending on the case.
In case of a longer inheritance tree, the other arguments
could be omitted (like in "ve.ce.FooBar, ve.FooBar,
ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
because ve.ce.FooBar inherits from ve.Bar).
In the case of where it previously had two mixins with
ve.extendClass(), either one becomes inheritClass and one
a mixin, both to mixinClass().
No visible changes should come from this commit as the
instances still all have the same visible properties in the
end. No more or less than before.
* Misc.:
- Be consistent in calling parent constructors in the
same order as the inheritance.
- Add missing @extends and @param documentation.
- Replace invalid {Integer} type hint with {Number}.
- Consistent doc comments order:
@class, @abstract, @constructor, @extends, @params.
- Fix indentation errors
A fairly common mistake was a superfluous space before the
identifier on the assignment line directly below the
documentation comment.
$ ack "^ [^*]" --js modules/ve
- Typo "Inhertiance" -> "Inheritance".
- Replacing the other confusing comment "Inheritance" (inside
the constructor) with "Parent constructor".
- Add missing @abstract for ve.ui.Tool.
- Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
- Add function names to all @constructor functions. Now that we
have inheritance it is important and useful to have these
functions not be anonymous.
Example of debug shot: http://cl.ly/image/1j3c160w3D45
Makes the difference between
< documentNode;
> ve_dm_DocumentNode
...
: ve_dm_BranchNode
...
: ve_dm_Node
...
: ve_dm_Node
...
: Object
...
without names (current situation):
< documentNode;
> Object
...
: Object
...
: Object
...
: Object
...
: Object
...
though before this commit, it really looks like this
(flattened since ve.extendClass really did a mixin):
< documentNode;
> Object
...
...
...
Pattern in Sublime (case-sensitive) to find nameless
constructor functions:
"^ve\..*\.([A-Z])([^\.]+) = function \("
Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
|
|
|
/* Inheritance */
|
|
|
|
|
|
|
|
ve.inheritClass( ve.ce.Document, ve.Document );
|
|
|
|
|
2012-05-30 21:38:02 +00:00
|
|
|
/* Methods */
|
|
|
|
|
2013-01-15 23:38:49 +00:00
|
|
|
/**
|
|
|
|
* Get a node a an offset.
|
|
|
|
*
|
|
|
|
* @method
|
2013-01-17 20:24:28 +00:00
|
|
|
* @param {number} offset Offset to get node at
|
2013-01-15 23:38:49 +00:00
|
|
|
* @returns {ve.ce.Node} Node at offset
|
|
|
|
*/
|
2012-08-07 01:50:44 +00:00
|
|
|
ve.ce.Document.prototype.getNodeFromOffset = function ( offset ) {
|
2012-05-30 21:38:02 +00:00
|
|
|
var node = this.documentNode.getNodeFromOffset( offset );
|
2012-11-21 21:22:29 +00:00
|
|
|
if ( node && !node.canHaveChildren() ) {
|
2012-05-30 21:38:02 +00:00
|
|
|
node = node.getParent();
|
|
|
|
}
|
|
|
|
return node;
|
|
|
|
};
|
2012-10-03 22:40:00 +00:00
|
|
|
|
2013-01-15 23:38:49 +00:00
|
|
|
/**
|
|
|
|
* Get a slug a an offset.
|
|
|
|
*
|
|
|
|
* @method
|
2013-01-17 20:24:28 +00:00
|
|
|
* @param {number} offset Offset to get slug at
|
2013-01-15 23:38:49 +00:00
|
|
|
* @returns {jQuery} Slug at offset
|
|
|
|
*/
|
2012-10-03 22:40:00 +00:00
|
|
|
ve.ce.Document.prototype.getSlugAtOffset = function ( offset ) {
|
|
|
|
var node = this.getNodeFromOffset( offset );
|
2012-11-21 21:22:29 +00:00
|
|
|
return node ? node.getSlugAtOffset( offset ) : null;
|
2012-10-03 22:40:00 +00:00
|
|
|
};
|
2013-03-21 21:30:04 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the nearest word boundary.
|
2013-03-26 06:10:17 +00:00
|
|
|
* This method is in CE instead of DM because its behaviour depends on the browser (IE/non-IE) and
|
|
|
|
* that information is closer to view layer. (CE)
|
2013-03-21 21:30:04 +00:00
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @param {number} offset Offset to start from
|
|
|
|
* @param {number} [direction] Direction to prefer matching offset in, -1 for left and 1 for right
|
|
|
|
* @returns {number} Nearest word boundary
|
|
|
|
*/
|
|
|
|
ve.ce.Document.prototype.getSiblingWordBoundary = function ( offset, direction ) {
|
2013-04-12 11:12:53 +00:00
|
|
|
var dataString = new ve.dm.DataString( this.model.getData() );
|
|
|
|
return unicodeJS.wordbreak.moveBreakOffset( direction, dataString, offset, true );
|
2013-03-22 18:41:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the relative word or character boundary.
|
2013-03-26 06:10:17 +00:00
|
|
|
* This method is in CE instead of DM because it uses information about slugs about which model
|
|
|
|
* does not know at all.
|
|
|
|
*
|
2013-03-22 18:41:26 +00:00
|
|
|
* @method
|
|
|
|
* @param {number} offset Offset to start from
|
|
|
|
* @param {number} [direction] Direction to prefer matching offset in, -1 for left and 1 for right
|
|
|
|
* @param {string} [unit] Unit [word|character]
|
|
|
|
* @returns {number} Relative offset
|
|
|
|
*/
|
|
|
|
ve.ce.Document.prototype.getRelativeOffset = function ( offset, direction, unit ) {
|
2013-04-15 23:10:32 +00:00
|
|
|
var bias, relativeContentOffset, relativeStructuralOffset, newOffset;
|
2013-03-22 18:41:26 +00:00
|
|
|
if ( unit === 'word' ) { // word
|
2013-04-15 23:10:32 +00:00
|
|
|
// Method getSiblingWordBoundary does not "move/jump" over element data. If passed offset is
|
|
|
|
// an element data offset then the same offset is returned - and in such case this method
|
|
|
|
// fallback to the other path (character) which does "move/jump" over element data.
|
|
|
|
newOffset = this.getSiblingWordBoundary( offset, direction );
|
|
|
|
if ( offset === newOffset ) {
|
|
|
|
newOffset = this.getRelativeOffset( offset, direction, 'character' );
|
|
|
|
}
|
|
|
|
return newOffset;
|
2013-03-22 18:41:26 +00:00
|
|
|
} else { // character
|
2013-03-25 23:43:36 +00:00
|
|
|
bias = direction > 0 ? 1 : -1;
|
2013-03-20 22:35:05 +00:00
|
|
|
relativeContentOffset = this.model.data.getRelativeContentOffset( offset, direction );
|
|
|
|
relativeStructuralOffset = this.model.data.getRelativeStructuralOffset( offset + bias, direction, true );
|
2013-03-25 23:43:36 +00:00
|
|
|
// Check if we've moved into a slug
|
|
|
|
if ( !!this.getSlugAtOffset( relativeStructuralOffset ) ) {
|
|
|
|
// Check if the relative content offset is in the opposite direction we are trying to go
|
2013-04-15 21:59:04 +00:00
|
|
|
if (
|
|
|
|
relativeContentOffset === offset ||
|
|
|
|
( relativeContentOffset - offset < 0 ? -1 : 1 ) !== bias
|
|
|
|
) {
|
2013-03-25 23:43:36 +00:00
|
|
|
// There's nothing past the slug we are already in, stay in it
|
|
|
|
return relativeStructuralOffset;
|
|
|
|
}
|
|
|
|
// There's a slug neaby, go into it if it's closer
|
|
|
|
return direction > 0 ?
|
|
|
|
Math.min( relativeContentOffset, relativeStructuralOffset ) :
|
|
|
|
Math.max( relativeContentOffset, relativeStructuralOffset );
|
|
|
|
} else {
|
|
|
|
return relativeContentOffset;
|
|
|
|
}
|
2013-03-22 18:41:26 +00:00
|
|
|
}
|
2013-03-26 06:10:17 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a DOM node and DOM element offset for a document offset.
|
|
|
|
*
|
|
|
|
* The results of this function are meant to be used with rangy.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @param {number} offset Linear model offset
|
|
|
|
* @returns {Object} Object containing a node and offset property where node is an HTML element and
|
2013-05-20 16:24:33 +00:00
|
|
|
* offset is the byte position within the element
|
2013-03-26 06:10:17 +00:00
|
|
|
* @throws {Error} Offset could not be translated to a DOM element and offset
|
|
|
|
*/
|
|
|
|
ve.ce.Document.prototype.getNodeAndOffset = function ( offset ) {
|
|
|
|
var node, startOffset, current, stack, item, $item, length,
|
|
|
|
$slug = this.getSlugAtOffset( offset );
|
|
|
|
if ( $slug ) {
|
|
|
|
return { node: $slug[0].childNodes[0], offset: 0 };
|
|
|
|
}
|
|
|
|
node = this.getNodeFromOffset( offset );
|
2013-05-09 22:50:09 +00:00
|
|
|
startOffset = node.getOffset() + ( ( node.isWrapped() ) ? 1 : 0 );
|
2013-03-26 06:10:17 +00:00
|
|
|
current = [node.$.contents(), 0];
|
|
|
|
stack = [current];
|
|
|
|
while ( stack.length > 0 ) {
|
|
|
|
if ( current[1] >= current[0].length ) {
|
|
|
|
stack.pop();
|
|
|
|
current = stack[ stack.length - 1 ];
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
item = current[0][current[1]];
|
|
|
|
if ( item.nodeType === Node.TEXT_NODE ) {
|
2013-06-07 13:26:46 +00:00
|
|
|
// offset, startOffset and length are all data model lengths (not byte lengths)
|
|
|
|
length = ve.getClusterOffset( item.textContent, item.textContent.length );
|
2013-03-26 06:10:17 +00:00
|
|
|
if ( offset >= startOffset && offset <= startOffset + length ) {
|
|
|
|
return {
|
|
|
|
node: item,
|
2013-05-20 16:24:33 +00:00
|
|
|
offset: ve.getByteOffset( item.textContent, offset - startOffset )
|
2013-03-26 06:10:17 +00:00
|
|
|
};
|
|
|
|
} else {
|
|
|
|
startOffset += length;
|
|
|
|
}
|
|
|
|
} else if ( item.nodeType === Node.ELEMENT_NODE ) {
|
|
|
|
$item = current[0].eq( current[1] );
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
if ( $item.hasClass( 've-ce-branchNode-slug' ) ) {
|
2013-03-26 06:10:17 +00:00
|
|
|
if ( offset === startOffset ) {
|
|
|
|
return {
|
|
|
|
node: $item[0],
|
|
|
|
offset: 1
|
|
|
|
};
|
|
|
|
}
|
|
|
|
} else if ( $item.is( '.ve-ce-branchNode, .ve-ce-leafNode' ) ) {
|
2013-04-02 19:33:22 +00:00
|
|
|
length = $item.data( 'view' ).model.getOuterLength();
|
2013-03-26 06:10:17 +00:00
|
|
|
if ( offset >= startOffset && offset < startOffset + length ) {
|
|
|
|
stack.push( [$item.contents(), 0] );
|
|
|
|
current[1]++;
|
|
|
|
current = stack[stack.length-1];
|
|
|
|
continue;
|
|
|
|
} else {
|
|
|
|
startOffset += length;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
stack.push( [$item.contents(), 0] );
|
|
|
|
current[1]++;
|
|
|
|
current = stack[stack.length-1];
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
current[1]++;
|
|
|
|
}
|
|
|
|
throw new Error( 'Offset could not be translated to a DOM element and offset: ' + offset );
|
2013-03-20 22:35:05 +00:00
|
|
|
};
|
2013-06-01 04:53:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the nearest focusable node.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @param {number} offset Offset to start looking at
|
|
|
|
* @param {number} direction Direction to look in, +1 or -1
|
|
|
|
* @param {number} limit Stop looking after reaching certain offset
|
|
|
|
*/
|
|
|
|
ve.ce.Document.prototype.getNearestFocusableNode = function ( offset, direction, limit ) {
|
|
|
|
// It is never an offset of the node, but just an offset for which getNodeFromOffset should
|
|
|
|
// return that node. Usually it would be node offset + 1 or offset of node closing tag.
|
|
|
|
var coveredOffset;
|
|
|
|
this.model.data.getRelativeOffset(
|
|
|
|
offset,
|
|
|
|
direction === 1 ? 0 : -1,
|
|
|
|
function ( index, limit ) {
|
|
|
|
if ( ( index >= limit ? 1 : -1 ) === direction ) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
if (
|
|
|
|
this.isOpenElementData( index ) &&
|
|
|
|
ve.dm.nodeFactory.isNodeFocusable( this.getType( index ) )
|
|
|
|
) {
|
|
|
|
coveredOffset = index + 1;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
if (
|
|
|
|
this.isCloseElementData( index ) &&
|
|
|
|
ve.dm.nodeFactory.isNodeFocusable( this.getType( index ) )
|
|
|
|
) {
|
|
|
|
coveredOffset = index;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
},
|
|
|
|
limit
|
|
|
|
);
|
|
|
|
if ( coveredOffset ) {
|
|
|
|
return this.documentNode.getNodeFromOffset( coveredOffset );
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the relative range.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @param {ve.Range} range Input range
|
|
|
|
* @param {number} direction Direction to look in, +1 or -1
|
|
|
|
* @param {string} unit Unit [word|character]
|
|
|
|
* @param {boolean} expand Expanding range
|
|
|
|
* @returns {ve.Range} Relative range
|
|
|
|
*/
|
2013-06-06 12:02:16 +00:00
|
|
|
ve.ce.Document.prototype.getRelativeRange = function ( range, direction, unit, expand ) {
|
2013-06-01 04:53:33 +00:00
|
|
|
var contentOrSlugOffset,
|
|
|
|
focusableNode,
|
|
|
|
node;
|
|
|
|
|
|
|
|
contentOrSlugOffset = this.getRelativeOffset( range.to, direction, unit );
|
|
|
|
|
|
|
|
if ( expand ) {
|
|
|
|
return new ve.Range( range.from, contentOrSlugOffset );
|
|
|
|
}
|
|
|
|
|
|
|
|
node = this.documentNode.getNodeFromOffset( range.start + 1 );
|
|
|
|
if ( node && ve.dm.nodeFactory.isNodeFocusable( node.type ) ) {
|
|
|
|
if ( node === this.documentNode.getNodeFromOffset( range.end - 1 ) ) {
|
|
|
|
if ( this.model.data.isContentOffset( range.to ) || !!this.getSlugAtOffset( range.to ) ) {
|
|
|
|
return new ve.Range( direction === 1 ? range.end : range.start );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
focusableNode = this.getNearestFocusableNode( range.to, direction, contentOrSlugOffset );
|
|
|
|
if ( focusableNode ) {
|
|
|
|
return focusableNode.getOuterRange( direction === -1 /* backwards */ );
|
|
|
|
} else {
|
|
|
|
return new ve.Range( contentOrSlugOffset );
|
|
|
|
}
|
|
|
|
};
|